add new result format (#51)

* add new result format

Author: cx-pedro-lopes

src/main/java/com/checkmarx/ast/results/ReportFormat.java

@@ -5,6 +5,7 @@
 public enum ReportFormat {
     summaryHTML(".html"),
     json(".json"),
+    summaryJSON(".json"),
     sarif(".sarif"),
     ;
 

src/main/java/com/checkmarx/ast/results/ResultsSummary.java

@@ -0,0 +1,66 @@
+package com.checkmarx.ast.results;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import lombok.Value;
+
+@Value
+@JsonDeserialize()
+@JsonInclude(JsonInclude.Include.NON_NULL)
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ResultsSummary {
+
+    private int totalIssues;
+    private int highIssues;
+    private int mediumIssues;
+    private int lowIssues;
+    private int sastIssues;
+    private int scaIssues;
+    private int kicsIssues;
+    private String riskStyle;
+    private String riskMessage;
+    private String status;
+    private String scanId;
+    private String scanDate;
+    private String scanTime;
+    private String createdAt;
+    private String projectId;
+    private String baseURI;
+
+
+    public ResultsSummary(@JsonProperty("TotalIssues") int totalIssues,
+                @JsonProperty("HighIssues") int highIssues,
+                @JsonProperty("MediumIssues") int mediumIssues,
+                @JsonProperty("LowIssues") int lowIssues,
+                @JsonProperty("SastIssues") int sastIssues,
+                @JsonProperty("ScaIssues") int scaIssues,
+                @JsonProperty("KicsIssues") int kicsIssues,
+                @JsonProperty("RiskStyle") String riskStyle,
+                @JsonProperty("RiskMsg") String riskMessage,
+                @JsonProperty("Status") String status,
+                @JsonProperty("ScanID") String scanId,
+                @JsonProperty("ScanDate") String scanDate,
+                @JsonProperty("ScanTime") String scanTime,
+                @JsonProperty("CreatedAt") String createdAt,
+                @JsonProperty("ProjectID") String projectId,
+                @JsonProperty("BaseURI") String baseURI) {
+        this.totalIssues = totalIssues;
+        this.highIssues = highIssues;
+        this.mediumIssues = mediumIssues;
+        this.lowIssues = lowIssues;
+        this.sastIssues = sastIssues;
+        this.scaIssues = scaIssues;
+        this.kicsIssues = kicsIssues;
+        this.riskStyle = riskStyle;
+        this.riskMessage = riskMessage;
+        this.status = status;
+        this.scanId = scanId;
+        this.scanDate = scanDate;
+        this.scanTime = scanTime;
+        this.createdAt = createdAt;
+        this.projectId = projectId;
+        this.baseURI = baseURI;
+    }
+}

src/main/java/com/checkmarx/ast/wrapper/CxWrapper.java

@@ -4,6 +4,7 @@
 import com.checkmarx.ast.project.Project;
 import com.checkmarx.ast.results.ReportFormat;
 import com.checkmarx.ast.results.Results;
+import com.checkmarx.ast.results.ResultsSummary;
 import com.checkmarx.ast.scan.Scan;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.type.CollectionType;
@@ -195,6 +196,12 @@ public List<String> projectBranches(@NonNull UUID projectId, String filter)
                                         (line) -> CxBaseObject.parse(line, BRANCHES_TYPE));
     }
 
+    public ResultsSummary resultsSummary(@NonNull UUID scanId) throws IOException, InterruptedException, CxException {
+        return new ObjectMapper()
+                .readerFor(ResultsSummary.class)
+                .readValue(results(scanId, ReportFormat.summaryJSON));
+    }
+
     public Results results(@NonNull UUID scanId) throws IOException, InterruptedException, CxException {
         return new ObjectMapper()
                 .readerFor(Results.class)

src/test/java/com/checkmarx/ast/ResultTest.java

@@ -2,13 +2,15 @@
 
 import com.checkmarx.ast.results.ReportFormat;
 import com.checkmarx.ast.results.Results;
+import com.checkmarx.ast.results.ResultsSummary;
 import com.checkmarx.ast.scan.Scan;
 import org.junit.Assert;
 import org.junit.Test;
 
 import java.util.List;
 import java.util.UUID;
 
+import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertTrue;
 
 public class ResultTest extends BaseTest {
@@ -32,11 +34,21 @@ public void testResultsJSON() throws Exception {
     }
 
     @Test
+    public void testResultsSummaryJSON() throws Exception {
+        List<Scan> scanList = wrapper.scanList();
+        Assert.assertTrue(scanList.size() > 0);
+        String scanId = scanList.get(0).getID();
+        ResultsSummary results = wrapper.resultsSummary(UUID.fromString(scanId));
+        assertNotNull(results.getScanId());
+    }
+
+    @Test(expected = Test.None.class)
     public void testResultsStructure() throws Exception {
         List<Scan> scanList = wrapper.scanList();
         Assert.assertTrue(scanList.size() > 0);
         String scanId = scanList.get(0).getID();
         Results results = wrapper.results(UUID.fromString(scanId));
+        results.getResults().stream().filter(result -> "sast".equalsIgnoreCase(result.getType())).findFirst();
         Assert.assertEquals(results.getTotalCount(), results.getResults().size());
     }
 }