DMP-5222 Automated Tasks Should Log Dynatrace Failure on InterruptedException (#3045)

Author: karen-hedges

src/main/java/uk/gov/hmcts/darts/task/runner/impl/AbstractLockableAutomatedTask.java

@@ -45,6 +45,7 @@
 import static uk.gov.hmcts.darts.task.status.AutomatedTaskStatus.NOT_STARTED;
 import static uk.gov.hmcts.darts.task.status.AutomatedTaskStatus.SKIPPED;
 
+@SuppressWarnings("PMD.TooManyMethods")
 @Slf4j
 public abstract class AbstractLockableAutomatedTask<T extends AbstractAutomatedTaskConfig> implements AutomatedTask, AutoloadingAutomatedTask {
 
@@ -128,14 +129,22 @@ public void run(boolean isManualRun) {
                 }
             }
         } catch (Exception exception) {
-            logApi.taskFailed(executionId.get(), getTaskName());
-            setAutomatedTaskStatus(FAILED);
             log.error("Task: {} exception while attempting to start the task", getTaskName(), exception);
+            logTaskFailed(executionId);
         } finally {
             postRunTask();
         }
     }
 
+    private void logTaskFailed(ThreadLocal<UUID> executionId) {
+        UUID executionUuid = null;
+        if (executionId != null && executionId.get() != null) {
+            executionUuid = executionId.get();
+        }
+        logApi.taskFailed(executionUuid, getTaskName());
+        setAutomatedTaskStatus(FAILED);
+    }
+
     LockedTask createLockableTask() {
         return new LockedTask();
     }
@@ -287,17 +296,17 @@ public void run() {
                 try {
                     future.get(getLockAtMostFor().toMillis(), TimeUnit.MILLISECONDS);
                 } catch (TimeoutException e) {
-                    setAutomatedTaskStatus(FAILED);
                     log.error("Task: {} timed out after {}ms", getTaskName(), getLockAtMostFor().toMillis());
+                    logTaskFailed(executionId);
                     if (!future.cancel(true)) {
                         log.error("Failed to cancel task: {}.", getTaskName());
                     }
                 } catch (ExecutionException e) {
-                    setAutomatedTaskStatus(FAILED);
                     log.error("Task: {} execution exception", getTaskName(), e);
+                    logTaskFailed(executionId);
                 } catch (InterruptedException e) {
-                    setAutomatedTaskStatus(FAILED);
                     log.error("Task: {} interrupted", getTaskName(), e);
+                    logTaskFailed(executionId);
                     Thread.currentThread().interrupt();
                 }
                 executor.shutdown();

src/test/java/uk/gov/hmcts/darts/task/runner/impl/AbstractLockableAutomatedTaskTest.java

@@ -51,16 +51,14 @@ public class AbstractLockableAutomatedTaskTest {
     @Mock
     private LockService lockService;
 
-
     @Nested
     @ExtendWith(OutputCaptureExtension.class)
     @SuppressWarnings("PMD.SystemPrintln") // System.out.println is used to ensure runnable is executed
     @Isolated
     class LockedTaskTest {
 
-
         @Test
-        void lockedTaskRun_shouldBeSuccessfull_whenTaskCompletesWithinLockAtMostFor(CapturedOutput output) {
+        void lockedTaskRun_shouldBeSuccessful_whenTaskCompletesWithinLockAtMostFor(CapturedOutput output) {
             Runnable task = () -> {
                 System.out.println("LockedTaskTest: Task is running");
             };
@@ -114,7 +112,6 @@ void lockedTaskRun_shouldFail_whenTaskDoesNotCompletesWithinLockAtMostFor(Captur
 
             doNothing().when(lockedTask).assertLocked();
 
-
             lockedTask.run();
 
             //Ensure task is run
@@ -125,6 +122,7 @@ void lockedTaskRun_shouldFail_whenTaskDoesNotCompletesWithinLockAtMostFor(Captur
                              "Timeout waiting for task status to be FAILED", 10);
             verify(abstractLockableAutomatedTask, atLeastOnce()).setAutomatedTaskStatus(AutomatedTaskStatus.FAILED);
             verify(lockedTask).assertLocked();
+            verify(logApi).taskFailed(any(), any());
         }
 
         @Test
@@ -145,7 +143,6 @@ void lockedTaskRun_shouldFail_whenTaskHasException(CapturedOutput output) {
 
             doNothing().when(lockedTask).assertLocked();
 
-
             lockedTask.run();
 
             //Ensure task is run
@@ -158,6 +155,7 @@ void lockedTaskRun_shouldFail_whenTaskHasException(CapturedOutput output) {
             verify(abstractLockableAutomatedTask, atLeastOnce()).setAutomatedTaskStatus(AutomatedTaskStatus.FAILED);
             verify(abstractLockableAutomatedTask).handleException(exception);
             verify(lockedTask).assertLocked();
+            verify(logApi).taskFailed(any(), any());
         }
 
         @Test
@@ -182,7 +180,6 @@ void lockedTaskRun_shouldFail_whenTaskInterupted(CapturedOutput output) throws E
                 lock.setAtMostFor(Duration.ofSeconds(10));
                 when(abstractAutomatedTaskConfig.getLock()).thenReturn(lock);
 
-
                 AbstractLockableAutomatedTask<AbstractAutomatedTaskConfig> abstractLockableAutomatedTask = spy(createAbstractLockableAutomatedTask(() -> {
                 }));
 
@@ -198,6 +195,7 @@ void lockedTaskRun_shouldFail_whenTaskInterupted(CapturedOutput output) throws E
                                  "Timeout waiting for task status to be FAILED", 10);
                 verify(abstractLockableAutomatedTask, atLeastOnce()).setAutomatedTaskStatus(AutomatedTaskStatus.FAILED);
                 verify(lockedTask).assertLocked();
+                verify(logApi).taskFailed(any(), any());
             }
         }