Feature/change exit code strategy

.github/workflows/main.yml

@@ -39,3 +39,10 @@ jobs:
           CX_BASE_URI: ${{ secrets.BASE_URI }}
           PATH_TO_EXECUTABLE: /tmp/cx-linux
         run: npm test
+      - name: 'Upload Artifact'
+        uses: actions/upload-artifact@v2
+        with:
+          name: cxAST.log
+          path: cxAST.log
+          retention-days: 30
+

.gitignore

@@ -0,0 +1 @@
+node_modules

.npmignore

@@ -0,0 +1,2 @@
+src/
+dist/tests/

package.json

@@ -1,37 +1,32 @@
 {
   "name": "@CheckmarxDev/ast-cli-javascript-wrapper",
-  "version": "1.0.3",
+  "version": "0.0.15",
   "description": "AST CLI Javascript wrapper",
-  "main": "dist/CxAuthCall.js",
-  "typings": "dist/CxAuthCall.d.ts",
+  "main": "dist/CxAuth.js",
+  "typings": "dist/CxAuth.d.ts",
   "jest": {
     "verbose": true
   },
   "type": "commonjs",
   "files": [
-    "src/*",
-    "out/*",
+    "dist/main/resources/cx*",
+    "dist/main/*.ts",
+    "dist/main/*.js",
+    "dist/main/*.map",
     "babel.config.js",
     "jest.config.js",
     "jest.setup.js",
     "README.md"
   ],
   "dependencies": {
-    "@babel/plugin-proposal-class-properties": "^7.13.0",
-    "@babel/preset-env": "^7.14.2",
-    "@babel/preset-react": "^7.13.13",
-    "@babel/preset-typescript": "^7.13.0",
-    "babel-core": "^6.26.3",
-    "babel-jest": "^27.0.1",
-    "babel-polyfill": "^6.26.0",
+    "typescript-logging": "^1.0.0",
     "log4js": "6.3.0",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.3.2",
-    "typescript-logging": "^1.0.0"
+    "tslog": "3.2.0"
   },
   "scripts": {
     "build": "tsc",
-    "test": "jest"
+    "postbuild": "copyfiles -u 1 src/main/resources/cx* dist/",
+    "test": "jest -i --silent=false"
   },
   "repository": "https://github.com/CheckmarxDev/ast-cli-javascript-wrapper.git",
   "author": "Jay Nanduri",
@@ -41,9 +36,19 @@
   },
   "homepage": "https://github.com/CheckmarxDev/ast-cli-javascript-wrapper#readme",
   "devDependencies": {
+    "@babel/plugin-proposal-class-properties": "^7.13.0",
+    "@babel/preset-env": "^7.14.2",
+    "@babel/preset-react": "^7.13.13",
+    "@babel/preset-typescript": "^7.13.0",
     "@types/jest": "^26.0.23",
     "@types/node": "^15.6.1",
-    "jest": "^27.0.1",
+    "@types/regenerator-runtime": "^0.13.0",
+    "babel-core": "^6.26.3",
+    "babel-jest": "^27.0.1",
+    "babel-plugin-transform-regenerator": "^6.26.0",
+    "babel-polyfill": "^6.26.0",
+    "copyfiles": "^2.4.1",
+    "jest": "^27.0.6",
     "ts-jest": "^26.5.6"
   },
   "publishConfig": {

src/main/CxAuthCall.ts → src/main/CxAuth.ts

@@ -1,32 +1,35 @@
 import 'regenerator-runtime/runtime'
-import {CxScanConfigCall} from "./CxScanConfigCall";
+import {CxScanConfig} from "./CxScanConfig";
 import {CxParamType} from "./CxParamType";
 import {ExecutionService} from "./ExecutionService";
 import {spawn} from "child_process";
 import {CxResultType} from "./CxResultType";
+import {CxCommandOutput} from "./CxCommandOutput";
 
 type ParamTypeMap = Map<CxParamType, string>;
 
-export class CxAuthCall {
+export class CxAuth {
     baseUri: string = "";
     clientId: string = "";
     clientSecret: string = "";
     apiKey: string = "";
     commands: string[] = [];
     pathToExecutable: string;
 
-    constructor(cxScanConfig: CxScanConfigCall) {
+    constructor(cxScanConfig: CxScanConfig) {
         let path = require("path");
-        if (cxScanConfig.clientId !== null && cxScanConfig.clientSecret !== null) {
+        if (cxScanConfig.clientId !== null && cxScanConfig.clientSecret !== null && cxScanConfig.clientId !== '' && cxScanConfig.clientId !== '') {
             console.log("Received clientId and clientSecret");
             this.clientId = cxScanConfig.clientId;
             this.clientSecret = cxScanConfig.clientSecret;
         } else if (cxScanConfig.apiKey != null) {
             this.apiKey = cxScanConfig.apiKey;
         } else {
-            console.log("Did not receive ClientId/Secret or ApiKey");
+            console.log("Did not receive ClientId/Secret or ApiKey from cli arguments");
         }
         let executablePath: string;
+
+
         if (cxScanConfig.pathToExecutable !== null && cxScanConfig.pathToExecutable !== "") {
             this.pathToExecutable = cxScanConfig.pathToExecutable;
         } else if (process.platform === 'win32') {
@@ -40,26 +43,26 @@ export class CxAuthCall {
             executablePath = path.join(__dirname, '/resources/cx-linux');
             this.pathToExecutable = executablePath;
         }
-        if (cxScanConfig.baseUri !== null) {
+        if (cxScanConfig.baseUri !== null && cxScanConfig.baseUri !== '') {
             this.baseUri = cxScanConfig.baseUri;
         }
     }
 
     initializeCommands(formatRequired: boolean): string[] {
         let list: string[] = [];
-        if (this.clientId !== null && this.clientId !== "") {
+        if (this.clientId !== null && this.clientId.length > 1) {
             list.push("--client-id");
             list.push(this.clientId);
         }
-        if (this.clientSecret !== null && this.clientSecret !== "") {
+        if (this.clientSecret !== null && this.clientSecret.length > 1) {
             list.push("--client-secret");
             list.push(this.clientSecret);
         }
-        if (this.apiKey !== null && this.apiKey !== "") {
+        if (this.apiKey !== null && this.apiKey.length > 1) {
             list.push("--apikey");
             list.push(this.apiKey);
         }
-        if (this.baseUri !== null && this.baseUri !== "") {
+        if (this.baseUri !== null && this.baseUri.length > 1) {
             list.push("--base-uri");
             list.push(this.baseUri);
         }
@@ -71,18 +74,18 @@ export class CxAuthCall {
         return list;
     }
 
-    async scanCreate(params: ParamTypeMap): Promise<string> {
+    async scanCreate(params: ParamTypeMap): Promise<CxCommandOutput> {
         this.commands = this.initializeCommands(true);
         this.commands.push("scan");
         this.commands.push("create");
         params.forEach((value: string, key: CxParamType) => {
-            if (key !== CxParamType.ADDITIONAL_PARAMETERS && key.length !== 1) {
+            if (key !== CxParamType.ADDITIONAL_PARAMETERS && key.length !== 1 && value !== null && value!== undefined && value.length > 1) {
                 this.commands.push("--" + key.toString().replace(/_/g, "-").toLowerCase());
                 this.commands.push(value);
-            } else if (key.length === 1) {
+            } else if (key.length === 1 && value !== null && value!== undefined) {
                 this.commands.push("-" + key.toString().replace(/_/g, "-").toLowerCase());
                 this.commands.push(value);
-            } else {
+            } else if(key === CxParamType.ADDITIONAL_PARAMETERS) {
                 let paramList = value.match(/(?:[^\s"]+|"[^"]*")+/g);
                 console.log("Additional parameters refined: " + paramList)
                 if (paramList !== null) {
@@ -97,24 +100,25 @@ export class CxAuthCall {
         return await exec.executeCommands(this.pathToExecutable, this.commands);
     }
 
-    async scanShow(id: string): Promise<string> {
+    async scanShow(id: string): Promise<CxCommandOutput> {
         this.commands = this.initializeCommands(true);
         this.commands.push("scan");
         this.commands.push("show");
+        this.commands.push("--scan-id");
         this.commands.push(id);
         let exec = new ExecutionService();
         return await exec.executeCommands(this.pathToExecutable, this.commands);
     }
 
-    async scanList(): Promise<string> {
+    async scanList(): Promise<CxCommandOutput> {
         this.commands = this.initializeCommands(true);
         this.commands.push("scan");
         this.commands.push("list");
         let exec = new ExecutionService();
         return await exec.executeCommands(this.pathToExecutable, this.commands);
     }
 
-    async projectList(): Promise<string> {
+    async projectList(): Promise<CxCommandOutput> {
         this.commands = this.initializeCommands(true);
         this.commands.push("project");
         this.commands.push("list");

src/main/CxCommandOutput.ts

@@ -0,0 +1,6 @@
+import CxScan from "./CxScan";
+
+export class CxCommandOutput {
+    exitCode: number = 0;
+    scanObjectList: CxScan[];
+}

src/main/CxParamType.ts

@@ -1,3 +1,3 @@
 export enum CxParamType {
-    S = "S", V = "V", G = "G", PROJECT_NAME = "PROJECT_NAME", SCAN_TYPES = "SCAN_TYPES", SAST_PRESET_NAME = "SAST_PRESET_NAME", FILTER = "FILTER", DIRECTORY = "DIRECTORY", ADDITIONAL_PARAMETERS = "ADDITIONAL_PARAMETERS", AGENT = "AGENT", SOURCES = "SOURCES", TENANT = "TENANT"
+    S = "S", V = "V", G = "G", PROJECT_NAME = "PROJECT_NAME", SCAN_TYPES = "SCAN_TYPES", SAST_PRESET_NAME = "SAST_PRESET_NAME", FILTER = "FILTER", DIRECTORY = "DIRECTORY", ADDITIONAL_PARAMETERS = "ADDITIONAL_PARAMETERS", AGENT = "AGENT", SOURCES = "SOURCES", TENANT = "TENANT", BRANCH = "BRANCH"
 }

src/main/CxResultType.ts

@@ -1,3 +1,3 @@
 export enum CxResultType {
-    LIST = "list", LIST_SIMPLE = "list-simple"
+    LIST = "list", SUMMARY = "summary"
 }

src/main/CxScanConfigCall.ts → src/main/CxScanConfig.ts

@@ -1,4 +1,4 @@
-export class CxScanConfigCall {
+export class CxScanConfig {
     baseUri: string = "";
     pathToExecutable: string = "";
     clientId: string = " ";