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.ParameterGroup;
  28 import org.onap.policy.common.parameters.GroupValidationResult;
  29 import org.onap.policy.common.parameters.ParameterConstants;
  30 import org.onap.policy.common.parameters.ValidationStatus;
  31
  32 public class TestParametersL10 implements ParameterGroup {
  33     private String name;
  34     private int l10IntField = 0;
  35     private String l10StringField = "Legal " + this.getClass().getCanonicalName();
  36     private TestParametersLGeneric l10LGenericNested0 = new TestParametersLGeneric("l10LGenericNested0");
  37     private TestParametersLGeneric l10LGenericNested1 = new TestParametersLGeneric("l10LGenericNested1");
  38     private Map<String, TestParametersLGeneric> l10LGenericNestedMap = new LinkedHashMap<>();
  39
  40     /**
  41      * Default constructor
  42      */
  43     public TestParametersL10() {
  44     }
  45
  46     /**
  47      * Create a test parameter group.
  48      *
  49      * @param name the parameter group name
  50      */
  51     public TestParametersL10(final String name) {
  52         this.name = name;
  53
  54         TestParametersLGeneric l10LGenericNestedMapVal0 = new TestParametersLGeneric("l10LGenericNestedMapVal0");
  55         l10LGenericNestedMap.put(l10LGenericNestedMapVal0.getName(), l10LGenericNestedMapVal0);
  56         TestParametersLGeneric l10LGenericNestedMapVal1 = new TestParametersLGeneric("l10LGenericNestedMapVal1");
  57         l10LGenericNestedMap.put(l10LGenericNestedMapVal1.getName(), l10LGenericNestedMapVal1);
  58     }
  59
  60     public void setName(String name) {
  61         this.name = name;
  62     }
  63
  64     public void setL10IntField(int l10IntField) {
  65         this.l10IntField = l10IntField;
  66     }
  67
  68     public void setL10StringField(String l10StringField) {
  69         this.l10StringField = l10StringField;
  70     }
  71
  72     public void setL10LGenericNested0(TestParametersLGeneric l10lGenericNested0) {
  73         l10LGenericNested0 = l10lGenericNested0;
  74     }
  75
  76     public void setL10LGenericNested1(TestParametersLGeneric l10lGenericNested1) {
  77         l10LGenericNested1 = l10lGenericNested1;
  78     }
  79
  80     public void setL10LGenericNestedMap(Map<String, TestParametersLGeneric> l10lGenericNestedMap) {
  81         l10LGenericNestedMap = l10lGenericNestedMap;
  82     }
  83
  84     /**
  85      * Trigger a validation message.
  86      *
  87      * @param level Number of levels to recurse before stopping
  88      */
  89     public void triggerValidationStatus(final ValidationStatus triggerStatus, int level) {
  90         if (level == 0) {
  91             return;
  92         }
  93         else {
  94             level--;
  95         }
  96
  97         switch (triggerStatus) {
  98             case CLEAN:
  99                 l10StringField = "Legal " + this.getClass().getCanonicalName();
 100                 l10IntField = 0;
 101                 break;
 102             case OBSERVATION:
 103                 l10StringField = "aString";
 104                 l10IntField = 2;
 105                 break;
 106             case WARNING:
 107                 l10StringField = "l10StringField";
 108                 l10IntField = 3;
 109                 break;
 110             case INVALID:
 111                 l10StringField = "";
 112                 l10IntField = -1;
 113                 break;
 114             default:
 115                 break;
 116         }
 117
 118         l10LGenericNested0.triggerValidationStatus(triggerStatus, level);
 119         l10LGenericNested1.triggerValidationStatus(triggerStatus, level);
 120
 121         for (TestParametersLGeneric nestedParameterGroup : l10LGenericNestedMap.values()) {
 122             nestedParameterGroup.triggerValidationStatus(triggerStatus, level);
 123         }
 124     }
 125
 126     @Override
 127     public String getName() {
 128         return this.name;
 129     }
 130
 131     @Override
 132     public GroupValidationResult validate() {
 133         GroupValidationResult validationResult = new GroupValidationResult(this);
 134
 135         if (l10StringField == null || l10StringField.trim().length() == 0) {
 136             validationResult.setResult("l10StringField", ValidationStatus.INVALID,
 137                             "l10StringField must be a non-blank string");
 138         } else if (l10StringField.equals("l10StringField")) {
 139             validationResult.setResult("l10StringField", ValidationStatus.WARNING,
 140                             "using the field name for the parameter value is dangerous");
 141         } else if (l10StringField.equals("aString")) {
 142             validationResult.setResult("l10StringField", ValidationStatus.OBSERVATION,
 143                             "this value for name is unhelpful");
 144         } else {
 145             validationResult.setResult("l10StringField", ValidationStatus.CLEAN,
 146                             ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
 147         }
 148
 149         if (l10IntField < 0) {
 150             validationResult.setResult("l10IntField", ValidationStatus.INVALID,
 151                             "l10IntField must be a positive integer");
 152         } else if (l10IntField > 2) {
 153             validationResult.setResult("l10IntField", ValidationStatus.WARNING,
 154                             "values greater than 2 are not recommended");
 155         } else if (l10IntField == 2) {
 156             validationResult.setResult("l10IntField", ValidationStatus.OBSERVATION, "this field has been set to 2");
 157         } else {
 158             validationResult.setResult("l10IntField", ValidationStatus.CLEAN,
 159                             ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
 160         }
 161
 162
 163         validationResult.setResult("l10LGenericNested0", l10LGenericNested0.validate());
 164         validationResult.setResult("l10LGenericNested1", l10LGenericNested1.validate());
 165
 166         for (Entry<String, TestParametersLGeneric> nestedGroupEntry : l10LGenericNestedMap.entrySet()) {
 167             validationResult.setResult("l10LGenericNestedMap", nestedGroupEntry.getKey(),
 168                             nestedGroupEntry.getValue().validate());
 169         }
 170
 171         return validationResult;
 172     }
 173 }