controlloop/common/controller-usecases/src/main/java/org/onap/policy/drools/apps/controller/usecases/UsecasesEventManager.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.drools.apps.controller.usecases;
  22
  23 import static org.onap.policy.controlloop.ControlLoopTargetType.PNF;
  24 import static org.onap.policy.controlloop.ControlLoopTargetType.VM;
  25 import static org.onap.policy.controlloop.ControlLoopTargetType.VNF;
  26 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.GENERIC_VNF_IS_CLOSED_LOOP_DISABLED;
  27 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.GENERIC_VNF_PROV_STATUS;
  28 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.GENERIC_VNF_VNF_ID;
  29 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.GENERIC_VNF_VNF_NAME;
  30 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.PNF_IS_IN_MAINT;
  31 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.PNF_NAME;
  32 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.PROV_STATUS_ACTIVE;
  33 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.VM_NAME;
  34 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.VNF_NAME;
  35 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.VSERVER_IS_CLOSED_LOOP_DISABLED;
  36 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.VSERVER_PROV_STATUS;
  37 import static org.onap.policy.drools.apps.controller.usecases.UsecasesConstants.VSERVER_VSERVER_NAME;
  38
  39 import java.util.Deque;
  40 import java.util.Map;
  41 import java.util.Set;
  42 import java.util.stream.Collectors;
  43 import java.util.stream.Stream;
  44 import org.drools.core.WorkingMemory;
  45 import org.onap.policy.controlloop.ControlLoopException;
  46 import org.onap.policy.controlloop.ControlLoopResponse;
  47 import org.onap.policy.controlloop.VirtualControlLoopEvent;
  48 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  49 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
  50 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  51 import org.onap.policy.controlloop.drl.legacy.ControlLoopParams;
  52 import org.onap.policy.controlloop.eventmanager.ActorConstants;
  53 import org.onap.policy.controlloop.eventmanager.ClEventManagerWithEvent;
  54 import org.onap.policy.controlloop.eventmanager.EventManagerServices;
  55 import org.onap.policy.controlloop.eventmanager.StepContext;
  56 import org.onap.policy.drools.apps.controller.usecases.step.AaiCqStep2;
  57 import org.onap.policy.drools.apps.controller.usecases.step.AaiGetPnfStep2;
  58 import org.onap.policy.drools.apps.controller.usecases.step.AaiGetTenantStep2;
  59 import org.onap.policy.drools.apps.controller.usecases.step.GetTargetEntityStep2;
  60 import org.onap.policy.drools.apps.controller.usecases.step.GuardStep2;
  61 import org.onap.policy.drools.apps.controller.usecases.step.LockStep2;
  62 import org.onap.policy.drools.apps.controller.usecases.step.Step2;
  63 import org.onap.policy.sdnr.PciMessage;
  64
  65 /**
  66  * Manager for a single control loop event. Once this has been created, the event can be
  67  * retracted from working memory. Processing progresses through each policy, which
  68  * involves at least one step. As a step is processed, additional preprocessor steps may
  69  * be pushed onto the queue (e.g., locks, A&AI queries, guards).
  70  */
  71 public class UsecasesEventManager extends ClEventManagerWithEvent<Step2> implements StepContext {
  72
  73     private static final long serialVersionUID = -1216568161322872641L;
  74
  75     /**
  76      * If there's a failure from one of these actors, then the TOSCA processing should be
  77      * aborted.
  78      */
  79     private static final Set<String> ABORT_ACTORS = Set.of(ActorConstants.CL_TIMEOUT_ACTOR, ActorConstants.LOCK_ACTOR);
  80
  81     private static final Set<String> VALID_TARGETS = Stream
  82                     .of(VM_NAME, VNF_NAME, VSERVER_VSERVER_NAME, GENERIC_VNF_VNF_ID, GENERIC_VNF_VNF_NAME, PNF_NAME)
  83                     .map(String::toLowerCase).collect(Collectors.toSet());
  84
  85     private static final Set<String> TRUE_VALUES = Set.of("true", "t", "yes", "y");
  86
  87     /**
  88      * Names of Operation properties for which A&AI PNF query is needed.
  89      */
  90     private static final Set<String> PNF_PROPERTIES = Set.of(OperationProperties.AAI_PNF);
  91
  92     /**
  93      * Names of Operation properties for which A&AI Tenant query is needed.
  94      */
  95     private static final Set<String> TENANT_PROPERTIES = Set.of(OperationProperties.AAI_VSERVER_LINK);
  96
  97     /**
  98      * Names of Operation properties for which A&AI custom query is needed.
  99      */
 100     private static final Set<String> CQ_PROPERTIES = Set.of(OperationProperties.AAI_DEFAULT_CLOUD_REGION,
 101                     OperationProperties.AAI_VNF, OperationProperties.AAI_SERVICE_MODEL,
 102                     OperationProperties.AAI_VNF_MODEL, OperationProperties.AAI_SERVICE,
 103                     OperationProperties.AAI_RESOURCE_VNF, UsecasesConstants.AAI_DEFAULT_GENERIC_VNF);
 104
 105
 106     /**
 107      * Constructs the object.
 108      *
 109      * @param services services the manager should use when processing the event
 110      * @param params control loop parameters
 111      * @param event event to be managed by this object
 112      * @param workMem working memory to update if this changes
 113      * @throws ControlLoopException if the event is invalid or if a YAML processor cannot
 114      *         be created
 115      */
 116     public UsecasesEventManager(EventManagerServices services, ControlLoopParams params, VirtualControlLoopEvent event,
 117                     WorkingMemory workMem) throws ControlLoopException {
 118
 119         super(services, params, event, workMem);
 120
 121         if (isClosedLoopDisabled(event)) {
 122             throw new IllegalStateException("is-closed-loop-disabled is set to true on VServer or VNF");
 123         }
 124
 125         if (isProvStatusInactive(event)) {
 126             throw new IllegalStateException("prov-status is not ACTIVE on VServer or VNF");
 127         }
 128     }
 129
 130     /*
 131      * This is needed to satisfy drools, thus disabling sonar.
 132      */
 133     @Override
 134     public Deque<Step2> getSteps() {    // NOSONAR
 135         return super.getSteps();
 136     }
 137
 138     @Override
 139     public void loadPreprocessorSteps() {
 140         super.loadPreprocessorSteps();
 141
 142         final Deque<Step2> steps = getSteps();
 143         final Step2 step = getSteps().peek();
 144
 145         // determine if any A&AI queries are needed
 146         var needCq = false;
 147         var needPnf = false;
 148         var needTenant = false;
 149         var needTargetEntity = false;
 150
 151         for (String propName : step.getPropertyNames()) {
 152             needCq = needCq || CQ_PROPERTIES.contains(propName);
 153             needPnf = needPnf || PNF_PROPERTIES.contains(propName);
 154             needTenant = needTenant || TENANT_PROPERTIES.contains(propName);
 155             needTargetEntity = needTargetEntity || OperationProperties.AAI_TARGET_ENTITY.equals(propName);
 156         }
 157
 158         /*
 159          * The Policy's actual operation requires additional, implicit steps, such as
 160          * locking and guards.
 161          */
 162         final boolean needPolicySteps = step.isPolicyStep();
 163
 164
 165         /*
 166          * NOTE: need to push steps onto the queue in the OPPOSITE order in which they
 167          * must be performed.
 168          */
 169
 170
 171         // GUARD must be pushed first
 172         if (needPolicySteps) {
 173             steps.push(new GuardStep2(step, getClosedLoopControlName()));
 174         }
 175
 176         // A&AI queries
 177         if (needCq) {
 178             steps.push(new AaiCqStep2(step));
 179         }
 180
 181         if (needPnf) {
 182             steps.push(new AaiGetPnfStep2(step));
 183         }
 184
 185         if (needTenant) {
 186             steps.push(new AaiGetTenantStep2(step));
 187         }
 188
 189         // LOCK must be pushed after the queries
 190         if (needPolicySteps) {
 191             steps.push(new LockStep2(step));
 192         }
 193
 194         // GET-TARGET-ENTITY should be pushed last
 195         if (needTargetEntity) {
 196             steps.push(new GetTargetEntityStep2(step));
 197         }
 198     }
 199
 200     @Override
 201     public boolean isAbort(OperationOutcome outcome) {
 202         return (super.isAbort(outcome) && ABORT_ACTORS.contains(outcome.getActor()));
 203     }
 204
 205     /**
 206      * Stores an operation outcome in the DB.
 207      *
 208      * @param outcome operation outcome to store
 209      */
 210     public void storeInDataBase(OperationOutcome2 outcome) {
 211         storeInDataBase(outcome, getProperty(OperationProperties.AAI_TARGET_ENTITY));
 212     }
 213
 214     @Override
 215     public ControlLoopResponse makeControlLoopResponse(OperationOutcome outcome) {
 216         var clRsp = super.makeControlLoopResponse(outcome);
 217
 218         Object obj = outcome.getResponse();
 219         if (!(obj instanceof PciMessage)) {
 220             return clRsp;
 221         }
 222
 223         PciMessage msg = (PciMessage) obj;
 224         if (msg.getBody() != null && msg.getBody().getOutput() != null) {
 225             clRsp.setPayload(msg.getBody().getOutput().getPayload());
 226         }
 227
 228         return clRsp;
 229     }
 230
 231     @Override
 232     protected void checkEventSyntax(VirtualControlLoopEvent event) throws ControlLoopException {
 233         super.checkEventSyntax(event);
 234         validateAaiData(event);
 235     }
 236
 237     @Override
 238     protected void validateTarget(VirtualControlLoopEvent event) throws ControlLoopException {
 239         super.validateTarget(event);
 240
 241         if (!VALID_TARGETS.contains(event.getTarget().toLowerCase())) {
 242             throw new ControlLoopException("target field invalid");
 243         }
 244     }
 245
 246     private void validateAaiData(VirtualControlLoopEvent event) throws ControlLoopException {
 247         Map<String, String> eventAai = event.getAai();
 248         if (eventAai == null) {
 249             throw new ControlLoopException("AAI is null");
 250         }
 251         if (event.getTargetType() == null) {
 252             throw new ControlLoopException("The Target type is null");
 253         }
 254         switch (event.getTargetType()) {
 255             case VM, VNF:
 256                 validateAaiVmVnfData(eventAai);
 257                 return;
 258             case PNF:
 259                 validateAaiPnfData(eventAai);
 260                 return;
 261             default:
 262                 throw new ControlLoopException("The target type is not supported");
 263         }
 264     }
 265
 266     private void validateAaiVmVnfData(Map<String, String> eventAai) throws ControlLoopException {
 267         if (eventAai.get(GENERIC_VNF_VNF_ID) == null && eventAai.get(VSERVER_VSERVER_NAME) == null
 268                         && eventAai.get(GENERIC_VNF_VNF_NAME) == null) {
 269             throw new ControlLoopException(
 270                             "generic-vnf.vnf-id or generic-vnf.vnf-name or vserver.vserver-name information missing");
 271         }
 272     }
 273
 274     private void validateAaiPnfData(Map<String, String> eventAai) throws ControlLoopException {
 275         if (eventAai.get(PNF_NAME) == null) {
 276             throw new ControlLoopException("AAI PNF object key pnf-name is missing");
 277         }
 278     }
 279
 280     /**
 281      * Is closed loop disabled for an event.
 282      *
 283      * @param event the event
 284      * @return <code>true</code> if the control loop is disabled, <code>false</code>
 285      *         otherwise
 286      */
 287     private static boolean isClosedLoopDisabled(VirtualControlLoopEvent event) {
 288         Map<String, String> aai = event.getAai();
 289         return (isAaiTrue(aai.get(VSERVER_IS_CLOSED_LOOP_DISABLED))
 290                         || isAaiTrue(aai.get(GENERIC_VNF_IS_CLOSED_LOOP_DISABLED))
 291                         || isAaiTrue(aai.get(PNF_IS_IN_MAINT)));
 292     }
 293
 294     /**
 295      * Does provisioning status, for an event, have a value other than ACTIVE.
 296      *
 297      * @param event the event
 298      * @return {@code true} if the provisioning status is neither ACTIVE nor {@code null},
 299      *         {@code false} otherwise
 300      */
 301     private static boolean isProvStatusInactive(VirtualControlLoopEvent event) {
 302         Map<String, String> aai = event.getAai();
 303         return !(PROV_STATUS_ACTIVE.equalsIgnoreCase(aai.getOrDefault(VSERVER_PROV_STATUS, PROV_STATUS_ACTIVE))
 304                         && PROV_STATUS_ACTIVE.equalsIgnoreCase(
 305                                         aai.getOrDefault(GENERIC_VNF_PROV_STATUS, PROV_STATUS_ACTIVE)));
 306     }
 307
 308     /**
 309      * Determines the boolean value represented by the given AAI field value.
 310      *
 311      * @param aaiValue value to be examined
 312      * @return the boolean value represented by the field value, or {@code false} if the
 313      *         value is {@code null}
 314      */
 315     private static boolean isAaiTrue(String aaiValue) {
 316         return (aaiValue != null && TRUE_VALUES.contains(aaiValue.toLowerCase()));
 317     }
 318
 319     @Override
 320     protected void loadPolicyStep(ControlLoopOperationParams params) {
 321         getSteps().add(new Step2(this, params, getEvent()));
 322     }
 323 }