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.core.infrastructure.threading.ThreadUtilities;
  42 import org.onap.policy.apex.examples.adaptive.model.AdaptiveDomainModelFactory;
  43 import org.onap.policy.apex.model.basicmodel.concepts.ApexException;
  44 import org.onap.policy.apex.model.basicmodel.concepts.AxArtifactKey;
  45 import org.onap.policy.apex.model.basicmodel.concepts.AxValidationResult;
  46 import org.onap.policy.apex.model.policymodel.concepts.AxPolicyModel;
  47 import org.onap.policy.apex.plugins.executor.java.JavaExecutorParameters;
  48 import org.onap.policy.apex.plugins.executor.mvel.MvelExecutorParameters;
  49 import org.onap.policy.common.parameters.ParameterService;
  50 import org.slf4j.ext.XLogger;
  51 import org.slf4j.ext.XLoggerFactory;
  52
  53 // TODO: Auto-generated Javadoc
  54 /**
  55  * Test Auto learning in TSL.
  56  *
  57  * @author John Keeney (John.Keeney@ericsson.com)
  58  */
  59 public class AutoLearnTslUseCaseTest {
  60     private static final XLogger LOGGER = XLoggerFactory.getXLogger(AutoLearnTslUseCaseTest.class);
  61
  62     private static final int MAXITERATIONS = 1000;
  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 auto learn 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 testAutoLearnTsl() throws ApexException, InterruptedException, IOException {
 124         final AxPolicyModel apexPolicyModel = new AdaptiveDomainModelFactory().getAutoLearnPolicyModel();
 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("AADMApexEngine", "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 = apexEngine1.createEvent(new AxArtifactKey("AutoLearnTriggerEvent", "0.0.1"));
 140         final double rval = rand.nextGaussian();
 141         triggerEvent.put("MonitoredValue", rval);
 142         triggerEvent.put("LastMonitoredValue", 0D);
 143         LOGGER.info("Triggering policy in Engine 1 with " + triggerEvent);
 144         apexEngine1.handleEvent(triggerEvent);
 145         final EnEvent result = listener1.getResult();
 146         LOGGER.info("Receiving action event {} ", result);
 147         assertEquals("ExecutionIDs are different", triggerEvent.getExecutionId(), result.getExecutionId());
 148         triggerEvent.clear();
 149         result.clear();
 150         ThreadUtilities.sleep(10);
 151         apexEngine1.stop();
 152     }
 153
 154     /**
 155      * This policy passes, and receives a Double event context filed called "EVCDouble"<br>
 156      * The policy tries to keep the value at 50, with a Min -100, Max 100 (These should probably be set using
 157      * TaskParameters!)<br>
 158      * The policy has 7 Decide Tasks that manipulate the value of this field in unknown ways.<br>
 159      * The Decide TSL learns the effect of each task, and then selects the appropriate task to get the value back to
 160      * 50<br>
 161      * After the value settles close to 50 for a while, the test Rests the value to to random number and then
 162      * continues<br>
 163      * To plot the results grep stdout debug results for the string "*******", paste into excel and delete non-relevant
 164      * columns<br>
 165      *
 166      * @throws ApexException the apex exception
 167      * @throws InterruptedException the interrupted exception
 168      * @throws IOException Signals that an I/O exception has occurred.
 169      */
 170     // @Test
 171     public void testAutoLearnTslMain() throws ApexException, InterruptedException, IOException {
 172
 173         final double dwant = 50.0;
 174         final double toleranceTileJump = 3.0;
 175
 176         final AxPolicyModel apexPolicyModel = new AdaptiveDomainModelFactory().getAutoLearnPolicyModel();
 177         assertNotNull(apexPolicyModel);
 178
 179         final AxValidationResult validationResult = new AxValidationResult();
 180         apexPolicyModel.validate(validationResult);
 181         assertTrue(validationResult.isValid());
 182
 183         final AxArtifactKey key = new AxArtifactKey("AADMApexEngine", "0.0.1");
 184         final EngineParameters parameters = new EngineParameters();
 185         parameters.getExecutorParameterMap().put("MVEL", new MvelExecutorParameters());
 186         parameters.getExecutorParameterMap().put("JAVA", new JavaExecutorParameters());
 187
 188         final ApexEngine apexEngine1 = new ApexEngineFactory().createApexEngine(key);
 189
 190         final TestApexActionListener listener1 = new TestApexActionListener("TestListener1");
 191         apexEngine1.addEventListener("listener1", listener1);
 192         apexEngine1.updateModel(apexPolicyModel);
 193         apexEngine1.start();
 194
 195         final EnEvent triggerEvent = apexEngine1.createEvent(new AxArtifactKey("AutoLearnTriggerEvent", "0.0.1"));
 196         assertNotNull(triggerEvent);
 197         final double dmin = -100;
 198         final double dmax = 100;
 199
 200         double rval = (((rand.nextGaussian() + 1) / 2) * (dmax - dmin)) + dmin;
 201         triggerEvent.put("MonitoredValue", rval);
 202         triggerEvent.put("LastMonitoredValue", 0);
 203
 204         double avval = 0;
 205         double distance;
 206         double avcount = 0;
 207
 208         for (int iteration = 0; iteration < MAXITERATIONS; iteration++) {
 209             // Trigger the policy in engine 1
 210             LOGGER.info("Triggering policy in Engine 1 with " + triggerEvent);
 211             apexEngine1.handleEvent(triggerEvent);
 212             final EnEvent result = listener1.getResult();
 213             LOGGER.info("Receiving action event {} ", result);
 214             triggerEvent.clear();
 215
 216             double val = (Double) result.get("MonitoredValue");
 217             final double prevval = (Double) result.get("LastMonitoredValue");
 218
 219             triggerEvent.put("MonitoredValue", prevval);
 220             triggerEvent.put("LastMonitoredValue", val);
 221
 222             avcount = Math.min((avcount + 1), 20); // maintain average of only the last 20 values
 223             avval = ((avval * (avcount - 1)) + val) / (avcount);
 224
 225             distance = Math.abs(dwant - avval);
 226             if (distance < toleranceTileJump) {
 227                 rval = (((rand.nextGaussian() + 1) / 2) * (dmax - dmin)) + dmin;
 228                 val = rval;
 229                 triggerEvent.put("MonitoredValue", val);
 230                 LOGGER.info("Iteration " + iteration + ": Average " + avval + " has become closer (" + distance
 231                         + ") than " + toleranceTileJump + " to " + dwant + " so reseting val:\t\t\t\t\t\t\t\t" + val);
 232                 avval = 0;
 233                 avcount = 0;
 234             }
 235             LOGGER.info("Iteration " + iteration + ": \tpreval\t" + prevval + "\tval\t" + val + "\tavval\t" + avval);
 236
 237             result.clear();
 238             ThreadUtilities.sleep(10);
 239         }
 240
 241         apexEngine1.stop();
 242         ThreadUtilities.sleep(1000);
 243     }
 244
 245     /**
 246      * The main method.
 247      *
 248      * @param args the arguments
 249      * @throws ApexException the apex exception
 250      * @throws InterruptedException the interrupted exception
 251      * @throws IOException Signals that an I/O exception has occurred.
 252      */
 253     public static void main(final String[] args) throws ApexException, InterruptedException, IOException {
 254         new AutoLearnTslUseCaseTest().testAutoLearnTslMain();
 255     }
 256 }