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) 2020 Nordix Foundation.
   5  *  Modifications Copyright (C) 2022 Bell Canada. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.apex.service.engine.event;
  24
  25 import static org.assertj.core.api.Assertions.assertThatThrownBy;
  26 import static org.junit.Assert.assertEquals;
  27 import static org.junit.Assert.assertNotNull;
  28 import static org.junit.Assert.assertNull;
  29 import static org.junit.Assert.assertTrue;
  30
  31 import java.io.ByteArrayInputStream;
  32 import java.io.IOException;
  33 import java.util.HashMap;
  34 import java.util.List;
  35 import java.util.Map;
  36 import org.junit.AfterClass;
  37 import org.junit.BeforeClass;
  38 import org.junit.Test;
  39 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
  40 import org.onap.policy.apex.context.parameters.SchemaParameters;
  41 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  42 import org.onap.policy.apex.model.basicmodel.concepts.AxToscaPolicyProcessingStatus;
  43 import org.onap.policy.apex.model.basicmodel.handling.ApexModelException;
  44 import org.onap.policy.apex.model.basicmodel.handling.ApexModelReader;
  45 import org.onap.policy.apex.model.basicmodel.service.ModelService;
  46 import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
  47 import org.onap.policy.apex.model.eventmodel.concepts.AxEvents;
  48 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  49 import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.Apex2JsonEventConverter;
  50 import org.onap.policy.apex.service.engine.event.impl.jsonprotocolplugin.JsonEventProtocolParameters;
  51 import org.onap.policy.common.parameters.ParameterService;
  52 import org.onap.policy.common.utils.resources.TextFileUtils;
  53 import org.slf4j.ext.XLogger;
  54 import org.slf4j.ext.XLoggerFactory;
  55
  56 /**
  57  * Test JSON Event Handler.
  58  *
  59  * @author Liam Fallon (liam.fallon@ericsson.com)
  60  */
  61 public class JsonEventHandlerTest {
  62     private static final XLogger logger = XLoggerFactory.getXLogger(JsonEventHandlerTest.class);
  63
  64     /**
  65      * Setup event model.
  66      *
  67      * @throws IOException Signals that an I/O exception has occurred.
  68      * @throws ApexModelException the apex model exception
  69      */
  70     @BeforeClass
  71     public static void setupEventModel() throws IOException, ApexModelException {
  72         final String policyModelString =
  73                 TextFileUtils.getTextFileAsString("src/test/resources/policymodels/SmallModel.json");
  74         final ApexModelReader<AxPolicyModel> modelReader = new ApexModelReader<AxPolicyModel>(AxPolicyModel.class);
  75         final AxPolicyModel apexPolicyModel = modelReader.read(new ByteArrayInputStream(policyModelString.getBytes()));
  76
  77         // Set up the models in the model service
  78         apexPolicyModel.register();
  79     }
  80
  81     /**
  82      * Initialize default schema parameters.
  83      */
  84     @BeforeClass
  85     public static void initializeDefaultSchemaParameters() {
  86         ParameterService.clear();
  87         final SchemaParameters schemaParameters = new SchemaParameters();
  88         schemaParameters.setName(ContextParameterConstants.SCHEMA_GROUP_NAME);
  89         ParameterService.register(schemaParameters);
  90     }
  91
  92     /**
  93      * Teardown default schema parameters.
  94      */
  95     @AfterClass
  96     public static void teardownDefaultSchemaParameters() {
  97         ParameterService.deregister(ContextParameterConstants.SCHEMA_GROUP_NAME);
  98         ModelService.clear();
  99     }
 100
 101     /**
 102      * Test JSON to apex event.
 103      *
 104      * @throws ApexException the apex exception
 105      */
 106     @Test
 107     public void testJsontoApexEvent() throws ApexException {
 108         final Apex2JsonEventConverter jsonEventConverter = new Apex2JsonEventConverter();
 109         assertNotNull(jsonEventConverter);
 110         jsonEventConverter.init(new JsonEventProtocolParameters());
 111
 112         final String apexEventJsonStringIn = SupportJsonEventGenerator.jsonEvent();
 113
 114         logger.debug("input event\n" + apexEventJsonStringIn);
 115
 116         final List<ApexEvent> apexEventList = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 117         for (final ApexEvent apexEvent : apexEventList) {
 118             assertNotNull(apexEvent);
 119
 120             logger.debug(apexEvent.toString());
 121
 122             assertEquals("BasicEvent", apexEvent.getName());
 123             assertEquals("0.0.1", apexEvent.getVersion());
 124             assertEquals("org.onap.policy.apex.events", apexEvent.getNameSpace());
 125             assertEquals("test", apexEvent.getSource());
 126             assertEquals("apex", apexEvent.getTarget());
 127             assertEquals(12345, apexEvent.get("intPar"));
 128             final Object testMatchCaseSelected = apexEvent.get("TestMatchCaseSelected");
 129             assertNull(testMatchCaseSelected);
 130         }
 131
 132     }
 133
 134     /**
 135      * Test JSON to apex bad event.
 136      *
 137      * @throws ApexException the apex exception
 138      */
 139     @Test
 140     public void testJsontoApexBadEvent() throws ApexException {
 141         final Apex2JsonEventConverter jsonEventConverter = new Apex2JsonEventConverter();
 142         assertNotNull(jsonEventConverter);
 143         jsonEventConverter.init(new JsonEventProtocolParameters());
 144
 145         assertThatThrownBy(() -> {
 146             String apexEventJsonStringIn = null;
 147             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventNoName();
 148             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 149         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 150             .getCause().hasMessageStartingWith("event received without mandatory parameter \"name\" ");
 151         assertThatThrownBy(() -> {
 152             String apexEventJsonStringIn = null;
 153             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventBadName();
 154             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 155         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 156             .getCause().hasMessageStartingWith("field \"name\" with value \"%%%%\" is invalid");
 157         assertThatThrownBy(() -> {
 158             String apexEventJsonStringIn = null;
 159             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventNoExName();
 160             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 161         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 162             .getCause().hasMessageStartingWith("an event definition for an event named \"I_DONT_EXI");
 163         String apexEventJsonStringIn1 = null;
 164         apexEventJsonStringIn1 = SupportJsonEventGenerator.jsonEventNoVersion();
 165         ApexEvent event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn1).get(0);
 166         assertEquals("0.0.1", event.getVersion());
 167         assertThatThrownBy(() -> {
 168             String apexEventJsonStringIn = null;
 169             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventBadVersion();
 170             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 171         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 172             .getCause().hasMessageStartingWith("field \"version\" with value \"#####\" is invalid");
 173         assertThatThrownBy(() -> {
 174             String apexEventJsonStringIn = null;
 175             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventNoExVersion();
 176             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 177         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 178             .getCause().hasMessageStartingWith("an event definition for an event named "
 179                 + "\"BasicEvent\" with version \"1.2.3\" not found in Apex model");
 180         apexEventJsonStringIn1 = SupportJsonEventGenerator.jsonEventNoNamespace();
 181         event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn1).get(0);
 182         assertEquals("org.onap.policy.apex.events", event.getNameSpace());
 183
 184         assertThatThrownBy(() -> {
 185             String apexEventJsonStringIn = null;
 186             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventBadNamespace();
 187             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 188         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 189             .getCause().hasMessageStartingWith("field \"nameSpace\" with value \"hello.&&&&\" is invalid");
 190         assertThatThrownBy(() -> {
 191             String apexEventJsonStringIn = null;
 192             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventNoExNamespace();
 193             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 194         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 195             .getCause().hasMessageStartingWith("namespace \"pie.in.the.sky\" "
 196                 + "on event \"BasicEvent\" does not" + " match namespace \"org.onap.policy.apex.events\" "
 197                 + "for that event in the Apex model");
 198         apexEventJsonStringIn1 = SupportJsonEventGenerator.jsonEventNoSource();
 199         event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn1).get(0);
 200         assertEquals("source", event.getSource());
 201
 202         assertThatThrownBy(() -> {
 203             String apexEventJsonStringIn = null;
 204             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventBadSource();
 205             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 206         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 207             .getCause().hasMessageStartingWith("field \"source\" with value \"%!@**@!\" is invalid");
 208         apexEventJsonStringIn1 = SupportJsonEventGenerator.jsonEventNoTarget();
 209         event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn1).get(0);
 210         assertEquals("target", event.getTarget());
 211
 212         assertThatThrownBy(() -> {
 213             String apexEventJsonStringIn = null;
 214             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventBadTarget();
 215             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 216         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 217             .getCause().hasMessageStartingWith("field \"target\" with value \"KNIO(*S)A(S)D\" is invalid");
 218         assertThatThrownBy(() -> {
 219             String apexEventJsonStringIn = null;
 220             apexEventJsonStringIn = SupportJsonEventGenerator.jsonEventMissingFields();
 221             jsonEventConverter.toApexEvent(null, apexEventJsonStringIn);
 222         }).hasMessageStartingWith("Failed to unmarshal JSON event")
 223             .getCause().hasMessageStartingWith("error parsing BasicEvent:0.0.1 "
 224                + "event from Json. Field \"intPar\" is missing, but is mandatory.");
 225         apexEventJsonStringIn1 = SupportJsonEventGenerator.jsonEventNullFields();
 226         event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn1).get(0);
 227         assertEquals(null, event.get("TestSlogan"));
 228         assertEquals(-1, event.get("intPar"));
 229
 230         // Set the missing fields as optional in the model
 231         final AxEvent eventDefinition = ModelService.getModel(AxEvents.class).get("BasicEvent");
 232         eventDefinition.getParameterMap().get("intPar").setOptional(true);
 233
 234         apexEventJsonStringIn1 = SupportJsonEventGenerator.jsonEventMissingFields();
 235         event = jsonEventConverter.toApexEvent(null, apexEventJsonStringIn1).get(0);
 236         assertEquals(null, event.get("TestSlogan"));
 237         assertEquals(null, event.get("intPar"));
 238     }
 239
 240     /**
 241      * Test apex event to JSON.
 242      *
 243      * @throws ApexException the apex exception
 244      */
 245     @Test
 246     public void testApexEventToJson() throws ApexException {
 247         final Apex2JsonEventConverter jsonEventConverter = new Apex2JsonEventConverter();
 248         jsonEventConverter.init(new JsonEventProtocolParameters());
 249         assertNotNull(jsonEventConverter);
 250
 251         final Map<String, Object> basicEventMap = new HashMap<String, Object>();
 252         basicEventMap.put("intPar", 12345);
 253
 254         final ApexEvent basicEvent =
 255                new ApexEvent("BasicEvent", "0.0.1", "org.onap.policy.apex.events", "test", "apex",
 256                        AxToscaPolicyProcessingStatus.ENTRY.name());
 257         basicEvent.putAll(basicEventMap);
 258
 259         final String apexEvent0000JsonString = (String) jsonEventConverter.fromApexEvent(basicEvent);
 260
 261         logger.debug(apexEvent0000JsonString);
 262
 263         assertTrue(apexEvent0000JsonString.contains("\"name\": \"BasicEvent\""));
 264         assertTrue(apexEvent0000JsonString.contains("\"version\": \"0.0.1\""));
 265         assertTrue(apexEvent0000JsonString.contains("\"nameSpace\": \"org.onap.policy.apex.events\""));
 266         assertTrue(apexEvent0000JsonString.contains("\"source\": \"test\""));
 267         assertTrue(apexEvent0000JsonString.contains("\"target\": \"apex\""));
 268         assertTrue(apexEvent0000JsonString.contains("\"intPar\": 12345"));
 269         assertTrue(apexEvent0000JsonString.contains("\"toscaPolicyState\": \"ENTRY\""));
 270     }
 271 }