Feature/results update (#14)

* update version

* update cli to 2.0.0-rc.22

* update tests to use galactica tenant

Author: cx-pedro-lopes

.github/workflows/main.yml

@@ -31,5 +31,6 @@ jobs:
           CX_CLIENT_ID: ${{ secrets.CLIENT_ID}}
           CX_CLIENT_SECRET: ${{ secrets.CLIENT_SECRET}}
           CX_BASE_URI: ${{ secrets.BASE_URI }}
+          CX_TENANT: ${{ secrets.TENANT }}
           PATH_TO_EXECUTABLE: /tmp/cx-linux
         run: mvn -B test --file pom.xml

.github/workflows/maven-publish.yml

@@ -34,5 +34,6 @@ jobs:
         CX_CLIENT_ID: ${{ secrets.CLIENT_ID}}
         CX_CLIENT_SECRET: ${{ secrets.CLIENT_SECRET}}
         CX_BASE_URI	: ${{ secrets.BASE_URI }}
+        CX_TENANT: ${{ secrets.TENANT }}
         PATH_TO_EXECUTABLE: /tmp/cx-linux
         GITHUB_TOKEN: ${{ github.token }}

src/main/java/com/checkmarx/ast/scans/CxAuth.java

@@ -8,13 +8,18 @@
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.reflect.FieldUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.*;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.security.CodeSource;
 import java.security.ProtectionDomain;
 import java.util.ArrayList;
@@ -185,43 +190,57 @@ public CxCommandOutput cxScanShow(String id) throws IOException, InterruptedExce
         return scanObject;
     }
 
-    public String cxGetResultsSummary(String scanID, String formatType, String target)
+    public String cxGetResultsSummary(String scanID) throws IOException {
+        return runResultExecutionCommands(scanID, "summaryHTML", ".html");
+    }
+
+    public String cxGetResultsList(String scanID) throws IOException {
+        return runResultExecutionCommands(scanID, "json", ".json");
+    }
+
+    public void cxGetResults(String resultType, String scanID, String fileName, String target)
             throws IOException {
-        List<String> commands = initialCommandsCommon();
-        commands.add("result");
-        commands.add("summary");
-        if (scanID.isEmpty()) {
+
+        List<String> commands = buildResultCommand(resultType, scanID, fileName, target);
+
+        runResultExecutionCommands(commands);
+    }
+
+    private List<String> buildResultCommand(String resultType, String scanId, String outputName, String outputTarget) {
+        if (scanId.isEmpty()) {
             throw new CxException("Please provide the scan id ");
         }
-        commands.add("--scan-id");
-        commands.add(scanID);
-        if (!formatType.isEmpty()) {
-            commands.add("--format");
-            commands.add(formatType);
-        }
-        if (!target.isEmpty()) {
-            commands.add("--target");
-            commands.add(target);
-        }
-        return runResultExecutionCommands(commands);
-    }
 
-    public String cxGetResultsList(String scanID, String formatType)
-            throws IOException {
         List<String> commands = initialCommandsCommon();
         commands.add("result");
-        commands.add("list");
-        if (scanID.isEmpty()) {
-            throw new CxException("Please provide the scan id ");
-        }
         commands.add("--scan-id");
-        commands.add(scanID);
-        if (!formatType.isEmpty()) {
-            commands.add("--format");
-            commands.add(formatType);
+        commands.add(scanId);
+        commands.add("--report-format");
+        commands.add(resultType);
+
+        if (StringUtils.isNotBlank(outputName)) {
+            commands.add("--output-name");
+            commands.add(outputName);
+        }
+
+        if (StringUtils.isNotBlank(outputTarget)) {
+            commands.add("--output-path");
+            commands.add(outputTarget);
         }
-    
-        return runResultExecutionCommands(commands);
+
+        return commands;
+    }
+
+
+
+    private String runResultExecutionCommands(String scanId, String resultType, String extension) throws IOException {
+        Path tempDir = Files.createTempDirectory("cx");
+        String fileName = Long.toString(System.nanoTime());
+        List<String> commands = buildResultCommand(resultType, scanId, fileName, tempDir.toAbsolutePath().toString());
+        runResultExecutionCommands(commands);
+
+        File outputFile = new File(tempDir.toAbsolutePath().toString(), fileName + extension);
+        return new String(Files.readAllBytes(Paths.get(outputFile.getAbsolutePath())), StandardCharsets.UTF_8);
     }
 
     private String runResultExecutionCommands(List<String> commands) throws IOException {

src/main/resources/cx-linux

@@ -112,24 +112,24 @@ public void cxScanCreationSuccess() throws InterruptedException, IOException {
     public void cxGenerateHTMLResults() throws InterruptedException, IOException {
         CxCommandOutput scanList = auth.cxAstScanList();
         String id = scanList.getScanObjectList().get(0).getID();
-        String filePath = System.getProperty("user.dir") + "/index.html";
-        auth.cxGetResultsSummary( id, "", filePath);
-        assertTrue(new File(filePath).length() > 0);
+        String filePath = System.getProperty("user.dir");
+        auth.cxGetResults("summaryHTML", id, "index", filePath);
+        assertTrue(new File(filePath + "/index.html").length() > 0);
     }
 
     @Test
     public void cxGetResultsSummaryString() throws InterruptedException, IOException {
         CxCommandOutput scanList = auth.cxAstScanList();
         String id = scanList.getScanObjectList().get(0).getID();
-        String op = auth.cxGetResultsSummary(id,"","");
+        String op = auth.cxGetResultsSummary(id);
         assertTrue(op.length() > 0);
     }
 
     @Test
     public void cxGetResultsListString() throws InterruptedException, IOException {
         CxCommandOutput scanList = auth.cxAstScanList();
         String id = scanList.getScanObjectList().get(0).getID();
-        String op = auth.cxGetResultsList(id,"json");
+        String op = auth.cxGetResultsList(id);
         assertTrue(op.length() > 0);
     }
 }