Do additional processing when control loop times out

When the overall control loop times out, a notification is sent to
POLICY-CL-MGT, but then the event is discarded.  Modified the code
to update the operation history, if an operation had been started,
and to generate an SDNR notification, if appropriate.
Applied the same logic for when a lock is lost.

Issue-ID: POLICY-2582
Change-Id: I35510ec8a3cfc6b2ca9be5751896f3c0f7d9bd09
Signed-off-by: Jim Hahn <jrh3@att.com>

2 files changed, 37 insertions, 5 deletions

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
index 3f7aca6e0..b2a8dd308 100644
--- 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
@@ -478,6 +478,7 @@ public class ControlLoopOperationManager2 implements Serializable {
 
             case CL_TIMEOUT_ACTOR:
                 state = State.CONTROL_LOOP_TIMEOUT;
+                processAbort(outcome, PolicyResult.FAILURE, "Control loop timed out");
                 break;
 
             case LOCK_ACTOR:
@@ -487,7 +488,7 @@ public class ControlLoopOperationManager2 implements Serializable {
                     storeFailureInDataBase(outcome, PolicyResult.FAILURE_GUARD, "Operation denied by Lock");
                 } else {
                     state = State.LOCK_LOST;
-                    storeFailureInDataBase(outcome, PolicyResult.FAILURE, "Operation aborted by Lock");
+                    processAbort(outcome, PolicyResult.FAILURE, "Operation aborted by Lock");
                 }
                 break;
 
@@ -531,10 +532,41 @@ public class ControlLoopOperationManager2 implements Serializable {
     }
 
     /**
+     * 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, PolicyResult 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.getControlLoopResponse());
+
+        storeFailureInDataBase(outcome, result, message);
+    }
+
+    /**
      * Makes a control loop response.
      *
      * @param source original control loop response or {@code null}
-     * @return a new control loop response, or {@code null} none is required
+     * @return a new control loop response, or {@code null} if none is required
      */
     protected ControlLoopResponse makeControlLoopResponse(ControlLoopResponse source) {
         if (source != null) {
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
index be8b70b13..6fda667eb 100644
--- 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
@@ -240,7 +240,7 @@ public class ControlLoopOperationManager2Test {
     }
 
     /**
-     * Tests start() when the control loop times out.
+     * Tests start() when the control loop times out before the operation starts.
      */
     @Test
     public void testStartClTimeout_testHandleTimeout() throws InterruptedException {
@@ -276,8 +276,8 @@ public class ControlLoopOperationManager2Test {
         // should have called update() for operation-start, but not for any nextStep()
         verify(mgrctx).updated(mgr);
 
-        // should not have tried to store anything in the DB
-        verify(dataMgr, never()).store(any(), any(), any(), any());
+        // should have added a record to the DB
+        verify(dataMgr).store(any(), any(), any(), any());
     }
 
     @Test