summaryrefslogtreecommitdiffstats
path: root/controlloop/common/eventmanager/src
diff options
context:
space:
mode:
authorJim Hahn <jrh3@att.com>2020-10-26 16:48:47 -0400
committerJim Hahn <jrh3@att.com>2020-11-16 14:28:34 -0500
commite8369d6d3088b7b68acb987ebff432ac830a3200 (patch)
tree70a4b752c6c9f2b0ff351dc1a195548a300fb098 /controlloop/common/eventmanager/src
parent21362791e6488bb36f543f0319b195e24f239dcb (diff)
Make drools-apps event agnostic
Removed tdjam and frankfurt controllers, which use event-specific actors. Issue-ID: POLICY-2804 Change-Id: Ica05f80bf72d039d9c4903591af7fb3793a81159 Signed-off-by: Jim Hahn <jrh3@att.com>
Diffstat (limited to 'controlloop/common/eventmanager/src')
-rw-r--r--controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2.java648
-rw-r--r--controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Drools.java76
-rw-r--r--controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2.java820
-rw-r--r--controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/LockData.java4
-rw-r--r--controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ManagerContext.java64
-rw-r--r--controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Test.java848
-rw-r--r--controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2Test.java1037
-rw-r--r--controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/LockDataTest.java8
-rw-r--r--controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/StepTest.java10
9 files changed, 8 insertions, 3507 deletions
diff --git a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2.java b/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2.java
deleted file mode 100644
index 1b3ae9220..000000000
--- a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2.java
+++ /dev/null
@@ -1,648 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2017-2020 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.eventmanager;
-
-import static org.onap.policy.controlloop.ControlLoopTargetType.PNF;
-import static org.onap.policy.controlloop.ControlLoopTargetType.VM;
-import static org.onap.policy.controlloop.ControlLoopTargetType.VNF;
-
-import java.io.Serializable;
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.LinkedList;
-import java.util.Map;
-import java.util.Set;
-import java.util.UUID;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.Executor;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.ForkJoinPool;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicLong;
-import java.util.concurrent.atomic.AtomicReference;
-import java.util.function.Consumer;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
-import lombok.Getter;
-import lombok.ToString;
-import org.apache.commons.lang3.StringUtils;
-import org.onap.policy.controlloop.ControlLoopEventStatus;
-import org.onap.policy.controlloop.ControlLoopException;
-import org.onap.policy.controlloop.ControlLoopNotificationType;
-import org.onap.policy.controlloop.ControlLoopOperation;
-import org.onap.policy.controlloop.ControlLoopResponse;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.VirtualControlLoopNotification;
-import org.onap.policy.controlloop.actorserviceprovider.ActorService;
-import org.onap.policy.controlloop.actorserviceprovider.OperationFinalResult;
-import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.drl.legacy.ControlLoopParams;
-import org.onap.policy.controlloop.ophistory.OperationHistoryDataManager;
-import org.onap.policy.controlloop.processor.ControlLoopProcessor;
-import org.onap.policy.drools.core.lock.LockCallback;
-import org.onap.policy.drools.domain.models.operational.Operation;
-import org.onap.policy.drools.system.PolicyEngineConstants;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Manager for a single control loop event. Once this has been created, the event can be
- * retracted from working memory. Once this has been created, {@link #start()} should be
- * invoked, and then {@link #nextStep()} should be invoked continually until
- * {@link #isActive()} returns {@code false}, indicating that all steps have completed.
- */
-@ToString(onlyExplicitlyIncluded = true)
-public abstract class ControlLoopEventManager2 implements ManagerContext, Serializable {
- private static final Logger logger = LoggerFactory.getLogger(ControlLoopEventManager2.class);
- private static final long serialVersionUID = -1216568161322872641L;
-
- private static final String EVENT_MANAGER_SERVICE_CONFIG = "event-manager";
- public static final String PROV_STATUS_ACTIVE = "ACTIVE";
- private static final String VM_NAME = "VM_NAME";
- private static final String VNF_NAME = "VNF_NAME";
- public static final String GENERIC_VNF_VNF_ID = "generic-vnf.vnf-id";
- public static final String GENERIC_VNF_VNF_NAME = "generic-vnf.vnf-name";
- public static final String VSERVER_VSERVER_NAME = "vserver.vserver-name";
- public static final String GENERIC_VNF_IS_CLOSED_LOOP_DISABLED = "generic-vnf.is-closed-loop-disabled";
- public static final String VSERVER_IS_CLOSED_LOOP_DISABLED = "vserver.is-closed-loop-disabled";
- public static final String PNF_IS_IN_MAINT = "pnf.in-maint";
- public static final String GENERIC_VNF_PROV_STATUS = "generic-vnf.prov-status";
- public static final String VSERVER_PROV_STATUS = "vserver.prov-status";
- public static final String PNF_ID = "pnf.pnf-id";
- public static final String PNF_NAME = "pnf.pnf-name";
-
- private static final Set<String> VALID_TARGETS = Stream
- .of(VM_NAME, VNF_NAME, VSERVER_VSERVER_NAME, GENERIC_VNF_VNF_ID, GENERIC_VNF_VNF_NAME, PNF_NAME)
- .map(String::toLowerCase).collect(Collectors.toSet());
-
- private static final Set<String> TRUE_VALUES = Set.of("true", "t", "yes", "y");
-
- /**
- * Counts the number of these objects that have been created. This is used by junit
- * tests.
- */
- private static final AtomicLong createCount = new AtomicLong(0);
-
- public enum NewEventStatus {
- FIRST_ONSET, SUBSEQUENT_ONSET, FIRST_ABATEMENT, SUBSEQUENT_ABATEMENT, SYNTAX_ERROR
- }
-
- /**
- * {@code True} if this object was created by this JVM instance, {@code false}
- * otherwise. This will be {@code false} if this object is reconstituted from a
- * persistent store or by transfer from another server.
- */
- private transient boolean createdByThisJvmInstance;
-
- @Getter
- @ToString.Include
- public final String closedLoopControlName;
- @Getter
- @ToString.Include
- private final UUID requestId;
- @Getter
- private final ControlLoopEventContext context;
- @ToString.Include
- private int numOnsets = 1;
- @ToString.Include
- private int numAbatements = 0;
- private VirtualControlLoopEvent abatement = null;
-
- /**
- * Time, in milliseconds, when the control loop will time out.
- */
- @Getter
- private final long endTimeMs;
-
- // fields extracted from the ControlLoopParams
- @Getter
- private final String policyName;
- private final String policyScope;
- private final String policyVersion;
-
- private final LinkedList<ControlLoopOperation> controlLoopHistory = new LinkedList<>();
-
- /**
- * Maps a target entity to its lock.
- */
- private final transient Map<String, LockData> target2lock = new HashMap<>();
-
- private final ControlLoopProcessor processor;
- private final AtomicReference<ControlLoopOperationManager2> currentOperation = new AtomicReference<>();
-
- private OperationFinalResult finalResult = null;
-
- @Getter
- private VirtualControlLoopNotification notification;
- @Getter
- private ControlLoopResponse controlLoopResponse;
-
- @Getter
- private boolean updated = false;
-
-
- /**
- * Constructs the object.
- *
- * @param params control loop parameters
- * @param event event to be managed by this object
- * @throws ControlLoopException if the event is invalid or if a YAML processor cannot
- * be created
- */
- public ControlLoopEventManager2(ControlLoopParams params, VirtualControlLoopEvent event)
- throws ControlLoopException {
-
- createCount.incrementAndGet();
-
- checkEventSyntax(event);
-
- if (isClosedLoopDisabled(event)) {
- throw new IllegalStateException("is-closed-loop-disabled is set to true on VServer or VNF");
- }
-
- if (isProvStatusInactive(event)) {
- throw new IllegalStateException("prov-status is not ACTIVE on VServer or VNF");
- }
-
- this.createdByThisJvmInstance = true;
- this.closedLoopControlName = params.getClosedLoopControlName();
- this.requestId = event.getRequestId();
- this.context = new ControlLoopEventContext(event);
- this.policyName = params.getPolicyName();
- this.policyScope = params.getPolicyScope();
- this.policyVersion = params.getPolicyVersion();
- this.processor = new ControlLoopProcessor(params.getToscaPolicy());
- this.endTimeMs = System.currentTimeMillis() + detmControlLoopTimeoutMs();
- }
-
- /**
- * Gets the number of managers objects that have been created.
- * @return the number of managers objects that have been created
- */
- public static long getCreateCount() {
- return createCount.get();
- }
-
- /**
- * Starts the manager.
- *
- * @throws ControlLoopException if the processor cannot get a policy
- */
- public void start() throws ControlLoopException {
- if (!isActive()) {
- throw new IllegalStateException("manager is no longer active");
- }
-
- startHook();
-
- if (currentOperation.get() != null) {
- throw new IllegalStateException("manager already started");
- }
-
- startOperation();
- }
-
- /**
- * Starts an operation for the current processor policy.
- *
- * @throws ControlLoopException if the processor cannot get a policy
- */
- private synchronized void startOperation() throws ControlLoopException {
-
- if ((finalResult = processor.checkIsCurrentPolicyFinal()) == null) {
- // not final - start the next operation
- currentOperation.set(makeOperationManager(context, processor.getCurrentPolicy()));
- currentOperation.get().start(endTimeMs - System.currentTimeMillis());
- return;
- }
-
- logger.info("final={} oper state={} for {}", finalResult, currentOperation.get().getState(), requestId);
-
- controlLoopResponse = null;
- notification = makeNotification();
- notification.setHistory(controlLoopHistory);
-
- switch (finalResult) {
- case FINAL_FAILURE_EXCEPTION:
- notification.setNotification(ControlLoopNotificationType.FINAL_FAILURE);
- notification.setMessage("Exception in processing closed loop");
- break;
- case FINAL_SUCCESS:
- notification.setNotification(ControlLoopNotificationType.FINAL_SUCCESS);
- break;
- case FINAL_OPENLOOP:
- notification.setNotification(ControlLoopNotificationType.FINAL_OPENLOOP);
- break;
- case FINAL_FAILURE:
- default:
- notification.setNotification(ControlLoopNotificationType.FINAL_FAILURE);
- break;
- }
- }
-
- /**
- * Starts the next step, whatever that may be.
- */
- public synchronized void nextStep() {
- if (!isActive()) {
- return;
- }
-
- updated = false;
-
- try {
- if (!currentOperation.get().nextStep()) {
- // current operation is done - try the next
- controlLoopHistory.addAll(currentOperation.get().getHistory());
- processor.nextPolicyForResult(currentOperation.get().getOperationResult());
- startOperation();
- }
-
- } catch (ControlLoopException | RuntimeException e) {
- // processor problem - this is fatal
- logger.warn("{}: cannot start next step for {}", closedLoopControlName, requestId, e);
- finalResult = OperationFinalResult.FINAL_FAILURE_EXCEPTION;
- controlLoopResponse = null;
- notification = makeNotification();
- notification.setNotification(ControlLoopNotificationType.FINAL_FAILURE);
- notification.setMessage("Policy processing aborted due to policy error");
- notification.setHistory(controlLoopHistory);
- }
- }
-
- /**
- * Determines if the manager is still active.
- *
- * @return {@code true} if the manager is still active, {@code false} otherwise
- */
- public synchronized boolean isActive() {
- return (createdByThisJvmInstance && finalResult == null);
- }
-
- /**
- * Updates working memory if this changes.
- *
- * @param operation operation manager that was updated
- */
- @Override
- public synchronized void updated(ControlLoopOperationManager2 operation) {
- if (!isActive() || operation != currentOperation.get()) {
- // no longer working on the given operation
- return;
- }
-
- controlLoopResponse = operation.getControlLoopResponse();
- notification = makeNotification();
-
- VirtualControlLoopEvent event = context.getEvent();
-
- switch (operation.getState()) {
- case LOCK_DENIED:
- notification.setNotification(ControlLoopNotificationType.REJECTED);
- notification.setMessage("The target " + event.getAai().get(event.getTarget()) + " is already locked");
- break;
- case LOCK_LOST:
- notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
- notification.setMessage("The target " + event.getAai().get(event.getTarget()) + " is no longer locked");
- break;
- case GUARD_STARTED:
- notification.setNotification(ControlLoopNotificationType.OPERATION);
- notification.setMessage(
- "Sending guard query for " + operation.getActor() + " " + operation.getOperation());
- break;
- case GUARD_PERMITTED:
- notification.setNotification(ControlLoopNotificationType.OPERATION);
- notification.setMessage("Guard result for " + operation.getActor() + " " + operation.getOperation()
- + " is Permit");
- break;
- case GUARD_DENIED:
- notification.setNotification(ControlLoopNotificationType.OPERATION);
- notification.setMessage("Guard result for " + operation.getActor() + " " + operation.getOperation()
- + " is Deny");
- break;
- case OPERATION_STARTED:
- notification.setNotification(ControlLoopNotificationType.OPERATION);
- notification.setMessage(operation.getOperationMessage());
- notification.setHistory(Collections.emptyList());
- break;
- case OPERATION_SUCCESS:
- notification.setNotification(ControlLoopNotificationType.OPERATION_SUCCESS);
- break;
-
- case CONTROL_LOOP_TIMEOUT:
- logger.warn("{}: control loop timed out for {}", closedLoopControlName, requestId);
- controlLoopHistory.addAll(currentOperation.get().getHistory());
- notification.setNotification(ControlLoopNotificationType.FINAL_FAILURE);
- notification.setMessage("Control Loop timed out");
- notification.setHistory(controlLoopHistory);
- finalResult = OperationFinalResult.FINAL_FAILURE;
- break;
-
- case OPERATION_FAILURE:
- default:
- notification.setNotification(ControlLoopNotificationType.OPERATION_FAILURE);
- break;
- }
-
- updated = true;
- notifyUpdate();
- }
-
- /**
- * Cancels the current operation and frees all locks.
- */
- public synchronized void destroy() {
- ControlLoopOperationManager2 oper = currentOperation.get();
- if (oper != null) {
- oper.cancel();
- }
-
- getBlockingExecutor().execute(this::freeAllLocks);
- }
-
- /**
- * Frees all locks.
- */
- private void freeAllLocks() {
- target2lock.values().forEach(LockData::free);
- }
-
- /**
- * Makes a notification message for the current operation.
- *
- * @return a new notification
- */
- public synchronized VirtualControlLoopNotification makeNotification() {
- VirtualControlLoopNotification notif = new VirtualControlLoopNotification(context.getEvent());
- notif.setNotification(ControlLoopNotificationType.OPERATION);
- notif.setFrom("policy");
- notif.setPolicyScope(policyScope);
- notif.setPolicyVersion(policyVersion);
-
- if (finalResult == null) {
- ControlLoopOperationManager2 oper = currentOperation.get();
- if (oper != null) {
- notif.setMessage(oper.getOperationHistory());
- notif.setHistory(oper.getHistory());
- }
- }
-
- return notif;
- }
-
- /**
- * An event onset/abatement.
- *
- * @param event the event
- * @return the status
- */
- public synchronized NewEventStatus onNewEvent(VirtualControlLoopEvent event) {
- try {
- checkEventSyntax(event);
-
- if (event.getClosedLoopEventStatus() == ControlLoopEventStatus.ONSET) {
- if (event.equals(context.getEvent())) {
- return NewEventStatus.FIRST_ONSET;
- }
-
- numOnsets++;
- return NewEventStatus.SUBSEQUENT_ONSET;
-
- } else {
- if (abatement == null) {
- abatement = event;
- numAbatements++;
- return NewEventStatus.FIRST_ABATEMENT;
- } else {
- numAbatements++;
- return NewEventStatus.SUBSEQUENT_ABATEMENT;
- }
- }
- } catch (ControlLoopException e) {
- logger.error("{}: onNewEvent threw an exception", this, e);
- return NewEventStatus.SYNTAX_ERROR;
- }
- }
-
- /**
- * Determines the overall control loop timeout.
- *
- * @return the policy timeout, in milliseconds, if specified, a default timeout
- * otherwise
- */
- private long detmControlLoopTimeoutMs() {
- // validation checks preclude null or 0 timeout values in the policy
- Integer timeout = processor.getPolicy().getProperties().getTimeout();
- return TimeUnit.MILLISECONDS.convert(timeout, TimeUnit.SECONDS);
- }
-
- /**
- * Check an event syntax.
- *
- * @param event the event syntax
- * @throws ControlLoopException if an error occurs
- */
- protected void checkEventSyntax(VirtualControlLoopEvent event) throws ControlLoopException {
- validateStatus(event);
- if (StringUtils.isBlank(event.getClosedLoopControlName())) {
- throw new ControlLoopException("No control loop name");
- }
- if (event.getRequestId() == null) {
- throw new ControlLoopException("No request ID");
- }
- if (event.getClosedLoopEventStatus() == ControlLoopEventStatus.ABATED) {
- return;
- }
- if (StringUtils.isBlank(event.getTarget())) {
- throw new ControlLoopException("No target field");
- } else if (!VALID_TARGETS.contains(event.getTarget().toLowerCase())) {
- throw new ControlLoopException("target field invalid");
- }
- validateAaiData(event);
- }
-
- private void validateStatus(VirtualControlLoopEvent event) throws ControlLoopException {
- if (event.getClosedLoopEventStatus() != ControlLoopEventStatus.ONSET
- && event.getClosedLoopEventStatus() != ControlLoopEventStatus.ABATED) {
- throw new ControlLoopException("Invalid value in closedLoopEventStatus");
- }
- }
-
- private void validateAaiData(VirtualControlLoopEvent event) throws ControlLoopException {
- Map<String, String> eventAai = event.getAai();
- if (eventAai == null) {
- throw new ControlLoopException("AAI is null");
- }
- if (event.getTargetType() == null) {
- throw new ControlLoopException("The Target type is null");
- }
- switch (event.getTargetType()) {
- case VM:
- case VNF:
- validateAaiVmVnfData(eventAai);
- return;
- case PNF:
- validateAaiPnfData(eventAai);
- return;
- default:
- throw new ControlLoopException("The target type is not supported");
- }
- }
-
- private void validateAaiVmVnfData(Map<String, String> eventAai) throws ControlLoopException {
- if (eventAai.get(GENERIC_VNF_VNF_ID) == null && eventAai.get(VSERVER_VSERVER_NAME) == null
- && eventAai.get(GENERIC_VNF_VNF_NAME) == null) {
- throw new ControlLoopException(
- "generic-vnf.vnf-id or generic-vnf.vnf-name or vserver.vserver-name information missing");
- }
- }
-
- private void validateAaiPnfData(Map<String, String> eventAai) throws ControlLoopException {
- if (eventAai.get(PNF_NAME) == null) {
- throw new ControlLoopException("AAI PNF object key pnf-name is missing");
- }
- }
-
- /**
- * Is closed loop disabled for an event.
- *
- * @param event the event
- * @return <code>true</code> if the control loop is disabled, <code>false</code>
- * otherwise
- */
- private static boolean isClosedLoopDisabled(VirtualControlLoopEvent event) {
- Map<String, String> aai = event.getAai();
- return (isAaiTrue(aai.get(VSERVER_IS_CLOSED_LOOP_DISABLED))
- || isAaiTrue(aai.get(GENERIC_VNF_IS_CLOSED_LOOP_DISABLED))
- || isAaiTrue(aai.get(PNF_IS_IN_MAINT)));
- }
-
- /**
- * Does provisioning status, for an event, have a value other than ACTIVE.
- *
- * @param event the event
- * @return {@code true} if the provisioning status is neither ACTIVE nor {@code null},
- * {@code false} otherwise
- */
- private static boolean isProvStatusInactive(VirtualControlLoopEvent event) {
- Map<String, String> aai = event.getAai();
- return !(PROV_STATUS_ACTIVE.equalsIgnoreCase(aai.getOrDefault(VSERVER_PROV_STATUS, PROV_STATUS_ACTIVE))
- && PROV_STATUS_ACTIVE.equalsIgnoreCase(
- aai.getOrDefault(GENERIC_VNF_PROV_STATUS, PROV_STATUS_ACTIVE)));
- }
-
- /**
- * Determines the boolean value represented by the given AAI field value.
- *
- * @param aaiValue value to be examined
- * @return the boolean value represented by the field value, or {@code false} if the
- * value is {@code null}
- */
- private static boolean isAaiTrue(String aaiValue) {
- return (aaiValue != null && TRUE_VALUES.contains(aaiValue.toLowerCase()));
- }
-
- /**
- * Requests a lock. This requests the lock for the time that remains before the
- * timeout expires. This avoids having to extend the lock.
- *
- * @param targetEntity entity to be locked
- * @param lockUnavailableCallback function to be invoked if the lock is
- * unavailable/lost
- * @return a future that can be used to await the lock
- */
- @Override
- public synchronized CompletableFuture<OperationOutcome> requestLock(String targetEntity,
- Consumer<OperationOutcome> lockUnavailableCallback) {
-
- long remainingMs = endTimeMs - System.currentTimeMillis();
- int remainingSec = 15 + Math.max(0, (int) TimeUnit.SECONDS.convert(remainingMs, TimeUnit.MILLISECONDS));
-
- LockData data = target2lock.computeIfAbsent(targetEntity, key -> {
- LockData data2 = new LockData(key, requestId);
- makeLock(targetEntity, requestId.toString(), remainingSec, data2);
- return data2;
- });
-
- data.addUnavailableCallback(lockUnavailableCallback);
-
- return data.getFuture();
- }
-
- /**
- * Initializes various components, on demand.
- */
- private static class LazyInitData {
- private static final OperationHistoryDataManager DATA_MANAGER;
- private static final ActorService ACTOR_SERVICE;
-
- static {
- EventManagerServices services = new EventManagerServices(EVENT_MANAGER_SERVICE_CONFIG);
- ACTOR_SERVICE = services.getActorService();
- DATA_MANAGER = services.getDataManager();
- }
- }
-
- // the following methods may be overridden by junit tests
-
- protected ControlLoopOperationManager2 makeOperationManager(ControlLoopEventContext ctx, Operation operation) {
- return new ControlLoopOperationManager2(this, ctx, operation, getExecutor());
- }
-
- protected Executor getExecutor() {
- return ForkJoinPool.commonPool();
- }
-
- protected ExecutorService getBlockingExecutor() {
- return PolicyEngineConstants.getManager().getExecutorService();
- }
-
- protected void makeLock(String targetEntity, String requestId, int holdSec, LockCallback callback) {
- PolicyEngineConstants.getManager().createLock(targetEntity, requestId, holdSec, callback, false);
- }
-
- @Override
- public ActorService getActorService() {
- return LazyInitData.ACTOR_SERVICE;
- }
-
- @Override
- public OperationHistoryDataManager getDataManager() {
- return LazyInitData.DATA_MANAGER;
- }
-
- /* ============================================================ */
-
- /**
- * This is a method, invoked from the 'start' method -- it gives subclasses
- * the ability to add operations. The default implementation does nothing.
- */
- protected void startHook() {
- }
-
- /**
- * This is an abstract method that is called after a notable update has
- * occurred to the 'ControlLoopEventManager2' object. It gives subclasses
- * the ability to add a callback method to process state changes.
- */
- protected abstract void notifyUpdate();
-}
diff --git a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Drools.java b/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Drools.java
deleted file mode 100644
index 9e8af9afb..000000000
--- a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Drools.java
+++ /dev/null
@@ -1,76 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.eventmanager;
-
-import org.drools.core.WorkingMemory;
-import org.kie.api.runtime.rule.FactHandle;
-import org.onap.policy.controlloop.ControlLoopException;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.drl.legacy.ControlLoopParams;
-
-/**
- * Manager for a single control loop event. Once this has been created, the event can be
- * retracted from working memory. Once this has been created, {@link #start()} should be
- * invoked, and then {@link #nextStep()} should be invoked continually until
- * {@link #isActive()} returns {@code false}, indicating that all steps have completed.
- */
-public class ControlLoopEventManager2Drools extends ControlLoopEventManager2 {
- private static final long serialVersionUID = 1L;
-
- private final transient WorkingMemory workMem;
- private transient FactHandle factHandle;
-
- /**
- * Constructs the object.
- *
- * @param params control loop parameters
- * @param event event to be managed by this object
- * @param workMem working memory to update if this changes
- * @throws ControlLoopException if the event is invalid or if a YAML processor cannot
- * be created
- */
- public ControlLoopEventManager2Drools(ControlLoopParams params, VirtualControlLoopEvent event,
- WorkingMemory workMem) throws ControlLoopException {
-
- super(params, event);
- this.workMem = workMem;
- }
-
- /**
- * This is a hook added to 'ControlLoopEventManager2.start()' --
- * here, we add an additional check.
- */
- @Override
- protected void startHook() {
- if ((factHandle = workMem.getFactHandle(this)) == null) {
- throw new IllegalStateException("manager is not in working memory");
- }
- }
-
- /**
- * This is a hook added to 'ControlLoopEventManager2.updated(...)' --
- * here, we mark it as updated in Drools memory.
- */
- @Override
- protected void notifyUpdate() {
- workMem.update(factHandle, this);
- }
-}
diff --git a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2.java b/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2.java
deleted file mode 100644
index ea269fe46..000000000
--- a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2.java
+++ /dev/null
@@ -1,820 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2017-2020 AT&T Intellectual Property. All rights reserved.
- * Modifications Copyright (C) 2019 Huawei Technologies Co., Ltd. All rights reserved.
- * Modifications Copyright (C) 2019 Tech Mahindra
- * Modifications Copyright (C) 2019 Bell Canada.
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.eventmanager;
-
-import java.io.Serializable;
-import java.time.Instant;
-import java.util.Deque;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.concurrent.CancellationException;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ConcurrentLinkedDeque;
-import java.util.concurrent.Executor;
-import java.util.concurrent.TimeUnit;
-import java.util.concurrent.atomic.AtomicReference;
-import java.util.stream.Collectors;
-import lombok.AccessLevel;
-import lombok.Getter;
-import lombok.ToString;
-import org.onap.policy.aai.AaiConstants;
-import org.onap.policy.aai.AaiCqResponse;
-import org.onap.policy.controlloop.ControlLoopOperation;
-import org.onap.policy.controlloop.ControlLoopResponse;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.actor.guard.GuardActor;
-import org.onap.policy.controlloop.actor.sdnr.SdnrActor;
-import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
-import org.onap.policy.controlloop.actorserviceprovider.TargetType;
-import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
-import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineUtil;
-import org.onap.policy.drools.domain.models.operational.OperationalTarget;
-import org.onap.policy.sdnr.PciMessage;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-/**
- * Manages a single Operation for a single event. Once this has been created,
- * {@link #start()} should be invoked, and then {@link #nextStep()} should be invoked
- * continually until it returns {@code false}, indicating that all steps have completed.
- */
-@ToString(onlyExplicitlyIncluded = true)
-public class ControlLoopOperationManager2 implements Serializable {
- private static final long serialVersionUID = -3773199283624595410L;
- private static final Logger logger = LoggerFactory.getLogger(ControlLoopOperationManager2.class);
- private static final String CL_TIMEOUT_ACTOR = "-CL-TIMEOUT-";
- public static final String LOCK_ACTOR = "LOCK";
- public static final String LOCK_OPERATION = "Lock";
- private static final String GUARD_ACTOR = GuardActor.NAME;
- public static final String VSERVER_VSERVER_NAME = "vserver.vserver-name";
- public static final String GENERIC_VNF_VNF_NAME = "generic-vnf.vnf-name";
- public static final String GENERIC_VNF_VNF_ID = "generic-vnf.vnf-id";
- public static final String PNF_NAME = "pnf.pnf-name";
-
- // @formatter:off
- public enum State {
- ACTIVE,
- LOCK_DENIED,
- LOCK_LOST,
- GUARD_STARTED,
- GUARD_PERMITTED,
- GUARD_DENIED,
- OPERATION_STARTED,
- OPERATION_SUCCESS,
- OPERATION_FAILURE,
- CONTROL_LOOP_TIMEOUT
- }
- // @formatter:on
-
- private final transient ManagerContext operContext;
- private final transient ControlLoopEventContext eventContext;
- private final org.onap.policy.drools.domain.models.operational.Operation policy;
-
- @Getter
- @ToString.Include
- private State state = State.ACTIVE;
-
- @ToString.Include
- private final String requestId;
-
- @ToString.Include
- private final String policyId;
-
- /**
- * Bumped each time the "complete" callback is invoked by the Actor, provided it's for
- * this operation.
- */
- @ToString.Include
- private int attempts = 0;
-
- private final Deque<Operation> operationHistory = new ConcurrentLinkedDeque<>();
-
- /**
- * Set to {@code true} to prevent the last item in {@link #operationHistory} from
- * being included in the outcome of {@link #getHistory()}. Used when the operation
- * aborts prematurely due to lock-denied, guard-denied, etc.
- */
- private boolean holdLast = false;
-
- /**
- * Queue of outcomes yet to be processed. Outcomes are added to this each time the
- * "start" or "complete" callback is invoked.
- */
- @Getter(AccessLevel.PROTECTED)
- private final transient Deque<OperationOutcome> outcomes = new ConcurrentLinkedDeque<>();
-
- /**
- * Used to cancel the running operation.
- */
- @Getter(AccessLevel.PROTECTED)
- private transient CompletableFuture<OperationOutcome> future = null;
-
- /**
- * Target entity. Determined after the lock is granted, though it may require the
- * custom query to be performed first.
- */
- @Getter
- private String targetEntity;
-
- @Getter(AccessLevel.PROTECTED)
- private final transient ControlLoopOperationParams params;
- private final transient PipelineUtil taskUtil;
-
- @Getter
- private ControlLoopResponse controlLoopResponse;
-
- /**
- * Time when the lock was first requested.
- */
- private transient AtomicReference<Instant> lockStart = new AtomicReference<>();
-
- // values extracted from the policy
- @Getter
- private final String actor;
- @Getter
- private final String operation;
-
- private final String targetStr;
- private final OperationalTarget target;
-
-
- /**
- * Construct an instance.
- *
- * @param operContext this operation's context
- * @param context event context
- * @param operation2 operation's policy
- * @param executor executor for the Operation
- */
- public ControlLoopOperationManager2(ManagerContext operContext, ControlLoopEventContext context,
- org.onap.policy.drools.domain.models.operational.Operation operation2, Executor executor) {
-
- this.operContext = operContext;
- this.eventContext = context;
- this.policy = operation2;
- this.requestId = context.getEvent().getRequestId().toString();
- this.policyId = "" + operation2.getId();
- this.actor = operation2.getActorOperation().getActor();
- this.operation = operation2.getActorOperation().getOperation();
- this.target = operation2.getActorOperation().getTarget();
-
- String targetType = (target != null ? target.getTargetType() : null);
- Map<String, String> entityIds = (target != null ? target.getEntityIds() : null);
-
- // TODO encode()?
- this.targetStr = (target != null ? target.toString() : null);
-
- // @formatter:off
- params = ControlLoopOperationParams.builder()
- .actorService(operContext.getActorService())
- .actor(actor)
- .operation(operation)
- .context(context)
- .executor(executor)
- .targetType(TargetType.toTargetType(targetType))
- .targetEntityIds(entityIds)
- .startCallback(this::onStart)
- .completeCallback(this::onComplete)
- .build();
- // @formatter:on
-
- taskUtil = new PipelineUtil(params);
- }
-
- //
- // Internal class used for tracking
- //
- @Getter
- @ToString
- private class Operation implements Serializable {
- private static final long serialVersionUID = 1L;
-
- private int attempt;
- private OperationResult policyResult;
- private ControlLoopOperation clOperation;
- private ControlLoopResponse clResponse;
-
- /**
- * Constructs the object.
- *
- * @param outcome outcome of the operation
- */
- public Operation(OperationOutcome outcome) {
- attempt = ControlLoopOperationManager2.this.attempts;
- policyResult = outcome.getResult();
- clOperation = outcome.toControlLoopOperation();
- clOperation.setTarget(targetStr);
- clResponse = makeControlLoopResponse(outcome);
-
- if (outcome.getEnd() == null) {
- clOperation.setOutcome("Started");
- } else if (clOperation.getOutcome() == null) {
- clOperation.setOutcome("");
- }
- }
- }
-
- /**
- * Start the operation, first acquiring any locks that are needed. This should not
- * throw any exceptions, but will, instead, invoke the callbacks with exceptions.
- *
- * @param remainingMs time remaining, in milliseconds, for the control loop
- */
- @SuppressWarnings("unchecked")
- public synchronized void start(long remainingMs) {
- // this is synchronized while we update "future"
-
- try {
- // provide a default, in case something fails before requestLock() is called
- lockStart.set(Instant.now());
-
- // @formatter:off
- future = taskUtil.sequence(
- this::detmTarget,
- this::requestLock,
- this::startOperation);
- // @formatter:on
-
- // handle any exceptions that may be thrown, set timeout, and handle timeout
-
- // @formatter:off
- future.exceptionally(this::handleException)
- .orTimeout(remainingMs, TimeUnit.MILLISECONDS)
- .exceptionally(this::handleTimeout);
- // @formatter:on
-
- } catch (RuntimeException e) {
- handleException(e);
- }
- }
-
- /**
- * Start the operation, after the lock has been acquired.
- *
- * @return CompletableFuture for the operation being started
- */
- private CompletableFuture<OperationOutcome> startOperation() {
- // @formatter:off
- ControlLoopOperationParams params2 = params.toBuilder()
- .payload(new LinkedHashMap<>())
- .retry(policy.getRetries())
- .timeoutSec(policy.getTimeout())
- .targetEntity(targetEntity)
- .build();
- // @formatter:on
-
- if (policy.getActorOperation().getPayload() != null) {
- params2.getPayload().putAll(policy.getActorOperation().getPayload());
- }
-
- return params2.start();
- }
-
- /**
- * Handles exceptions that may be generated.
- *
- * @param thrown exception that was generated
- * @return {@code null}
- */
- private OperationOutcome handleException(Throwable thrown) { // NOSONAR
- /*
- * disabling sonar about returning the same value because we prefer the code to be
- * structured this way
- */
-
- if (thrown instanceof CancellationException || thrown.getCause() instanceof CancellationException) {
- return null;
- }
-
- logger.warn("{}.{}: exception starting operation for {}", actor, operation, requestId, thrown);
- OperationOutcome outcome = taskUtil.setOutcome(params.makeOutcome(), thrown);
- outcome.setStart(lockStart.get());
- outcome.setEnd(Instant.now());
- outcome.setFinalOutcome(true);
- onComplete(outcome);
-
- // this outcome is not used so just return "null"
- return null;
- }
-
- /**
- * Handles control loop timeout exception.
- *
- * @param thrown exception that was generated
- * @return {@code null}
- */
- private OperationOutcome handleTimeout(Throwable thrown) {
- logger.warn("{}.{}: control loop timeout for {}", actor, operation, requestId, thrown);
-
- OperationOutcome outcome = taskUtil.setOutcome(params.makeOutcome(), thrown);
- outcome.setActor(CL_TIMEOUT_ACTOR);
- outcome.setOperation(null);
- outcome.setStart(lockStart.get());
- outcome.setEnd(Instant.now());
- outcome.setFinalOutcome(true);
- onComplete(outcome);
-
- // cancel the operation, if it's still running
- future.cancel(false);
-
- // this outcome is not used so just return "null"
- return null;
- }
-
- /**
- * Cancels the operation.
- */
- public void cancel() {
- synchronized (this) {
- if (future == null) {
- return;
- }
- }
-
- future.cancel(false);
- }
-
- /**
- * Requests a lock on the {@link #targetEntity}.
- *
- * @return a future to await the lock
- */
- private CompletableFuture<OperationOutcome> requestLock() {
- /*
- * Failures are handled via the callback, and successes are discarded by
- * sequence(), without passing them to onComplete().
- *
- * Return a COPY of the future so that if we try to cancel it, we'll only cancel
- * the copy, not the original. This is done by tacking thenApply() onto the end.
- */
- lockStart.set(Instant.now());
- return operContext.requestLock(targetEntity, this::lockUnavailable).thenApply(outcome -> outcome);
- }
-
- /**
- * Indicates that the lock on the target entity is unavailable.
- *
- * @param outcome lock outcome
- */
- private void lockUnavailable(OperationOutcome outcome) {
-
- // Note: NEVER invoke onStart() for locks; only invoke onComplete()
- onComplete(outcome);
-
- /*
- * Now that we've added the lock outcome to the queue, ensure the future is
- * canceled, which may, itself, generate an operation outcome.
- */
- cancel();
- }
-
- /**
- * Handles responses provided via the "start" callback. Note: this is never be invoked
- * for locks; only {@link #onComplete(OperationOutcome)} is invoked for locks.
- *
- * @param outcome outcome provided to the callback
- */
- private void onStart(OperationOutcome outcome) {
- if (outcome.isFor(actor, operation) || GUARD_ACTOR.equals(outcome.getActor())) {
- addOutcome(outcome);
- }
- }
-
- /**
- * Handles responses provided via the "complete" callback. Note: this is never invoked
- * for "successful" locks.
- *
- * @param outcome outcome provided to the callback
- */
- private void onComplete(OperationOutcome outcome) {
-
- switch (outcome.getActor()) {
- case LOCK_ACTOR:
- case GUARD_ACTOR:
- case CL_TIMEOUT_ACTOR:
- addOutcome(outcome);
- break;
-
- default:
- if (outcome.isFor(actor, operation)) {
- addOutcome(outcome);
- }
- break;
- }
- }
-
- /**
- * Adds an outcome to {@link #outcomes}.
- *
- * @param outcome outcome to be added
- */
- private synchronized void addOutcome(OperationOutcome outcome) {
- /*
- * This is synchronized to prevent nextStep() from invoking processOutcome() at
- * the same time.
- */
-
- logger.debug("added outcome={} for {}", outcome, requestId);
- outcomes.add(outcome);
-
- if (outcomes.peekFirst() == outcomes.peekLast()) {
- // this is the first outcome in the queue - process it
- processOutcome();
- }
- }
-
- /**
- * Looks for the next step in the queue.
- *
- * @return {@code true} if more responses are expected, {@code false} otherwise
- */
- public synchronized boolean nextStep() {
- switch (state) {
- case LOCK_DENIED:
- case LOCK_LOST:
- case GUARD_DENIED:
- case CONTROL_LOOP_TIMEOUT:
- holdLast = false;
- return false;
- default:
- break;
- }
-
- OperationOutcome outcome = outcomes.peek();
- if (outcome == null) {
- // empty queue
- return true;
- }
-
- if (outcome.isFinalOutcome() && outcome.isFor(actor, operation)) {
- controlLoopResponse = null;
- return false;
- }
-
- // first item has been processed, remove it
- outcomes.remove();
- if (!outcomes.isEmpty()) {
- // have a new "first" item - process it
- processOutcome();
- }
-
- return true;
- }
-
- /**
- * Processes the first item in {@link #outcomes}. Sets the state, increments
- * {@link #attempts}, if appropriate, and stores the operation history in the DB.
- */
- private synchronized void processOutcome() {
- OperationOutcome outcome = outcomes.peek();
- logger.debug("process outcome={} for {}", outcome, requestId);
-
- controlLoopResponse = null;
-
- switch (outcome.getActor()) {
-
- case CL_TIMEOUT_ACTOR:
- state = State.CONTROL_LOOP_TIMEOUT;
- processAbort(outcome, OperationResult.FAILURE, "Control loop timed out");
- break;
-
- case LOCK_ACTOR:
- // lock is no longer available
- if (state == State.ACTIVE) {
- state = State.LOCK_DENIED;
- storeFailureInDataBase(outcome, OperationResult.FAILURE_GUARD, "Operation denied by Lock");
- } else {
- state = State.LOCK_LOST;
- processAbort(outcome, OperationResult.FAILURE, "Operation aborted by Lock");
- }
- break;
-
- case GUARD_ACTOR:
- if (outcome.getEnd() == null) {
- state = State.GUARD_STARTED;
- } else if (outcome.getResult() == OperationResult.SUCCESS) {
- state = State.GUARD_PERMITTED;
- } else {
- state = State.GUARD_DENIED;
- storeFailureInDataBase(outcome, OperationResult.FAILURE_GUARD, "Operation denied by Guard");
- }
- break;
-
- default:
- if (outcome.getEnd() == null) {
- // operation started
- ++attempts;
- state = State.OPERATION_STARTED;
-
- } else {
- /*
- * Operation completed. If the last entry was a "start" (i.e., "end" field
- * is null), then replace it. Otherwise, just add the completion.
- */
- state = (outcome.getResult() == OperationResult.SUCCESS ? State.OPERATION_SUCCESS
- : State.OPERATION_FAILURE);
- controlLoopResponse = makeControlLoopResponse(outcome);
- if (!operationHistory.isEmpty() && operationHistory.peekLast().getClOperation().getEnd() == null) {
- operationHistory.removeLast();
- }
- }
-
- operationHistory.add(new Operation(outcome));
- storeOperationInDataBase();
- break;
- }
-
- // indicate that this has changed
- operContext.updated(this);
- }
-
- /**
- * Processes an operation abort, updating the DB record, if an operation has been
- * started.
- *
- * @param outcome operation outcome
- * @param result result to put into the DB
- * @param message message to put into the DB
- */
- private void processAbort(OperationOutcome outcome, OperationResult result, String message) {
- if (operationHistory.isEmpty() || operationHistory.peekLast().getClOperation().getEnd() != null) {
- // last item was not a "start" operation
-
- // NOTE: do NOT generate control loop response since operation was not started
-
- storeFailureInDataBase(outcome, result, message);
- return;
- }
-
- // last item was a "start" operation - replace it with a failure
- final Operation operOrig = operationHistory.removeLast();
-
- // use start time from the operation, itself
- if (operOrig != null && operOrig.getClOperation() != null) {
- outcome.setStart(operOrig.getClOperation().getStart());
- }
-
- controlLoopResponse = makeControlLoopResponse(outcome);
-
- storeFailureInDataBase(outcome, result, message);
- }
-
- /**
- * Makes a control loop response.
- *
- * @param outcome operation outcome
- * @return a new control loop response, or {@code null} if none is required
- */
- protected ControlLoopResponse makeControlLoopResponse(OperationOutcome outcome) {
-
- // only generate response for certain actors.
- if (outcome == null || !actor.equals(SdnrActor.NAME)) {
- return null;
- }
-
- VirtualControlLoopEvent event = eventContext.getEvent();
-
- ControlLoopResponse clRsp = new ControlLoopResponse();
- clRsp.setFrom(actor);
- clRsp.setTarget("DCAE");
- clRsp.setClosedLoopControlName(event.getClosedLoopControlName());
- clRsp.setPolicyName(event.getPolicyName());
- clRsp.setPolicyVersion(event.getPolicyVersion());
- clRsp.setRequestId(event.getRequestId());
- clRsp.setVersion(event.getVersion());
-
- PciMessage msg = outcome.getResponse();
- if (msg != null && msg.getBody() != null && msg.getBody().getOutput() != null) {
- clRsp.setPayload(msg.getBody().getOutput().getPayload());
- }
-
- return clRsp;
- }
-
- /**
- * Get the operation, as a message.
- *
- * @return the operation, as a message
- */
- public String getOperationMessage() {
- Operation last = operationHistory.peekLast();
- return (last == null ? null : last.getClOperation().toMessage());
- }
-
- /**
- * Gets the operation result.
- *
- * @return the operation result
- */
- public OperationResult getOperationResult() {
- Operation last = operationHistory.peekLast();
- return (last == null ? OperationResult.FAILURE_EXCEPTION : last.getPolicyResult());
- }
-
- /**
- * Get the latest operation history.
- *
- * @return the latest operation history
- */
- public String getOperationHistory() {
- Operation last = operationHistory.peekLast();
- return (last == null ? null : last.clOperation.toHistory());
- }
-
- /**
- * Get the history.
- *
- * @return the list of control loop operations
- */
- public List<ControlLoopOperation> getHistory() {
- Operation last = (holdLast ? operationHistory.removeLast() : null);
-
- List<ControlLoopOperation> result = operationHistory.stream().map(Operation::getClOperation)
- .map(ControlLoopOperation::new).collect(Collectors.toList());
-
- if (last != null) {
- operationHistory.add(last);
- }
-
- return result;
- }
-
- /**
- * Stores a failure in the DB.
- *
- * @param outcome operation outcome
- * @param result result to put into the DB
- * @param message message to put into the DB
- */
- private void storeFailureInDataBase(OperationOutcome outcome, OperationResult result, String message) {
- // don't include this in history yet
- holdLast = true;
-
- outcome.setActor(actor);
- outcome.setOperation(operation);
- outcome.setMessage(message);
- outcome.setResult(result);
-
- operationHistory.add(new Operation(outcome));
- storeOperationInDataBase();
- }
-
- /**
- * Stores the latest operation in the DB.
- */
- private void storeOperationInDataBase() {
- operContext.getDataManager().store(requestId, eventContext.getEvent(), targetEntity,
- operationHistory.peekLast().getClOperation());
- }
-
- /**
- * Determines the target entity.
- *
- * @return a future to determine the target entity, or {@code null} if the entity has
- * already been determined
- */
- protected CompletableFuture<OperationOutcome> detmTarget() {
- if (target == null) {
- throw new IllegalArgumentException("The target is null");
- }
-
- if (target.getTargetType() == null) {
- throw new IllegalArgumentException("The target type is null");
- }
-
- switch (TargetType.toTargetType(target.getTargetType())) {
- case PNF:
- return detmPnfTarget();
- case VM:
- case VNF:
- case VFMODULE:
- return detmVfModuleTarget();
- default:
- throw new IllegalArgumentException("The target type is not supported");
- }
- }
-
- /**
- * Determines the PNF target entity.
- *
- * @return a future to determine the target entity, or {@code null} if the entity has
- * already been determined
- */
- private CompletableFuture<OperationOutcome> detmPnfTarget() {
- if (!PNF_NAME.equalsIgnoreCase(eventContext.getEvent().getTarget())) {
- throw new IllegalArgumentException("Target does not match target type");
- }
-
- targetEntity = eventContext.getEnrichment().get(PNF_NAME);
- if (targetEntity == null) {
- throw new IllegalArgumentException("AAI section is missing " + PNF_NAME);
- }
-
- return null;
- }
-
- /**
- * Determines the VF Module target entity.
- *
- * @return a future to determine the target entity, or {@code null} if the entity has
- * already been determined
- */
- private CompletableFuture<OperationOutcome> detmVfModuleTarget() {
- String targetFieldName = eventContext.getEvent().getTarget();
- if (targetFieldName == null) {
- throw new IllegalArgumentException("Target is null");
- }
-
- switch (targetFieldName.toLowerCase()) {
- case VSERVER_VSERVER_NAME:
- targetEntity = eventContext.getEnrichment().get(VSERVER_VSERVER_NAME);
- break;
- case GENERIC_VNF_VNF_ID:
- targetEntity = eventContext.getEnrichment().get(GENERIC_VNF_VNF_ID);
- break;
- case GENERIC_VNF_VNF_NAME:
- return detmVnfName();
- default:
- throw new IllegalArgumentException("Target does not match target type");
- }
-
- if (targetEntity == null) {
- throw new IllegalArgumentException("Enrichment data is missing " + targetFieldName);
- }
-
- return null;
- }
-
- /**
- * Determines the VNF Name target entity.
- *
- * @return a future to determine the target entity, or {@code null} if the entity has
- * already been determined
- */
- @SuppressWarnings("unchecked")
- private CompletableFuture<OperationOutcome> detmVnfName() {
- // if the onset is enriched with the vnf-id, we don't need an A&AI response
- targetEntity = eventContext.getEnrichment().get(GENERIC_VNF_VNF_ID);
- if (targetEntity != null) {
- return null;
- }
-
- // vnf-id was not in the onset - obtain it via the custom query
-
- // @formatter:off
- ControlLoopOperationParams cqparams = params.toBuilder()
- .actor(AaiConstants.ACTOR_NAME)
- .operation(AaiCqResponse.OPERATION)
- .targetEntity("")
- .build();
- // @formatter:on
-
- // perform custom query and then extract the VNF ID from it
- return taskUtil.sequence(() -> eventContext.obtain(AaiCqResponse.CONTEXT_KEY, cqparams),
- this::extractVnfFromCq);
- }
-
- /**
- * Extracts the VNF Name target entity from the custom query data.
- *
- * @return {@code null}
- */
- private CompletableFuture<OperationOutcome> extractVnfFromCq() {
- // already have the CQ data
- AaiCqResponse cq = eventContext.getProperty(AaiCqResponse.CONTEXT_KEY);
- if (cq.getDefaultGenericVnf() == null) {
- throw new IllegalArgumentException("No vnf-id found");
- }
-
- targetEntity = cq.getDefaultGenericVnf().getVnfId();
- if (targetEntity == null) {
- throw new IllegalArgumentException("No vnf-id found");
- }
-
- return null;
- }
-}
diff --git a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/LockData.java b/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/LockData.java
index 119d14651..67eddba34 100644
--- a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/LockData.java
+++ b/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/LockData.java
@@ -169,8 +169,8 @@ public class LockData implements LockCallback {
*/
private OperationOutcome makeOutcome() {
OperationOutcome outcome = new OperationOutcome();
- outcome.setActor(ControlLoopOperationManager2.LOCK_ACTOR);
- outcome.setOperation(ControlLoopOperationManager2.LOCK_OPERATION);
+ outcome.setActor(ActorConstants.LOCK_ACTOR);
+ outcome.setOperation(ActorConstants.LOCK_OPERATION);
outcome.setTarget(targetEntity);
outcome.setFinalOutcome(true);
outcome.setStart(createTime);
diff --git a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ManagerContext.java b/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ManagerContext.java
deleted file mode 100644
index 0dcd30269..000000000
--- a/controlloop/common/eventmanager/src/main/java/org/onap/policy/controlloop/eventmanager/ManagerContext.java
+++ /dev/null
@@ -1,64 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.eventmanager;
-
-import java.util.concurrent.CompletableFuture;
-import java.util.function.Consumer;
-import org.onap.policy.controlloop.actorserviceprovider.ActorService;
-import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.ophistory.OperationHistoryDataManager;
-
-/**
- * Context for the Operation Manager.
- */
-public interface ManagerContext {
-
- /**
- * Gets the actor service.
- *
- * @return the actor service
- */
- ActorService getActorService();
-
- /**
- * Gets the operation history data manager.
- *
- * @return the operation history data manager
- */
- OperationHistoryDataManager getDataManager();
-
- /**
- * Requests a lock on the specified target.
- *
- * @param target target to be locked
- * @param lockUnavailableCallback callback to be invoked if the lock is
- * unavailable/lost
- * @return a future to await the lock
- */
- CompletableFuture<OperationOutcome> requestLock(String target, Consumer<OperationOutcome> lockUnavailableCallback);
-
- /**
- * Indicates that the given operation manager has been updated.
- *
- * @param operationMgr operation manager that has been updated
- */
- void updated(ControlLoopOperationManager2 operationMgr);
-}
diff --git a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Test.java b/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Test.java
deleted file mode 100644
index d3c217c9f..000000000
--- a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopEventManager2Test.java
+++ /dev/null
@@ -1,848 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.eventmanager;
-
-import static org.assertj.core.api.Assertions.assertThatCode;
-import static org.assertj.core.api.Assertions.assertThatThrownBy;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertSame;
-import static org.junit.Assert.assertTrue;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.anyLong;
-import static org.mockito.Mockito.never;
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
-
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.List;
-import java.util.Map;
-import java.util.TreeMap;
-import java.util.UUID;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutorService;
-import java.util.function.Consumer;
-import org.drools.core.WorkingMemory;
-import org.junit.Before;
-import org.junit.Test;
-import org.kie.api.runtime.rule.FactHandle;
-import org.mockito.ArgumentCaptor;
-import org.mockito.Mock;
-import org.mockito.MockitoAnnotations;
-import org.onap.policy.common.utils.coder.Coder;
-import org.onap.policy.common.utils.coder.CoderException;
-import org.onap.policy.common.utils.coder.StandardYamlCoder;
-import org.onap.policy.common.utils.io.Serializer;
-import org.onap.policy.common.utils.resources.ResourceUtils;
-import org.onap.policy.controlloop.ControlLoopEventStatus;
-import org.onap.policy.controlloop.ControlLoopException;
-import org.onap.policy.controlloop.ControlLoopNotificationType;
-import org.onap.policy.controlloop.ControlLoopOperation;
-import org.onap.policy.controlloop.ControlLoopTargetType;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.VirtualControlLoopNotification;
-import org.onap.policy.controlloop.actorserviceprovider.ActorService;
-import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
-import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.drl.legacy.ControlLoopParams;
-import org.onap.policy.controlloop.eventmanager.ControlLoopEventManager2.NewEventStatus;
-import org.onap.policy.controlloop.eventmanager.ControlLoopOperationManager2.State;
-import org.onap.policy.controlloop.ophistory.OperationHistoryDataManager;
-import org.onap.policy.drools.core.lock.LockCallback;
-import org.onap.policy.drools.core.lock.LockImpl;
-import org.onap.policy.drools.core.lock.LockState;
-import org.onap.policy.drools.domain.models.operational.Operation;
-import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
-import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
-
-public class ControlLoopEventManager2Test {
- private static final UUID REQ_ID = UUID.randomUUID();
- private static final String CL_NAME = "my-closed-loop-name";
- private static final String POLICY_NAME = "my-policy-name";
- private static final String POLICY_SCOPE = "my-scope";
- private static final String POLICY_VERSION = "1.2.3";
- private static final String MY_TARGET = "my-target";
- private static final String LOCK1 = "my-lock-A";
- private static final String LOCK2 = "my-lock-B";
- private static final Coder yamlCoder = new StandardYamlCoder();
-
- @Mock
- private WorkingMemory workMem;
- @Mock
- private Consumer<OperationOutcome> callback1;
- @Mock
- private Consumer<OperationOutcome> callback2;
- @Mock
- private Consumer<OperationOutcome> callback3;
- @Mock
- private FactHandle factHandle;
- @Mock
- private ActorService actors;
- @Mock
- private OperationHistoryDataManager dataMgr;
- @Mock
- private ControlLoopOperationManager2 oper1;
- @Mock
- private ControlLoopOperationManager2 oper2;
- @Mock
- private ControlLoopOperationManager2 oper3;
- @Mock
- private ExecutorService executor;
-
- private long preCreateTimeMs;
- private List<LockImpl> locks;
- private ToscaPolicy tosca;
- private ControlLoopParams params;
- private VirtualControlLoopEvent event;
- private int updateCount;
- private ControlLoopEventManager2Drools mgr;
-
- /**
- * Sets up.
- */
- @Before
- public void setUp() throws ControlLoopException, CoderException {
- MockitoAnnotations.initMocks(this);
-
- when(oper1.getHistory()).thenReturn(makeHistory("A"));
- when(oper2.getHistory()).thenReturn(makeHistory("B"));
- when(oper3.getHistory()).thenReturn(makeHistory("C"));
-
- when(oper1.getActor()).thenReturn("First");
- when(oper1.getOperation()).thenReturn("OperationA");
- when(oper1.getOperationMessage()).thenReturn("message-A");
- when(oper1.getOperationHistory()).thenReturn("history-A");
-
- when(oper2.getActor()).thenReturn("Second");
- when(oper2.getOperation()).thenReturn("OperationB");
- when(oper2.getOperationMessage()).thenReturn("message-B");
- when(oper2.getOperationHistory()).thenReturn("history-B");
-
- when(oper3.getActor()).thenReturn("Third");
- when(oper3.getOperation()).thenReturn("OperationC");
- when(oper3.getOperationMessage()).thenReturn("message-C");
- when(oper3.getOperationHistory()).thenReturn("history-C");
-
- when(workMem.getFactHandle(any())).thenReturn(factHandle);
-
- event = new VirtualControlLoopEvent();
- event.setRequestId(REQ_ID);
- event.setTarget(ControlLoopOperationManager2.VSERVER_VSERVER_NAME);
- event.setAai(new TreeMap<>(Map.of(ControlLoopOperationManager2.VSERVER_VSERVER_NAME, MY_TARGET)));
- event.setClosedLoopEventStatus(ControlLoopEventStatus.ONSET);
- event.setClosedLoopControlName(CL_NAME);
- event.setTargetType(ControlLoopTargetType.VNF);
-
- params = new ControlLoopParams();
- params.setClosedLoopControlName(CL_NAME);
- params.setPolicyName(POLICY_NAME);
- params.setPolicyScope(POLICY_SCOPE);
- params.setPolicyVersion(POLICY_VERSION);
-
- loadPolicy("eventManager/event-mgr-simple.yaml");
-
- locks = new ArrayList<>();
-
- updateCount = 0;
-
- preCreateTimeMs = System.currentTimeMillis();
-
- mgr = new MyManagerWithOper(params, event, workMem);
- }
-
- @Test
- public void testConstructor() {
- assertEquals(POLICY_NAME, mgr.getPolicyName());
-
- Map<String, String> orig = event.getAai();
-
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_IS_CLOSED_LOOP_DISABLED, "true"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .hasMessage("is-closed-loop-disabled is set to true on VServer or VNF");
-
- // vserver ACTIVE
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_PROV_STATUS,
- ControlLoopEventManager2.PROV_STATUS_ACTIVE.toUpperCase()));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
-
- // vserver active
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_PROV_STATUS,
- ControlLoopEventManager2.PROV_STATUS_ACTIVE.toLowerCase()));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
-
- // vserver inactive
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_PROV_STATUS, "inactive"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .hasMessage("prov-status is not ACTIVE on VServer or VNF");
-
- // vnf ACTIVE
- event.setAai(addAai(orig, ControlLoopEventManager2.GENERIC_VNF_PROV_STATUS,
- ControlLoopEventManager2.PROV_STATUS_ACTIVE.toUpperCase()));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
-
- // vnf active
- event.setAai(addAai(orig, ControlLoopEventManager2.GENERIC_VNF_PROV_STATUS,
- ControlLoopEventManager2.PROV_STATUS_ACTIVE.toLowerCase()));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
-
- // vnf inactive
- event.setAai(addAai(orig, ControlLoopEventManager2.GENERIC_VNF_PROV_STATUS, "inactive"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .hasMessage("prov-status is not ACTIVE on VServer or VNF");
-
- // valid
- event.setAai(orig);
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- // invalid
- event.setTarget("unknown-target");
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(ControlLoopException.class);
- }
-
- /**
- * Runs through a policy that has several operations.
- */
- @Test
- public void testMultiOperation() throws Exception {
-
- loadPolicy("eventManager/event-mgr-multi.yaml");
-
- mgr = new MyManagerWithOper(params, event, workMem);
- mgr.start();
-
- for (ControlLoopOperationManager2 oper : Arrays.asList(oper1, oper2, oper3)) {
- assertTrue(mgr.isActive());
- nextStep(oper, true, OperationResult.SUCCESS);
- runRule();
-
- assertTrue(mgr.isActive());
- nextStep(oper, false, OperationResult.SUCCESS);
- runRule();
- }
-
- assertFalse(mgr.isActive());
- }
-
- @Test
- public void testStart() throws Exception {
- // start it
- mgr.start();
-
- // cannot re-start
- assertThatCode(() -> mgr.start()).isInstanceOf(IllegalStateException.class)
- .hasMessage("manager already started");
- }
-
- /**
- * Tests start() error cases.
- */
- @Test
- public void testStartErrors() throws Exception {
- // wrong jvm
- ControlLoopEventManager2Drools mgr2 = new ControlLoopEventManager2Drools(params, event, workMem);
- ControlLoopEventManager2Drools mgr3 = Serializer.roundTrip(mgr2);
- assertThatCode(() -> mgr3.start()).isInstanceOf(IllegalStateException.class)
- .hasMessage("manager is no longer active");
-
- // no fact handle
- when(workMem.getFactHandle(any())).thenReturn(null);
- assertThatCode(() -> mgr.start()).isInstanceOf(IllegalStateException.class)
- .hasMessage("manager is not in working memory");
- }
-
- @Test
- public void testNextStep_testStartOperationSuccess() throws ControlLoopException {
- runOperation(OperationResult.SUCCESS);
-
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals(ControlLoopNotificationType.FINAL_SUCCESS, notif.getNotification());
- assertNull(notif.getMessage());
-
- assertThatCode(() -> mgr.nextStep()).doesNotThrowAnyException();
- }
-
- /**
- * Tests nextStep() when the next step is invalid, which should cause an exception to
- * be thrown by the processor.
- */
- @Test
- public void testNextStepMissing() throws Exception {
- mgr.start();
-
- when(oper1.nextStep()).thenThrow(new IllegalArgumentException("expected exception"));
-
- mgr.nextStep();
-
- assertFalse(mgr.isActive());
-
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notif.getNotification());
- assertEquals("Policy processing aborted due to policy error", notif.getMessage());
- assertTrue(notif.getHistory().isEmpty());
- }
-
- /**
- * Tests startOperation() with FINAL_FAILURE_EXCEPTION.
- */
- @Test
- public void testStartOperationException() throws ControlLoopException {
- runOperation(OperationResult.FAILURE_EXCEPTION);
-
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notif.getNotification());
- assertEquals("Exception in processing closed loop", notif.getMessage());
- }
-
- /**
- * Tests startOperation() with FINAL_FAILURE.
- */
- @Test
- public void testStartOperationFailure() throws ControlLoopException {
- runOperation(OperationResult.FAILURE);
-
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals(ControlLoopNotificationType.FINAL_FAILURE, notif.getNotification());
- assertNull(notif.getMessage());
- }
-
- /**
- * Tests startOperation() with FINAL_OPENLOOP.
- */
- @Test
- public void testStartOperationOpenLoop() throws ControlLoopException {
- runOperation(OperationResult.FAILURE_GUARD);
-
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals(ControlLoopNotificationType.FINAL_OPENLOOP, notif.getNotification());
- assertNull(notif.getMessage());
- }
-
- @Test
- public void testIsActive() throws Exception {
- mgr = new ControlLoopEventManager2Drools(params, event, workMem);
- assertTrue(mgr.isActive());
-
- ControlLoopEventManager2Drools mgr2 = Serializer.roundTrip(mgr);
- assertFalse(mgr2.isActive());
- }
-
- @Test
- public void testUpdated() throws ControlLoopException {
- mgr.start();
-
- // not the active operation - should be ignored
- mgr.updated(oper3);
- verify(workMem, never()).update(any(), any());
-
- VirtualControlLoopNotification notif;
-
- // check notification data
- when(oper1.getState()).thenReturn(State.LOCK_DENIED);
- mgr.updated(oper1);
- notif = mgr.getNotification();
- assertNotNull(notif.getHistory());
-
- /*
- * try the various cases
- */
- when(oper1.getState()).thenReturn(State.LOCK_DENIED);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.REJECTED, "The target my-target is already locked");
-
- when(oper1.getState()).thenReturn(State.LOCK_LOST);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION_FAILURE, "The target my-target is no longer locked");
-
- when(oper1.getState()).thenReturn(State.GUARD_STARTED);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION, "Sending guard query for First OperationA");
-
- when(oper1.getState()).thenReturn(State.GUARD_PERMITTED);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION, "Guard result for First OperationA is Permit");
-
- when(oper1.getState()).thenReturn(State.GUARD_DENIED);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION, "Guard result for First OperationA is Deny");
-
- when(oper1.getState()).thenReturn(State.OPERATION_STARTED);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION, "message-A");
-
- when(oper1.getState()).thenReturn(State.OPERATION_SUCCESS);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION_SUCCESS, "history-A");
-
- when(oper1.getState()).thenReturn(State.OPERATION_FAILURE);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.OPERATION_FAILURE, "history-A");
-
- // should still be active
- assertTrue(mgr.isActive());
-
- /*
- * control loop time
- */
- when(oper1.getState()).thenReturn(State.CONTROL_LOOP_TIMEOUT);
- mgr.updated(oper1);
- verifyNotification(ControlLoopNotificationType.FINAL_FAILURE, "Control Loop timed out");
-
- // should now be done
- assertFalse(mgr.isActive());
- }
-
- @Test
- public void testDestroy() {
- mgr.requestLock(LOCK1, callback1);
- mgr.requestLock(LOCK2, callback2);
- mgr.requestLock(LOCK1, callback3);
-
- mgr.destroy();
-
- freeLocks();
-
- for (LockImpl lock : locks) {
- assertTrue(lock.isUnavailable());
- }
- }
-
- /**
- * Tests destroy() once it has been started.
- */
- @Test
- public void testDestroyStarted() throws ControlLoopException {
- mgr.start();
-
- mgr.requestLock(LOCK1, callback1);
- mgr.requestLock(LOCK2, callback2);
- mgr.requestLock(LOCK1, callback3);
-
- mgr.destroy();
-
- freeLocks();
-
- // should have canceled the operation
- verify(oper1).cancel();
-
- for (LockImpl lock : locks) {
- assertTrue(lock.isUnavailable());
- }
- }
-
- @Test
- public void testMakeNotification() throws ControlLoopException {
- // before started
- assertNotNull(mgr.makeNotification());
-
- mgr.start();
-
- nextStep(oper1, true, OperationResult.SUCCESS);
- runRule();
-
- // check notification while running
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals("history-A", notif.getMessage());
-
- List<ControlLoopOperation> history = notif.getHistory();
- assertNotNull(history);
-
- nextStep(oper1, false, OperationResult.SUCCESS);
- runRule();
-
- assertFalse(mgr.isActive());
-
- // check notification when complete
- notif = mgr.getNotification();
- assertNull(notif.getMessage());
- assertEquals(history, notif.getHistory());
- }
-
- @Test
- public void testOnNewEvent() {
- VirtualControlLoopEvent event2 = new VirtualControlLoopEvent(event);
- assertEquals(NewEventStatus.FIRST_ONSET, mgr.onNewEvent(event2));
-
- event2.setPayload("other payload");
- assertEquals(NewEventStatus.SUBSEQUENT_ONSET, mgr.onNewEvent(event2));
- assertEquals(NewEventStatus.SUBSEQUENT_ONSET, mgr.onNewEvent(event2));
- assertEquals(NewEventStatus.FIRST_ONSET, mgr.onNewEvent(event));
-
- event2.setClosedLoopEventStatus(ControlLoopEventStatus.ABATED);
- assertEquals(NewEventStatus.FIRST_ABATEMENT, mgr.onNewEvent(event2));
-
- assertEquals(NewEventStatus.SUBSEQUENT_ABATEMENT, mgr.onNewEvent(event2));
- assertEquals(NewEventStatus.SUBSEQUENT_ABATEMENT, mgr.onNewEvent(event2));
-
- event2.setClosedLoopEventStatus(null);
- assertEquals(NewEventStatus.SYNTAX_ERROR, mgr.onNewEvent(event2));
- }
-
- @Test
- public void testDetmControlLoopTimeoutMs() throws Exception {
- verifyTimeout(1200 * 1000L);
- }
-
- private void verifyTimeout(long timeMs) {
- long end = mgr.getEndTimeMs();
- assertTrue(end >= preCreateTimeMs + timeMs);
- assertTrue(end < preCreateTimeMs + timeMs + 5000);
- }
-
- @Test
- public void testCheckEventSyntax() {
- // initially, it's valid
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setTarget("unknown-target");
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("target field invalid");
-
- event.setTarget(null);
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("No target field");
-
- // abated supersedes previous errors - so it shouldn't throw an exception
- event.setClosedLoopEventStatus(ControlLoopEventStatus.ABATED);
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setRequestId(null);
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("No request ID");
-
- event.setClosedLoopControlName(null);
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("No control loop name");
- }
-
- @Test
- public void testValidateStatus() {
- event.setClosedLoopEventStatus(ControlLoopEventStatus.ONSET);
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setClosedLoopEventStatus(ControlLoopEventStatus.ABATED);
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setClosedLoopEventStatus(null);
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("Invalid value in closedLoopEventStatus");
- }
-
- @Test
- public void testValidateAaiData() {
- event.setTargetType("unknown-target-type");
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("The target type is not supported");
-
- event.setTargetType(null);
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("The Target type is null");
-
- event.setAai(null);
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("AAI is null");
-
- // VM case
- event.setTargetType(ControlLoopTargetType.VM);
- event.setAai(Map.of(ControlLoopEventManager2.GENERIC_VNF_VNF_ID, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of());
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class);
-
- // VNF case
- event.setTargetType(ControlLoopTargetType.VNF);
- event.setAai(Map.of(ControlLoopEventManager2.GENERIC_VNF_VNF_ID, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of());
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class);
-
- // PNF case
- event.setTargetType(ControlLoopTargetType.PNF);
- event.setAai(Map.of(ControlLoopEventManager2.PNF_NAME, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of());
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class);
- }
-
- @Test
- public void testValidateAaiVmVnfData() {
- event.setTargetType(ControlLoopTargetType.VM);
- event.setAai(Map.of(ControlLoopEventManager2.GENERIC_VNF_VNF_ID, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of(ControlLoopEventManager2.VSERVER_VSERVER_NAME, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of(ControlLoopEventManager2.GENERIC_VNF_VNF_NAME, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of());
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class).hasMessage(
- "generic-vnf.vnf-id or generic-vnf.vnf-name or vserver.vserver-name information missing");
- }
-
- @Test
- public void testValidateAaiPnfData() {
- event.setTargetType(ControlLoopTargetType.PNF);
- event.setAai(Map.of(ControlLoopEventManager2.PNF_NAME, MY_TARGET));
- assertThatCode(() -> mgr.checkEventSyntax(event)).doesNotThrowAnyException();
-
- event.setAai(Map.of());
- assertThatCode(() -> mgr.checkEventSyntax(event)).isInstanceOf(ControlLoopException.class)
- .hasMessage("AAI PNF object key pnf-name is missing");
- }
-
- @Test
- public void testIsClosedLoopDisabled() {
- Map<String, String> orig = event.getAai();
-
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_IS_CLOSED_LOOP_DISABLED, "true"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(IllegalStateException.class);
-
- event.setAai(addAai(orig, ControlLoopEventManager2.GENERIC_VNF_IS_CLOSED_LOOP_DISABLED, "true"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(IllegalStateException.class);
-
- event.setAai(addAai(orig, ControlLoopEventManager2.PNF_IS_IN_MAINT, "true"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(IllegalStateException.class);
- }
-
- private Map<String, String> addAai(Map<String, String> original, String key, String value) {
- Map<String, String> map = new TreeMap<>(original);
- map.put(key, value);
- return map;
- }
-
- @Test
- public void testIsProvStatusInactive() {
- Map<String, String> orig = event.getAai();
-
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_PROV_STATUS, "ACTIVE"));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
-
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_PROV_STATUS, "inactive"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(IllegalStateException.class);
-
- event.setAai(addAai(orig, ControlLoopEventManager2.GENERIC_VNF_PROV_STATUS, "ACTIVE"));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
- event.setAai(addAai(orig, ControlLoopEventManager2.GENERIC_VNF_PROV_STATUS, "inactive"));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(IllegalStateException.class);
- }
-
- @Test
- public void testIsAaiTrue() {
- Map<String, String> orig = event.getAai();
-
- for (String value : Arrays.asList("yes", "y", "true", "t", "yEs", "trUe")) {
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_IS_CLOSED_LOOP_DISABLED, value));
- assertThatThrownBy(() -> new ControlLoopEventManager2Drools(params, event, workMem))
- .isInstanceOf(IllegalStateException.class);
- }
-
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_IS_CLOSED_LOOP_DISABLED, "false"));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
-
- event.setAai(addAai(orig, ControlLoopEventManager2.VSERVER_IS_CLOSED_LOOP_DISABLED, "no"));
- assertThatCode(() -> new ControlLoopEventManager2Drools(params, event, workMem)).doesNotThrowAnyException();
- }
-
- @Test
- public void testRequestLock() {
- final CompletableFuture<OperationOutcome> future1 = mgr.requestLock(LOCK1, callback1);
- final CompletableFuture<OperationOutcome> future2 = mgr.requestLock(LOCK2, callback2);
- assertSame(future1, mgr.requestLock(LOCK1, callback3));
-
- assertEquals(2, locks.size());
-
- assertTrue(future1.isDone());
- assertTrue(future2.isDone());
-
- verify(callback1, never()).accept(any());
- verify(callback2, never()).accept(any());
- verify(callback3, never()).accept(any());
-
- // indicate that the first lock failed
- locks.get(0).notifyUnavailable();
-
- verify(callback1).accept(any());
- verify(callback2, never()).accept(any());
- verify(callback3).accept(any());
- }
-
- @Test
- public void testMakeOperationManager() throws ControlLoopException {
- // use a manager that creates real operation managers
- mgr = new MyManager(params, event, workMem);
-
- assertThatCode(() -> mgr.start()).doesNotThrowAnyException();
- }
-
- @Test
- public void testGetBlockingExecutor() throws Exception {
- mgr = new ControlLoopEventManager2Drools(params, event, workMem);
- assertThatCode(() -> mgr.getBlockingExecutor()).doesNotThrowAnyException();
- }
-
- @Test
- public void testToString() {
- assertNotNull(mgr.toString());
- }
-
-
- private void nextStep(ControlLoopOperationManager2 oper, boolean moreSteps, OperationResult result) {
- when(oper.nextStep()).thenReturn(moreSteps);
- when(oper.getOperationResult()).thenReturn(result);
-
- if (result == OperationResult.SUCCESS) {
- when(oper.getState()).thenReturn(State.OPERATION_SUCCESS);
- } else {
- when(oper.getState()).thenReturn(State.OPERATION_FAILURE);
- }
-
- mgr.updated(oper);
-
- updateCount++;
-
- verify(workMem, times(updateCount)).update(factHandle, mgr);
- }
-
- private void runRule() {
- assertTrue(mgr.isActive());
- mgr.nextStep();
- }
-
- private void runOperation(OperationResult finalResult) throws ControlLoopException {
- mgr.start();
- verify(oper1).start(anyLong());
-
- assertTrue(mgr.isActive());
-
- nextStep(oper1, true, OperationResult.SUCCESS);
- runRule();
-
- nextStep(oper1, false, finalResult);
- runRule();
-
- assertFalse(mgr.isActive());
-
- // should have no effect, because it's done
- mgr.updated(oper1);
- verify(workMem, times(updateCount)).update(any(), any());
- }
-
- private void verifyNotification(ControlLoopNotificationType expectedType, String expectedMsg) {
- VirtualControlLoopNotification notif = mgr.getNotification();
- assertEquals(expectedType, notif.getNotification());
- assertEquals(expectedMsg, notif.getMessage());
- }
-
- private List<ControlLoopOperation> makeHistory(String message) {
- ControlLoopOperation clo = new ControlLoopOperation();
- clo.setMessage("history-" + message);
-
- return List.of(clo);
- }
-
- private void loadPolicy(String fileName) throws CoderException {
- ToscaServiceTemplate template =
- yamlCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
- tosca = template.getToscaTopologyTemplate().getPolicies().get(0).values().iterator().next();
-
- params.setToscaPolicy(tosca);
- }
-
- private void freeLocks() {
- ArgumentCaptor<Runnable> runCaptor = ArgumentCaptor.forClass(Runnable.class);
- verify(executor).execute(runCaptor.capture());
-
- runCaptor.getValue().run();
- }
-
-
- private class MyManager extends ControlLoopEventManager2Drools {
- private static final long serialVersionUID = 1L;
-
- public MyManager(ControlLoopParams params, VirtualControlLoopEvent event, WorkingMemory workMem)
- throws ControlLoopException {
-
- super(params, event, workMem);
- }
-
- @Override
- protected ExecutorService getBlockingExecutor() {
- return executor;
- }
-
- @Override
- protected void makeLock(String targetEntity, String requestId, int holdSec, LockCallback callback) {
- LockImpl lock = new LockImpl(LockState.ACTIVE, targetEntity, requestId, holdSec, callback);
- locks.add(lock);
- callback.lockAvailable(lock);
- }
-
- @Override
- public ActorService getActorService() {
- return actors;
- }
-
- @Override
- public OperationHistoryDataManager getDataManager() {
- return dataMgr;
- }
- }
-
-
- private class MyManagerWithOper extends MyManager {
- private static final long serialVersionUID = 1L;
-
- public MyManagerWithOper(ControlLoopParams params, VirtualControlLoopEvent event, WorkingMemory workMem)
- throws ControlLoopException {
-
- super(params, event, workMem);
- }
-
- @Override
- protected ControlLoopOperationManager2 makeOperationManager(ControlLoopEventContext ctx, Operation policy) {
- switch (policy.getActorOperation().getActor()) {
- case "First":
- return oper1;
- case "Second":
- return oper2;
- case "Third":
- return oper3;
- default:
- throw new IllegalArgumentException("unknown policy actor " + policy.getActorOperation().getActor());
- }
- }
- }
-}
diff --git a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2Test.java b/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2Test.java
deleted file mode 100644
index 0b066651b..000000000
--- a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/ControlLoopOperationManager2Test.java
+++ /dev/null
@@ -1,1037 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * ONAP
- * ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.onap.policy.controlloop.eventmanager;
-
-import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
-import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertSame;
-import static org.junit.Assert.assertTrue;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.Mockito.doAnswer;
-import static org.mockito.Mockito.never;
-import static org.mockito.Mockito.times;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
-
-import java.time.Instant;
-import java.util.Map;
-import java.util.TreeMap;
-import java.util.UUID;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.CountDownLatch;
-import java.util.concurrent.TimeUnit;
-import java.util.function.Consumer;
-import org.junit.Before;
-import org.junit.Test;
-import org.mockito.ArgumentCaptor;
-import org.mockito.Captor;
-import org.mockito.Mock;
-import org.mockito.MockitoAnnotations;
-import org.onap.aai.domain.yang.GenericVnf;
-import org.onap.policy.aai.AaiCqResponse;
-import org.onap.policy.common.utils.time.PseudoExecutor;
-import org.onap.policy.controlloop.ControlLoopOperation;
-import org.onap.policy.controlloop.ControlLoopResponse;
-import org.onap.policy.controlloop.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.actor.guard.DecisionOperation;
-import org.onap.policy.controlloop.actor.guard.GuardActor;
-import org.onap.policy.controlloop.actorserviceprovider.ActorService;
-import org.onap.policy.controlloop.actorserviceprovider.Operation;
-import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
-import org.onap.policy.controlloop.actorserviceprovider.Operator;
-import org.onap.policy.controlloop.actorserviceprovider.TargetType;
-import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
-import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
-import org.onap.policy.controlloop.ophistory.OperationHistoryDataManager;
-import org.onap.policy.drools.domain.models.operational.ActorOperation;
-import org.onap.policy.drools.domain.models.operational.OperationalTarget;
-import org.onap.policy.sdnr.PciBody;
-import org.onap.policy.sdnr.PciMessage;
-import org.onap.policy.sdnr.PciResponse;
-
-public class ControlLoopOperationManager2Test {
- private static final UUID REQ_ID = UUID.randomUUID();
- private static final String MISMATCH = "mismatch";
- private static final String POLICY_ID = "my-policy";
- private static final String POLICY_ACTOR = "my-actor";
- private static final String POLICY_OPERATION = "my-operation";
- private static final String OTHER_ACTOR = "another-actor";
- private static final String MY_TARGET = "my-target";
- private static final String MY_VNF_ID = "my-vnf-id";
- private static final String PAYLOAD_KEY = "payload-key";
- private static final String PAYLOAD_VALUE = "payload-value";
- private static final long REMAINING_MS = 5000;
- private static final int MAX_RUN = 100;
- private static final Integer POLICY_RETRY = 3;
- private static final Integer POLICY_TIMEOUT = 20;
- private static final IllegalArgumentException EXPECTED_EXCEPTION =
- new IllegalArgumentException("expected exception");
-
- @Captor
- private ArgumentCaptor<Consumer<OperationOutcome>> lockCallback;
-
- @Mock
- private OperationHistoryDataManager dataMgr;
- @Mock
- private ManagerContext mgrctx;
- @Mock
- private Operator policyOperator;
- @Mock
- private Operation policyOperation;
- @Mock
- private Actor policyActor;
- @Mock
- private ActorService actors;
- @Mock
- private AaiCqResponse cqdata;
- @Mock
- private GenericVnf vnf;
-
- private CompletableFuture<OperationOutcome> lockFuture;
- private CompletableFuture<OperationOutcome> policyFuture;
- private ActorOperation operation;
- private OperationalTarget target;
- private Map<String, String> entityIds;
- private Map<String, String> payload;
- private org.onap.policy.drools.domain.models.operational.Operation policy;
- private VirtualControlLoopEvent event;
- private ControlLoopEventContext context;
- private PseudoExecutor executor;
- private ControlLoopOperationManager2 mgr;
-
- /**
- * Sets up.
- */
- @Before
- public void setUp() {
- MockitoAnnotations.initMocks(this);
-
- lockFuture = new CompletableFuture<>();
- policyFuture = new CompletableFuture<>();
-
- when(mgrctx.getActorService()).thenReturn(actors);
- when(mgrctx.getDataManager()).thenReturn(dataMgr);
- when(mgrctx.requestLock(any(), any())).thenReturn(lockFuture);
-
- // configure policy operation
- when(actors.getActor(POLICY_ACTOR)).thenReturn(policyActor);
- when(policyActor.getOperator(POLICY_OPERATION)).thenReturn(policyOperator);
- when(policyOperator.buildOperation(any())).thenReturn(policyOperation);
- when(policyOperation.start()).thenReturn(policyFuture);
-
- when(vnf.getVnfId()).thenReturn(MY_VNF_ID);
- when(cqdata.getDefaultGenericVnf()).thenReturn(vnf);
-
- entityIds = Map.of("entity-name-A", "entity-value-A");
-
- target = OperationalTarget.builder()
- .targetType(TargetType.VM.toString())
- .entityIds(entityIds)
- .build();
-
- payload = Map.of(PAYLOAD_KEY, PAYLOAD_VALUE);
-
- operation = ActorOperation.builder()
- .actor(POLICY_ACTOR)
- .operation(POLICY_OPERATION)
- .payload(payload)
- .target(target)
- .build();
-
- policy = org.onap.policy.drools.domain.models.operational.Operation.builder()
- .id(POLICY_ID)
- .actorOperation(operation)
- .retries(POLICY_RETRY)
- .timeout(POLICY_TIMEOUT)
- .build();
-
- event = new VirtualControlLoopEvent();
- event.setRequestId(REQ_ID);
- event.setTarget(ControlLoopOperationManager2.VSERVER_VSERVER_NAME);
- event.setAai(new TreeMap<>(Map.of(ControlLoopOperationManager2.VSERVER_VSERVER_NAME, MY_TARGET)));
-
- context = new ControlLoopEventContext(event);
- context.setProperty(AaiCqResponse.CONTEXT_KEY, cqdata);
-
- executor = new PseudoExecutor();
-
- mgr = new ControlLoopOperationManager2(mgrctx, context, policy, executor);
- }
-
- @Test
- public void testStart() {
- mgr.start(REMAINING_MS);
-
- // should have determined the target entity by now
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- verify(mgrctx).requestLock(eq(MY_TARGET), any());
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- policyFuture.complete(genOpOutcome());
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_SUCCESS, mgr.getState());
-
- assertFalse(mgr.nextStep());
-
- OperationOutcome outcome = mgr.getOutcomes().peek();
- assertEquals(OperationResult.SUCCESS, outcome.getResult());
- assertTrue(outcome.isFinalOutcome());
-
- verify(mgrctx, times(4)).updated(mgr);
- }
-
- /**
- * Tests start() when detmTarget() (i.e., the first task) throws an exception.
- */
- @Test
- public void testStartDetmTargetException() {
- operation.setTarget(OperationalTarget.builder().build());
- mgr = new ControlLoopOperationManager2(mgrctx, context, policy, executor);
- mgr.start(REMAINING_MS);
-
- runToCompletion();
-
- assertFalse(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_FAILURE, mgr.getState());
-
- // should have called update() for operation-start, but not for any nextStep()
- verify(mgrctx).updated(mgr);
- }
-
- /**
- * Tests start() when a subsequent task throws an exception.
- */
- @Test
- public void testStartException() {
- when(policyOperation.start()).thenThrow(EXPECTED_EXCEPTION);
-
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- runToCompletion();
-
- assertFalse(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_FAILURE, mgr.getState());
-
- // should have called update() for operation-start, but not for any nextStep()
- verify(mgrctx).updated(mgr);
- }
-
- /**
- * Tests start() when the control loop times out before the operation starts.
- */
- @Test
- public void testStartClTimeout_testHandleTimeout() throws InterruptedException {
- // catch the callback when it times out
- CountDownLatch updatedLatch = new CountDownLatch(1);
- doAnswer(args -> {
- updatedLatch.countDown();
- return null;
- }).when(mgrctx).updated(any());
-
- long tstart = System.currentTimeMillis();
-
- // give it a short timeout
- mgr.start(100);
-
- assertTrue(updatedLatch.await(5, TimeUnit.SECONDS));
- assertTrue(System.currentTimeMillis() - tstart >= 100);
-
- // don't generate any responses
- runToCompletion();
-
- // wait for the future to be canceled, via a background thread
- CountDownLatch futureLatch = new CountDownLatch(1);
- mgr.getFuture().whenComplete((unused, thrown) -> futureLatch.countDown());
- assertTrue(futureLatch.await(5, TimeUnit.SECONDS));
-
- // lock should have been canceled
- assertTrue(mgr.getFuture().isCancelled());
-
- assertFalse(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.CONTROL_LOOP_TIMEOUT, mgr.getState());
-
- // should have called update() for operation-start, but not for any nextStep()
- verify(mgrctx).updated(mgr);
-
- // should have added a record to the DB
- verify(dataMgr).store(any(), any(), any(), any());
- }
-
- @Test
- public void testStartOperation() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- runToCompletion();
-
- verify(policyOperation).start();
-
- ArgumentCaptor<ControlLoopOperationParams> captor = ArgumentCaptor.forClass(ControlLoopOperationParams.class);
- verify(policyOperator).buildOperation(captor.capture());
-
- ControlLoopOperationParams params = captor.getValue();
-
- assertNotNull(params);
- assertEquals(POLICY_ACTOR, params.getActor());
- assertSame(actors, params.getActorService());
- assertNotNull(params.getCompleteCallback());
- assertSame(context, params.getContext());
- assertSame(executor, params.getExecutor());
- assertEquals(POLICY_OPERATION, params.getOperation());
- assertEquals(payload, params.getPayload());
- assertSame(REQ_ID, params.getRequestId());
- assertSame(POLICY_RETRY, params.getRetry());
- assertNotNull(params.getStartCallback());
- assertEquals(target.getTargetType().toString(), params.getTargetType().toString());
- assertSame(entityIds, params.getTargetEntityIds());
- assertEquals(MY_TARGET, params.getTargetEntity());
- assertSame(POLICY_TIMEOUT, params.getTimeoutSec());
- }
-
- @Test
- public void testStartOperationNullPayload() {
- operation.setPayload(null);
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- runToCompletion();
-
- verify(policyOperation).start();
-
- ArgumentCaptor<ControlLoopOperationParams> captor = ArgumentCaptor.forClass(ControlLoopOperationParams.class);
- verify(policyOperator).buildOperation(captor.capture());
-
- ControlLoopOperationParams params = captor.getValue();
-
- assertNotNull(params);
- assertEquals(POLICY_ACTOR, params.getActor());
- assertSame(actors, params.getActorService());
- assertNotNull(params.getCompleteCallback());
- assertSame(context, params.getContext());
- assertSame(executor, params.getExecutor());
- assertEquals(POLICY_OPERATION, params.getOperation());
- assertTrue(params.getPayload().isEmpty());
- assertSame(REQ_ID, params.getRequestId());
- assertSame(POLICY_RETRY, params.getRetry());
- assertNotNull(params.getStartCallback());
- assertEquals(target.getTargetType().toString(), params.getTargetType().toString());
- assertSame(entityIds, params.getTargetEntityIds());
- assertEquals(MY_TARGET, params.getTargetEntity());
- assertSame(POLICY_TIMEOUT, params.getTimeoutSec());
- }
-
- @Test
- public void testMakeControlLoopResponse() {
- final OperationOutcome outcome = new OperationOutcome();
- PciMessage msg = new PciMessage();
- outcome.setResponse(msg);
-
- PciBody body = new PciBody();
- msg.setBody(body);
-
- PciResponse output = new PciResponse();
- body.setOutput(output);
-
- output.setPayload("my-payload");
-
-
- // not an SDNR action - should return null
- assertNull(mgr.makeControlLoopResponse(outcome));
-
- /*
- * now work with SDNR actor
- */
- operation.setActor("SDNR");
- mgr = new ControlLoopOperationManager2(mgrctx, context, policy, executor);
-
- // should return null for a null input
- assertNull(mgr.makeControlLoopResponse(null));
-
- // should generate a response, with a payload
- checkResp(outcome, "my-payload");
-
- /*
- * these should generate a response, with null payload
- */
- output.setPayload(null);
- checkResp(outcome, null);
-
- body.setOutput(null);
- checkResp(outcome, null);
-
- msg.setBody(null);
- checkResp(outcome, null);
-
- outcome.setResponse(null);
- checkResp(outcome, null);
- }
-
- @Test
- public void testGetOperationMessage() {
- // no history yet
- assertNull(mgr.getOperationMessage());
-
- runCyle();
- assertThat(mgr.getOperationMessage()).contains("actor=my-actor").contains("operation=my-operation");
- }
-
- @Test
- public void testGetOperationResult() {
- // no history yet
- assertNotNull(mgr.getOperationResult());
-
- runCyle();
- assertEquals(OperationResult.SUCCESS, mgr.getOperationResult());
- }
-
- /**
- * Tests getOperationResult() when it ends in a failure.
- */
- @Test
- public void testGetOperationResultFailure() {
- mgr.start(REMAINING_MS);
-
- genLockFailure();
- runToCompletion();
-
- assertEquals(OperationResult.FAILURE_GUARD, mgr.getOperationResult());
- }
-
- /**
- * Tests handleException() when the exception is a "cancel".
- */
- @Test
- public void testHandleExceptionCanceled() {
- lockFuture.cancel(false);
-
- mgr.start(REMAINING_MS);
-
- runToCompletion();
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.ACTIVE, mgr.getState());
- }
-
- @Test
- public void testCancel() {
- mgr.start(REMAINING_MS);
-
- mgr.cancel();
- assertTrue(mgr.getFuture().isCancelled());
- }
-
- /**
- * Tests cancel() when the operation hasn't been started.
- */
- @Test
- public void testCancelNotStarted() {
- assertNull(mgr.getFuture());
-
- mgr.cancel();
- assertNull(mgr.getFuture());
- }
-
- @Test
- public void testLockUnavailable() {
- mgr.start(REMAINING_MS);
-
- runToCompletion();
-
- // lock failure outcome
- final OperationOutcome outcome = genLockFailure();
-
- runToCompletion();
-
- assertFalse(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.LOCK_DENIED, mgr.getState());
-
- assertEquals(outcome, mgr.getOutcomes().peek());
-
- // should have called update() for operation-start, but not for any nextStep()
- verify(mgrctx).updated(mgr);
- }
-
- /**
- * Tests onStart() and onComplete() with other actors.
- */
- @Test
- public void testOnStart_testOnComplete() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
-
- // generate failure outcome for ANOTHER actor - should be ignored
- OperationOutcome outcome = mgr.getParams().makeOutcome();
- outcome.setActor(OTHER_ACTOR);
- outcome.setResult(OperationResult.FAILURE);
- outcome.setStart(Instant.now());
- mgr.getParams().callbackStarted(new OperationOutcome(outcome));
-
- outcome.setEnd(Instant.now());
- mgr.getParams().callbackCompleted(outcome);
-
- policyFuture.complete(genOpOutcome());
- runToCompletion();
-
- // should not include the other actor's outcome
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_SUCCESS, mgr.getState());
-
- assertFalse(mgr.nextStep());
-
- assertEquals(OperationResult.SUCCESS, mgr.getOutcomes().peek().getResult());
-
- verify(mgrctx, times(4)).updated(mgr);
- }
-
- @Test
- public void testNextStep() {
- mgr.start(REMAINING_MS);
-
- // only do the lock and the guard
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertTrue(mgr.nextStep());
-
- verify(mgrctx, times(2)).updated(mgr);
- }
-
- /**
- * Tests processOutcome() when the lock is denied.
- */
- @Test
- public void testProcessOutcomeLockDenied() {
- mgr.start(REMAINING_MS);
-
- // unavailable from the start => "denied"
- genLockFailure();
-
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.LOCK_DENIED, mgr.getState());
-
- assertFalse(mgr.nextStep());
- verify(mgrctx).updated(mgr);
-
- verifyDb(1, OperationResult.FAILURE_GUARD, "Operation denied by Lock");
- }
-
- /**
- * Tests processOutcome() when the lock is lost.
- */
- @Test
- public void testProcessOutcomeLockLost() {
- mgr.start(REMAINING_MS);
-
- // indicate lock success initially
- lockFuture.complete(new OperationOutcome());
-
- // do the guard
- genGuardOutcome();
-
- // now generate a lock failure => "lost"
- genLockFailure();
-
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.LOCK_LOST, mgr.getState());
-
- assertFalse(mgr.nextStep());
- verify(mgrctx, times(3)).updated(mgr);
-
- verifyDb(1, OperationResult.FAILURE, "Operation aborted by Lock");
- }
-
- /**
- * Tests processOutcome() when the guard is permitted.
- */
- @Test
- public void testProcessOutcomeGuardPermit() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
-
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- verify(mgrctx, times(2)).updated(mgr);
-
- verify(dataMgr, never()).store(any(), any(), any(), any());
- }
-
- /**
- * Tests processOutcome() when the guard is permitted.
- */
- @Test
- public void testProcessOutcomeGuardDenied() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome(false);
-
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_DENIED, mgr.getState());
-
- assertFalse(mgr.nextStep());
- verify(mgrctx, times(2)).updated(mgr);
-
- verifyDb(1, OperationResult.FAILURE_GUARD, "Operation denied by Guard");
- }
-
- /**
- * Tests processOutcome() when the operation is a success.
- */
- @Test
- public void testProcessOutcomeOperSuccess() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- genOpOutcome();
-
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_SUCCESS, mgr.getState());
-
- assertFalse(mgr.nextStep());
- verify(mgrctx, times(4)).updated(mgr);
-
- verifyDb(2, OperationResult.SUCCESS, null);
- }
-
- /**
- * Tests processOutcome() when the operation is a failure.
- */
- @Test
- public void testProcessOutcomeOperFailure() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- genOpOutcome(false);
-
- runToCompletion();
-
- assertEquals(ControlLoopOperationManager2.State.GUARD_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.GUARD_PERMITTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_FAILURE, mgr.getState());
- verifyDb(2, OperationResult.FAILURE, null);
-
- assertThat(mgr.toString()).contains("attempts=1");
-
- // next failure
- genOpOutcome(false);
- runToCompletion();
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_FAILURE, mgr.getState());
- verifyDb(4, OperationResult.FAILURE, null);
-
- assertThat(mgr.toString()).contains("attempts=2");
-
- // and finally a success
- genOpOutcome();
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_STARTED, mgr.getState());
-
- assertTrue(mgr.nextStep());
- assertEquals(ControlLoopOperationManager2.State.OPERATION_SUCCESS, mgr.getState());
- verifyDb(6, OperationResult.SUCCESS, null);
-
- assertThat(mgr.toString()).contains("attempts=3");
-
- assertFalse(mgr.nextStep());
- verify(mgrctx, times(8)).updated(mgr);
- }
-
- @Test
- public void testGetOperationHistory() {
- // no history yet
- assertNull(mgr.getOperationHistory());
-
- runCyle();
- assertThat(mgr.getOperationHistory()).contains("actor=my-actor").contains("operation=my-operation")
- .contains("outcome=Success");
- }
-
- @Test
- public void testGetHistory() {
- // no history yet
- assertEquals(0, mgr.getHistory().size());
-
- runCyle();
- assertEquals(1, mgr.getHistory().size());
- }
-
- @Test
- public void testDetmTargetVm() {
- target.setTargetType(TargetType.VM.toString());
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- target.setTargetType(TargetType.VNF.toString());
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- target.setTargetType(TargetType.VFMODULE.toString());
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- // unsupported type
- target.setTargetType(TargetType.VFC.toString());
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget())
- .withMessage("The target type is not supported");
-
- // null type
- target.setTargetType(null);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget()).withMessage("The target type is null");
-
- // null target
- operation.setTarget(null);
- mgr = new ControlLoopOperationManager2(mgrctx, context, policy, executor);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget()).withMessage("The target is null");
- }
-
- @Test
- public void testDetmPnfTarget() {
- setTargetPnf();
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- // missing enrichment data
- event.getAai().clear();
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget())
- .withMessage("AAI section is missing " + ControlLoopOperationManager2.PNF_NAME);
-
- // wrong target
- event.setTarget(MISMATCH);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget())
- .withMessage("Target does not match target type");
- }
-
- @Test
- public void testDetmVfModuleTarget() {
- // vserver
- event.setTarget(ControlLoopOperationManager2.VSERVER_VSERVER_NAME);
- event.getAai().clear();
- event.getAai().putAll(Map.of(ControlLoopOperationManager2.VSERVER_VSERVER_NAME, MY_TARGET));
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- // vnf-id
- event.setTarget(ControlLoopOperationManager2.GENERIC_VNF_VNF_ID);
- event.getAai().clear();
- event.getAai().putAll(Map.of(ControlLoopOperationManager2.GENERIC_VNF_VNF_ID, MY_TARGET));
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- // wrong type
- event.setTarget(MISMATCH);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget())
- .withMessage("Target does not match target type");
-
- // missing enrichment data
- event.setTarget(ControlLoopOperationManager2.VSERVER_VSERVER_NAME);
- event.getAai().clear();
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget())
- .withMessage("Enrichment data is missing " + ControlLoopOperationManager2.VSERVER_VSERVER_NAME);
-
- // null target
- event.setTarget(null);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget()).withMessage("Target is null");
- }
-
- @Test
- public void testDetmVnfName() {
- setTargetVnfName();
- assertNull(mgr.detmTarget());
- assertEquals(MY_TARGET, mgr.getTargetEntity());
-
- // force it to be gotten from the CQ data
- event.getAai().clear();
- assertNull(mgr.detmTarget());
- assertEquals(MY_VNF_ID, mgr.getTargetEntity());
- }
-
- @Test
- public void testExtractVnfFromCq() {
- // force it to be gotten from the CQ data
- setTargetVnfName();
- event.getAai().clear();
-
- // missing vnf id in CQ data
- when(vnf.getVnfId()).thenReturn(null);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget()).withMessage("No vnf-id found");
-
- // missing default vnf in CQ data
- when(cqdata.getDefaultGenericVnf()).thenReturn(null);
- assertThatIllegalArgumentException().isThrownBy(() -> mgr.detmTarget()).withMessage("No vnf-id found");
- }
-
- @Test
- public void testGetState_testGetActor_testGetOperation() {
- assertEquals(ControlLoopOperationManager2.State.ACTIVE, mgr.getState());
- assertEquals(POLICY_ACTOR, mgr.getActor());
- assertEquals(POLICY_OPERATION, mgr.getOperation());
- }
-
- @Test
- public void testToString() {
- assertThat(mgr.toString()).contains("state").contains("requestId").contains("policyId").contains("attempts");
- }
-
- /**
- * Runs a cycle, from start to completion.
- */
- private void runCyle() {
- mgr.start(REMAINING_MS);
-
- lockFuture.complete(new OperationOutcome());
- genGuardOutcome();
- genOpOutcome();
-
- runToCompletion();
-
- // guard start
- assertTrue(mgr.nextStep());
-
- // guard permit
- assertTrue(mgr.nextStep());
-
- // operation start
- assertTrue(mgr.nextStep());
-
- // operation success
- assertFalse(mgr.nextStep());
- }
-
- /**
- * Runs everything until the executor queue is empty.
- */
- private void runToCompletion() {
- assertTrue(executor.runAll(MAX_RUN));
- }
-
- /**
- * Generates a failure outcome for the lock, and invokes the callbacks.
- *
- * @return the generated outcome
- */
- private OperationOutcome genLockFailure() {
- OperationOutcome outcome = new OperationOutcome();
- outcome.setActor(ControlLoopOperationManager2.LOCK_ACTOR);
- outcome.setOperation(ControlLoopOperationManager2.LOCK_OPERATION);
- outcome.setResult(OperationResult.FAILURE);
- outcome.setStart(Instant.now());
- outcome.setEnd(Instant.now());
- outcome.setFinalOutcome(true);
-
- verify(mgrctx).requestLock(eq(MY_TARGET), lockCallback.capture());
- lockCallback.getValue().accept(outcome);
-
- lockFuture.complete(outcome);
-
- return outcome;
- }
-
- /**
- * Generates an outcome for the guard, and invokes the callbacks.
- *
- * @return the generated outcome
- */
- private OperationOutcome genGuardOutcome() {
- return genGuardOutcome(true);
- }
-
- /**
- * Generates an outcome for the guard, and invokes the callbacks.
- *
- * @param permit {@code true} if the guard should be permitted, {@code false} if
- * denied
- * @return the generated outcome
- */
- private OperationOutcome genGuardOutcome(boolean permit) {
- OperationOutcome outcome = mgr.getParams().makeOutcome();
- outcome.setActor(GuardActor.NAME);
- outcome.setOperation(DecisionOperation.NAME);
- outcome.setStart(Instant.now());
- mgr.getParams().callbackStarted(new OperationOutcome(outcome));
-
- if (!permit) {
- outcome.setResult(OperationResult.FAILURE);
- }
-
- outcome.setEnd(Instant.now());
- mgr.getParams().callbackCompleted(outcome);
-
- return outcome;
- }
-
- /**
- * Generates an outcome for the operation, itself, and invokes the callbacks.
- *
- * @return the generated outcome
- */
- private OperationOutcome genOpOutcome() {
- return genOpOutcome(true);
- }
-
- /**
- * Generates an outcome for the operation, itself, and invokes the callbacks.
- *
- * @param success {@code true} if the outcome should be a success, {@code false} if a
- * failure
- * @return the generated outcome
- */
- private OperationOutcome genOpOutcome(boolean success) {
- OperationOutcome outcome = mgr.getParams().makeOutcome();
- outcome.setStart(Instant.now());
- mgr.getParams().callbackStarted(new OperationOutcome(outcome));
-
- if (success) {
- outcome.setFinalOutcome(true);
- } else {
- outcome.setResult(OperationResult.FAILURE);
- }
-
- outcome.setEnd(Instant.now());
- mgr.getParams().callbackCompleted(outcome);
-
- return outcome;
- }
-
- /**
- * Configures the data for a PNF target.
- */
- private void setTargetPnf() {
- event.setTarget(ControlLoopOperationManager2.PNF_NAME);
- event.getAai().clear();
- event.getAai().putAll(Map.of(ControlLoopOperationManager2.PNF_NAME, MY_TARGET));
-
- target.setTargetType(TargetType.PNF.toString());
- }
-
- /**
- * Configures the data for a VNF-NAME target.
- */
- private void setTargetVnfName() {
- event.setTarget(ControlLoopOperationManager2.GENERIC_VNF_VNF_NAME);
- event.getAai().clear();
- event.getAai().putAll(Map.of(ControlLoopOperationManager2.GENERIC_VNF_VNF_ID, MY_TARGET));
-
- target.setTargetType(TargetType.VNF.toString());
- }
-
- private void checkResp(OperationOutcome outcome, String expectedPayload) {
- ControlLoopResponse resp = mgr.makeControlLoopResponse(outcome);
- assertNotNull(resp);
- assertEquals(REQ_ID, resp.getRequestId());
- assertEquals(expectedPayload, resp.getPayload());
- }
-
- private void verifyDb(int nrecords, OperationResult expectedResult, String expectedMsg) {
- ArgumentCaptor<String> entityCaptor = ArgumentCaptor.forClass(String.class);
- ArgumentCaptor<ControlLoopOperation> opCaptor = ArgumentCaptor.forClass(ControlLoopOperation.class);
- verify(dataMgr, times(nrecords)).store(any(), any(), entityCaptor.capture(), opCaptor.capture());
-
- assertEquals(MY_TARGET, entityCaptor.getValue());
-
- ControlLoopOperation oper = opCaptor.getValue();
-
- assertEquals(expectedResult.toString(), oper.getOutcome());
- assertEquals(expectedMsg, oper.getMessage());
- }
-}
diff --git a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/LockDataTest.java b/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/LockDataTest.java
index 98ff04da5..164dfb4d1 100644
--- a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/LockDataTest.java
+++ b/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/LockDataTest.java
@@ -132,8 +132,8 @@ public class LockDataTest {
assertTrue(future.isDone());
OperationOutcome outcome = future.get();
- assertEquals(ControlLoopOperationManager2.LOCK_ACTOR, outcome.getActor());
- assertEquals(ControlLoopOperationManager2.LOCK_OPERATION, outcome.getOperation());
+ assertEquals(ActorConstants.LOCK_ACTOR, outcome.getActor());
+ assertEquals(ActorConstants.LOCK_OPERATION, outcome.getOperation());
assertEquals(ENTITY, outcome.getTarget());
assertEquals(OperationResult.SUCCESS, outcome.getResult());
assertEquals(ControlLoopOperation.SUCCESS_MSG, outcome.getMessage());
@@ -173,8 +173,8 @@ public class LockDataTest {
assertTrue(future2.isDone());
assertSame(outcome, future2.get());
- assertEquals(ControlLoopOperationManager2.LOCK_ACTOR, outcome.getActor());
- assertEquals(ControlLoopOperationManager2.LOCK_OPERATION, outcome.getOperation());
+ assertEquals(ActorConstants.LOCK_ACTOR, outcome.getActor());
+ assertEquals(ActorConstants.LOCK_OPERATION, outcome.getOperation());
assertEquals(ENTITY, outcome.getTarget());
assertEquals(OperationResult.FAILURE, outcome.getResult());
assertEquals(ControlLoopOperation.FAILED_MSG, outcome.getMessage());
diff --git a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/StepTest.java b/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/StepTest.java
index efcc6101a..aec4693f8 100644
--- a/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/StepTest.java
+++ b/controlloop/common/eventmanager/src/test/java/org/onap/policy/controlloop/eventmanager/StepTest.java
@@ -55,7 +55,6 @@ import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.Operator;
import org.onap.policy.controlloop.actorserviceprovider.TargetType;
-import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.spi.Actor;
import org.onap.policy.drools.domain.models.operational.OperationalTarget;
@@ -84,7 +83,6 @@ public class StepTest {
private Map<String, String> entityIds;
private Map<String, String> payload;
private VirtualControlLoopEvent event;
- private ControlLoopEventContext context;
private BlockingQueue<OperationOutcome> starts;
private BlockingQueue<OperationOutcome> completions;
private ControlLoopOperationParams params;
@@ -117,19 +115,15 @@ public class StepTest {
event = new VirtualControlLoopEvent();
event.setRequestId(REQ_ID);
- event.setTarget(ControlLoopOperationManager2.VSERVER_VSERVER_NAME);
- event.setAai(new TreeMap<>(Map.of(ControlLoopOperationManager2.VSERVER_VSERVER_NAME, MY_TARGET)));
-
- context = new ControlLoopEventContext(event);
starts = new LinkedBlockingQueue<>();
completions = new LinkedBlockingQueue<>();
params = ControlLoopOperationParams.builder().actor(POLICY_ACTOR).actorService(actors)
- .completeCallback(completions::add).context(context).executor(ForkJoinPool.commonPool())
+ .completeCallback(completions::add).executor(ForkJoinPool.commonPool())
.operation(POLICY_OPERATION).payload(new TreeMap<>(payload)).startCallback(starts::add)
.targetType(TargetType.valueOf(target.getTargetType())).targetEntityIds(target.getEntityIds())
- .targetEntity(MY_TARGET).build();
+ .requestId(REQ_ID).targetEntity(MY_TARGET).build();
startTime = new AtomicReference<>();