Merge pull request #607 from Checkmarx/other/benalvo/update-azure-wit…

…h-runtime-wrapper-1 Azure Plugin | Update Azure Plugin to use JS-Wrapper-Runtime-CLI (AST-64802)
Checkmarx · Oct 8, 2024 · 738a8c8 · 738a8c8
2 parents 48bb188 + 2a02415
commit 738a8c8
Show file tree

Hide file tree

Showing 10 changed files with 1,468 additions and 50 deletions.
diff --git a/cxAstScan/package-lock.json b/cxAstScan/package-lock.json
diff --git a/cxAstScan/package.json b/cxAstScan/package.json
@@ -1,6 +1,6 @@
 {
   "dependencies": {
     "azure-pipelines-task-lib": "4.10.1",
-    "@checkmarxdev/ast-cli-javascript-wrapper": "v0.0.113-azure.0"
+    "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli": "1.0.2"
   }
 }
diff --git a/cxAstScan/services/CleanUpRunner.ts b/cxAstScan/services/CleanUpRunner.ts
@@ -1,9 +1,11 @@
 import * as taskLib from "azure-pipelines-task-lib/task";
 import {promises as fs} from 'fs';
-import {CxWrapper} from "@checkmarxdev/ast-cli-javascript-wrapper";
-import { getConfiguration, getLogFilename } from "./Utils";
+import {getConfiguration, getLogFilename} from "./Utils";
+import CxWrapperFactory from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/dist/main/wrapper/CxWrapperFactory";
 
 export class CleanUpRunner {
+    cxWrapperFactory= new CxWrapperFactory();
+
     async run() {
         console.log("Getting job status");
         const jobStatus = taskLib.getVariable('AGENT_JOBSTATUS');
@@ -15,16 +17,16 @@ export class CleanUpRunner {
         }
 
         const cxScanConfig = getConfiguration();
-        const wrapper = new CxWrapper(cxScanConfig);
+        const wrapper = await this.cxWrapperFactory.createWrapper(cxScanConfig);
         let data: string;
 
         try {
             data = await fs.readFile(getLogFilename(), 'utf8')
         } catch (err: any) {
-            if(err.code === 'ENOENT') {
+            if (err.code === 'ENOENT') {
                 console.log("Log file not created. Task ended successfully")
                 taskLib.setResult(taskLib.TaskResult.Succeeded, "");
-            } else if ( err.code === 'EACCES') {
+            } else if (err.code === 'EACCES') {
                 console.log('No permissions to read log file')
                 taskLib.setResult(taskLib.TaskResult.Failed, "")
             } else {
@@ -57,9 +59,9 @@ export class CleanUpRunner {
         try {
             fs.unlink(getLogFilename())
             //file removed
-          } catch(err) {
+        } catch (err) {
             console.log("Unable to delete log file.", err)
-          }
+        }
 
     }
 

diff --git a/cxAstScan/services/TaskRunner.ts b/cxAstScan/services/TaskRunner.ts
@@ -1,12 +1,14 @@
 import * as taskLib from "azure-pipelines-task-lib/task";
 import * as path from "path"
-import {CxWrapper} from "@checkmarxdev/ast-cli-javascript-wrapper";
-import {CxCommandOutput} from "@checkmarxdev/ast-cli-javascript-wrapper/dist/main/wrapper/CxCommandOutput";
-import {CxParamType} from "@checkmarxdev/ast-cli-javascript-wrapper/dist/main/wrapper/CxParamType";
-import CxScan from "@checkmarxdev/ast-cli-javascript-wrapper/dist/main/scan/CxScan";
+import {CxWrapper} from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli";
+import {CxCommandOutput} from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/dist/main/wrapper/CxCommandOutput";
+import {CxParamType} from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/dist/main/wrapper/CxParamType";
+import CxScan from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/dist/main/scan/CxScan";
 import {getConfiguration, getLogFilename} from "./Utils";
+import CxWrapperFactory from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/dist/main/wrapper/CxWrapperFactory";
 
 export class TaskRunner {
+    cxWrapperFactory= new CxWrapperFactory();   
 
     async run() {
         const cxScanConfig = getConfiguration();
@@ -31,7 +33,7 @@ export class TaskRunner {
         try {
             //Write to file to test if possible to read from file in cleanup post execution event
 
-            const wrapper = new CxWrapper(cxScanConfig, getLogFilename());
+            const wrapper = await this.cxWrapperFactory.createWrapper(cxScanConfig, getLogFilename());
 
             const cxCommandOutput: CxCommandOutput = await wrapper.scanCreate(params);
 

diff --git a/cxAstScan/services/Utils.ts b/cxAstScan/services/Utils.ts
@@ -1,5 +1,5 @@
 import * as taskLib from "azure-pipelines-task-lib/task";
-import { CxConfig } from "@checkmarxdev/ast-cli-javascript-wrapper/dist/main/wrapper/CxConfig";
+import { CxConfig } from "@checkmarxdev/ast-cli-javascript-wrapper-runtime-cli/dist/main/wrapper/CxConfig";
 import * as path from "path"
 
 export function getLogFilename(): string {

diff --git a/cxAstScan/task.json b/cxAstScan/task.json
@@ -67,12 +67,12 @@
     }
   ],
   "execution": {
-    "Node10": {
+    "Node16": {
       "target": "./dist/index.js"
     }
   },
   "postjobexecution": {
-    "Node10": {
+    "Node16": {
       "target": "./dist/cleanup.js"
     }
   },

diff --git a/cxAstScan/test/_suite.ts b/cxAstScan/test/_suite.ts
@@ -2,15 +2,15 @@ import * as path from 'path';
 import * as ttm from 'azure-pipelines-task-lib/mock-test';
 import * as assert from 'assert';
 
-
+const nodeVersion = 16;
 describe('Task runner test', function () {
 
 
     it('should be success with api key', function (done) {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'success_api_key.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
 
         console.log(tr.stdout)
         console.log(tr.stderr)
@@ -22,7 +22,7 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'success_waitmode.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
 
         console.log(tr.stdout)
         console.log(tr.stderr)
@@ -34,7 +34,7 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'success_nowait.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
 
         console.log(tr.stdout)
         console.log(tr.stderr)
@@ -46,7 +46,7 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'failure_additional_params.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
         console.log(tr.stdout)
         console.log(tr.stderr)
         assert.ok(tr.failed);
@@ -57,7 +57,7 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'failure_wrong_preset.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
 
         console.log(tr.stdout)
         console.log(tr.stderr)
@@ -69,7 +69,7 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'success_no_cancel.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run();
+        tr.run(nodeVersion);
         console.log(tr.succeeded);
         assert.strictEqual(tr.succeeded, true, 'should have succeeded');
         console.log(tr.stdout);
@@ -83,14 +83,14 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const scan = path.join(__dirname, 'success_nowait.js');
         const scanTestRunner: ttm.MockTestRunner = new ttm.MockTestRunner(scan);
-        scanTestRunner.run(10);
+        scanTestRunner.run(nodeVersion);
         console.log(scanTestRunner.stdout)
         console.log(scanTestRunner.stderr)
         assert.ok(scanTestRunner.succeeded);
 
         const tp = path.join(__dirname, 'success_cancel.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
         console.log(tr.stdout);
         assert.strictEqual(tr.stdout.indexOf('Canceling scan with ID') >= 0, 
         true, 
@@ -102,7 +102,7 @@ describe('Task runner test', function () {
         this.timeout(3000000);
         const tp = path.join(__dirname, 'success_cancel.js');
         const tr: ttm.MockTestRunner = new ttm.MockTestRunner(tp);
-        tr.run(10);
+        tr.run(nodeVersion);
         console.log(tr.stdout);
         assert.strictEqual(tr.stdout.indexOf('Log file not created. Task ended successfully') >= 0,
         true, 

diff --git a/cxAstScan/tsconfig.json b/cxAstScan/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es6",
+    "target": "ES2015",
     "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     "outDir": "./dist" /* Redirect output structure to the directory. */,
 
@@ -14,6 +14,12 @@
 
     /* Source Map Options */
     "inlineSourceMap": true /* Emit a single file with source maps instead of having a separate file. */,
-    "inlineSources": true /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+    "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+    "declaration": true,
+    "removeComments": false,
+    "forceConsistentCasingInFileNames": true,
+    "noUnusedLocals": true,
+    "pretty": true,
+    "allowSyntheticDefaultImports": true
   }
 }
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "main": "index.js",
   "repository": "https://github.com/checkmarx/ast-azure-plugin",
   "engines": {
-    "node": ">=10"
+    "node": ">=16"
   },
   "scripts": {
     "build": "tsc -b cxAstScan/tsconfig.json && tsc -b ui/enhancer/tsconfig.json",