add learn more descriptions command to wrapper and tests

Author: Jay Nanduri

src/main/learnmore/CxLearnMoreDescriptions.ts

@@ -0,0 +1,26 @@
+import CxLearnMoreSamples from "./CxLearnMoreSamples";
+
+export default class CxLearnMoreDescriptions {
+    queryId: string;
+    queryName: string;
+    queryDescriptionId: string;
+    resultDescription: string;
+    risk: string;
+    cause: string;
+    generalRecommendations: string;
+    samples: CxLearnMoreSamples[];
+
+    static parseLearnMoreDescriptionsResponse(result: any): CxLearnMoreDescriptions {
+        const cxLearnMoreDescriptions = new CxLearnMoreDescriptions();
+        cxLearnMoreDescriptions.queryId = result.queryId;
+        cxLearnMoreDescriptions.queryName = result.queryName;
+        cxLearnMoreDescriptions.queryDescriptionId = result.queryDescriptionId;
+        cxLearnMoreDescriptions.resultDescription = result.resultDescription;
+        cxLearnMoreDescriptions.risk = result.risk;
+        cxLearnMoreDescriptions.cause = result.cause;
+        cxLearnMoreDescriptions.generalRecommendations = result.generalRecommendations;
+        cxLearnMoreDescriptions.samples = result.samples;
+        return cxLearnMoreDescriptions;
+    }
+
+}

src/main/learnmore/CxLearnMoreSamples.ts

@@ -0,0 +1,5 @@
+export default class CxLearnMoreSamples {
+    progLanguage: string;
+    code: string;
+    title: string;
+}

src/main/wrapper/CxConstants.ts

@@ -56,6 +56,7 @@ export enum CxConstants {
     PREDICATE_TYPE = "CxPredicate",
     CODE_BASHING_TYPE = "CxCodeBashing",
     KICS_REALTIME_TYPE = "CxKicsRealTime",
+    LEARN_MORE_DESCRIPTIONS_TYPE = "CxLearnMoreDescriptions",
     BFL_TYPE = "CxBFL",
     SAST = "sast",
     LANGUAGE = "--language",
@@ -64,5 +65,8 @@ export enum CxConstants {
 
     SEVERITY_HIGH = "high",
     SEVERITY_MEDIUM = "medium",
-    STATE_CONFIRMED = "confirmed"
+    STATE_CONFIRMED = "confirmed",
+
+    CMD_UTILS = "utils",
+    CMD_LEARN_MORE = "learn-more"
 }

src/main/wrapper/CxWrapper.ts

@@ -1,13 +1,13 @@
-import { CxConfig } from "./CxConfig";
-import { CxParamType } from "./CxParamType";
-import { CxConstants } from "./CxConstants";
-import { ExecutionService } from "./ExecutionService";
-import { CxCommandOutput } from "./CxCommandOutput";
-import path = require('path');
-import { getLoggerWithFilePath, logger } from "./loggerConfig";
+import {CxConfig} from "./CxConfig";
+import {CxParamType} from "./CxParamType";
+import {CxConstants} from "./CxConstants";
+import {ExecutionService} from "./ExecutionService";
+import {CxCommandOutput} from "./CxCommandOutput";
+import {getLoggerWithFilePath, logger} from "./loggerConfig";
 import * as fs from "fs"
 import * as os from "os";
 import CxBFL from "../bfl/CxBFL";
+import path = require('path');
 
 type ParamTypeMap = Map<CxParamType, string>;
 
@@ -247,6 +247,12 @@ export class CxWrapper {
         return exec.executeKicsCommands(this.config.pathToExecutable, commands, CxConstants.KICS_REALTIME_TYPE);
     }
 
+    async learnMore(queryId: string){
+        const commands: string[] = [CxConstants.CMD_UTILS,CxConstants.CMD_LEARN_MORE,CxConstants.QUERY_ID,queryId]
+        commands.push(...this.initializeCommands(true))
+        const exec = new ExecutionService();
+        return exec.executeCommands(this.config.pathToExecutable, commands, CxConstants.LEARN_MORE_DESCRIPTIONS_TYPE);
+    }
     getIndexOfBflNode(bflNodes: CxBFL[], resultNodes: any[]): number {
 
         const bflNodeNotFound = -1;

src/main/wrapper/ExecutionService.ts

@@ -10,6 +10,7 @@ import CxCodeBashing from "../codebashing/CxCodeBashing";
 import CxBFL from "../bfl/CxBFL";
 import spawner = require('child_process');
 import CxKicsRealTime from "../kicsRealtime/CxKicsRealTime";
+import CxLearnMoreDescriptions from "../learnmore/CxLearnMoreDescriptions";
 
 
 
@@ -140,6 +141,10 @@ export class ExecutionService {
                     const kicsResults = CxKicsRealTime.parseKicsRealTimeResponse(resultObject);
                     cxCommandOutput.payload = [kicsResults];
                     break;
+              case "cxLearnMoreDescriptions":
+                  const learnMore = CxLearnMoreDescriptions.parseLearnMoreDescriptionsResponse(resultObject);
+                  cxCommandOutput.payload = [learnMore];
+                  break;
                 default:
                   cxCommandOutput.payload = resultObject;
               }

src/tests/LearnMoreDescriptions.test.ts

@@ -0,0 +1,21 @@
+import {BaseTest} from "./BaseTest";
+import {CxWrapper} from "../main/wrapper/CxWrapper";
+import {CxCommandOutput} from "../main/wrapper/CxCommandOutput";
+
+describe("LearnMoreDescriptions cases",() => {
+    const cxScanConfig = new BaseTest();
+    it('LearnMoreDescriptions Successful case', async () => {
+        const auth = new CxWrapper(cxScanConfig);
+        const queryId = process.env.CX_TEST_QUERY_ID;
+        const data = await auth.learnMore(queryId !== undefined? queryId : "10308959669028119927")
+        const cxCommandOutput: CxCommandOutput = data;
+        expect(cxCommandOutput.payload.length).toBeGreaterThan(0);
+    })
+
+    it('LearnMoreDescriptions Failure case', async () => {
+        const auth = new CxWrapper(cxScanConfig);
+        const data = await auth.learnMore("")
+        const cxCommandOutput: CxCommandOutput = data;
+        expect(cxCommandOutput.status).toBe("Value of query-id is invalid\n");
+    })
+})