aboutsummaryrefslogtreecommitdiffstats
path: root/common-parameters/src/test/java/org/onap/policy/common/parameters/testclasses/TestParametersL00.java
blob: 514405464ae1541db1f375f184ab2c31d5a34628 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019 AT&T Intellectual Property.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.common.parameters.testclasses;

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.Map.Entry;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.common.parameters.GroupValidationResult;
import org.onap.policy.common.parameters.ParameterConstants;
import org.onap.policy.common.parameters.ParameterGroupImpl;
import org.onap.policy.common.parameters.ValidationStatus;

public class TestParametersL00 extends ParameterGroupImpl {
    private static final String L00_INT_FIELD = "l00IntField";
    private static final String L00_STRING_FIELD = "l00StringField";

    private static final String A_CONSTANT = "A Constant";

    private int l00IntField = 0;
    private String l00StringField = "Legal " + this.getClass().getName();
    private TestParametersL10 l00L10Nested = new TestParametersL10("l00L10Nested");
    private TestParametersLGeneric l00LGenericNested = new TestParametersLGeneric("l00LGenericNested");
    private Map<String, TestParametersLGeneric> l00LGenericNestedMap = new LinkedHashMap<>();
    private boolean isSomeFlag;
    private boolean someNonIsFlag;

    /**
     * Default constructor.
     */
    public TestParametersL00() {
        super(A_CONSTANT);
    }

    /**
     * Create a test parameter group.
     *
     * @param name the parameter group name
     */
    public TestParametersL00(final String name) {
        super(name);

        TestParametersLGeneric l00LGenericNestedMapVal0 = new TestParametersLGeneric("l00LGenericNestedMapVal0");
        l00LGenericNestedMap.put(l00LGenericNestedMapVal0.getName(), l00LGenericNestedMapVal0);
        TestParametersLGeneric l00LGenericNestedMapVal1 = new TestParametersLGeneric("l00LGenericNestedMapVal1");
        l00LGenericNestedMap.put(l00LGenericNestedMapVal1.getName(), l00LGenericNestedMapVal1);
    }

    public int getL00IntField() {
        return l00IntField;
    }

    public String getL00StringField() {
        return l00StringField;
    }

    public TestParametersL10 getL00L10Nested() {
        return l00L10Nested;
    }

    public TestParametersLGeneric getL00LGenericNested() {
        return l00LGenericNested;
    }

    public Map<String, TestParametersLGeneric> getL00LGenericNestedMap() {
        return l00LGenericNestedMap;
    }

    public boolean isSomeFlag() {
        return isSomeFlag;
    }

    public boolean isSomeNonIsFlag() {
        return someNonIsFlag;
    }

    public void setSomeFlag(boolean isSomeFlag) {
        this.isSomeFlag = isSomeFlag;
    }

    public void setL00IntField(int l00IntField) {
        this.l00IntField = l00IntField;
    }

    public void setL00StringField(String l00StringField) {
        this.l00StringField = l00StringField;
    }

    public void setL00L10Nested(TestParametersL10 l00l10Nested) {
        l00L10Nested = l00l10Nested;
    }

    public void setL00LGenericNested(TestParametersLGeneric l00lGenericNested) {
        l00LGenericNested = l00lGenericNested;
    }

    public void setL00LGenericNestedMap(Map<String, TestParametersLGeneric> l00lGenericNestedMap) {
        l00LGenericNestedMap = l00lGenericNestedMap;
    }

    /**
     * Trigger a validation message.
     *
     * @param triggerStatus Validation status to trigger
     * @param level Number of levels to recurse before stopping
     */
    public void triggerValidationStatus(final ValidationStatus triggerStatus, int level) {
        if (level == 0) {
            return;
        } else {
            level--;
        }

        switch (triggerStatus) {
            case CLEAN:
                l00StringField = "Legal " + this.getClass().getName();
                l00IntField = 0;
                break;
            case OBSERVATION:
                l00StringField = "aString";
                l00IntField = 2;
                break;
            case WARNING:
                l00StringField = L00_STRING_FIELD;
                l00IntField = 3;
                break;
            case INVALID:
                l00StringField = "";
                l00IntField = -1;
                break;
            default:
                break;
        }

        l00L10Nested.triggerValidationStatus(triggerStatus, level);
        l00LGenericNested.triggerValidationStatus(triggerStatus, level);

        for (TestParametersLGeneric nestedParameterGroup : l00LGenericNestedMap.values()) {
            nestedParameterGroup.triggerValidationStatus(triggerStatus, level);
        }

    }

    @Override
    public GroupValidationResult validate() {
        GroupValidationResult validationResult = super.validate();

        if (StringUtils.isBlank(getName())) {
            validationResult.setResult("name", ValidationStatus.INVALID, "name must be a non-blank string");
        }

        if (StringUtils.isBlank(l00StringField)) {
            validationResult.setResult(L00_STRING_FIELD, ValidationStatus.INVALID,
                            "l00StringField must be a non-blank string");
        } else if (l00StringField.equals(L00_STRING_FIELD)) {
            validationResult.setResult(L00_STRING_FIELD, ValidationStatus.WARNING,
                            "using the field name for the parameter value is dangerous");
        } else if (l00StringField.equals("aString")) {
            validationResult.setResult(L00_STRING_FIELD, ValidationStatus.OBSERVATION,
                            "this value for name is unhelpful");
        } else {
            validationResult.setResult(L00_STRING_FIELD, ValidationStatus.CLEAN,
                            ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
        }

        if (l00IntField < 0) {
            validationResult.setResult(L00_INT_FIELD, ValidationStatus.INVALID,
                            "l00IntField must be a positive integer");
        } else if (l00IntField > 2) {
            validationResult.setResult(L00_INT_FIELD, ValidationStatus.WARNING,
                            "values greater than 2 are not recommended");
        } else if (l00IntField == 2) {
            validationResult.setResult(L00_INT_FIELD, ValidationStatus.OBSERVATION, "this field has been set to 2");
        } else {
            validationResult.setResult(L00_INT_FIELD, ValidationStatus.CLEAN,
                            ParameterConstants.PARAMETER_HAS_STATUS_MESSAGE + ValidationStatus.CLEAN.toString());
        }

        validationResult.setResult("l00L10Nested", l00L10Nested.validate());
        validationResult.setResult("l00LGenericNested", l00LGenericNested.validate());

        for (Entry<String, TestParametersLGeneric> nestedGroupEntry : l00LGenericNestedMap.entrySet()) {
            validationResult.setResult("l00LGenericNestedMap", nestedGroupEntry.getKey(),
                            nestedGroupEntry.getValue().validate());
        }

        return validationResult;
    }
}