gerrit.onap Code Review - policy/common.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.common.parameters.testclasses;
  22
  23 import java.util.LinkedHashMap;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26
  27 import org.onap.policy.common.parameters.GroupValidationResult;
  28 import org.onap.policy.common.parameters.ParameterConstants;
  29 import org.onap.policy.common.parameters.ParameterGroup;
  30 import org.onap.policy.common.parameters.ValidationStatus;
  31
  32 public class TestParametersL00 implements ParameterGroup {
  33     private String name;
  34     private int l00IntField = 0;
  35     private String l00StringField = "Legal " + this.getClass().getCanonicalName();
  36     private TestParametersL10 l00L10Nested = new TestParametersL10("l00L10Nested");
  37     private TestParametersLGeneric l00LGenericNested = new TestParametersLGeneric("l00LGenericNested");
  38     private Map<String, TestParametersLGeneric> l00LGenericNestedMap = new LinkedHashMap<>();
  39
  40     /**
  41      * Default constructor.
  42      */
  43     public TestParametersL00() {
  44         // Default Cnstructor
  45     }
  46
  47     /**
  48      * Create a test parameter group.
  49      *
  50      * @param name the parameter group name
  51      */
  52     public TestParametersL00(final String name) {
  53         this.name = name;
  54
  55         TestParametersLGeneric l00LGenericNestedMapVal0 = new TestParametersLGeneric("l00LGenericNestedMapVal0");
  56         l00LGenericNestedMap.put(l00LGenericNestedMapVal0.getName(), l00LGenericNestedMapVal0);
  57         TestParametersLGeneric l00LGenericNestedMapVal1 = new TestParametersLGeneric("l00LGenericNestedMapVal1");
  58         l00LGenericNestedMap.put(l00LGenericNestedMapVal1.getName(), l00LGenericNestedMapVal1);
  59     }
  60
  61     public void setName(String name) {
  62         this.name = name;
  63     }
  64
  65     public void setL00IntField(int l00IntField) {
  66         this.l00IntField = l00IntField;
  67     }
  68
  69     public void setL00StringField(String l00StringField) {
  70         this.l00StringField = l00StringField;
  71     }
  72
  73     public void setL00L10Nested(TestParametersL10 l00l10Nested) {
  74         l00L10Nested = l00l10Nested;
  75     }
  76
  77     public void setL00LGenericNested(TestParametersLGeneric l00lGenericNested) {
  78         l00LGenericNested = l00lGenericNested;
  79     }
  80
  81     public void setL00LGenericNestedMap(Map<String, TestParametersLGeneric> l00lGenericNestedMap) {
  82         l00LGenericNestedMap = l00lGenericNestedMap;
  83     }
  84
  85     /**
  86      * Trigger a validation message.
  87      *
  88      * @param triggerStatus Validation status to trigger
  89      * @param level Number of levels to recurse before stopping
  90      */
  91     public void triggerValidationStatus(final ValidationStatus triggerStatus, int level) {
  92         if (level == 0) {
  93             return;
  94         } else {
  95             level--;
  96         }
  97
  98         switch (triggerStatus) {
  99             case CLEAN:
 100                 l00StringField = "Legal " + this.getClass().getCanonicalName();
 101                 l00IntField = 0;
 102                 break;
 103             case OBSERVATION:
 104                 l00StringField = "aString";
 105                 l00IntField = 2;
 106                 break;
 107             case WARNING:
 108                 l00StringField = "l00StringField";
 109                 l00IntField = 3;
 110                 break;
 111             case INVALID:
 112                 l00StringField = "";
 113                 l00IntField = -1;
 114                 break;
 115             default:
 116                 break;
 117         }
 118
 119         l00L10Nested.triggerValidationStatus(triggerStatus, level);
 120         l00LGenericNested.triggerValidationStatus(triggerStatus, level);
 121
 122         for (TestParametersLGeneric nestedParameterGroup : l00LGenericNestedMap.values()) {
 123             nestedParameterGroup.triggerValidationStatus(triggerStatus, level);
 124         }
 125
 126     }
 127
 128     @Override
 129     public String getName() {
 130         return name;
 131     }
 132
 133     @Override
 134     public GroupValidationResult validate() {
 135         GroupValidationResult validationResult = new GroupValidationResult(this);
 136
 137         if (name == null || name.trim().length() == 0) {
 138             validationResult.setResult("name", ValidationStatus.INVALID, "name must be a non-blank string");
 139         }
 140
 141         if (l00StringField == null || l00StringField.trim().length() == 0) {
 142             validationResult.setResult("l00StringField", ValidationStatus.INVALID,
 143                             "l00StringField must be a non-blank string");
 144         } else if (l00StringField.equals("l00StringField")) {
 145             validationResult.setResult("l00StringField", ValidationStatus.WARNING,
 146                             "using the field name for the parameter value is dangerous");
 147         } else if (l00StringField.equals("aString")) {
 148             validationResult.setResult("l00StringField", ValidationStatus.OBSERVATION,
 149                             "this value for name is unhelpful");
 150         } else {
 151             validationResult.setResult("l00StringField", ValidationStatus.CLEAN,
 152                             ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
 153         }
 154
 155         if (l00IntField < 0) {
 156             validationResult.setResult("l00IntField", ValidationStatus.INVALID,
 157                             "l00IntField must be a positive integer");
 158         } else if (l00IntField > 2) {
 159             validationResult.setResult("l00IntField", ValidationStatus.WARNING,
 160                             "values greater than 2 are not recommended");
 161         } else if (l00IntField == 2) {
 162             validationResult.setResult("l00IntField", ValidationStatus.OBSERVATION, "this field has been set to 2");
 163         } else {
 164             validationResult.setResult("l00IntField", ValidationStatus.CLEAN,
 165                             ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
 166         }
 167
 168         validationResult.setResult("l00L10Nested", l00L10Nested.validate());
 169         validationResult.setResult("l00LGenericNested", l00LGenericNested.validate());
 170
 171         for (Entry<String, TestParametersLGeneric> nestedGroupEntry : l00LGenericNestedMap.entrySet()) {
 172             validationResult.setResult("l00LGenericNestedMap", nestedGroupEntry.getKey(),
 173                             nestedGroupEntry.getValue().validate());
 174         }
 175
 176         return validationResult;
 177     }
 178 }