Merge pull request #39 from CheckmarxDev/feature/AST-7569_triage_command

Triage show and update methods added

Author: AndreGCX

src/main/predicates/CxPredicate.ts

@@ -0,0 +1,10 @@
+export default class CxPredicate {
+    id: string = "";
+    similarityId: string = "";
+    projectId: string = "";
+    state: string = "";
+    severity: string = "";
+    created: string = "";
+    updated: string = "";
+    comment: string = "";
+}

src/main/results/CxResult.ts

@@ -2,6 +2,7 @@ export default class CxResult {
     type: string = "";
     id: string = "";
     status: string = "";
+    similarityId = "";
     state: string = "";
     severity: string = "";
     created: string = "";

src/main/wrapper/CxConstants.ts

@@ -2,7 +2,7 @@ export enum CxConstants {
   SOURCE = "-s",
   VERBOSE = "-v",
   PROJECT_NAME = "--project-name",
-  SCAN_TYPES = "--scan-types",
+  SCAN_TYPES_SUB_CMD = "--scan-type",
   SAST_PRESET_NAME = "--sast-preset-name",
   FILE_FILTER = "--file-filter",
   AGENT = "--agent",
@@ -22,6 +22,8 @@ export enum CxConstants {
   SUB_CMD_SHOW = "show",
   SUB_CMD_LIST = "list",
   SUB_CMD_CREATE = "create",
+  CMD_TRIAGE = "triage",
+  SUB_CMD_UPDATE = "update",
   CMD_RESULT = "result",
   FORMAT = "--format",
   FORMAT_JSON = "json",
@@ -32,9 +34,14 @@ export enum CxConstants {
   FILTER = "--filter",
   SCAN_ID = "--scan-id",
   PROJECT_ID = "--project-id",
+  SIMILARITY_ID = "--similarity-id",
+  STATE = "--state",
+  COMMENT = "--comment",
+  SEVERITY = "--severity",
   REPORT_FORMAT = "--report-format",
   OUTPUT_NAME = "--output-name",
   OUTPUT_PATH = "--output-path",
   SCAN_TYPE = "CxScan",
   PROJECT_TYPE = "CxProject",
+  PREDICATE_TYPE = "CxPredicate"
 }

src/main/wrapper/CxWrapper.ts

@@ -75,6 +75,13 @@ export class CxWrapper {
         return list;
     }
 
+    async authValidate(): Promise<CxCommandOutput> {
+        const commands: string[] = [CxConstants.CMD_AUTH, CxConstants.SUB_CMD_VALIDATE];
+        commands.push(...this.initializeCommands(false));
+        let exec = new ExecutionService();
+        return await exec.executeCommands(this.config.pathToExecutable, commands);
+    }
+
     async scanCreate(params: ParamTypeMap): Promise<CxCommandOutput> {
         const commands: string[] = [CxConstants.CMD_SCAN, CxConstants.SUB_CMD_CREATE];
         commands.push(...this.initializeCommands(true));
@@ -99,13 +106,6 @@ export class CxWrapper {
         return await exec.executeCommands(this.config.pathToExecutable, commands, CxConstants.SCAN_TYPE);
     }
 
-    async authValidate(): Promise<CxCommandOutput> {
-        const commands: string[] = [CxConstants.CMD_AUTH, CxConstants.SUB_CMD_VALIDATE];
-        commands.push(...this.initializeCommands(false));
-        let exec = new ExecutionService();
-        return await exec.executeCommands(this.config.pathToExecutable, commands);
-    }
-
     async scanShow(id: string): Promise<CxCommandOutput> {
         const commands: string[] = [CxConstants.CMD_SCAN, CxConstants.SUB_CMD_SHOW, CxConstants.SCAN_ID, id];
         commands.push(...this.initializeCommands(true));
@@ -145,6 +145,20 @@ export class CxWrapper {
         return await exec.executeCommands(this.config.pathToExecutable, commands, CxConstants.PROJECT_TYPE);
     }
 
+    async triageShow(projectId: string, similarityId: string, scanType: string ): Promise<CxCommandOutput> {
+        const commands: string[] = [CxConstants.CMD_TRIAGE, CxConstants.SUB_CMD_SHOW, CxConstants.PROJECT_ID, projectId, CxConstants.SIMILARITY_ID, similarityId, CxConstants.SCAN_TYPES_SUB_CMD, scanType];
+        commands.push(...this.initializeCommands(true));
+        const exec = new ExecutionService();
+        return await exec.executeCommands(this.config.pathToExecutable, commands, CxConstants.PREDICATE_TYPE);
+    }  
+    
+    async triageUpdate(projectId: string, similarityId: string, scanType: string, state: string, comment: string, severity: string): Promise<CxCommandOutput> {
+        const commands: string[] = [CxConstants.CMD_TRIAGE, CxConstants.SUB_CMD_UPDATE, CxConstants.PROJECT_ID, projectId, CxConstants.SIMILARITY_ID, similarityId, CxConstants.SCAN_TYPE, scanType, CxConstants.STATE, state, CxConstants.COMMENT, comment, CxConstants.SEVERITY, severity];
+        commands.push(...this.initializeCommands(false));
+        const exec = new ExecutionService();
+        return await exec.executeCommands(this.config.pathToExecutable, commands);
+    }  
+
     async getResultsList(scanId: string) {
         const exec = new ExecutionService();
         const fileName = new Date().getTime().toString();

src/tests/PredicateTest.test.ts

@@ -0,0 +1,33 @@
+import {CxWrapper} from '../main/wrapper/CxWrapper';
+import {CxCommandOutput} from "../main/wrapper/CxCommandOutput";
+import {BaseTest} from "./BaseTest";
+import CxResult from '../main/results/CxResult';
+import CxScan from '../main/scan/CxScan';
+
+describe("Triage cases",() => {
+    let cxScanConfig = new BaseTest();
+
+    it('TriageShow Successful case', async () => {
+        const auth = new CxWrapper(cxScanConfig);
+        const scanListOutput = await auth.scanList("statuses=Completed");
+        const scan: CxScan = scanListOutput.payload[0]
+        const results = await auth.getResultsList(scan.id)
+        const result: CxResult = results.payload.find(res => res.type == "sast")
+
+        const cxCommandOutput: CxCommandOutput = await auth.triageShow(scan.projectID, result.similarityId, "sast");
+        
+        expect(cxCommandOutput.exitCode).toEqual(0);
+    })
+
+    it('TriageUpdate Successful case', async () => {
+        const auth = new CxWrapper(cxScanConfig);
+        const scanListOutput = await auth.scanList("statuses=Completed");
+        const scan: CxScan = scanListOutput.payload[0]
+        const results = await auth.getResultsList(scan.id)
+        const result: CxResult = results.payload.find(res => res.type == "sast")
+
+        const cxCommandOutput: CxCommandOutput = await auth.triageUpdate(scan.projectID, result.similarityId, "sast", "confirmed", "Edited via JavascriptWrapper", "high");
+        
+        expect(cxCommandOutput.exitCode).toEqual(0);
+    })
+});