testsuites/integration/integration-uservice-test/src/test/java/org/onap/policy/apex/testsuites/integration/uservice/engine/ApexServiceModelUpdateTest.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2020 Nordix Foundation.
   5  *  Modifications Copyright (C) 2020 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.testsuites.integration.uservice.engine;
  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.assertTrue;
  29
  30 import java.io.ByteArrayOutputStream;
  31 import java.io.IOException;
  32 import java.util.Date;
  33 import java.util.HashMap;
  34 import java.util.Map;
  35 import org.junit.After;
  36 import org.junit.Before;
  37 import org.junit.Test;
  38 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
  39 import org.onap.policy.apex.context.parameters.ContextParameters;
  40 import org.onap.policy.apex.context.parameters.DistributorParameters;
  41 import org.onap.policy.apex.context.parameters.LockManagerParameters;
  42 import org.onap.policy.apex.context.parameters.PersistorParameters;
  43 import org.onap.policy.apex.context.parameters.SchemaParameters;
  44 import org.onap.policy.apex.core.engine.EngineParameterConstants;
  45 import org.onap.policy.apex.core.engine.EngineParameters;
  46 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
  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.basicmodel.handling.ApexModelException;
  50 import org.onap.policy.apex.model.basicmodel.handling.ApexModelWriter;
  51 import org.onap.policy.apex.model.basicmodel.service.ModelService;
  52 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  53 import org.onap.policy.apex.plugins.executor.javascript.JavascriptExecutorParameters;
  54 import org.onap.policy.apex.plugins.executor.mvel.MvelExecutorParameters;
  55 import org.onap.policy.apex.service.engine.event.ApexEvent;
  56 import org.onap.policy.apex.service.engine.event.ApexEventException;
  57 import org.onap.policy.apex.service.engine.runtime.ApexEventListener;
  58 import org.onap.policy.apex.service.engine.runtime.EngineService;
  59 import org.onap.policy.apex.service.engine.runtime.EngineServiceEventInterface;
  60 import org.onap.policy.apex.service.engine.runtime.impl.EngineServiceImpl;
  61 import org.onap.policy.apex.service.parameters.ApexParameterConstants;
  62 import org.onap.policy.apex.service.parameters.engineservice.EngineServiceParameters;
  63 import org.onap.policy.apex.testsuites.integration.common.model.SampleDomainModelFactory;
  64 import org.onap.policy.common.parameters.ParameterService;
  65 import org.slf4j.ext.XLogger;
  66 import org.slf4j.ext.XLoggerFactory;
  67
  68 /**
  69  * The Class ApexServiceTest.
  70  *
  71  * @author Liam Fallon (liam.fallon@ericsson.com)
  72  */
  73 public class ApexServiceModelUpdateTest {
  74     // Logger for this class
  75     private static final XLogger LOGGER = XLoggerFactory.getXLogger(ApexServiceModelUpdateTest.class);
  76
  77     private final AxArtifactKey engineServiceKey = new AxArtifactKey("Machine-1_process-1_engine-1", "0.0.0");
  78     private final EngineServiceParameters parameters = new EngineServiceParameters();
  79     private EngineService service = null;
  80     private TestListener listener = null;
  81     private int actionEventsReceived = 0;
  82
  83     private AxPolicyModel apexSamplePolicyModel = null;
  84     private String apexSampleModelString;
  85
  86     /**
  87      * Set up parameters.
  88      */
  89     @Before
  90     public void setupParameters() {
  91         ParameterService.register(new SchemaParameters());
  92         ParameterService.register(new ContextParameters());
  93         ParameterService.register(new DistributorParameters());
  94         ParameterService.register(new LockManagerParameters());
  95         ParameterService.register(new PersistorParameters());
  96         ParameterService.register(new EngineServiceParameters());
  97
  98         EngineParameters engineParameters = new EngineParameters();
  99         engineParameters.getExecutorParameterMap().put("JAVASCRIPT", new JavascriptExecutorParameters());
 100         ParameterService.register(engineParameters);
 101     }
 102
 103     /**
 104      * Clear down parameters.
 105      */
 106     @After
 107     public void teardownParameters() {
 108         ParameterService.deregister(EngineParameterConstants.MAIN_GROUP_NAME);
 109         ParameterService.deregister(ApexParameterConstants.ENGINE_SERVICE_GROUP_NAME);
 110         ParameterService.deregister(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
 111         ParameterService.deregister(ContextParameterConstants.LOCKING_GROUP_NAME);
 112         ParameterService.deregister(ContextParameterConstants.DISTRIBUTOR_GROUP_NAME);
 113         ParameterService.deregister(ContextParameterConstants.MAIN_GROUP_NAME);
 114         ParameterService.deregister(ContextParameterConstants.SCHEMA_GROUP_NAME);
 115     }
 116
 117     /**
 118      * Sets up the test by creating an engine and reading in the test policy.
 119      *
 120      * @throws ApexException if something goes wrong
 121      * @throws IOException on IO exceptions
 122      */
 123     @Before
 124     public void setUp() throws ApexException, IOException {
 125         // create engine with 3 threads
 126         parameters.setInstanceCount(3);
 127         parameters.setName(engineServiceKey.getName());
 128         parameters.setVersion(engineServiceKey.getVersion());
 129         parameters.setId(100);
 130         parameters.getEngineParameters().getExecutorParameterMap().put("MVEL", new MvelExecutorParameters());
 131
 132         apexSamplePolicyModel = new SampleDomainModelFactory().getSamplePolicyModel("JAVASCRIPT");
 133         assertNotNull(apexSamplePolicyModel);
 134
 135         apexSampleModelString = getModelString(apexSamplePolicyModel);
 136
 137         parameters.setPolicyModel(apexSampleModelString);
 138         service = EngineServiceImpl.create(parameters);
 139
 140         LOGGER.debug("Running TestApexEngine. . .");
 141
 142         // create engine
 143         listener = new TestListener();
 144         service.registerActionListener("MyListener", listener);
 145     }
 146
 147     /**
 148      * Tear down the the test infrastructure.
 149      *
 150      * @throws ApexException if there is an error
 151      */
 152     @After
 153     public void tearDown() throws Exception {
 154         if (service != null) {
 155             service.stop();
 156         }
 157         service = null;
 158     }
 159
 160     /**
 161      * Test start with no model.
 162      */
 163     @Test
 164     public void testNoModelStart() {
 165         assertThatThrownBy(service::startAll)
 166             .hasMessage("start()<-Machine-1_process-1_engine-1-0:0.0.0,STOPPED,  cannot start engine, "
 167                     + "engine has not been initialized, its model is not loaded");
 168     }
 169
 170     /**
 171      * Test model update with string model without force.
 172      *
 173      * @throws ApexException if there is an error
 174      */
 175     @Test
 176     public void testModelUpdateStringNewNoForce() throws ApexException {
 177         service.updateModel(parameters.getEngineKey(), apexSampleModelString, false);
 178
 179         assertEquals(apexSamplePolicyModel.getKey(), ModelService.getModel(AxPolicyModel.class).getKey());
 180     }
 181
 182     /**
 183      * Test model update with string model with force.
 184      *
 185      * @throws ApexException if there is an error
 186      */
 187     @Test
 188     public void testModelUpdateStringNewForce() throws ApexException {
 189         service.updateModel(parameters.getEngineKey(), apexSampleModelString, true);
 190
 191         assertEquals(apexSamplePolicyModel.getKey(), ModelService.getModel(AxPolicyModel.class).getKey());
 192     }
 193
 194     /**
 195      * Test model update with a new string model without force.
 196      *
 197      * @throws ApexException if there is an error
 198      */
 199     @Test
 200     public void testModelUpdateStringNewNewNoForce() throws ApexException {
 201         service.updateModel(parameters.getEngineKey(), apexSampleModelString, false);
 202
 203         assertEquals(apexSamplePolicyModel.getKey(), ModelService.getModel(AxPolicyModel.class).getKey());
 204
 205         sendEvents();
 206
 207         service.updateModel(parameters.getEngineKey(), apexSampleModelString, false);
 208         assertEquals(apexSamplePolicyModel.getKey(), ModelService.getModel(AxPolicyModel.class).getKey());
 209
 210         sendEvents();
 211     }
 212
 213     /**
 214      * Test incompatible model update with a model object without force.
 215      *
 216      * @throws ApexException if there is an error
 217      */
 218     @Test
 219     public void testModelUpdateIncoNoForce() throws ApexException {
 220         service.updateModel(parameters.getEngineKey(), apexSamplePolicyModel, false);
 221
 222         assertEquals(apexSamplePolicyModel.getKey(), ModelService.getModel(AxPolicyModel.class).getKey());
 223
 224         // Different model name, incompatible
 225         final AxPolicyModel incoPolicyModel0 = new AxPolicyModel(apexSamplePolicyModel);
 226         incoPolicyModel0.getKey().setName("INCOMPATIBLE");
 227
 228         assertThatThrownBy(() -> service.updateModel(parameters.getEngineKey(), incoPolicyModel0, false))
 229             .hasMessage("apex model update failed, supplied model with key \"INCOMPATIBLE:0.0.1\" is "
 230                     + "not a compatible model update from the existing engine model " + "with key "
 231                     + "\"SamplePolicyModelJAVASCRIPT:0.0.1\"");
 232         // Still on old model
 233         sendEvents();
 234
 235         // Different major version, incompatible
 236         final AxPolicyModel incoPolicyModel1 = new AxPolicyModel(apexSamplePolicyModel);
 237         incoPolicyModel1.getKey().setVersion("1.0.1");
 238
 239         assertThatThrownBy(() -> service.updateModel(parameters.getEngineKey(), incoPolicyModel1, false))
 240             .hasMessage("apex model update failed, supplied model with key \"SamplePolicyModelJAVASCRIPT:"
 241                     + "1.0.1\" is not a compatible model update from the existing engine model with key "
 242                     + "\"SamplePolicyModelJAVASCRIPT:0.0.1\"");
 243         // Still on old model
 244         sendEvents();
 245
 246         // Different minor version, compatible
 247         final AxPolicyModel coPolicyModel0 = new AxPolicyModel(apexSamplePolicyModel);
 248         coPolicyModel0.getKey().setVersion("0.1.0");
 249         service.updateModel(parameters.getEngineKey(), coPolicyModel0, false);
 250
 251         // On new compatible model
 252         sendEvents();
 253
 254         // Different patch version, compatible
 255         final AxPolicyModel coPolicyModel1 = new AxPolicyModel(apexSamplePolicyModel);
 256         coPolicyModel1.getKey().setVersion("0.0.2");
 257         service.updateModel(parameters.getEngineKey(), coPolicyModel1, false);
 258
 259         // On new compatible model
 260         sendEvents();
 261
 262     }
 263
 264     /**
 265      * Test incompatible model update with a model object with force.
 266      *
 267      * @throws ApexException if there is an error
 268      */
 269     @Test
 270     public void testModelUpdateIncoForce() throws ApexException {
 271         service.updateModel(parameters.getEngineKey(), apexSamplePolicyModel, false);
 272
 273         assertEquals(apexSamplePolicyModel.getKey(), ModelService.getModel(AxPolicyModel.class).getKey());
 274
 275         // Different model name, incompatible
 276         final AxPolicyModel incoPolicyModel0 = new AxPolicyModel(apexSamplePolicyModel);
 277         incoPolicyModel0.getKey().setName("INCOMPATIBLE");
 278         service.updateModel(parameters.getEngineKey(), incoPolicyModel0, true);
 279
 280         // On updated model
 281         sendEvents();
 282
 283         // Different major version, incompatible
 284         final AxPolicyModel incoPolicyModel1 = new AxPolicyModel(apexSamplePolicyModel);
 285         incoPolicyModel1.getKey().setVersion("1.0.1");
 286         service.updateModel(parameters.getEngineKey(), incoPolicyModel1, true);
 287
 288         // On updated model
 289         sendEvents();
 290
 291         // Different minor version, compatible
 292         final AxPolicyModel coPolicyModel0 = new AxPolicyModel(apexSamplePolicyModel);
 293         coPolicyModel0.getKey().setVersion("0.1.0");
 294         service.updateModel(parameters.getEngineKey(), coPolicyModel0, true);
 295
 296         // On new compatible model
 297         sendEvents();
 298
 299         // Different patch version, compatible
 300         final AxPolicyModel coPolicyModel1 = new AxPolicyModel(apexSamplePolicyModel);
 301         coPolicyModel1.getKey().setVersion("0.0.2");
 302         service.updateModel(parameters.getEngineKey(), coPolicyModel1, true);
 303
 304         // On new compatible model
 305         sendEvents();
 306
 307     }
 308
 309     /**
 310      * Utility method to send some events into the test engine.
 311      *
 312      * @throws ApexEventException if there is an error
 313      */
 314     private void sendEvents() throws ApexEventException {
 315         final EngineServiceEventInterface engineServiceEventInterface = service.getEngineServiceEventInterface();
 316
 317         // Send some events
 318         final Date testStartTime = new Date();
 319         final Map<String, Object> eventDataMap = new HashMap<String, Object>();
 320         eventDataMap.put("TestSlogan", "This is a test slogan");
 321         eventDataMap.put("TestMatchCase", (byte) 123);
 322         eventDataMap.put("TestTimestamp", testStartTime.getTime());
 323         eventDataMap.put("TestTemperature", 34.5445667);
 324
 325         final ApexEvent event =
 326                 new ApexEvent("Event0000", "0.0.1", "org.onap.policy.apex.domains.sample.events", "test", "apex");
 327         event.putAll(eventDataMap);
 328         engineServiceEventInterface.sendEvent(event);
 329
 330         final ApexEvent event2 =
 331                 new ApexEvent("Event0100", "0.0.1", "org.onap.policy.apex.domains.sample.events", "test", "apex");
 332         event2.putAll(eventDataMap);
 333         engineServiceEventInterface.sendEvent(event2);
 334
 335         // Wait for results
 336         while (actionEventsReceived < 2) {
 337             ThreadUtilities.sleep(100);
 338         }
 339         ThreadUtilities.sleep(500);
 340     }
 341
 342     /**
 343      * The listener interface for receiving test events. The class that is interested in processing a test event
 344      * implements this interface, and the object created with that class is registered with a component using the
 345      * component's <code>addTestListener</code> method. When the test event occurs, that object's appropriate method is
 346      * invoked.
 347      *
 348      * @see TestEvent
 349      */
 350     private final class TestListener implements ApexEventListener {
 351
 352         /**
 353          * {@inheritDoc}.
 354          */
 355         @Override
 356         public synchronized void onApexEvent(final ApexEvent event) {
 357             LOGGER.debug("result 1 is:" + event);
 358             checkResult(event);
 359             actionEventsReceived++;
 360
 361             final Date testStartTime = new Date((Long) event.get("TestTimestamp"));
 362             final Date testEndTime = new Date();
 363
 364             LOGGER.info("policy execution time: " + (testEndTime.getTime() - testStartTime.getTime()) + "ms");
 365         }
 366
 367         /**
 368          * Check result.
 369          *
 370          * @param result the result
 371          */
 372         private void checkResult(final ApexEvent result) {
 373             assertTrue(result.getName().startsWith("Event0004") || result.getName().startsWith("Event0104"));
 374
 375             assertEquals("This is a test slogan", result.get("TestSlogan"));
 376             assertEquals((byte) 123, result.get("TestMatchCase"));
 377             assertEquals(34.5445667, result.get("TestTemperature"));
 378             assertTrue(((byte) result.get("TestMatchCaseSelected")) >= 0
 379                     && ((byte) result.get("TestMatchCaseSelected") <= 3));
 380             assertTrue(((byte) result.get("TestEstablishCaseSelected")) >= 0
 381                     && ((byte) result.get("TestEstablishCaseSelected") <= 3));
 382             assertTrue(((byte) result.get("TestDecideCaseSelected")) >= 0
 383                     && ((byte) result.get("TestDecideCaseSelected") <= 3));
 384             assertTrue(
 385                     ((byte) result.get("TestActCaseSelected")) >= 0 && ((byte) result.get("TestActCaseSelected") <= 3));
 386         }
 387     }
 388
 389     /**
 390      * Gets the model string.
 391      *
 392      * @param policyModel the eca policy model
 393      * @return the model string
 394      * @throws ApexModelException the apex model exception
 395      * @throws IOException Signals that an I/O exception has occurred.
 396      */
 397     private String getModelString(final AxPolicyModel policyModel) throws ApexModelException, IOException {
 398         try (final ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream()) {
 399             new ApexModelWriter<AxPolicyModel>(AxPolicyModel.class).write(policyModel, baOutputStream);
 400             return baOutputStream.toString();
 401         }
 402     }
 403 }