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