aboutsummaryrefslogtreecommitdiffstats
path: root/utils/src/test/java/org/onap/policy/common/utils/properties/SpecPropertiesTest.java
blob: 0e4216c6b4635efa7b1eefdc111b9d036307c9fb (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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
/*
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2018 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.common.utils.properties;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;

import java.util.Properties;
import org.junit.Before;
import org.junit.Test;

public class SpecPropertiesTest {

    /**
     * Property prefix of interest.
     */
    private static final String MY_PREFIX = "my.prefix";

    /**
     * Specialization, which follows the prefix.
     */
    private static final String MY_SPEC = "my.spec";

    /**
     * Generalized prefix (i.e., without the spec).
     */
    private static final String PREFIX_GEN = MY_PREFIX + ".";

    /**
     * Specialized prefix (i.e., with the spec).
     */
    private static final String PREFIX_SPEC = PREFIX_GEN + MY_SPEC + ".";

    /**
     * Suffix to add to property names to generate names of properties that are not
     * populated.
     */
    private static final String SUFFIX = ".suffix";

    /**
     * Property name without a prefix.
     */
    private static final String PROP_NO_PREFIX = "other";

    /**
     * Generalized property name (i.e., without the spec).
     */
    private static final String PROP_GEN = PREFIX_GEN + "generalized";

    // property names that include the spec
    private static final String PROP_SPEC = PREFIX_SPEC + "specialized";
    private static final String PROP_UNKNOWN = PREFIX_SPEC + "unknown";

    // property values
    private static final String VAL_NO_PREFIX = "no-prefix";
    private static final String VAL_GEN = "gen";
    private static final String VAL_SPEC = "spec";

    private static final String VAL_DEFAULT = "default value";

    private Properties supportingProps;
    private SpecProperties props;

    /**
     * Set up the tests.
     */
    @Before
    public void setUp() {
        supportingProps = new Properties();

        supportingProps.setProperty(PROP_NO_PREFIX, VAL_NO_PREFIX);
        supportingProps.setProperty(PROP_GEN, VAL_GEN);
        supportingProps.setProperty(PROP_SPEC, VAL_SPEC);

        props = new SpecProperties(MY_PREFIX, MY_SPEC);

        props.putAll(supportingProps);
    }

    @Test
    public void testSpecPropertiesStringString() {

        // no supporting properties
        props = new SpecProperties(MY_PREFIX, MY_SPEC);

        assertEquals(PREFIX_GEN, props.getPrefix());
        assertEquals(PREFIX_SPEC, props.getSpecPrefix());

        // everything is null
        assertNull(props.getProperty(gen(PROP_NO_PREFIX)));
        assertNull(props.getProperty(gen(PROP_GEN)));
        assertNull(props.getProperty(gen(PROP_SPEC)));
        assertNull(props.getProperty(gen(PROP_UNKNOWN)));
    }

    @Test
    public void testSpecPropertiesStringStringProperties() {

        // use supportingProps as default properties
        props = new SpecProperties(MY_PREFIX, MY_SPEC, supportingProps);

        assertEquals(PREFIX_GEN, props.getPrefix());
        assertEquals(PREFIX_SPEC, props.getSpecPrefix());

        assertEquals(VAL_NO_PREFIX, props.getProperty(gen(PROP_NO_PREFIX)));
        assertEquals(VAL_GEN, props.getProperty(gen(PROP_GEN)));
        assertEquals(VAL_SPEC, props.getProperty(gen(PROP_SPEC)));
        assertNull(props.getProperty(gen(PROP_UNKNOWN)));
    }

    @Test
    public void testSpecPropertiesStringStringProperties_EmptyPrefix() {
        supportingProps = new Properties();

        supportingProps.setProperty(PROP_NO_PREFIX, VAL_NO_PREFIX);
        supportingProps.setProperty("a.value", VAL_GEN);
        supportingProps.setProperty("b.value", VAL_GEN);
        supportingProps.setProperty(MY_SPEC + ".b.value", VAL_SPEC);

        // no supporting properties
        props = new SpecProperties("", MY_SPEC, supportingProps);

        assertEquals(VAL_NO_PREFIX, props.getProperty(gen(PROP_NO_PREFIX)));
        assertEquals(VAL_GEN, props.getProperty(gen("a.value")));
        assertEquals(VAL_SPEC, props.getProperty(MY_SPEC + ".b.value"));
        assertNull(props.getProperty(gen(PROP_UNKNOWN)));
    }

    @Test
    public void testWithTrailingDot() {
        // neither has trailing dot
        assertEquals(PREFIX_GEN, props.getPrefix());
        assertEquals(PREFIX_SPEC, props.getSpecPrefix());

        // both have trailing dot
        props = new SpecProperties(PREFIX_GEN, MY_SPEC + ".");
        assertEquals(PREFIX_GEN, props.getPrefix());
        assertEquals(PREFIX_SPEC, props.getSpecPrefix());

        // first is empty
        props = new SpecProperties("", MY_SPEC);
        assertEquals("", props.getPrefix());
        assertEquals(MY_SPEC + ".", props.getSpecPrefix());

        // second is empty
        props = new SpecProperties(PREFIX_GEN, "");
        assertEquals(PREFIX_GEN, props.getPrefix());
        assertEquals(PREFIX_GEN, props.getSpecPrefix());
    }

    @Test
    public void testGetPropertyString() {
        // the key does contain the prefix
        assertEquals(VAL_NO_PREFIX, props.getProperty(gen(PROP_NO_PREFIX)));
        assertNull(props.getProperty(gen(PROP_NO_PREFIX + SUFFIX)));

        // specialized value exists
        assertEquals(VAL_GEN, props.getProperty(gen(PROP_GEN)));
        assertNull(props.getProperty(gen(PROP_GEN + SUFFIX)));

        // generalized value exists
        assertEquals(VAL_SPEC, props.getProperty(gen(PROP_SPEC)));
        assertNull(props.getProperty(gen(PROP_SPEC + SUFFIX)));

        // not found
        assertNull(props.getProperty(gen(PROP_UNKNOWN)));
        assertNull(props.getProperty(gen(PROP_UNKNOWN + SUFFIX)));
    }

    @Test
    public void testGetPropertyStringString() {
        // the key does contain the prefix
        assertEquals(VAL_NO_PREFIX, props.getProperty(gen(PROP_NO_PREFIX), VAL_DEFAULT));
        assertEquals(VAL_DEFAULT, props.getProperty(gen(PROP_NO_PREFIX + SUFFIX), VAL_DEFAULT));

        // specialized value exists
        assertEquals(VAL_GEN, props.getProperty(gen(PROP_GEN), VAL_DEFAULT));
        assertEquals(VAL_DEFAULT, props.getProperty(gen(PROP_GEN + SUFFIX), VAL_DEFAULT));

        // generalized value exists
        assertEquals(VAL_SPEC, props.getProperty(gen(PROP_SPEC), VAL_DEFAULT));
        assertEquals(VAL_DEFAULT, props.getProperty(gen(PROP_SPEC + SUFFIX), VAL_DEFAULT));

        // not found
        assertEquals(VAL_DEFAULT, props.getProperty(gen(PROP_UNKNOWN), VAL_DEFAULT));
        assertEquals(VAL_DEFAULT, props.getProperty(gen(PROP_UNKNOWN + SUFFIX), VAL_DEFAULT));

        // can return null
        assertNull(props.getProperty(gen(PROP_UNKNOWN), null));
    }

    @Test(expected = UnsupportedOperationException.class)
    public void testHashCode() {
        props.hashCode();
    }

    @Test(expected = UnsupportedOperationException.class)
    public void testEquals() {
        props.equals(props);
    }

    private String gen(String propnm) {
        if (propnm.startsWith(PREFIX_SPEC)) {
            return PREFIX_GEN + propnm.substring(PREFIX_SPEC.length());
        }

        return propnm;
    }

}