aboutsummaryrefslogtreecommitdiffstats
path: root/testsuites/integration/integration-context-test/src/test/java/org/onap/policy/apex/testsuites/integration/context/distribution/SequentialContextInstantiation.java
blob: 287dd61478630da152eb727d21a0bfce6aea55ea (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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
 *  Modifications Copyright (C) 2019-2020 Nordix Foundation.
 * ================================================================================
 * 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.apex.testsuites.integration.context.distribution;

import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.onap.policy.apex.testsuites.integration.context.factory.TestContextAlbumFactory.createMultiAlbumsContextModel;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.APEX_DISTRIBUTOR;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.BYTE_VAL;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.DATE_CONTEXT_ALBUM;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.FLOAT_VAL;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.INT_VAL;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.LONG_VAL;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.PI_VAL;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.STRING_GLOBAL_VAL;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.TIME_ZONE;
import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.VERSION;

import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.TimeZone;
import org.onap.policy.apex.context.ContextAlbum;
import org.onap.policy.apex.context.ContextException;
import org.onap.policy.apex.context.Distributor;
import org.onap.policy.apex.context.impl.distribution.DistributorFactory;
import org.onap.policy.apex.context.test.concepts.TestContextBooleanItem;
import org.onap.policy.apex.context.test.concepts.TestContextByteItem;
import org.onap.policy.apex.context.test.concepts.TestContextDateItem;
import org.onap.policy.apex.context.test.concepts.TestContextDateLocaleItem;
import org.onap.policy.apex.context.test.concepts.TestContextDateTzItem;
import org.onap.policy.apex.context.test.concepts.TestContextDoubleItem;
import org.onap.policy.apex.context.test.concepts.TestContextFloatItem;
import org.onap.policy.apex.context.test.concepts.TestContextIntItem;
import org.onap.policy.apex.context.test.concepts.TestContextLongItem;
import org.onap.policy.apex.context.test.concepts.TestContextLongObjectItem;
import org.onap.policy.apex.context.test.concepts.TestContextStringItem;
import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
import org.onap.policy.apex.testsuites.integration.context.utils.Constants;
import org.slf4j.ext.XLogger;
import org.slf4j.ext.XLoggerFactory;

/**
 * The Class SequentialContextInstantiation checks sequential initiation of context.
 *
 * @author Sergey Sachkov (sergey.sachkov@ericsson.com)
 */
public class SequentialContextInstantiation {
    // Logger for this class
    private static final XLogger LOGGER = XLoggerFactory.getXLogger(SequentialContextInstantiation.class);

    // Recurring string constants.
    private static final String TEST_AB = "TestAB";
    private static final String TEST_AA = "TestAA";
    private static final String ITEM_NULL = "ItemNull";
    private static final String ITEM06 = "Item06";
    private static final String ITEM05 = "Item05";
    private static final String ITEM03 = "Item03";
    private static final String ITEM02 = "Item02";
    private static final String ITEM01 = "Item01";
    private static final String ITEM00_2 = "Item00_2";

    // Recurring string constants.
    private static final String NORMAL_TEST_EXCEPTION = "normal test exception";
    private static final String DV1 = "dv1";
    private static final String DV0 = "dv0";

    /**
     * Test sequential context instantiation.
     *
     * @throws ContextException the context exception
     */
    public void testSequentialContextInstantiation() throws ContextException {
        LOGGER.debug("Running TestContextInstantiation test . . .");

        final Distributor contextDistributor = getDistributor();

        try {
            final ContextAlbum dateAlbum = getContextAlbum(DATE_CONTEXT_ALBUM, contextDistributor);
            final Date testDate = new Date();
            final TestContextDateLocaleItem tciA00 = getTestContextDateLocaleItem();

            dateAlbum.put(DV0, tciA00);
            assertEquals(tciA00, dateAlbum.get(DV0));

            dateAlbum.put(DV1, tciA00);
            assertEquals(tciA00, dateAlbum.get(DV1));

            final TestContextDateTzItem tci9 = getTestContextDateTzItem(testDate);

            assertThatThrownBy(() -> dateAlbum.put("tci9", tci9))
                .hasMessageContaining("class \"" + TestContextDateTzItem.class.getName()
                    + "\" not compatible with class \"" + TestContextDateLocaleItem.class.getName()
                    + "\"");

            final TestContextDateLocaleItem tciA01 = new TestContextDateLocaleItem(tciA00);
            final TestContextDateLocaleItem tciA02 = new TestContextDateLocaleItem(tciA00);
            final TestContextDateLocaleItem tciA03 = new TestContextDateLocaleItem(tciA00);

            final Map<String, Object> valueMap0 = new HashMap<>();
            valueMap0.put(ITEM01, tciA01);
            valueMap0.put(ITEM02, tciA02);
            valueMap0.put(ITEM03, tciA03);

            dateAlbum.putAll(valueMap0);
            assertEquals(5, dateAlbum.size());
            assertEquals(tciA01, dateAlbum.get(ITEM01));
            assertEquals(tciA02, dateAlbum.get(ITEM02));
            assertEquals(tciA03, dateAlbum.get(ITEM03));

            final Map<String, Object> valueMap1 = getMap(testDate, tciA00, tci9);

            // Get another reference to the album
            final ContextAlbum dateAlbum1 = getContextAlbum(DATE_CONTEXT_ALBUM, contextDistributor);

            assertThatThrownBy(() -> dateAlbum1.putAll(valueMap1))
                .hasMessageContaining("not compatible with class \""
                    + TestContextDateLocaleItem.class.getName() + "\"");
            assertEquals(5, dateAlbum1.size());

            valueMap1.clear();
            valueMap1.put(ITEM00_2, tciA00);
            dateAlbum1.putAll(valueMap1);
            assertEquals(6, dateAlbum1.size());

            assertEquals(tciA00, dateAlbum1.get(ITEM00_2));
            dateAlbum.remove(ITEM00_2);
            assertEquals(5, dateAlbum1.size());

            final ContextAlbum dateAlbumCopy = getContextAlbum(DATE_CONTEXT_ALBUM, contextDistributor);

            final Map<String, Object> valueMap2 = new HashMap<>();
            valueMap2.put("Item04", tciA01);
            valueMap2.put(ITEM05, tciA02);
            valueMap2.put(ITEM06, tciA03);

            dateAlbumCopy.putAll(valueMap2);
            assertEquals(8, dateAlbumCopy.size());

            assertEquals(tciA03, dateAlbumCopy.get(ITEM06));

            final Collection<Object> mapValues = dateAlbum.values();
            assertTrue(dateAlbumCopy.values().containsAll(mapValues));

            // Check that clearing works
            dateAlbum1.clear();
            assertTrue(dateAlbum1.isEmpty());

            dateAlbum.put("Item00", tciA00);
            final Map<String, Object> valueMap3 = new HashMap<>();
            valueMap3.put(ITEM01, tciA01);
            valueMap3.put(ITEM02, tciA02);
            valueMap3.put(ITEM03, tciA03);
            dateAlbum.putAll(valueMap3);

            final Map<String, Object> valueMap4 = new HashMap<>();
            valueMap4.put("Item04", tciA01);
            valueMap4.put(ITEM05, tciA02);
            valueMap4.put(ITEM06, tciA03);

            dateAlbumCopy.putAll(valueMap4);

            assertContains(dateAlbum, tciA01);

            final Set<Entry<String, Object>> entrySet = dateAlbum.entrySet();
            assertEquals(7, entrySet.size());

            assertAlbumGetAndPutMethods(dateAlbum, tciA03, tciA00);

            // Should do removes
            dateAlbum.remove(TEST_AA);
            dateAlbum.remove(TEST_AB);
            dateAlbum.remove(ITEM_NULL);
            assertEquals(7, entrySet.size());
            assertTrue(dateAlbumCopy.values().containsAll(mapValues));
            // CHECKSTYLE:ON: checkstyle:magicNumber
        } finally {
            contextDistributor.clear();
        }
    }

    private void assertContains(final ContextAlbum dateAlbum, final TestContextDateLocaleItem tciA01) {
        assertThatThrownBy(() -> dateAlbum.containsKey(null))
            .hasMessageContaining("null values are illegal on method parameter \"key\"");

        assertTrue(dateAlbum.containsKey(ITEM05));
        assertTrue(!dateAlbum.containsKey("Item07"));

        assertThatThrownBy(() -> dateAlbum.containsValue(null))
            .hasMessageContaining("null values are illegal on method parameter \"value\"");

        assertTrue(dateAlbum.containsValue(tciA01));
        assertTrue(!dateAlbum.containsValue("Hello"));
    }

    private void assertAlbumGetAndPutMethods(final ContextAlbum dateAlbum, final TestContextDateLocaleItem tciA03,
                    final TestContextDateLocaleItem tciA00) {
        assertThatThrownBy(() -> dateAlbum.get(null))
            .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null keys are illegal on keys for get()");

        final Object aObject = dateAlbum.get(ITEM03);
        assertEquals(tciA03, aObject);
        assertThatThrownBy(() -> dateAlbum.put(null, null))
            .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null keys are illegal on keys for put()");

        // Put null ContextItem should work (return null)
        assertThatThrownBy(() -> dateAlbum.put(ITEM_NULL, null))
            .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null values are illegal on "
                + "key \"ItemNull\" for put()");

        // Should return null
        assertNull(dateAlbum.get(ITEM_NULL));
        // Put should return the previous contextItem
        tciA00.setDst(false);
        final TestContextDateLocaleItem tciA03Clone = new TestContextDateLocaleItem(tciA03);
        tciA03Clone.setDst(true);
        TestContextDateLocaleItem retItem = (TestContextDateLocaleItem) dateAlbum.put(ITEM03, tciA03Clone);
        assertEquals(tciA03, retItem);
        retItem = (TestContextDateLocaleItem) dateAlbum.put(ITEM03, tciA03);
        assertEquals(tciA03Clone, retItem);

        assertThatThrownBy(() -> dateAlbum.put(ITEM_NULL, null))
            .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null values are illegal on "
                + "key \"ItemNull\" for put()");

        dateAlbum.put(TEST_AA, tciA00);
        assertEquals(tciA00, dateAlbum.get(TEST_AA));

        // Should print warning
        assertThatThrownBy(() -> dateAlbum.put(TEST_AA, null))
            .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null values are illegal on key \"TestAA\" "
                + "for put()");
        assertEquals(8, dateAlbum.size());
        assertThatThrownBy(() -> dateAlbum.put(TEST_AB, null))
            .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null values are illegal on key \"TestAB\" "
                + "for put()");
        assertEquals(8, dateAlbum.size());
    }

    private Map<String, Object> getMap(final Date testDate, final TestContextDateLocaleItem tciA00,
                    final TestContextDateTzItem tci9) {
        final TestContextBooleanItem testBadItem000 = new TestContextBooleanItem();
        final TestContextByteItem testBadItem001 = new TestContextByteItem();
        final TestContextIntItem testBadItem002 = new TestContextIntItem();
        final TestContextLongItem testBadItem003 = new TestContextLongItem();
        final TestContextFloatItem testBadItem004 = new TestContextFloatItem();
        final TestContextDoubleItem testBadItem005 = new TestContextDoubleItem();
        final TestContextStringItem testBadItem006 = new TestContextStringItem();
        final TestContextLongObjectItem testBadItem007 = new TestContextLongObjectItem();
        final TestContextDateItem testBadItem008 = new TestContextDateItem();

        testBadItem000.setFlag(false);
        testBadItem001.setByteValue(BYTE_VAL);
        testBadItem002.setIntValue(INT_VAL);
        testBadItem003.setLongValue(LONG_VAL);
        testBadItem004.setFloatValue(FLOAT_VAL);
        testBadItem005.setDoubleValue(PI_VAL);
        testBadItem006.setStringValue(STRING_GLOBAL_VAL);
        testBadItem007.setLongValue(testDate.getTime());
        testBadItem008.setDateValue(testDate);

        final Map<String, Object> values = new HashMap<>();
        values.put("TestBadItem000", testBadItem000);
        values.put("TestBadItem001", testBadItem001);
        values.put("TestBadItem002", testBadItem002);
        values.put("TestBadItem003", testBadItem003);
        values.put("TestBadItem004", testBadItem004);
        values.put("TestBadItem005", testBadItem005);
        values.put("TestBadItem006", testBadItem006);
        values.put("TestBadItem007", testBadItem007);
        values.put("TestBadItem008", testBadItem008);
        values.put("TestBadItem009", tci9);
        values.put(ITEM00_2, tciA00);
        return values;
    }

    private TestContextDateTzItem getTestContextDateTzItem(final Date testDate) {
        final TestContextDateTzItem tci9 = new TestContextDateTzItem();
        tci9.setDateValue(new TestContextDateItem(testDate));
        tci9.setTzValue(TimeZone.getTimeZone("Europe/Dublin").getDisplayName());
        tci9.setDst(true);
        return tci9;
    }

    private TestContextDateLocaleItem getTestContextDateLocaleItem() {
        final TestContextDateLocaleItem tciA00 = new TestContextDateLocaleItem();
        tciA00.setDateValue(new TestContextDateItem(new Date()));
        tciA00.setTzValue(TIME_ZONE.getDisplayName());
        tciA00.setDst(true);
        tciA00.setUtcOffset(-600);
        tciA00.setLocale(Locale.ENGLISH);
        return tciA00;
    }

    private ContextAlbum getContextAlbum(final String albumName, final Distributor contextDistributor)
                    throws ContextException {
        final ContextAlbum dateAlbum = contextDistributor.createContextAlbum(new AxArtifactKey(albumName, VERSION));
        assertNotNull(dateAlbum);
        dateAlbum.setUserArtifactStack(Constants.getAxArtifactKeyArray());
        return dateAlbum;
    }

    private Distributor getDistributor() throws ContextException {
        final AxArtifactKey distributorKey = new AxArtifactKey(APEX_DISTRIBUTOR, VERSION);
        final Distributor contextDistributor = new DistributorFactory().getDistributor(distributorKey);
        contextDistributor.registerModel(createMultiAlbumsContextModel());
        return contextDistributor;
    }
}