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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.apex.service.engine.event;
  22
  23 import static org.junit.Assert.assertEquals;
  24 import static org.junit.Assert.assertNotNull;
  25 import static org.junit.Assert.assertTrue;
  26 import static org.junit.Assert.fail;
  27
  28 import java.io.ByteArrayInputStream;
  29 import java.io.IOException;
  30 import java.util.Date;
  31 import java.util.HashMap;
  32 import java.util.List;
  33 import java.util.Map;
  34
  35 import org.junit.AfterClass;
  36 import org.junit.BeforeClass;
  37 import org.junit.Test;
  38 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
  39 import org.onap.policy.apex.context.parameters.SchemaParameters;
  40 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  41 import org.onap.policy.apex.model.basicmodel.handling.ApexModelException;
  42 import org.onap.policy.apex.model.basicmodel.handling.ApexModelReader;
  43 import org.onap.policy.apex.model.basicmodel.service.ModelService;
  44 import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
  45 import org.onap.policy.apex.model.eventmodel.concepts.AxEvents;
  46 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  47 import org.onap.policy.apex.model.utilities.TextFileUtils;
  48 import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.Apex2JsonEventConverter;
  49 import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.JsonEventProtocolParameters;
  50 import org.onap.policy.common.parameters.ParameterService;
  51 import org.slf4j.ext.XLogger;
  52 import org.slf4j.ext.XLoggerFactory;
  53
  54 /**
  55  * Test JSON Event Handler.
  56  *
  57  * @author Liam Fallon (liam.fallon@ericsson.com)
  58  */
  59 public class TestJsonEventHandler {
  60     private static final XLogger logger = XLoggerFactory.getXLogger(TestJsonEventHandler.class);
  61
  62     /**
  63      * Setup event model.
  64      *
  65      * @throws IOException Signals that an I/O exception has occurred.
  66      * @throws ApexModelException the apex model exception
  67      */
  68     @BeforeClass
  69     public static void setupEventModel() throws IOException, ApexModelException {
  70         final String policyModelString = TextFileUtils
  71                         .getTextFileAsString("src/test/resources/policymodels/SamplePolicyModelMVEL.json");
  72         final ApexModelReader<AxPolicyModel> modelReader = new ApexModelReader<AxPolicyModel>(AxPolicyModel.class);
  73         final AxPolicyModel apexPolicyModel = modelReader.read(new ByteArrayInputStream(policyModelString.getBytes()));
  74
  75         // Set up the models in the model service
  76         apexPolicyModel.register();
  77     }
  78
  79     /**
  80      * Initialize default schema parameters.
  81      */
  82     @BeforeClass
  83     public static void initializeDefaultSchemaParameters() {
  84         ParameterService.clear();
  85         final SchemaParameters schemaParameters = new SchemaParameters();
  86         schemaParameters.setName(ContextParameterConstants.SCHEMA_GROUP_NAME);
  87         ParameterService.register(schemaParameters);
  88     }
  89
  90     /**
  91      * Teardown default schema parameters.
  92      */
  93     @AfterClass
  94     public static void teardownDefaultSchemaParameters() {
  95         ParameterService.deregister(ContextParameterConstants.SCHEMA_GROUP_NAME);
  96     }
  97
  98     /**
  99      * Test JSON to apex event.
 100      *
 101      * @throws ApexException the apex exception
 102      */
 103     @Test
 104     public void testJsontoApexEvent() throws ApexException {
 105         try {
 106             final Apex2JsonEventConverter jsonEventConverter = new Apex2JsonEventConverter();
 107             assertNotNull(jsonEventConverter);
 108             jsonEventConverter.init(new JsonEventProtocolParameters());
 109
 110             final String apexEventJsonStringIn = JsonEventGenerator.jsonEvent();
 111
 112             logger.debug("input event\n" + apexEventJsonStringIn);
 113
 114             final List<ApexEvent> apexEventList = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 115             for (final ApexEvent apexEvent : apexEventList) {
 116                 assertNotNull(apexEvent);
 117
 118                 logger.debug(apexEvent.toString());
 119
 120                 assertTrue(apexEvent.getName().equals("Event0000") || apexEvent.getName().equals("Event0100"));
 121                 assertTrue(apexEvent.getVersion().equals("0.0.1"));
 122                 assertTrue(apexEvent.getNameSpace().equals("org.onap.policy.apex.sample.events"));
 123                 assertTrue(apexEvent.getSource().equals("test"));
 124                 assertTrue(apexEvent.getTarget().equals("apex"));
 125                 assertTrue(apexEvent.get("TestSlogan").toString().startsWith("Test slogan for External Event"));
 126
 127                 final Object testMatchCaseSelected = apexEvent.get("TestMatchCaseSelected");
 128                 assertTrue(testMatchCaseSelected == null);
 129             }
 130         } catch (final Exception e) {
 131             e.printStackTrace();
 132             throw new ApexException("Exception reading Apex event JSON file", e);
 133         }
 134     }
 135
 136     /**
 137      * Test JSON to apex bad event.
 138      *
 139      * @throws ApexException the apex exception
 140      */
 141     @Test
 142     public void testJsontoApexBadEvent() throws ApexException {
 143         try {
 144             final Apex2JsonEventConverter jsonEventConverter = new Apex2JsonEventConverter();
 145             assertNotNull(jsonEventConverter);
 146             jsonEventConverter.init(new JsonEventProtocolParameters());
 147
 148             String apexEventJsonStringIn = null;
 149
 150             try {
 151                 apexEventJsonStringIn = JsonEventGenerator.jsonEventNoName();
 152                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 153                 fail("Test should throw an exception here");
 154             } catch (final ApexEventException e) {
 155                 assertEquals("Failed to unmarshal JSON event: event received without mandatory parameter \"name\" ",
 156                                 e.getMessage().substring(0, 82));
 157             }
 158
 159             try {
 160                 apexEventJsonStringIn = JsonEventGenerator.jsonEventBadName();
 161                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 162                 fail("Test should throw an exception here");
 163             } catch (final ApexEventException e) {
 164                 assertTrue(e.getMessage().startsWith(
 165                                 "Failed to unmarshal JSON event: field \"name\" with value \"%%%%\" is invalid"));
 166             }
 167
 168             try {
 169                 apexEventJsonStringIn = JsonEventGenerator.jsonEventNoExName();
 170                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 171                 fail("Test should throw an exception here");
 172             } catch (final ApexEventException e) {
 173                 assertEquals("Failed to unmarshal JSON event: an event definition for an event named \"I_DONT_EXI",
 174                                 e.getMessage().substring(0, 82));
 175             }
 176
 177             apexEventJsonStringIn = JsonEventGenerator.jsonEventNoVersion();
 178             ApexEvent event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn).get(0);
 179             assertEquals("0.0.1", event.getVersion());
 180
 181             try {
 182                 apexEventJsonStringIn = JsonEventGenerator.jsonEventBadVersion();
 183                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 184                 fail("Test should throw an exception here");
 185             } catch (final ApexEventException e) {
 186                 assertTrue(e.getMessage().startsWith(
 187                                 "Failed to unmarshal JSON event: field \"version\" with value \"#####\" is invalid"));
 188             }
 189
 190             try {
 191                 apexEventJsonStringIn = JsonEventGenerator.jsonEventNoExVersion();
 192                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 193                 fail("Test should throw an exception here");
 194             } catch (final ApexEventException e) {
 195                 assertTrue(e.getMessage()
 196                                 .startsWith("Failed to unmarshal JSON event: an event definition for an event named "
 197                                                 + "\"Event0000\" with version \"1.2.3\" not found in Apex model"));
 198             }
 199
 200             apexEventJsonStringIn = JsonEventGenerator.jsonEventNoNamespace();
 201             event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn).get(0);
 202             assertEquals("org.onap.policy.apex.sample.events", event.getNameSpace());
 203
 204             try {
 205                 apexEventJsonStringIn = JsonEventGenerator.jsonEventBadNamespace();
 206                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 207                 fail("Test should throw an exception here");
 208             } catch (final ApexEventException e) {
 209                 assertTrue(e.getMessage().startsWith("Failed to unmarshal JSON event: field \"nameSpace\" "
 210                                 + "with value \"hello.&&&&\" is invalid"));
 211             }
 212
 213             try {
 214                 apexEventJsonStringIn = JsonEventGenerator.jsonEventNoExNamespace();
 215                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 216                 fail("Test should throw an exception here");
 217             } catch (final ApexEventException e) {
 218                 assertTrue(e.getMessage()
 219                                 .startsWith("Failed to unmarshal JSON event: namespace \"pie.in.the.sky\" "
 220                                                 + "on event \"Event0000\" does not"
 221                                                 + " match namespace \"org.onap.policy.apex.sample.events\" "
 222                                                 + "for that event in the Apex model"));
 223             }
 224
 225             apexEventJsonStringIn = JsonEventGenerator.jsonEventNoSource();
 226             event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn).get(0);
 227             assertEquals("Outside", event.getSource());
 228
 229             try {
 230                 apexEventJsonStringIn = JsonEventGenerator.jsonEventBadSource();
 231                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 232                 fail("Test should throw an exception here");
 233             } catch (final ApexEventException e) {
 234                 assertTrue(e.getMessage().startsWith(
 235                                 "Failed to unmarshal JSON event: field \"source\" with value \"%!@**@!\" is invalid"));
 236             }
 237
 238             apexEventJsonStringIn = JsonEventGenerator.jsonEventNoTarget();
 239             event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn).get(0);
 240             assertEquals("Match", event.getTarget());
 241
 242             try {
 243                 apexEventJsonStringIn = JsonEventGenerator.jsonEventBadTarget();
 244                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 245                 fail("Test should throw an exception here");
 246             } catch (final ApexEventException e) {
 247                 assertTrue(e.getMessage().startsWith("Failed to unmarshal JSON event: field \"target\" "
 248                                 + "with value \"KNIO(*S)A(S)D\" is invalid"));
 249             }
 250
 251             try {
 252                 apexEventJsonStringIn = JsonEventGenerator.jsonEventMissingFields();
 253                 jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 254                 fail("Test should throw an exception here");
 255             } catch (final ApexEventException e) {
 256                 assertTrue(e.getMessage().startsWith("Failed to unmarshal JSON event: error parsing Event0000:0.0.1 "
 257                                 + "event from Json. Field \"TestMatchCase\" is missing, but is mandatory."));
 258             }
 259
 260             apexEventJsonStringIn = JsonEventGenerator.jsonEventNullFields();
 261             event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn).get(0);
 262             assertEquals(null, event.get("TestSlogan"));
 263             assertEquals((byte) -1, event.get("TestMatchCase"));
 264             assertEquals((long) -1, event.get("TestTimestamp"));
 265             assertEquals(-1.0, event.get("TestTemperature"));
 266
 267             // Set the missing fields as optional in the model
 268             final AxEvent eventDefinition = ModelService.getModel(AxEvents.class).get("Event0000");
 269             eventDefinition.getParameterMap().get("TestSlogan").setOptional(true);
 270             eventDefinition.getParameterMap().get("TestMatchCase").setOptional(true);
 271             eventDefinition.getParameterMap().get("TestTimestamp").setOptional(true);
 272             eventDefinition.getParameterMap().get("TestTemperature").setOptional(true);
 273
 274             apexEventJsonStringIn = JsonEventGenerator.jsonEventMissingFields();
 275             event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn).get(0);
 276             assertEquals(null, event.get("TestSlogan"));
 277             assertEquals(null, event.get("TestMatchCase"));
 278             assertEquals(null, event.get("TestTimestamp"));
 279             assertEquals(null, event.get("TestTemperature"));
 280         } catch (final Exception e) {
 281             e.printStackTrace();
 282             throw new ApexException("Exception reading Apex event JSON file", e);
 283         }
 284     }
 285
 286     /**
 287      * Test apex event to JSON.
 288      *
 289      * @throws ApexException the apex exception
 290      */
 291     @Test
 292     public void testApexEventToJson() throws ApexException {
 293         try {
 294             final Apex2JsonEventConverter jsonEventConverter = new Apex2JsonEventConverter();
 295             jsonEventConverter.init(new JsonEventProtocolParameters());
 296             assertNotNull(jsonEventConverter);
 297
 298             final Date event0000StartTime = new Date();
 299             final Map<String, Object> event0000DataMap = new HashMap<String, Object>();
 300             event0000DataMap.put("TestSlogan", "This is a test slogan");
 301             event0000DataMap.put("TestMatchCase", 12345);
 302             event0000DataMap.put("TestTimestamp", event0000StartTime.getTime());
 303             event0000DataMap.put("TestTemperature", 34.5445667);
 304
 305             final ApexEvent apexEvent0000 = new ApexEvent("Event0000", "0.0.1", "org.onap.policy.apex.sample.events",
 306                             "test", "apex");
 307             apexEvent0000.putAll(event0000DataMap);
 308
 309             final String apexEvent0000JsonString = (String) jsonEventConverter.fromApexEvent(apexEvent0000);
 310
 311             logger.debug(apexEvent0000JsonString);
 312
 313             assertTrue(apexEvent0000JsonString.contains("\"name\": \"Event0000\""));
 314             assertTrue(apexEvent0000JsonString.contains("\"version\": \"0.0.1\""));
 315             assertTrue(apexEvent0000JsonString.contains("\"nameSpace\": \"org.onap.policy.apex.sample.events\""));
 316             assertTrue(apexEvent0000JsonString.contains("\"source\": \"test\""));
 317             assertTrue(apexEvent0000JsonString.contains("\"target\": \"apex\""));
 318             assertTrue(apexEvent0000JsonString.contains("\"TestSlogan\": \"This is a test slogan\""));
 319             assertTrue(apexEvent0000JsonString.contains("\"TestMatchCase\": 12345"));
 320             assertTrue(apexEvent0000JsonString.contains("\"TestTimestamp\": " + event0000StartTime.getTime()));
 321             assertTrue(apexEvent0000JsonString.contains("\"TestTemperature\": 34.5445667"));
 322
 323             final Date event0004StartTime = new Date(1434363272000L);
 324             final Map<String, Object> event0004DataMap = new HashMap<String, Object>();
 325             event0004DataMap.put("TestSlogan", "Test slogan for External Event");
 326             event0004DataMap.put("TestMatchCase", new Integer(2));
 327             event0004DataMap.put("TestTimestamp", new Long(event0004StartTime.getTime()));
 328             event0004DataMap.put("TestTemperature", new Double(1064.43));
 329             event0004DataMap.put("TestMatchCaseSelected", new Integer(2));
 330             event0004DataMap.put("TestMatchStateTime", new Long(1434370506078L));
 331             event0004DataMap.put("TestEstablishCaseSelected", new Integer(0));
 332             event0004DataMap.put("TestEstablishStateTime", new Long(1434370506085L));
 333             event0004DataMap.put("TestDecideCaseSelected", new Integer(3));
 334             event0004DataMap.put("TestDecideStateTime", new Long(1434370506092L));
 335             event0004DataMap.put("TestActCaseSelected", new Integer(2));
 336             event0004DataMap.put("TestActStateTime", new Long(1434370506095L));
 337
 338             final ApexEvent apexEvent0004 = new ApexEvent("Event0004", "0.0.1", "org.onap.policy.apex.sample.events",
 339                             "test", "apex");
 340             apexEvent0004.putAll(event0004DataMap);
 341
 342             final String apexEvent0004JsonString = (String) jsonEventConverter.fromApexEvent(apexEvent0004);
 343
 344             logger.debug(apexEvent0004JsonString);
 345
 346             assertTrue(apexEvent0004JsonString.contains("\"name\": \"Event0004\""));
 347             assertTrue(apexEvent0004JsonString.contains("\"version\": \"0.0.1\""));
 348             assertTrue(apexEvent0004JsonString.contains("\"nameSpace\": \"org.onap.policy.apex.sample.events\""));
 349             assertTrue(apexEvent0004JsonString.contains("\"source\": \"test\""));
 350             assertTrue(apexEvent0004JsonString.contains("\"target\": \"apex\""));
 351             assertTrue(apexEvent0004JsonString.contains("\"TestSlogan\": \"Test slogan for External Event\""));
 352             assertTrue(apexEvent0004JsonString.contains("1434370506078"));
 353             assertTrue(apexEvent0004JsonString.contains("1064.43"));
 354         } catch (final Exception e) {
 355             e.printStackTrace();
 356             throw new ApexException("Exception reading Apex event JSON file", e);
 357         }
 358     }
 359 }