refactor: extract scanner into class

Author: tembleking

dist/index.js

@@ -1,7 +1,7 @@
 import * as core from '@actions/core';
 import fs from 'fs';
 import { generateSARIFReport } from './src/sarif';
-import { cliScannerName, cliScannerResult, cliScannerURL, executeScan, numericPriorityForSeverity, pullScanner, ScanExecutionResult, ScanMode } from './src/scanner';
+import { cliScannerName, cliScannerResult, defaultScannerURL, executeScan, numericPriorityForSeverity, ScanExecutionResult, ScanMode, Scanner } from './src/scanner';
 import { ActionInputs, defaultSecureEndpoint } from './src/action';
 import { generateSummary } from './src/summary';
 import { Report } from './src/report';
@@ -25,8 +25,12 @@ export async function run() {
     let scanFlags = opts.composeFlags();
 
     let scanResult: ScanExecutionResult;
+
+    let scanner = new Scanner(
+      Scanner.Options.withScannerURL(opts.cliScannerURL),
+    );
     // Download CLI Scanner from 'cliScannerURL'
-    let retCode = await pullScanner(opts.cliScannerURL);
+    let retCode = await scanner.pullScanner();
     if (retCode == 0) {
       // Execute Scanner
       scanResult = await executeScan(scanFlags);
@@ -103,9 +107,8 @@ export async function processScanResult(result: ScanExecutionResult, opts: Actio
 }
 
 export {
-  cliScannerURL,
+  defaultScannerURL as cliScannerURL,
   defaultSecureEndpoint,
-  pullScanner,
   cliScannerName,
   executeScan,
   cliScannerResult,

dist/index.js.map

@@ -1,5 +1,5 @@
 import * as core from '@actions/core';
-import { cliScannerResult, cliScannerURL, ComposeFlags, ScanMode, scannerURLForVersion } from './scanner';
+import { cliScannerResult, defaultScannerURL, ComposeFlags, ScanMode, scannerURLForVersion } from './scanner';
 
 export const defaultSecureEndpoint = "https://secure.sysdig.com/"
 
@@ -54,7 +54,7 @@ export class ActionInputs {
   static overridingParsedActionInputs(overrides: { [key: string]: any }) {
 
     const params: ActionInputParameters = {
-      cliScannerURL: core.getInput('cli-scanner-url') || cliScannerURL,
+      cliScannerURL: core.getInput('cli-scanner-url') || defaultScannerURL,
       cliScannerVersion: core.getInput('cli-scanner-version'),
       registryUser: core.getInput('registry-user'),
       registryPassword: core.getInput('registry-password'),
@@ -147,7 +147,7 @@ export class ActionInputs {
 
   // FIXME(fede) this also modifies the opts.cliScannerURL, which is something we don't want
   public composeFlags(): ComposeFlags {
-    if (this.params.cliScannerVersion && this.params.cliScannerURL == cliScannerURL) {
+    if (this.params.cliScannerVersion && this.params.cliScannerURL == defaultScannerURL) {
       this.params.cliScannerURL = scannerURLForVersion(this.params.cliScannerVersion)
     }
 

index.ts

@@ -10,7 +10,7 @@ const cliScannerArch = getRunArch()
 const cliScannerURLBase = "https://download.sysdig.com/scanning/bin/sysdig-cli-scanner";
 export const cliScannerName = "sysdig-cli-scanner"
 export const cliScannerResult = "scan-result.json"
-export const cliScannerURL = `${cliScannerURLBase}/${cliScannerVersion}/${cliScannerOS}/${cliScannerArch}/${cliScannerName}`
+export const defaultScannerURL = `${cliScannerURLBase}/${cliScannerVersion}/${cliScannerOS}/${cliScannerArch}/${cliScannerName}`
 
 export enum ScanMode {
   vm = "vm",
@@ -28,21 +28,40 @@ export namespace ScanMode {
   }
 }
 
-export async function pullScanner(scannerURL: string) {
-  let start = performance.now();
-  core.info('Pulling cli-scanner from: ' + scannerURL);
-  let cmd = `wget ${scannerURL} -O ./${cliScannerName}`;
-  let retCode = await exec.exec(cmd, undefined, { silent: true });
-
-  if (retCode == 0) {
-    cmd = `chmod u+x ./${cliScannerName}`;
-    await exec.exec(cmd, undefined, { silent: true });
-  } else {
-    core.error(`Falied to pull scanner using "${scannerURL}"`)
+type ScannerOption = (scanner: Scanner) => void;
+
+export class Scanner {
+  protected scannerURL: string;
+
+  constructor(...options: ScannerOption[]) {
+    this.scannerURL = defaultScannerURL;
+    options.forEach(o => o(this));
+  }
+
+  async pullScanner() {
+    let start = performance.now();
+    core.info('Pulling cli-scanner from: ' + this.scannerURL);
+    let cmd = `wget ${this.scannerURL} -O ./${cliScannerName}`;
+    let retCode = await exec.exec(cmd, undefined, { silent: true });
+
+    if (retCode == 0) {
+      cmd = `chmod u+x ./${cliScannerName}`;
+      await exec.exec(cmd, undefined, { silent: true });
+    } else {
+      core.error(`Falied to pull scanner using "${this.scannerURL}"`)
+    }
+
+    core.info("Scanner pull took " + Math.round(performance.now() - start) + " milliseconds.");
+    return retCode;
   }
 
-  core.info("Scanner pull took " + Math.round(performance.now() - start) + " milliseconds.");
-  return retCode;
+  static Options = class {
+    static withScannerURL(scannerURL: string): ScannerOption {
+      return (scanner) => {
+        scanner.scannerURL = scannerURL
+      }
+    }
+  }
 }
 
 export interface ScanExecutionResult {

src/action.ts

@@ -7,6 +7,7 @@ import * as report_test from "./fixtures/report-test.json";
 
 import { exec } from "@actions/exec";
 import { ActionInputs } from '../src/action';
+import { Scanner } from '../src/scanner';
 jest.mock("@actions/exec");
 const mockExec = jest.mocked(exec);
 
@@ -207,7 +208,11 @@ describe("scanner pulling", () => {
   it("pulls the configured scanner", async () => {
     mockExec.mockImplementation(jest.fn());
 
-    await index.pullScanner("https://foo");
+    let scanner = new Scanner(
+      Scanner.Options.withScannerURL("https://foo"),
+    );
+
+    await scanner.pullScanner();
     expect(mockExec).toHaveBeenCalledTimes(1);
     expect(mockExec.mock.calls[0][0]).toMatch(`wget https://foo -O ./${index.cliScannerName}`);
   });