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