examples/examples-adaptive/src/test/java/org/onap/policy/apex/examples/adaptive/AnomalyDetectionTslUseCaseTest.java

   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.examples.adaptive;
  23
  24 import static org.awaitility.Awaitility.await;
  25 import static org.junit.Assert.assertEquals;
  26 import static org.junit.Assert.assertNotNull;
  27 import static org.junit.Assert.assertTrue;
  28
  29 import java.io.IOException;
  30 import java.util.Random;
  31 import java.util.concurrent.TimeUnit;
  32 import org.junit.After;
  33 import org.junit.Before;
  34 import org.junit.Test;
  35 import org.onap.policy.apex.context.impl.schema.java.JavaSchemaHelperParameters;
  36 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
  37 import org.onap.policy.apex.context.parameters.ContextParameters;
  38 import org.onap.policy.apex.context.parameters.SchemaParameters;
  39 import org.onap.policy.apex.core.engine.EngineParameters;
  40 import org.onap.policy.apex.core.engine.engine.ApexEngine;
  41 import org.onap.policy.apex.core.engine.engine.impl.ApexEngineFactory;
  42 import org.onap.policy.apex.core.engine.event.EnEvent;
  43 import org.onap.policy.apex.examples.adaptive.model.AdaptiveDomainModelFactory;
  44 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  45 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  46 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
  47 import org.onap.policy.apex.model.enginemodel.concepts.AxEngineState;
  48 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  49 import org.onap.policy.apex.plugins.executor.java.JavaExecutorParameters;
  50 import org.onap.policy.apex.plugins.executor.mvel.MvelExecutorParameters;
  51 import org.onap.policy.common.parameters.ParameterService;
  52 import org.slf4j.ext.XLogger;
  53 import org.slf4j.ext.XLoggerFactory;
  54
  55 /**
  56  * This policy passes, and recieves a Double event context filed called "EVCDouble".<br>
  57  * The policy tries to detect anomalies in the pattern of values for EVCDouble<br>
  58  * See the 2 test cases below (1 short, 1 long)
  59  *
  60  * @author John Keeney (John.Keeney@ericsson.com)
  61  */
  62 public class AnomalyDetectionTslUseCaseTest {
  63     private static final XLogger LOGGER = XLoggerFactory.getXLogger(AnomalyDetectionTslUseCaseTest.class);
  64
  65     private static final int MAXITERATIONS = 3660;
  66     private static final Random RAND = new Random(System.currentTimeMillis());
  67
  68     private SchemaParameters schemaParameters;
  69     private ContextParameters contextParameters;
  70     private EngineParameters engineParameters;
  71
  72     /**
  73      * Before test.
  74      */
  75     @Before
  76     public void beforeTest() {
  77         schemaParameters = new SchemaParameters();
  78
  79         schemaParameters.setName(ContextParameterConstants.SCHEMA_GROUP_NAME);
  80         schemaParameters.getSchemaHelperParameterMap().put("JAVA", new JavaSchemaHelperParameters());
  81
  82         ParameterService.register(schemaParameters);
  83
  84         contextParameters = new ContextParameters();
  85
  86         contextParameters.setName(ContextParameterConstants.MAIN_GROUP_NAME);
  87         contextParameters.getDistributorParameters().setName(ContextParameterConstants.DISTRIBUTOR_GROUP_NAME);
  88         contextParameters.getLockManagerParameters().setName(ContextParameterConstants.LOCKING_GROUP_NAME);
  89         contextParameters.getPersistorParameters().setName(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
  90
  91         ParameterService.register(contextParameters);
  92         ParameterService.register(contextParameters.getDistributorParameters());
  93         ParameterService.register(contextParameters.getLockManagerParameters());
  94         ParameterService.register(contextParameters.getPersistorParameters());
  95
  96         engineParameters = new EngineParameters();
  97         engineParameters.getExecutorParameterMap().put("MVEL", new MvelExecutorParameters());
  98         engineParameters.getExecutorParameterMap().put("JAVA", new JavaExecutorParameters());
  99         ParameterService.register(engineParameters);
 100     }
 101
 102     /**
 103      * After test.
 104      */
 105     @After
 106     public void afterTest() {
 107         ParameterService.deregister(engineParameters);
 108
 109         ParameterService.deregister(contextParameters.getDistributorParameters());
 110         ParameterService.deregister(contextParameters.getLockManagerParameters());
 111         ParameterService.deregister(contextParameters.getPersistorParameters());
 112         ParameterService.deregister(contextParameters);
 113
 114         ParameterService.deregister(schemaParameters);
 115     }
 116
 117     /**
 118      * Test anomaly detection tsl.
 119      *
 120      * @throws ApexException the apex exception
 121      * @throws InterruptedException the interrupted exception
 122      * @throws IOException Signals that an I/O exception has occurred.
 123      */
 124     @Test
 125     // once through the long running test below
 126     public void testAnomalyDetectionTsl() throws ApexException, InterruptedException, IOException {
 127         final AxPolicyModel apexPolicyModel = new AdaptiveDomainModelFactory().getAnomalyDetectionPolicyModel();
 128         assertNotNull(apexPolicyModel);
 129
 130         final AxValidationResult validationResult = new AxValidationResult();
 131         apexPolicyModel.validate(validationResult);
 132         assertTrue(validationResult.isValid());
 133
 134         final AxArtifactKey key = new AxArtifactKey("AnomalyTSLApexEngine", "0.0.1");
 135
 136         final ApexEngine apexEngine1 = new ApexEngineFactory().createApexEngine(key);
 137
 138         final TestApexActionListener listener1 = new TestApexActionListener("TestListener1");
 139         apexEngine1.addEventListener("listener", listener1);
 140         apexEngine1.updateModel(apexPolicyModel, false);
 141         apexEngine1.start();
 142         final EnEvent triggerEvent =
 143                 apexEngine1.createEvent(new AxArtifactKey("AnomalyDetectionTriggerEvent", "0.0.1"));
 144         final double rval = RAND.nextGaussian();
 145         triggerEvent.put("Iteration", 0);
 146         triggerEvent.put("MonitoredValue", rval);
 147         LOGGER.info("Triggering policy in Engine 1 with " + triggerEvent);
 148         apexEngine1.handleEvent(triggerEvent);
 149         final EnEvent result = listener1.getResult();
 150         LOGGER.info("Receiving action event {} ", result);
 151         assertEquals("ExecutionIDs are different", triggerEvent.getExecutionId(), result.getExecutionId());
 152         triggerEvent.clear();
 153         result.clear();
 154         await().atLeast(1, TimeUnit.MILLISECONDS).until(() -> result.isEmpty());
 155         apexEngine1.stop();
 156     }
 157
 158     /**
 159      * This policy passes, and recieves a Double event context filed called "EVCDouble"<br>
 160      * The policy tries to detect anomalies in the pattern of values for EVCDouble <br>
 161      * This test case generates a SineWave-like pattern for the parameter, repeating every 360 iterations. (These Period
 162      * should probably be set using TaskParameters!) Every 361st value is a random number!, so should be identified as
 163      * an Anomaly. The policy has 3 Decide Tasks, and the Decide TaskSelectionLogic picks one depending on the
 164      * 'Anomaliness' of the input data. <br>
 165      * To plot the results grep debug results for the string "************", paste into excel and delete non-relevant
 166      * columns<br>
 167      *
 168      * @throws ApexException the apex exception
 169      * @throws InterruptedException the interrupted exception
 170      * @throws IOException Signals that an I/O exception has occurred.
 171      */
 172     // Test is disabled by default. uncomment below, or execute using the main() method
 173     // @Test
 174     // EG Dos command: apex-core.engine> mvn
 175     // -Dtest=org.onap.policy.apex.core.engine.ml.TestAnomalyDetectionTslUseCase test | findstr /L /C:"Apex [main] DEBUG
 176     // c.e.a.e.TaskSelectionExecutionLogging -
 177     // TestAnomalyDetectionTSL_Policy0000DecideStateTaskSelectionLogic.getTask():"
 178     public void testAnomalyDetectionTslmain() throws ApexException, InterruptedException, IOException {
 179
 180         final AxPolicyModel apexPolicyModel = new AdaptiveDomainModelFactory().getAnomalyDetectionPolicyModel();
 181         assertNotNull(apexPolicyModel);
 182
 183         final AxValidationResult validationResult = new AxValidationResult();
 184         apexPolicyModel.validate(validationResult);
 185         assertTrue(validationResult.isValid());
 186
 187         final AxArtifactKey key = new AxArtifactKey("AnomalyTSLApexEngine", "0.0.1");
 188         final EngineParameters parameters = new EngineParameters();
 189         parameters.getExecutorParameterMap().put("MVEL", new MvelExecutorParameters());
 190         parameters.getExecutorParameterMap().put("JAVA", new JavaExecutorParameters());
 191
 192         final ApexEngine apexEngine1 = new ApexEngineFactory().createApexEngine(key);
 193
 194         final TestApexActionListener listener1 = new TestApexActionListener("TestListener1");
 195         apexEngine1.addEventListener("listener1", listener1);
 196         apexEngine1.updateModel(apexPolicyModel, false);
 197         apexEngine1.start();
 198
 199         final EnEvent triggerEvent =
 200                 apexEngine1.createEvent(new AxArtifactKey("AnomalyDetectionTriggerEvent", "0.0.1"));
 201         assertNotNull(triggerEvent);
 202
 203         for (int iteration = 0; iteration < MAXITERATIONS; iteration++) {
 204             // Trigger the policy in engine 1
 205
 206             double value = (Math.sin(Math.toRadians(iteration))) + (RAND.nextGaussian() / 25.0);
 207             // lets make every 361st number a random value to perhaps flag as an anomaly
 208             if (((iteration + 45) % 361) == 0) {
 209                 value = (RAND.nextGaussian() * 2.0);
 210             }
 211             triggerEvent.put("Iteration", iteration);
 212             triggerEvent.put("MonitoredValue", value);
 213             LOGGER.info("Iteration " + iteration + ":\tTriggering policy in Engine 1 with " + triggerEvent);
 214             apexEngine1.handleEvent(triggerEvent);
 215             final EnEvent result = listener1.getResult();
 216             LOGGER.info("Iteration " + iteration + ":\tReceiving action event {} ", result);
 217             triggerEvent.clear();
 218             result.clear();
 219         }
 220         apexEngine1.stop();
 221         await().atLeast(1000, TimeUnit.MILLISECONDS).until(() -> apexEngine1.getState().equals(AxEngineState.STOPPED));
 222     }
 223
 224     /**
 225      * The main method.
 226      *
 227      * @param args the arguments
 228      * @throws ApexException the apex exception
 229      * @throws InterruptedException the interrupted exception
 230      * @throws IOException Signals that an I/O exception has occurred.
 231      */
 232     public static void main(final String[] args) throws ApexException, InterruptedException, IOException {
 233         new AnomalyDetectionTslUseCaseTest().testAnomalyDetectionTslmain();
 234     }
 235 }