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