Refactor ExitCodeRequest

Author: shantyk

src/main/java/com/blackduck/integration/detect/lifecycle/exit/ExitManager.java

@@ -2,6 +2,7 @@
 
 import java.util.Optional;
 
+import com.blackduck.integration.detect.lifecycle.shutdown.ExitCodePublisher;
 import org.apache.commons.lang3.time.DurationFormatUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -34,7 +35,8 @@ public ExitResult exit(ExitOptions exitOptions, Optional<AutonomousManager> auto
 
         //Generally, when requesting a failure status, an exit code is also requested, but if it is not, we default to an unknown error.
         if (statusManager.hasAnyFailure()) {
-            eventSystem.publishEvent(Event.ExitCode, new ExitCodeRequest(ExitCodeType.FAILURE_UNKNOWN_ERROR, "A failure status was requested by one or more of Detect's tools."));
+            ExitCodePublisher publisher = new ExitCodePublisher(eventSystem);
+            publisher.publishExitCode(ExitCodeType.FAILURE_UNKNOWN_ERROR);
         }
 
         //Find the final (as requested) exit code

src/main/java/com/blackduck/integration/detect/lifecycle/run/operation/OperationRunner.java

@@ -1554,7 +1554,8 @@ public String findLicenseUrl(BlackDuckRunData blackDuckRunData, String licenseNa
     }
 
     public void publishDetectorFailure() {
-        eventSystem.publishEvent(Event.ExitCode, new ExitCodeRequest(ExitCodeType.FAILURE_DETECTOR, "A detector failed."));
+        ExitCodePublisher publisher = new ExitCodePublisher(eventSystem);
+        publisher.publishExitCode(ExitCodeType.FAILURE_DETECTOR);
     }
 
     public Optional<File> findRapidScanConfig() throws OperationException {

src/main/java/com/blackduck/integration/detect/lifecycle/shutdown/ExitCodeManager.java

@@ -6,6 +6,7 @@
 import com.blackduck.integration.detect.configuration.enumeration.ExitCodeType;
 import com.blackduck.integration.detect.workflow.event.Event;
 import com.blackduck.integration.detect.workflow.event.EventSystem;
+import org.jetbrains.annotations.TestOnly;
 
 public class ExitCodeManager {
     private final List<ExitCodeRequest> exitCodeRequests = new ArrayList<>();
@@ -24,6 +25,7 @@ public void requestExitCode(ExitCodeType exitCodeType) {
         exitCodeRequests.add(new ExitCodeRequest(exitCodeType));
     }
 
+    @TestOnly
     public void addExitCodeRequest(ExitCodeRequest request) {
         exitCodeRequests.add(request);
     }

src/main/java/com/blackduck/integration/detect/lifecycle/shutdown/ExitCodePublisher.java

@@ -12,7 +12,7 @@ public ExitCodePublisher(EventSystem eventSystem) {
     }
 
     public void publishExitCode(ExitCodeType exitCodeType) {
-        eventSystem.publishEvent(Event.ExitCode, new ExitCodeRequest(exitCodeType, null));
+        eventSystem.publishEvent(Event.ExitCode, new ExitCodeRequest(exitCodeType));
     }
 
     public void publishExitCode(ExitCodeRequestWithCustomDescription exitCodeRequest) {

src/main/java/com/blackduck/integration/detect/lifecycle/shutdown/ExitCodeRequest.java

@@ -4,25 +4,16 @@
 
 public class ExitCodeRequest {
     private final ExitCodeType exitCodeType;
-    private final String reason;
-
-    public ExitCodeRequest(ExitCodeType exitCodeType, String reason) {
-        this.exitCodeType = exitCodeType;
-        this.reason = reason;
-    }
 
     public ExitCodeRequest(ExitCodeType exitCodeType) {
-        this(exitCodeType, null);
+        this.exitCodeType = exitCodeType;
     }
 
     public ExitCodeType getExitCodeType() {
         return exitCodeType;
     }
 
     public String getReason() {
-        if (reason != null) {
-            return reason;
-        }
         return exitCodeType.getDescription();
     }
 }

src/main/java/com/blackduck/integration/detect/lifecycle/shutdown/ExitCodeRequestWithCustomDescription.java

@@ -4,7 +4,14 @@
 
 public class ExitCodeRequestWithCustomDescription extends ExitCodeRequest {
 
+    private String customDescription;
     public ExitCodeRequestWithCustomDescription(ExitCodeType exitCodeType, String reason) {
-        super(exitCodeType, reason);
+        super(exitCodeType);
+        this.customDescription = reason;
+    }
+
+    @Override
+    public String getReason() {
+        return customDescription;
     }
 }

src/main/java/com/blackduck/integration/detect/workflow/blackduck/developer/RapidModeLogReportOperation.java

@@ -1,9 +1,7 @@
 package com.blackduck.integration.detect.workflow.blackduck.developer;
 
 import java.util.List;
-import java.util.Set;
 
-import com.blackduck.integration.detect.lifecycle.shutdown.ExitCodeRequestWithCustomDescription;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 

src/test/java/com/blackduck/integration/detect/lifecycle/exit/ExitManagerTest.java

@@ -44,7 +44,7 @@ public void testForceExit() {
         DetectStatusManager statusManager = new DetectStatusManager(eventSystem);
         ExceptionUtility exitCodeUtility = new ExceptionUtility();
         ExitCodeManager exitCodeManager = new ExitCodeManager(eventSystem, exitCodeUtility);
-        exitCodeManager.addExitCodeRequest(new ExitCodeRequest(ExitCodeType.FAILURE_CONFIGURATION, "JUnit failure code."));
+        exitCodeManager.addExitCodeRequest(new ExitCodeRequest(ExitCodeType.FAILURE_CONFIGURATION));
         ExitManager exitManager = new ExitManager(eventSystem, exitCodeManager, statusManager);
 
         ExitOptions exitOptions = new ExitOptions(startTime, true, true);
@@ -63,7 +63,7 @@ public void testSkipExit() {
         DetectStatusManager statusManager = new DetectStatusManager(eventSystem);
         ExceptionUtility exitCodeUtility = new ExceptionUtility();
         ExitCodeManager exitCodeManager = new ExitCodeManager(eventSystem, exitCodeUtility);
-        exitCodeManager.addExitCodeRequest(new ExitCodeRequest(ExitCodeType.FAILURE_CONFIGURATION, "JUnit failure code."));
+        exitCodeManager.addExitCodeRequest(new ExitCodeRequest(ExitCodeType.FAILURE_CONFIGURATION));
         ExitManager exitManager = new ExitManager(eventSystem, exitCodeManager, statusManager);
 
         ExitOptions exitOptions = new ExitOptions(startTime, false, false);