Feature 345 summary in reports

sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/model/SecHubReportMetaData.java

@@ -11,7 +11,17 @@ public class SecHubReportMetaData {
 
     private Map<String, String> labels = new LinkedHashMap<>();
 
+    private SecHubReportSummary summary = new SecHubReportSummary();
+
     public Map<String, String> getLabels() {
         return labels;
     }
+
+    public SecHubReportSummary getSummary() {
+        return summary;
+    }
+
+    public void setSummary(SecHubReportSummary summary) {
+        this.summary = summary;
+    }
 }

sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/model/SecHubReportScan.java

@@ -0,0 +1,65 @@
+// SPDX-License-Identifier: MIT
+package com.mercedesbenz.sechub.commons.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class SecHubReportScan {
+
+    private long total = 0;
+    private long red = 0;
+    private long yellow = 0;
+    private long green = 0;
+    private SecHubReportScanDetails details = new SecHubReportScanDetails();
+
+    public void reportScanHelper(SecHubFinding finding) {
+        incrementColors(finding);
+        details.detailsHelper(finding);
+    }
+
+    public void incrementColors(SecHubFinding finding) {
+        Severity severity = finding.getSeverity();
+        switch (severity) {
+        case HIGH -> incrementRedCount();
+        case MEDIUM -> incrementYellowCount();
+        case LOW, INFO -> incrementGreenCount();
+        }
+        incrementTotalCount();
+    }
+
+    protected void incrementRedCount() {
+        this.red++;
+    }
+
+    protected void incrementYellowCount() {
+        this.yellow++;
+    }
+
+    protected void incrementGreenCount() {
+        this.green++;
+    }
+
+    protected void incrementTotalCount() {
+        this.total++;
+    }
+
+    public long getTotal() {
+        return total;
+    }
+
+    public long getRed() {
+        return red;
+    }
+
+    public long getYellow() {
+        return yellow;
+    }
+
+    public long getGreen() {
+        return green;
+    }
+
+    public SecHubReportScanDetails getDetails() {
+        return details;
+    }
+}

sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/model/SecHubReportScanDetails.java

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: MIT
+package com.mercedesbenz.sechub.commons.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class SecHubReportScanDetails {
+    private List<SeverityDetails> high = new ArrayList<>();
+    private List<SeverityDetails> medium = new ArrayList<>();
+    private List<SeverityDetails> low = new ArrayList<>();
+
+    public void detailsHelper(SecHubFinding finding) {
+        switch (finding.getSeverity()) {
+        case HIGH -> detailsFiller(high, finding);
+        case MEDIUM -> detailsFiller(medium, finding);
+        case LOW, INFO -> detailsFiller(low, finding);
+        }
+    }
+
+    private void detailsFiller(List<SeverityDetails> severityDetailsList, SecHubFinding finding) {
+        boolean fl = false;
+        int i = 0;
+        while (fl == false && i < severityDetailsList.size()) {
+            SeverityDetails details = severityDetailsList.get(i);
+            if (details.getCweId().equals(finding.getCweId())) {
+                details.incrementCount();
+                fl = true;
+            }
+            i++;
+        }
+        if (fl == false) {
+            severityDetailsList.add(new SeverityDetails(finding.getCweId(), finding.getName()));
+        }
+    }
+
+    public List<SeverityDetails> getHigh() {
+        return high;
+    }
+
+    public List<SeverityDetails> getMedium() {
+        return medium;
+    }
+
+    public List<SeverityDetails> getLow() {
+        return low;
+    }
+
+    @JsonIgnoreProperties(ignoreUnknown = true)
+    private class SeverityDetails {
+        private Integer cweId;
+        private String name;
+        private long count;
+
+        SeverityDetails(Integer cweId, String name) {
+            this.cweId = cweId;
+            this.name = name;
+            this.count = 1;
+        }
+
+        public void incrementCount() {
+            this.count++;
+        }
+
+        public Integer getCweId() {
+            return cweId;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public long getCount() {
+            return count;
+        }
+    }
+}

sechub-commons-model/src/main/java/com/mercedesbenz/sechub/commons/model/SecHubReportSummary.java

@@ -0,0 +1,36 @@
+// SPDX-License-Identifier: MIT
+package com.mercedesbenz.sechub.commons.model;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class SecHubReportSummary {
+
+    SecHubReportScan codeScan = new SecHubReportScan();
+    SecHubReportScan infraScan = new SecHubReportScan();
+    SecHubReportScan webScan = new SecHubReportScan();
+
+    public SecHubReportScan getCodeScan() {
+        return codeScan;
+    }
+
+    public void setCodeScan(SecHubReportScan codeScan) {
+        this.codeScan = codeScan;
+    }
+
+    public SecHubReportScan getInfraScan() {
+        return infraScan;
+    }
+
+    public void setInfraScan(SecHubReportScan infraScan) {
+        this.infraScan = infraScan;
+    }
+
+    public SecHubReportScan getWebScan() {
+        return webScan;
+    }
+
+    public void setWebScan(SecHubReportScan webScan) {
+        this.webScan = webScan;
+    }
+}

sechub-scan/src/main/java/com/mercedesbenz/sechub/domain/scan/HTMLScanResultReportModelBuilder.java

@@ -2,10 +2,7 @@
 package com.mercedesbenz.sechub.domain.scan;
 
 import java.io.File;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.UUID;
+import java.util.*;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -14,10 +11,7 @@
 import org.springframework.core.io.Resource;
 import org.springframework.stereotype.Component;
 
-import com.mercedesbenz.sechub.commons.model.SecHubFinding;
-import com.mercedesbenz.sechub.commons.model.SecHubResult;
-import com.mercedesbenz.sechub.commons.model.SecHubResultTrafficLightFilter;
-import com.mercedesbenz.sechub.commons.model.TrafficLight;
+import com.mercedesbenz.sechub.commons.model.*;
 import com.mercedesbenz.sechub.domain.scan.report.ScanSecHubReport;
 import com.mercedesbenz.sechub.sharedkernel.MustBeDocumented;
 
@@ -53,16 +47,16 @@ public Map<String, Object> build(ScanSecHubReport report) {
         }
 
         switch (trafficLight) {
-        case RED:
-            styleRed = SHOW_LIGHT;
-            break;
-        case YELLOW:
-            styleYellow = SHOW_LIGHT;
-            break;
-        case GREEN:
-            styleGreen = SHOW_LIGHT;
-            break;
-        default:
+            case RED:
+                styleRed = SHOW_LIGHT;
+                break;
+            case YELLOW:
+                styleYellow = SHOW_LIGHT;
+                break;
+            case GREEN:
+                styleGreen = SHOW_LIGHT;
+                break;
+            default:
         }
         HtmlCodeScanDescriptionSupport codeScanSupport = new HtmlCodeScanDescriptionSupport();
         SecHubResult result = report.getResult();
@@ -111,6 +105,36 @@ public Map<String, Object> build(ScanSecHubReport report) {
         } else {
             model.put("jobuuid", "none");
         }
+
+        Map<ScanType, ScanTypeCount> scanSummaryMap = new HashMap<>();
+        for (SecHubFinding finding : result.getFindings()) {
+            ScanType scanType = finding.getType();
+            ScanTypeCount scanTypeCount;
+            if (scanSummaryMap.containsKey(scanType)) {
+                scanTypeCount = scanSummaryMap.get(scanType);
+            } else {
+                scanTypeCount = ScanTypeCount.of(scanType);
+                scanSummaryMap.put(scanType, scanTypeCount);
+            }
+            incrementScanCount(finding.getSeverity(), scanTypeCount);
+        }
+        Set<ScanTypeCount> scanTypeCountSet = new TreeSet<>();
+        scanTypeCountSet.addAll(scanSummaryMap.values());
+        model.put("scanTypeCountSet", scanTypeCountSet);
+
         return model;
     }
