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

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