gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019-2020 Nordix Foundation.
   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.apex.testsuites.integration.context.distribution;
  23
  24 import static org.assertj.core.api.Assertions.assertThatThrownBy;
  25 import static org.junit.Assert.assertEquals;
  26 import static org.junit.Assert.assertNotNull;
  27 import static org.junit.Assert.assertNull;
  28 import static org.junit.Assert.assertTrue;
  29 import static org.onap.policy.apex.testsuites.integration.context.factory.TestContextAlbumFactory.createMultiAlbumsContextModel;
  30 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.APEX_DISTRIBUTOR;
  31 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.BYTE_VAL;
  32 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.DATE_CONTEXT_ALBUM;
  33 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.FLOAT_VAL;
  34 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.INT_VAL;
  35 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.LONG_VAL;
  36 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.PI_VAL;
  37 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.STRING_GLOBAL_VAL;
  38 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.TIME_ZONE;
  39 import static org.onap.policy.apex.testsuites.integration.context.utils.Constants.VERSION;
  40
  41 import java.util.Collection;
  42 import java.util.Date;
  43 import java.util.HashMap;
  44 import java.util.Locale;
  45 import java.util.Map;
  46 import java.util.Map.Entry;
  47 import java.util.Set;
  48 import java.util.TimeZone;
  49 import org.onap.policy.apex.context.ContextAlbum;
  50 import org.onap.policy.apex.context.ContextException;
  51 import org.onap.policy.apex.context.Distributor;
  52 import org.onap.policy.apex.context.impl.distribution.DistributorFactory;
  53 import org.onap.policy.apex.context.test.concepts.TestContextBooleanItem;
  54 import org.onap.policy.apex.context.test.concepts.TestContextByteItem;
  55 import org.onap.policy.apex.context.test.concepts.TestContextDateItem;
  56 import org.onap.policy.apex.context.test.concepts.TestContextDateLocaleItem;
  57 import org.onap.policy.apex.context.test.concepts.TestContextDateTzItem;
  58 import org.onap.policy.apex.context.test.concepts.TestContextDoubleItem;
  59 import org.onap.policy.apex.context.test.concepts.TestContextFloatItem;
  60 import org.onap.policy.apex.context.test.concepts.TestContextIntItem;
  61 import org.onap.policy.apex.context.test.concepts.TestContextLongItem;
  62 import org.onap.policy.apex.context.test.concepts.TestContextLongObjectItem;
  63 import org.onap.policy.apex.context.test.concepts.TestContextStringItem;
  64 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  65 import org.onap.policy.apex.testsuites.integration.context.utils.Constants;
  66 import org.slf4j.ext.XLogger;
  67 import org.slf4j.ext.XLoggerFactory;
  68
  69 /**
  70  * The Class SequentialContextInstantiation checks sequential initiation of
  71  * context.
  72  *
  73  * @author Sergey Sachkov (sergey.sachkov@ericsson.com)
  74  */
  75 public class SequentialContextInstantiation {
  76     // Logger for this class
  77     private static final XLogger LOGGER = XLoggerFactory.getXLogger(SequentialContextInstantiation.class);
  78
  79     // Recurring string constants.
  80     private static final String TEST_AB = "TestAB";
  81     private static final String TEST_AA = "TestAA";
  82     private static final String ITEM_NULL = "ItemNull";
  83     private static final String ITEM06 = "Item06";
  84     private static final String ITEM05 = "Item05";
  85     private static final String ITEM03 = "Item03";
  86     private static final String ITEM02 = "Item02";
  87     private static final String ITEM01 = "Item01";
  88     private static final String ITEM00_2 = "Item00_2";
  89
  90     // Recurring string constants.
  91     private static final String DV1 = "dv1";
  92     private static final String DV0 = "dv0";
  93
  94     /**
  95      * Test sequential context instantiation.
  96      *
  97      * @throws ContextException the context exception
  98      */
  99     public void testSequentialContextInstantiation() throws ContextException {
 100         LOGGER.debug("Running TestContextInstantiation test . . .");
 101
 102         final Distributor contextDistributor = getDistributor();
 103
 104         try {
 105             final ContextAlbum dateAlbum = getContextAlbum(DATE_CONTEXT_ALBUM, contextDistributor);
 106             final Date testDate = new Date();
 107             final TestContextDateLocaleItem tciA00 = getTestContextDateLocaleItem();
 108
 109             dateAlbum.put(DV0, tciA00);
 110             assertEquals(tciA00, dateAlbum.get(DV0));
 111
 112             dateAlbum.put(DV1, tciA00);
 113             assertEquals(tciA00, dateAlbum.get(DV1));
 114
 115             final TestContextDateTzItem tci9 = getTestContextDateTzItem(testDate);
 116
 117             assertThatThrownBy(() -> dateAlbum.put("tci9", tci9))
 118                 .hasMessageContaining("class \"" + TestContextDateTzItem.class.getName()
 119                     + "\" not compatible with class \"" + TestContextDateLocaleItem.class.getName() + "\"");
 120
 121             final TestContextDateLocaleItem tciA01 = new TestContextDateLocaleItem(tciA00);
 122             final TestContextDateLocaleItem tciA02 = new TestContextDateLocaleItem(tciA00);
 123             final TestContextDateLocaleItem tciA03 = new TestContextDateLocaleItem(tciA00);
 124
 125             final Map<String, Object> valueMap0 = new HashMap<>();
 126             valueMap0.put(ITEM01, tciA01);
 127             valueMap0.put(ITEM02, tciA02);
 128             valueMap0.put(ITEM03, tciA03);
 129
 130             dateAlbum.putAll(valueMap0);
 131             assertEquals(5, dateAlbum.size());
 132             assertEquals(tciA01, dateAlbum.get(ITEM01));
 133             assertEquals(tciA02, dateAlbum.get(ITEM02));
 134             assertEquals(tciA03, dateAlbum.get(ITEM03));
 135
 136             final Map<String, Object> valueMap1 = getMap(testDate, tciA00, tci9);
 137
 138             // Get another reference to the album
 139             final ContextAlbum dateAlbum1 = getContextAlbum(DATE_CONTEXT_ALBUM, contextDistributor);
 140
 141             assertThatThrownBy(() -> dateAlbum1.putAll(valueMap1)).hasMessageContaining(
 142                 "not compatible with class \"" + TestContextDateLocaleItem.class.getName() + "\"");
 143             assertEquals(5, dateAlbum1.size());
 144
 145             valueMap1.clear();
 146             valueMap1.put(ITEM00_2, tciA00);
 147             dateAlbum1.putAll(valueMap1);
 148             assertEquals(6, dateAlbum1.size());
 149
 150             assertEquals(tciA00, dateAlbum1.get(ITEM00_2));
 151             dateAlbum.remove(ITEM00_2);
 152             assertEquals(5, dateAlbum1.size());
 153
 154             final ContextAlbum dateAlbumCopy = getContextAlbum(DATE_CONTEXT_ALBUM, contextDistributor);
 155
 156             final Map<String, Object> valueMap2 = new HashMap<>();
 157             valueMap2.put("Item04", tciA01);
 158             valueMap2.put(ITEM05, tciA02);
 159             valueMap2.put(ITEM06, tciA03);
 160
 161             dateAlbumCopy.putAll(valueMap2);
 162             assertEquals(8, dateAlbumCopy.size());
 163
 164             assertEquals(tciA03, dateAlbumCopy.get(ITEM06));
 165
 166             final Collection<Object> mapValues = dateAlbum.values();
 167             assertTrue(dateAlbumCopy.values().containsAll(mapValues));
 168
 169             // Check that clearing works
 170             dateAlbum1.clear();
 171             assertTrue(dateAlbum1.isEmpty());
 172
 173             dateAlbum.put("Item00", tciA00);
 174             final Map<String, Object> valueMap3 = new HashMap<>();
 175             valueMap3.put(ITEM01, tciA01);
 176             valueMap3.put(ITEM02, tciA02);
 177             valueMap3.put(ITEM03, tciA03);
 178             dateAlbum.putAll(valueMap3);
 179
 180             final Map<String, Object> valueMap4 = new HashMap<>();
 181             valueMap4.put("Item04", tciA01);
 182             valueMap4.put(ITEM05, tciA02);
 183             valueMap4.put(ITEM06, tciA03);
 184
 185             dateAlbumCopy.putAll(valueMap4);
 186
 187             assertContains(dateAlbum, tciA01);
 188
 189             final Set<Entry<String, Object>> entrySet = dateAlbum.entrySet();
 190             assertEquals(7, entrySet.size());
 191
 192             assertAlbumGetAndPutMethods(dateAlbum, tciA03, tciA00);
 193
 194             // Should do removes
 195             dateAlbum.remove(TEST_AA);
 196             dateAlbum.remove(TEST_AB);
 197             dateAlbum.remove(ITEM_NULL);
 198             assertEquals(7, entrySet.size());
 199             assertTrue(dateAlbumCopy.values().containsAll(mapValues));
 200             // CHECKSTYLE:ON: checkstyle:magicNumber
 201         } finally {
 202             contextDistributor.clear();
 203         }
 204     }
 205
 206     private void assertContains(final ContextAlbum dateAlbum, final TestContextDateLocaleItem tciA01) {
 207         assertThatThrownBy(() -> dateAlbum.containsKey(null))
 208             .hasMessageContaining("null values are illegal on method parameter \"key\"");
 209
 210         assertTrue(dateAlbum.containsKey(ITEM05));
 211         assertTrue(!dateAlbum.containsKey("Item07"));
 212
 213         assertThatThrownBy(() -> dateAlbum.containsValue(null))
 214             .hasMessageContaining("null values are illegal on method parameter \"value\"");
 215
 216         assertTrue(dateAlbum.containsValue(tciA01));
 217         assertTrue(!dateAlbum.containsValue("Hello"));
 218     }
 219
 220     private void assertAlbumGetAndPutMethods(final ContextAlbum dateAlbum, final TestContextDateLocaleItem tciA03,
 221         final TestContextDateLocaleItem tciA00) {
 222         assertThatThrownBy(() -> dateAlbum.get(null))
 223             .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null keys are illegal on keys for get()");
 224
 225         final Object aObject = dateAlbum.get(ITEM03);
 226         assertEquals(tciA03, aObject);
 227         assertThatThrownBy(() -> dateAlbum.put(null, null))
 228             .hasMessageContaining("album \"DateContextAlbum:0.0.1\" null keys are illegal on keys for put()");
 229
 230         // Put null ContextItem should work (return null)
 231         assertThatThrownBy(() -> dateAlbum.put(ITEM_NULL, null)).hasMessageContaining(
 232             "album \"DateContextAlbum:0.0.1\" null values are illegal on " + "key \"ItemNull\" for put()");
 233
 234         // Should return null
 235         assertNull(dateAlbum.get(ITEM_NULL));
 236         // Put should return the previous contextItem
 237         tciA00.setDst(false);
 238         final TestContextDateLocaleItem tciA03Clone = new TestContextDateLocaleItem(tciA03);
 239         tciA03Clone.setDst(true);
 240         TestContextDateLocaleItem retItem = (TestContextDateLocaleItem) dateAlbum.put(ITEM03, tciA03Clone);
 241         assertEquals(tciA03, retItem);
 242         retItem = (TestContextDateLocaleItem) dateAlbum.put(ITEM03, tciA03);
 243         assertEquals(tciA03Clone, retItem);
 244
 245         assertThatThrownBy(() -> dateAlbum.put(ITEM_NULL, null)).hasMessageContaining(
 246             "album \"DateContextAlbum:0.0.1\" null values are illegal on " + "key \"ItemNull\" for put()");
 247
 248         dateAlbum.put(TEST_AA, tciA00);
 249         assertEquals(tciA00, dateAlbum.get(TEST_AA));
 250
 251         // Should print warning
 252         assertThatThrownBy(() -> dateAlbum.put(TEST_AA, null)).hasMessageContaining(
 253             "album \"DateContextAlbum:0.0.1\" null values are illegal on key \"TestAA\" " + "for put()");
 254         assertEquals(8, dateAlbum.size());
 255         assertThatThrownBy(() -> dateAlbum.put(TEST_AB, null)).hasMessageContaining(
 256             "album \"DateContextAlbum:0.0.1\" null values are illegal on key \"TestAB\" " + "for put()");
 257         assertEquals(8, dateAlbum.size());
 258     }
 259
 260     private Map<String, Object> getMap(final Date testDate, final TestContextDateLocaleItem tciA00,
 261         final TestContextDateTzItem tci9) {
 262         final TestContextBooleanItem testBadItem000 = new TestContextBooleanItem();
 263         final TestContextByteItem testBadItem001 = new TestContextByteItem();
 264         final TestContextIntItem testBadItem002 = new TestContextIntItem();
 265         final TestContextLongItem testBadItem003 = new TestContextLongItem();
 266         final TestContextFloatItem testBadItem004 = new TestContextFloatItem();
 267         final TestContextDoubleItem testBadItem005 = new TestContextDoubleItem();
 268         final TestContextStringItem testBadItem006 = new TestContextStringItem();
 269         final TestContextLongObjectItem testBadItem007 = new TestContextLongObjectItem();
 270         final TestContextDateItem testBadItem008 = new TestContextDateItem();
 271
 272         testBadItem000.setFlag(false);
 273         testBadItem001.setByteValue(BYTE_VAL);
 274         testBadItem002.setIntValue(INT_VAL);
 275         testBadItem003.setLongValue(LONG_VAL);
 276         testBadItem004.setFloatValue(FLOAT_VAL);
 277         testBadItem005.setDoubleValue(PI_VAL);
 278         testBadItem006.setStringValue(STRING_GLOBAL_VAL);
 279         testBadItem007.setLongValue(testDate.getTime());
 280         testBadItem008.setDateValue(testDate);
 281
 282         final Map<String, Object> values = new HashMap<>();
 283         values.put("TestBadItem000", testBadItem000);
 284         values.put("TestBadItem001", testBadItem001);
 285         values.put("TestBadItem002", testBadItem002);
 286         values.put("TestBadItem003", testBadItem003);
 287         values.put("TestBadItem004", testBadItem004);
 288         values.put("TestBadItem005", testBadItem005);
 289         values.put("TestBadItem006", testBadItem006);
 290         values.put("TestBadItem007", testBadItem007);
 291         values.put("TestBadItem008", testBadItem008);
 292         values.put("TestBadItem009", tci9);
 293         values.put(ITEM00_2, tciA00);
 294         return values;
 295     }
 296
 297     private TestContextDateTzItem getTestContextDateTzItem(final Date testDate) {
 298         final TestContextDateTzItem tci9 = new TestContextDateTzItem();
 299         tci9.setDateValue(new TestContextDateItem(testDate));
 300         tci9.setTzValue(TimeZone.getTimeZone("Europe/Dublin").getDisplayName());
 301         tci9.setDst(true);
 302         return tci9;
 303     }
 304
 305     private TestContextDateLocaleItem getTestContextDateLocaleItem() {
 306         final TestContextDateLocaleItem tciA00 = new TestContextDateLocaleItem();
 307         tciA00.setDateValue(new TestContextDateItem(new Date()));
 308         tciA00.setTzValue(TIME_ZONE.getDisplayName());
 309         tciA00.setDst(true);
 310         tciA00.setUtcOffset(-600);
 311         tciA00.setLocale(Locale.ENGLISH);
 312         return tciA00;
 313     }
 314
 315     private ContextAlbum getContextAlbum(final String albumName, final Distributor contextDistributor)
 316         throws ContextException {
 317         final ContextAlbum dateAlbum = contextDistributor.createContextAlbum(new AxArtifactKey(albumName, VERSION));
 318         assertNotNull(dateAlbum);
 319         dateAlbum.setUserArtifactStack(Constants.getAxArtifactKeyArray());
 320         return dateAlbum;
 321     }
 322
 323     private Distributor getDistributor() throws ContextException {
 324         final AxArtifactKey distributorKey = new AxArtifactKey(APEX_DISTRIBUTOR, VERSION);
 325         final Distributor contextDistributor = new DistributorFactory().getDistributor(distributorKey);
 326         contextDistributor.registerModel(createMultiAlbumsContextModel());
 327         return contextDistributor;
 328     }
 329 }