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 static final String A_CONSTANT = "A Constant";
  34
  35     private String name = A_CONSTANT;
  36     private int l00IntField = 0;
  37     private String l00StringField = "Legal " + this.getClass().getCanonicalName();
  38     private TestParametersL10 l00L10Nested = new TestParametersL10("l00L10Nested");
  39     private TestParametersLGeneric l00LGenericNested = new TestParametersLGeneric("l00LGenericNested");
  40     private Map<String, TestParametersLGeneric> l00LGenericNestedMap = new LinkedHashMap<>();
  41     private boolean isSomeFlag;
  42     private boolean someNonIsFlag;
  43
  44     /**
  45      * Default constructor.
  46      */
  47     public TestParametersL00() {
  48         // Default Cnstructor
  49     }
  50
  51     /**
  52      * Create a test parameter group.
  53      *
  54      * @param name the parameter group name
  55      */
  56     public TestParametersL00(final String name) {
  57         this.name = name;
  58
  59         TestParametersLGeneric l00LGenericNestedMapVal0 = new TestParametersLGeneric("l00LGenericNestedMapVal0");
  60         l00LGenericNestedMap.put(l00LGenericNestedMapVal0.getName(), l00LGenericNestedMapVal0);
  61         TestParametersLGeneric l00LGenericNestedMapVal1 = new TestParametersLGeneric("l00LGenericNestedMapVal1");
  62         l00LGenericNestedMap.put(l00LGenericNestedMapVal1.getName(), l00LGenericNestedMapVal1);
  63     }
  64
  65     public int getL00IntField() {
  66         return l00IntField;
  67     }
  68
  69     public String getL00StringField() {
  70         return l00StringField;
  71     }
  72
  73     public TestParametersL10 getL00L10Nested() {
  74         return l00L10Nested;
  75     }
  76
  77     public TestParametersLGeneric getL00LGenericNested() {
  78         return l00LGenericNested;
  79     }
  80
  81     public Map<String, TestParametersLGeneric> getL00LGenericNestedMap() {
  82         return l00LGenericNestedMap;
  83     }
  84
  85     public boolean isSomeFlag() {
  86         return isSomeFlag;
  87     }
  88
  89     public boolean isSomeNonIsFlag() {
  90         return someNonIsFlag;
  91     }
  92
  93     public void setSomeFlag(boolean isSomeFlag) {
  94         this.isSomeFlag = isSomeFlag;
  95     }
  96
  97     public void setName(String name) {
  98         this.name = name;
  99     }
 100
 101     public void setL00IntField(int l00IntField) {
 102         this.l00IntField = l00IntField;
 103     }
 104
 105     public void setL00StringField(String l00StringField) {
 106         this.l00StringField = l00StringField;
 107     }
 108
 109     public void setL00L10Nested(TestParametersL10 l00l10Nested) {
 110         l00L10Nested = l00l10Nested;
 111     }
 112
 113     public void setL00LGenericNested(TestParametersLGeneric l00lGenericNested) {
 114         l00LGenericNested = l00lGenericNested;
 115     }
 116
 117     public void setL00LGenericNestedMap(Map<String, TestParametersLGeneric> l00lGenericNestedMap) {
 118         l00LGenericNestedMap = l00lGenericNestedMap;
 119     }
 120
 121     /**
 122      * Trigger a validation message.
 123      *
 124      * @param triggerStatus Validation status to trigger
 125      * @param level Number of levels to recurse before stopping
 126      */
 127     public void triggerValidationStatus(final ValidationStatus triggerStatus, int level) {
 128         if (level == 0) {
 129             return;
 130         } else {
 131             level--;
 132         }
 133
 134         switch (triggerStatus) {
 135             case CLEAN:
 136                 l00StringField = "Legal " + this.getClass().getCanonicalName();
 137                 l00IntField = 0;
 138                 break;
 139             case OBSERVATION:
 140                 l00StringField = "aString";
 141                 l00IntField = 2;
 142                 break;
 143             case WARNING:
 144                 l00StringField = "l00StringField";
 145                 l00IntField = 3;
 146                 break;
 147             case INVALID:
 148                 l00StringField = "";
 149                 l00IntField = -1;
 150                 break;
 151             default:
 152                 break;
 153         }
 154
 155         l00L10Nested.triggerValidationStatus(triggerStatus, level);
 156         l00LGenericNested.triggerValidationStatus(triggerStatus, level);
 157
 158         for (TestParametersLGeneric nestedParameterGroup : l00LGenericNestedMap.values()) {
 159             nestedParameterGroup.triggerValidationStatus(triggerStatus, level);
 160         }
 161
 162     }
 163
 164     @Override
 165     public String getName() {
 166         return name;
 167     }
 168
 169     @Override
 170     public GroupValidationResult validate() {
 171         GroupValidationResult validationResult = new GroupValidationResult(this);
 172
 173         if (name == null || name.trim().length() == 0) {
 174             validationResult.setResult("name", ValidationStatus.INVALID, "name must be a non-blank string");
 175         }
 176
 177         if (l00StringField == null || l00StringField.trim().length() == 0) {
 178             validationResult.setResult("l00StringField", ValidationStatus.INVALID,
 179                             "l00StringField must be a non-blank string");
 180         } else if (l00StringField.equals("l00StringField")) {
 181             validationResult.setResult("l00StringField", ValidationStatus.WARNING,
 182                             "using the field name for the parameter value is dangerous");
 183         } else if (l00StringField.equals("aString")) {
 184             validationResult.setResult("l00StringField", ValidationStatus.OBSERVATION,
 185                             "this value for name is unhelpful");
 186         } else {
 187             validationResult.setResult("l00StringField", ValidationStatus.CLEAN,
 188                             ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
 189         }
 190
 191         if (l00IntField < 0) {
 192             validationResult.setResult("l00IntField", ValidationStatus.INVALID,
 193                             "l00IntField must be a positive integer");
 194         } else if (l00IntField > 2) {
 195             validationResult.setResult("l00IntField", ValidationStatus.WARNING,
 196                             "values greater than 2 are not recommended");
 197         } else if (l00IntField == 2) {
 198             validationResult.setResult("l00IntField", ValidationStatus.OBSERVATION, "this field has been set to 2");
 199         } else {
 200             validationResult.setResult("l00IntField", ValidationStatus.CLEAN,
 201                             ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
 202         }
 203
 204         validationResult.setResult("l00L10Nested", l00L10Nested.validate());
 205         validationResult.setResult("l00LGenericNested", l00LGenericNested.validate());
 206
 207         for (Entry<String, TestParametersLGeneric> nestedGroupEntry : l00LGenericNestedMap.entrySet()) {
 208             validationResult.setResult("l00LGenericNestedMap", nestedGroupEntry.getKey(),
 209                             nestedGroupEntry.getValue().validate());
 210         }
 211
 212         return validationResult;
 213     }
 214 }