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.examples.myfirstpolicy;
  22
  23 import static org.junit.Assert.assertEquals;
  24 import static org.junit.Assert.assertNotNull;
  25 import static org.junit.Assert.assertTrue;
  26
  27 import com.google.gson.GsonBuilder;
  28 import com.google.gson.JsonObject;
  29
  30 import java.io.IOException;
  31 import java.util.Arrays;
  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.impl.schema.java.JavaSchemaHelperParameters;
  39 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
  40 import org.onap.policy.apex.context.parameters.ContextParameters;
  41 import org.onap.policy.apex.context.parameters.SchemaParameters;
  42 import org.onap.policy.apex.core.engine.EngineParameters;
  43 import org.onap.policy.apex.core.engine.engine.impl.ApexEngineFactory;
  44 import org.onap.policy.apex.core.engine.engine.impl.ApexEngineImpl;
  45 import org.onap.policy.apex.core.engine.event.EnEvent;
  46 import org.onap.policy.apex.examples.myfirstpolicy.model.MfpDomainModelFactory;
  47 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  48 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  49 import org.onap.policy.apex.model.eventmodel.concepts.AxEvent;
  50 import org.onap.policy.apex.model.eventmodel.concepts.AxField;
  51 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  52 import org.onap.policy.apex.plugins.executor.javascript.JavascriptExecutorParameters;
  53 import org.onap.policy.apex.plugins.executor.mvel.MvelExecutorParameters;
  54 import org.onap.policy.common.parameters.ParameterService;
  55 import org.onap.policy.common.utils.resources.ResourceUtils;
  56
  57 /**
  58  * Test MyFirstPolicy Use Case.
  59  */
  60 public class MfpUseCaseTest {
  61     // CHECKSTYLE:OFF: MagicNumber
  62
  63     private static ApexEngineImpl apexEngine;
  64
  65     /**
  66      * Test MFP use case setup.
  67      */
  68     @BeforeClass
  69     public static void testMfpUseCaseSetup() {
  70         final AxArtifactKey key = new AxArtifactKey("MyFirstPolicyApexEngine", "0.0.1");
  71         apexEngine = (ApexEngineImpl) new ApexEngineFactory().createApexEngine(key);
  72     }
  73
  74     private static ContextParameters contextParameters;
  75     private static SchemaParameters schemaParameters;
  76     private static EngineParameters engineParameters;
  77
  78     /**
  79      * Before test.
  80      */
  81     @BeforeClass
  82     public static void beforeTest() {
  83         schemaParameters = new SchemaParameters();
  84
  85         schemaParameters.setName(ContextParameterConstants.SCHEMA_GROUP_NAME);
  86         schemaParameters.getSchemaHelperParameterMap().put("JAVA", new JavaSchemaHelperParameters());
  87
  88         ParameterService.register(schemaParameters);
  89
  90         contextParameters = new ContextParameters();
  91
  92         contextParameters.setName(ContextParameterConstants.MAIN_GROUP_NAME);
  93         contextParameters.getDistributorParameters().setName(ContextParameterConstants.DISTRIBUTOR_GROUP_NAME);
  94         contextParameters.getLockManagerParameters().setName(ContextParameterConstants.LOCKING_GROUP_NAME);
  95         contextParameters.getPersistorParameters().setName(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
  96
  97         ParameterService.register(contextParameters);
  98         ParameterService.register(contextParameters.getDistributorParameters());
  99         ParameterService.register(contextParameters.getLockManagerParameters());
 100         ParameterService.register(contextParameters.getPersistorParameters());
 101
 102         engineParameters = new EngineParameters();
 103         engineParameters.getExecutorParameterMap().put("MVEL", new MvelExecutorParameters());
 104         engineParameters.getExecutorParameterMap().put("JAVASCRIPT", new JavascriptExecutorParameters());
 105         ParameterService.register(engineParameters);
 106     }
 107
 108     /**
 109      * After test.
 110      */
 111     @AfterClass
 112     public static void afterTest() {
 113         ParameterService.deregister(engineParameters);
 114
 115         ParameterService.deregister(contextParameters.getDistributorParameters());
 116         ParameterService.deregister(contextParameters.getLockManagerParameters());
 117         ParameterService.deregister(contextParameters.getPersistorParameters());
 118         ParameterService.deregister(contextParameters);
 119
 120         ParameterService.deregister(schemaParameters);
 121     }
 122
 123     /**
 124      * Test MyFirstPolicy#1 use case.
 125      *
 126      * @throws ApexException if there is an Apex error
 127      * @throws InterruptedException if there is an Interruption.
 128      * @throws IOException Signals that an I/O exception has occurred.
 129      */
 130     @Test
 131     public void testMfp1Case() throws ApexException, InterruptedException, IOException {
 132         final AxPolicyModel apexPolicyModel = new MfpDomainModelFactory().getMfp1PolicyModel();
 133         assertNotNull(apexPolicyModel);
 134
 135         final TestSaleAuthListener listener = new TestSaleAuthListener("Test");
 136         apexEngine.addEventListener("listener", listener);
 137         apexEngine.updateModel(apexPolicyModel);
 138         apexEngine.start();
 139
 140         final AxEvent axEventin = apexPolicyModel.getEvents().get(new AxArtifactKey("SALE_INPUT:0.0.1"));
 141         assertNotNull(axEventin);
 142         final AxEvent axEventout = apexPolicyModel.getEvents().get(new AxArtifactKey("SALE_AUTH:0.0.1"));
 143         assertNotNull(axEventout);
 144
 145         EnEvent event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/1/EventIn_BoozeItem_084106GMT.json");
 146         apexEngine.handleEvent(event);
 147         EnEvent resultout = listener.getResult();
 148         EnEvent resulexpected =
 149                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/1/EventOut_BoozeItem_084106GMT.json");
 150         assertEquals(resulexpected, resultout);
 151
 152         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/1/EventIn_BoozeItem_201713GMT.json");
 153         apexEngine.handleEvent(event);
 154         resultout = listener.getResult();
 155         resulexpected =
 156                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/1/EventOut_BoozeItem_201713GMT.json");
 157         assertEquals(resulexpected, resultout);
 158         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 159
 160         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/1/EventIn_NonBoozeItem_101309GMT.json");
 161         apexEngine.handleEvent(event);
 162         resultout = listener.getResult();
 163         resulexpected =
 164                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/1/EventOut_NonBoozeItem_101309GMT.json");
 165         assertEquals(resulexpected, resultout);
 166         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 167
 168         apexEngine.stop();
 169     }
 170
 171     /**
 172      * Test MyFirstPolicy#2 use case.
 173      *
 174      * @throws ApexException if there is an Apex error
 175      * @throws InterruptedException if there is an Interruption.
 176      * @throws IOException Signals that an I/O exception has occurred.
 177      */
 178     @Test
 179     public void testMfp2Case() throws ApexException, InterruptedException, IOException {
 180         final AxPolicyModel apexPolicyModel = new MfpDomainModelFactory().getMfp2PolicyModel();
 181         assertNotNull(apexPolicyModel);
 182
 183         final TestSaleAuthListener listener = new TestSaleAuthListener("Test");
 184         apexEngine.addEventListener("listener", listener);
 185         apexEngine.updateModel(apexPolicyModel);
 186         apexEngine.start();
 187
 188         final AxEvent axEventin = apexPolicyModel.getEvents().get(new AxArtifactKey("SALE_INPUT:0.0.1"));
 189         assertNotNull(axEventin);
 190         final AxEvent axEventout = apexPolicyModel.getEvents().get(new AxArtifactKey("SALE_AUTH:0.0.1"));
 191         assertNotNull(axEventout);
 192
 193         EnEvent event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/1/EventIn_BoozeItem_084106GMT.json");
 194         apexEngine.handleEvent(event);
 195         EnEvent resultout = listener.getResult();
 196         EnEvent resultexpected =
 197                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/1/EventOut_BoozeItem_084106GMT.json");
 198         assertEquals(resultexpected, resultout);
 199         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 200
 201         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/1/EventIn_BoozeItem_201713GMT.json");
 202         apexEngine.handleEvent(event);
 203         resultout = listener.getResult();
 204         resultexpected =
 205                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/1/EventOut_BoozeItem_201713GMT.json");
 206         assertEquals(resultexpected, resultout);
 207         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 208
 209         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/1/EventIn_NonBoozeItem_101309GMT.json");
 210         apexEngine.handleEvent(event);
 211         resultout = listener.getResult();
 212         resultexpected =
 213                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/1/EventOut_NonBoozeItem_101309GMT.json");
 214         assertEquals(resultexpected, resultout);
 215         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 216
 217         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/2/EventIn_BoozeItem_101433CET_thurs.json");
 218         apexEngine.handleEvent(event);
 219         resultout = listener.getResult();
 220         resultexpected =
 221                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/2/EventOut_BoozeItem_101433CET_thurs.json");
 222         assertEquals(resultexpected, resultout);
 223         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 224
 225         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/2/EventIn_BoozeItem_171937CET_sun.json");
 226         apexEngine.handleEvent(event);
 227         resultout = listener.getResult();
 228         resultexpected =
 229                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/2/EventOut_BoozeItem_171937CET_sun.json");
 230         assertEquals(resultexpected, resultout);
 231         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 232
 233         event = fillTriggerEvent(axEventin, "examples/events/MyFirstPolicy/2/EventIn_NonBoozeItem_111309CET_mon.json");
 234         apexEngine.handleEvent(event);
 235         resultout = listener.getResult();
 236         resultexpected =
 237                 fillResultEvent(axEventout, "examples/events/MyFirstPolicy/2/EventOut_NonBoozeItem_111309CET_mon.json");
 238         assertEquals(resultexpected, resultout);
 239         assertEquals("ExecutionIDs are different", event.getExecutionId(), resultout.getExecutionId());
 240
 241         apexEngine.stop();
 242     }
 243
 244     /**
 245      * Fill trigger event for test.
 246      *
 247      * @param event the event
 248      * @param inputFile the input file
 249      * @return the filled event
 250      */
 251     private EnEvent fillTriggerEvent(final AxEvent event, final String inputFile) {
 252         final EnEvent ret = new EnEvent(event.getKey());
 253         final GsonBuilder gb = new GsonBuilder();
 254         gb.serializeNulls().enableComplexMapKeySerialization();
 255         final JsonObject jsonObject =
 256                 gb.create().fromJson(ResourceUtils.getResourceAsString(inputFile), JsonObject.class);
 257         assertNotNull(jsonObject);
 258         assertTrue(jsonObject.has("name"));
 259         assertTrue(ret.getName().equals(jsonObject.get("name").getAsString()));
 260         assertTrue(ret.getAxEvent().getKey().getName().equals(jsonObject.get("name").getAsString()));
 261         assertTrue(jsonObject.has("nameSpace"));
 262         assertTrue(ret.getAxEvent().getNameSpace().equals(jsonObject.get("nameSpace").getAsString()));
 263         assertTrue(jsonObject.has("version"));
 264         assertTrue(ret.getAxEvent().getKey().getVersion().equals(jsonObject.get("version").getAsString()));
 265         final List<String> reserved = Arrays.asList("name", "nameSpace", "version", "source", "target");
 266         for (final Map.Entry<String, ?> e : jsonObject.entrySet()) {
 267             if (reserved.contains(e.getKey())) {
 268                 continue;
 269             }
 270             assertTrue("Event file " + inputFile + " has a field " + e.getKey() + " but this is not defined for "
 271                     + event.getId(), (event.getParameterMap().containsKey(e.getKey())));
 272             if (jsonObject.get(e.getKey()).isJsonNull()) {
 273                 ret.put(e.getKey(), null);
 274             }
 275         }
 276         for (final AxField field : event.getFields()) {
 277             if (!field.getOptional()) {
 278                 assertTrue("Event file " + inputFile + " is missing a mandatory field " + field.getKey().getLocalName()
 279                         + " for " + event.getId(), jsonObject.has(field.getKey().getLocalName()));
 280             } else {
 281                 ret.put(field.getKey().getLocalName(), null);
 282             }
 283         }
 284         if (jsonObject.has("time") && !jsonObject.get("time").isJsonNull()) {
 285             ret.put("time", jsonObject.get("time").getAsLong());
 286         }
 287         if (jsonObject.has("sale_ID") && !jsonObject.get("sale_ID").isJsonNull()) {
 288             ret.put("sale_ID", jsonObject.get("sale_ID").getAsLong());
 289         }
 290         if (jsonObject.has("amount") && !jsonObject.get("amount").isJsonNull()) {
 291             ret.put("amount", jsonObject.get("amount").getAsDouble());
 292         }
 293         if (jsonObject.has("item_ID") && !jsonObject.get("item_ID").isJsonNull()) {
 294             ret.put("item_ID", jsonObject.get("item_ID").getAsLong());
 295         }
 296         if (jsonObject.has("quantity") && !jsonObject.get("quantity").isJsonNull()) {
 297             ret.put("quantity", jsonObject.get("quantity").getAsInt());
 298         }
 299         if (jsonObject.has("assistant_ID") && !jsonObject.get("assistant_ID").isJsonNull()) {
 300             ret.put("assistant_ID", jsonObject.get("assistant_ID").getAsLong());
 301         }
 302         if (jsonObject.has("branch_ID") && !jsonObject.get("branch_ID").isJsonNull()) {
 303             ret.put("branch_ID", jsonObject.get("branch_ID").getAsLong());
 304         }
 305         if (jsonObject.has("notes") && !jsonObject.get("notes").isJsonNull()) {
 306             ret.put("notes", jsonObject.get("notes").getAsString());
 307         }
 308         return ret;
 309     }
 310
 311     /**
 312      * Fill result event for test.
 313      *
 314      * @param event the event
 315      * @param inputFile the input file
 316      * @return the filled event
 317      */
 318     private EnEvent fillResultEvent(final AxEvent event, final String inputFile) {
 319         final EnEvent ret = new EnEvent(event.getKey());
 320         final GsonBuilder gb = new GsonBuilder();
 321         gb.serializeNulls().enableComplexMapKeySerialization();
 322         final JsonObject jsonObject =
 323                 gb.create().fromJson(ResourceUtils.getResourceAsString(inputFile), JsonObject.class);
 324         assertNotNull(jsonObject);
 325         assertTrue(jsonObject.has("name"));
 326         assertTrue(ret.getName().equals(jsonObject.get("name").getAsString()));
 327         assertTrue(ret.getAxEvent().getKey().getName().equals(jsonObject.get("name").getAsString()));
 328         assertTrue(jsonObject.has("nameSpace"));
 329         assertTrue(ret.getAxEvent().getNameSpace().equals(jsonObject.get("nameSpace").getAsString()));
 330         assertTrue(jsonObject.has("version"));
 331         assertTrue(ret.getAxEvent().getKey().getVersion().equals(jsonObject.get("version").getAsString()));
 332         final List<String> reserved = Arrays.asList("name", "nameSpace", "version", "source", "target");
 333         for (final Map.Entry<String, ?> e : jsonObject.entrySet()) {
 334             if (reserved.contains(e.getKey())) {
 335                 continue;
 336             }
 337             assertTrue("Event file " + inputFile + " has a field " + e.getKey() + " but this is not defined for "
 338                     + event.getId(), (event.getParameterMap().containsKey(e.getKey())));
 339             if (jsonObject.get(e.getKey()).isJsonNull()) {
 340                 ret.put(e.getKey(), null);
 341             }
 342         }
 343         for (final AxField field : event.getFields()) {
 344             if (!field.getOptional()) {
 345                 assertTrue("Event file " + inputFile + " is missing a mandatory field " + field.getKey().getLocalName()
 346                         + " for " + event.getId(), jsonObject.has(field.getKey().getLocalName()));
 347             } else {
 348                 ret.put(field.getKey().getLocalName(), null);
 349             }
 350         }
 351         if (jsonObject.has("time") && !jsonObject.get("time").isJsonNull()) {
 352             ret.put("time", jsonObject.get("time").getAsLong());
 353         }
 354         if (jsonObject.has("sale_ID") && !jsonObject.get("sale_ID").isJsonNull()) {
 355             ret.put("sale_ID", jsonObject.get("sale_ID").getAsLong());
 356         }
 357         if (jsonObject.has("amount") && !jsonObject.get("amount").isJsonNull()) {
 358             ret.put("amount", jsonObject.get("amount").getAsDouble());
 359         }
 360         if (jsonObject.has("item_ID") && !jsonObject.get("item_ID").isJsonNull()) {
 361             ret.put("item_ID", jsonObject.get("item_ID").getAsLong());
 362         }
 363         if (jsonObject.has("quantity") && !jsonObject.get("quantity").isJsonNull()) {
 364             ret.put("quantity", jsonObject.get("quantity").getAsInt());
 365         }
 366         if (jsonObject.has("assistant_ID") && !jsonObject.get("assistant_ID").isJsonNull()) {
 367             ret.put("assistant_ID", jsonObject.get("assistant_ID").getAsLong());
 368         }
 369         if (jsonObject.has("branch_ID") && !jsonObject.get("branch_ID").isJsonNull()) {
 370             ret.put("branch_ID", jsonObject.get("branch_ID").getAsLong());
 371         }
 372         if (jsonObject.has("notes") && !jsonObject.get("notes").isJsonNull()) {
 373             ret.put("notes", jsonObject.get("notes").getAsString());
 374         }
 375         if (jsonObject.has("authorised") && !jsonObject.get("authorised").isJsonNull()) {
 376             ret.put("authorised", jsonObject.get("authorised").getAsString());
 377         }
 378         if (jsonObject.has("message") && !jsonObject.get("message").isJsonNull()) {
 379             ret.put("message", jsonObject.get("message").getAsString());
 380         }
 381         return ret;
 382     }
 383 }