+
+    protected void incrementScanCount(Severity severity, ScanTypeCount scanTypeCount) {
+        if (Severity.HIGH.equals(severity)) {
+            scanTypeCount.incrementHighSeverityCount();
+        }
+        if (Severity.MEDIUM.equals(severity)) {
+            scanTypeCount.incrementMediumSeverityCount();
+        }
+        if (Severity.LOW.equals(severity)) {
+            scanTypeCount.incrementLowSeverityCount();
+        }
+    }
+
 }

sechub-scan/src/main/java/com/mercedesbenz/sechub/domain/scan/ScanTypeCount.java

@@ -0,0 +1,64 @@
+// SPDX-License-Identifier: MIT
+package com.mercedesbenz.sechub.domain.scan;
+
+import com.mercedesbenz.sechub.commons.model.ScanType;
+
+public class ScanTypeCount implements Comparable<ScanTypeCount> {
+
+    private ScanType scanType;
+    private int highSeverityCount;
+    private int mediumSeverityCount;
+    private int lowSeverityCount;
+
+    private ScanTypeCount(ScanType scanType){
+        this.scanType = scanType;
+        highSeverityCount = 0;
+        mediumSeverityCount = 0;
+        lowSeverityCount = 0;
+    }
+
+    public static ScanTypeCount of(ScanType scanType) {
+        if (scanType == null) {
+            throw new IllegalArgumentException("ScanType argument must exist");
+        }
+        return new ScanTypeCount(scanType);
+    }
+
+    public ScanType getScanType() {
+        return scanType;
+    }
+
+    public int getHighSeverityCount() {
+        return highSeverityCount;
+    }
+
+    public int getMediumSeverityCount() {
+        return mediumSeverityCount;
+    }
+
+    public int getLowSeverityCount() {
+        return lowSeverityCount;
+    }
+
+    public void incrementHighSeverityCount(){
+        this.highSeverityCount++;
+    }
+
+    public void incrementMediumSeverityCount(){
+        this.mediumSeverityCount++;
+    }
+
+    public void incrementLowSeverityCount(){
+        this.lowSeverityCount++;
+    }
+
+    @Override
+    public int compareTo(ScanTypeCount o) {
+        if (o == null) {
+            return 1;
+        }
+        String descriptionA = this.scanType.getDescription();
+        String descriptionB = o.scanType.getDescription();
+        return descriptionA.compareTo(descriptionB);
+    }
+}