Removed unused report archive code. Remove constants class.

Author: jschroeder-avi

src/main/java/com/codedx/bambooplugin/CodeDxScanTask.java

@@ -10,8 +10,6 @@
 import com.atlassian.util.concurrent.NotNull;
 import com.codedx.bambooplugin.utils.Archiver;
 import com.codedx.bambooplugin.utils.CodeDxBuildStatistics;
-import com.codedx.bambooplugin.utils.CodeDxConstants;
-import com.codedx.bambooplugin.utils.CodeDxReportWriter;
 import com.codedx.client.ApiClient;
 import com.codedx.client.ApiException;
 import com.codedx.client.api.*;
@@ -45,7 +43,6 @@ private static class ScanTaskState {
         String includePaths;
         String excludePaths;
         String toolOutputFiles;
-        String reportArchiveName;
         boolean waitForResults;
         String failureSeverity;
         boolean onlyConsiderNewFindings;
@@ -60,8 +57,7 @@ private static class ScanTaskState {
         List<File> filesToUpload;
         String analysisPrepId;
         String analysisJobId;
-        CodeDxBuildStatistics statsBeforeAnalysis;
-        CodeDxBuildStatistics statsAfterAnalysis;
+        CodeDxBuildStatistics buildStatistics;
         List<GroupedCount> groupedCounts;
     }
 
@@ -81,7 +77,6 @@ public TaskResult execute(final TaskContext taskContext) throws TaskException
 
         stateMachine.add(CodeDxScanTask::loadUserPreferences);
         stateMachine.add(CodeDxScanTask::setupApiClient);
-        stateMachine.add(CodeDxScanTask::getBuildStatsBeforeAnalysis);
         stateMachine.add(CodeDxScanTask::collectFilesToUpload);
         stateMachine.add(CodeDxScanTask::uploadFiles);
         stateMachine.add(CodeDxScanTask::waitForCodeDxToBeReadyForAnalysis);
@@ -126,7 +121,6 @@ private static Boolean loadUserPreferences(ScanTaskState state) {
             return false;
         }
         state.toolOutputFiles = config.get("toolOutputFiles");
-        state.reportArchiveName = config.get("reportArchiveName");
         state.waitForResults = config.getAsBoolean("waitForResults");
         state.failureSeverity = config.get("selectedFailureSeverity");
         // Don't wait if the failure severity is "None".  Is this what we want?
@@ -309,26 +303,6 @@ private static Boolean waitForCodeDxToBeReadyForAnalysis(ScanTaskState state) {
         return true;
     }
 
-    private static Boolean getBuildStatsBeforeAnalysis(ScanTaskState state) {
-
-        if(!state.waitForResults || state.reportArchiveName == null || state.reportArchiveName.isEmpty()) {
-            // We only need the pre-analysis stats if we are writing the report later
-            return true;
-        }
-
-        log(state, "Querying Code Dx for pre-analysis statistics");
-
-        CodeDxBuildStatistics stats = getBuildStats(state);
-
-        if (stats == null) {
-            return false; // Error already logged in helper method
-        }
-
-        state.statsBeforeAnalysis = stats;
-
-        return true;
-    }
-
     private static Boolean startAnalysis(ScanTaskState state) {
         log(state, "Querying Code Dx to start analysis");
 
@@ -364,9 +338,8 @@ private static Boolean handleAnalysisResults(ScanTaskState state) {
         List<Function<ScanTaskState, Boolean>> stateMachine = new ArrayList<Function<ScanTaskState, Boolean>>();
 
         stateMachine.add(CodeDxScanTask::waitForAnalysisToFinish);
-        stateMachine.add(CodeDxScanTask::getBuildStatsAfterAnalysis);
+        stateMachine.add(CodeDxScanTask::getBuildStatistics);
         stateMachine.add(CodeDxScanTask::getGroupedCounts);
-        stateMachine.add(CodeDxScanTask::writeReportArchive);
         stateMachine.add(CodeDxScanTask::checkFailureSeverity);
 
         return runStateMachine(stateMachine, state);
@@ -417,16 +390,30 @@ private static Boolean waitForAnalysisToFinish(ScanTaskState state) {
         return true;
     }
 
-    private static Boolean getBuildStatsAfterAnalysis(ScanTaskState state) {
+    private static Boolean getBuildStatistics(ScanTaskState state) {
         log(state, "Querying Code Dx for post-analysis statistics");
 
-        CodeDxBuildStatistics stats = getBuildStats(state);
+        Filter filter = new Filter();
+        filter.put("~status", "gone");
 
-        if (stats == null) {
-            return false; // Error already logged in helper method
+        GroupedCountsRequest bySeverity = new GroupedCountsRequest();
+        bySeverity.setFilter(filter);
+        bySeverity.setCountBy("severity");
+
+        GroupedCountsRequest byStatus =  new GroupedCountsRequest();
+        byStatus.setFilter(filter);
+        byStatus.setCountBy("status");
+
+        CodeDxBuildStatistics stats = null;
+        try {
+            List<GroupedCount> severityGroupedCounts = state.findingDataApi.getFindingsGroupCount(state.projectId, bySeverity);
+            List<GroupedCount> statusGroupedCounts = state.findingDataApi.getFindingsGroupCount(state.projectId, byStatus);
+            stats = new CodeDxBuildStatistics(severityGroupedCounts, statusGroupedCounts);
+        } catch (ApiException e) {
+            logApiException(state, e);
         }
 
-        state.statsAfterAnalysis = stats;
+        state.buildStatistics = stats;
 
         return true;
     }
@@ -450,33 +437,8 @@ private static Boolean getGroupedCounts(ScanTaskState state) {
                 return false;
             }
         } else {
-            state.groupedCounts = state.statsAfterAnalysis.getGroupedSeverityCounts();
-        }
-
-        return true;
-    }
-
-    private static Boolean writeReportArchive(ScanTaskState state) {
-
-        // TODO: Remove if not needed after implementing Build Results / Tables
-        /*
-        // If user provides an archive name, create a zip containing an simple html file
-        if(state.reportArchiveName != null && !state.reportArchiveName.isEmpty()) {
-            log(state, "Creating archived report file. Name: %s", state.reportArchiveName);
-
-            CodeDxReportWriter reportWriter = new CodeDxReportWriter(state.reportArchiveName,
-                    state.statsBeforeAnalysis,
-                    state.statsAfterAnalysis,
-                    state.apiUrl,
-                    state.projectId);
-            try {
-                reportWriter.writeReport(state.taskContext.getRootDirectory());
-            } catch (IOException e) {
-                logError(state, "An error occurred when trying to create the report archive file.");
-                return false;
-            }
+            state.groupedCounts = state.buildStatistics.getGroupedSeverityCounts();
         }
-        */
 
         return true;
     }
@@ -501,32 +463,6 @@ private static Boolean checkFailureSeverity(ScanTaskState state) {
         return true;
     }
 
-    // Helper methods
-
-    private static CodeDxBuildStatistics getBuildStats(ScanTaskState state) {
-        Filter filter = new Filter();
-        filter.put("~status", "gone");
-
-        GroupedCountsRequest bySeverity = new GroupedCountsRequest();
-        bySeverity.setFilter(filter);
-        bySeverity.setCountBy("severity");
-
-        GroupedCountsRequest byStatus =  new GroupedCountsRequest();
-        byStatus.setFilter(filter);
-        byStatus.setCountBy("status");
-
-        CodeDxBuildStatistics stats = null;
-        try {
-            List<GroupedCount> severityGroupedCounts = state.findingDataApi.getFindingsGroupCount(state.projectId, bySeverity);
-            List<GroupedCount> statusGroupedCounts = state.findingDataApi.getFindingsGroupCount(state.projectId, byStatus);
-            stats = new CodeDxBuildStatistics(severityGroupedCounts, statusGroupedCounts);
-        } catch (ApiException e) {
-            logApiException(state, e);
-        }
-
-        return stats;
-    }
-
     private static void log(ScanTaskState state, String format, Object... args) {
         state.buildLogger.addBuildLogEntry(String.format(format, args));
     }

src/main/java/com/codedx/bambooplugin/CodeDxScanTaskConfigurator.java

@@ -75,7 +75,6 @@ public Map<String, String> generateTaskConfigMap(final ActionParametersMap param
         config.put("includePaths", params.getString("includePaths"));
         config.put("excludePaths", params.getString("excludePaths"));
         config.put("toolOutputFiles", params.getString("toolOutputFiles"));
-        config.put("reportArchiveName", params.getString("reportArchiveName"));
         config.put("waitForResults", params.getString("waitForResults"));
         config.put("selectedFailureSeverity", params.getString("selectedFailureSeverity"));
         config.put("onlyConsiderNewFindings", params.getString("onlyConsiderNewFindings"));
@@ -212,7 +211,6 @@ public void populateContextForCreate(final Map<String, Object> context) {
         context.put("includePaths", "**");
         context.put("excludePaths", "");
         context.put("toolOutputFiles", "");
-        context.put("reportArchiveName", "");
         context.put("waitForResults", false);
         context.put("severities", severities);
         context.put("selectedFailureSeverity", severities[0]);
@@ -250,7 +248,6 @@ public void populateContextForEdit(Map<String, Object> context, TaskDefinition t
         context.put("includePaths", config.get("includePaths"));
         context.put("excludePaths", config.get("excludePaths"));
         context.put("toolOutputFiles", config.get("toolOutputFiles"));
-        context.put("reportArchiveName", config.get("reportArchiveName"));
         context.put("waitForResults", config.get("waitForResults"));
         context.put("selectedFailureSeverity", config.get("selectedFailureSeverity"));
         context.put("onlyConsiderNewFindings", config.get("onlyConsiderNewFindings"));

src/main/java/com/codedx/bambooplugin/utils/CodeDxConstants.java

@@ -258,21 +258,6 @@
         <span>Only findings with the 'New' status will be considered when determining if the build is a failure.</span>
     </div>
 
-	<!--Report Archive Name-->
-	<!-- TODO: Remove section if not needed after implementing Build Results / Tables  -->
-    <div class="setting-section" style="display:none;">
-        <div class="setting-textfield">
-            [@ww.textfield label="Report Archive Name" name="reportArchiveName"/]
-        </div>
-        <span id="help-button-report-name" class="setting-help-textfield" onclick="toggleHelp(this)">
-            <i class="fas fa-question-circle"></i>
-        </span>
-    </div>
-    <div id="help-content-report-name" class="setting-content">
-        <span>Please provide a unique name for the report archive file.</span>
-        <span>If the name is not unique, the report may be overwritten by other Code Dx build steps.</span>
-    </div>
-
 </div>
 
 <!-- Workaround for bug(?) in bamboo to pass variables from server.  After failing to save a configuration, variables get passed down inside of a size 1 array.  This causes normal escape syntax to fail. -->