gerrit.onap Code Review - policy/apex-pdp.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2016-2018 Ericsson. All rights reserved.
   4  *  Modifications Copyright (C) 2019 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.junit.Assert.assertEquals;
  25 import static org.junit.Assert.assertNotNull;
  26 import static org.junit.Assert.assertTrue;
  27
  28 import java.io.IOException;
  29 import java.util.Random;
  30
  31 import org.junit.After;
  32 import org.junit.Before;
  33 import org.junit.Test;
  34 import org.onap.policy.apex.context.impl.schema.java.JavaSchemaHelperParameters;
  35 import org.onap.policy.apex.context.parameters.ContextParameterConstants;
  36 import org.onap.policy.apex.context.parameters.ContextParameters;
  37 import org.onap.policy.apex.context.parameters.SchemaParameters;
  38 import org.onap.policy.apex.core.engine.EngineParameters;
  39 import org.onap.policy.apex.core.engine.engine.ApexEngine;
  40 import org.onap.policy.apex.core.engine.engine.impl.ApexEngineFactory;
  41 import org.onap.policy.apex.core.engine.event.EnEvent;
  42 import org.onap.policy.apex.core.infrastructure.threading.ThreadUtilities;
  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.policymodel.concepts.AxPolicyModel;
  48 import org.onap.policy.apex.plugins.executor.java.JavaExecutorParameters;
  49 import org.onap.policy.apex.plugins.executor.mvel.MvelExecutorParameters;
  50 import org.onap.policy.common.parameters.ParameterService;
  51 import org.slf4j.ext.XLogger;
  52 import org.slf4j.ext.XLoggerFactory;
  53
  54 // TODO: Auto-generated Javadoc
  55 /**
  56  * Test Auto learning in TSL.
  57  *
  58  * @author John Keeney (John.Keeney@ericsson.com)
  59  */
  60 public class AutoLearnTslUseCaseTest {
  61     private static final XLogger LOGGER = XLoggerFactory.getXLogger(AutoLearnTslUseCaseTest.class);
  62
  63     private static final int MAXITERATIONS = 1000;
  64     private static final Random rand = new Random(System.currentTimeMillis());
  65
  66     private SchemaParameters schemaParameters;
  67     private ContextParameters contextParameters;
  68     private EngineParameters engineParameters;
  69
  70     /**
  71      * Before test.
  72      */
  73     @Before
  74     public void beforeTest() {
  75         schemaParameters = new SchemaParameters();
  76
  77         schemaParameters.setName(ContextParameterConstants.SCHEMA_GROUP_NAME);
  78         schemaParameters.getSchemaHelperParameterMap().put("JAVA", new JavaSchemaHelperParameters());
  79
  80         ParameterService.register(schemaParameters);
  81
  82         contextParameters = new ContextParameters();
  83
  84         contextParameters.setName(ContextParameterConstants.MAIN_GROUP_NAME);
  85         contextParameters.getDistributorParameters().setName(ContextParameterConstants.DISTRIBUTOR_GROUP_NAME);
  86         contextParameters.getLockManagerParameters().setName(ContextParameterConstants.LOCKING_GROUP_NAME);
  87         contextParameters.getPersistorParameters().setName(ContextParameterConstants.PERSISTENCE_GROUP_NAME);
  88
  89         ParameterService.register(contextParameters);
  90         ParameterService.register(contextParameters.getDistributorParameters());
  91         ParameterService.register(contextParameters.getLockManagerParameters());
  92         ParameterService.register(contextParameters.getPersistorParameters());
  93
  94         engineParameters = new EngineParameters();
  95         engineParameters.getExecutorParameterMap().put("MVEL", new MvelExecutorParameters());
  96         engineParameters.getExecutorParameterMap().put("JAVA", new JavaExecutorParameters());
  97         ParameterService.register(engineParameters);
  98     }
  99
 100     /**
 101      * After test.
 102      */
 103     @After
 104     public void afterTest() {
 105         ParameterService.deregister(engineParameters);
 106
 107         ParameterService.deregister(contextParameters.getDistributorParameters());
 108         ParameterService.deregister(contextParameters.getLockManagerParameters());
 109         ParameterService.deregister(contextParameters.getPersistorParameters());
 110         ParameterService.deregister(contextParameters);
 111
 112         ParameterService.deregister(schemaParameters);
 113     }
 114
 115     /**
 116      * Test auto learn tsl.
 117      *
 118      * @throws ApexException the apex exception
 119      * @throws InterruptedException the interrupted exception
 120      * @throws IOException Signals that an I/O exception has occurred.
 121      */
 122     @Test
 123     // once through the long running test below
 124     public void testAutoLearnTsl() throws ApexException, InterruptedException, IOException {
 125         final AxPolicyModel apexPolicyModel = new AdaptiveDomainModelFactory().getAutoLearnPolicyModel();
 126         assertNotNull(apexPolicyModel);
 127
 128         final AxValidationResult validationResult = new AxValidationResult();
 129         apexPolicyModel.validate(validationResult);
 130         assertTrue(validationResult.isValid());
 131
 132         final AxArtifactKey key = new AxArtifactKey("AADMApexEngine", "0.0.1");
 133
 134         final ApexEngine apexEngine1 = new ApexEngineFactory().createApexEngine(key);
 135
 136         final TestApexActionListener listener1 = new TestApexActionListener("TestListener1");
 137         apexEngine1.addEventListener("listener", listener1);
 138         apexEngine1.updateModel(apexPolicyModel, false);
 139         apexEngine1.start();
 140         final EnEvent triggerEvent = apexEngine1.createEvent(new AxArtifactKey("AutoLearnTriggerEvent", "0.0.1"));
 141         final double rval = rand.nextGaussian();
 142         triggerEvent.put("MonitoredValue", rval);
 143         triggerEvent.put("LastMonitoredValue", 0D);
 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         ThreadUtilities.sleep(10);
 152         apexEngine1.stop();
 153     }
 154
 155     /**
 156      * This policy passes, and receives a Double event context filed called "EVCDouble"<br>
 157      * The policy tries to keep the value at 50, with a Min -100, Max 100 (These should probably be set using
 158      * TaskParameters!)<br>
 159      * The policy has 7 Decide Tasks that manipulate the value of this field in unknown ways.<br>
 160      * The Decide TSL learns the effect of each task, and then selects the appropriate task to get the value back to
 161      * 50<br>
 162      * After the value settles close to 50 for a while, the test Rests the value to to random number and then
 163      * continues<br>
 164      * To plot the results grep stdout debug results for the string "*******", paste into excel and delete non-relevant
 165      * columns<br>
 166      *
 167      * @throws ApexException the apex exception
 168      * @throws InterruptedException the interrupted exception
 169      * @throws IOException Signals that an I/O exception has occurred.
 170      */
 171     // @Test
 172     public void testAutoLearnTslMain() throws ApexException, InterruptedException, IOException {
 173
 174         final double dwant = 50.0;
 175         final double toleranceTileJump = 3.0;
 176
 177         final AxPolicyModel apexPolicyModel = new AdaptiveDomainModelFactory().getAutoLearnPolicyModel();
 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("AADMApexEngine", "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, false);
 194         apexEngine1.start();
 195
 196         final EnEvent triggerEvent = apexEngine1.createEvent(new AxArtifactKey("AutoLearnTriggerEvent", "0.0.1"));
 197         assertNotNull(triggerEvent);
 198         final double dmin = -100;
 199         final double dmax = 100;
 200
 201         double rval = (((rand.nextGaussian() + 1) / 2) * (dmax - dmin)) + dmin;
 202         triggerEvent.put("MonitoredValue", rval);
 203         triggerEvent.put("LastMonitoredValue", 0);
 204
 205         double avval = 0;
 206         double distance;
 207         double avcount = 0;
 208
 209         for (int iteration = 0; iteration < MAXITERATIONS; iteration++) {
 210             // Trigger the policy in engine 1
 211             LOGGER.info("Triggering policy in Engine 1 with " + triggerEvent);
 212             apexEngine1.handleEvent(triggerEvent);
 213             final EnEvent result = listener1.getResult();
 214             LOGGER.info("Receiving action event {} ", result);
 215             triggerEvent.clear();
 216
 217             double val = (Double) result.get("MonitoredValue");
 218             final double prevval = (Double) result.get("LastMonitoredValue");
 219
 220             triggerEvent.put("MonitoredValue", prevval);
 221             triggerEvent.put("LastMonitoredValue", val);
 222
 223             avcount = Math.min((avcount + 1), 20); // maintain average of only the last 20 values
 224             avval = ((avval * (avcount - 1)) + val) / (avcount);
 225
 226             distance = Math.abs(dwant - avval);
 227             if (distance < toleranceTileJump) {
 228                 rval = (((rand.nextGaussian() + 1) / 2) * (dmax - dmin)) + dmin;
 229                 val = rval;
 230                 triggerEvent.put("MonitoredValue", val);
 231                 LOGGER.info("Iteration " + iteration + ": Average " + avval + " has become closer (" + distance
 232                         + ") than " + toleranceTileJump + " to " + dwant + " so reseting val:\t\t\t\t\t\t\t\t" + val);
 233                 avval = 0;
 234                 avcount = 0;
 235             }
 236             LOGGER.info("Iteration " + iteration + ": \tpreval\t" + prevval + "\tval\t" + val + "\tavval\t" + avval);
 237
 238             result.clear();
 239             ThreadUtilities.sleep(10);
 240         }
 241
 242         apexEngine1.stop();
 243         ThreadUtilities.sleep(1000);
 244     }
 245
 246     /**
 247      * The main method.
 248      *
 249      * @param args the arguments
 250      * @throws ApexException the apex exception
 251      * @throws InterruptedException the interrupted exception
 252      * @throws IOException Signals that an I/O exception has occurred.
 253      */
 254     public static void main(final String[] args) throws ApexException, InterruptedException, IOException {
 255         new AutoLearnTslUseCaseTest().testAutoLearnTslMain();
 256     }
 257 }