BST-12445: add main branch scan timeout (#12)

* add main branch scan timeout * fixup replace test scanner
boostsecurityio · Sep 18, 2024 · cab4482 · cab4482
1 parent d9c8552
commit cab4482
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -87,10 +87,18 @@ Optional path within the git repository to execute scanners in.
 
 When this parameter is specified, you must also provide a `scan_label` to identify the component.
 
-### `scanTimeout` (Optional, number)
+### `scanTimeout` (Optional, number) deprecated
 
 The optional timeout after which the Github check will be marked as failed. This defaults to 120 seconds.
 
+### `scanDiffTimeout` (Optional, number)
+
+The optional timeout for non-main scans after which the Github check will be marked as failed. This defaults to 120 seconds.
+
+### `scanMainTimeout` (Optional, number)
+
+The optional timeout for main scans after which the Github check will be marked as failed. This defaults to 2 hours.
+
 ### `workingDirectory` (Optional, string)
 
 Optional path to change into before executing any commands.

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -70,7 +70,7 @@ stages:
           - task: BoostSecurityScanDev@1
             inputs:
               apiToken: $(api_token)
-              registryModule: boostsecurityio/native-scanner
+              registryModule: boostsecurityio/scanner
   - stage: PackageProd
     condition: eq(variables.isMain, 'true')
     dependsOn: Test
@@ -116,5 +116,5 @@ stages:
           - task: BoostSecurityScan@1
             inputs:
               apiToken: $(api_token)
-              registryModule: boostsecurityio/native-scanner
+              registryModule: boostsecurityio/scanner
 
diff --git a/source/src/params.ts b/source/src/params.ts
@@ -30,7 +30,9 @@ const BoostParamEnvMap: BoostParamEnvMap = {
   scanLabel: "BOOST_SCAN_LABEL",
   scannerId: "BOOST_SCANNER_ID",
   scanPath: "BOOST_SCAN_PATH",
-  scanTimeout: "BOOST_DIFF_SCAN_TIMEOUT",
+  scanTimeout: "BOOST_DIFF_SCAN_TIMEOUT", // deprecated
+  scanDiffTimeout: "BOOST_DIFF_SCAN_TIMEOUT",
+  scanMainTimeout: "BOOST_MAIN_SCAN_TIMEOUT",
   tmpDir: "BOOST_TMP_DIR",
   workingDirectory: "BOOST_WORKING_DIRECTORY",
 }
@@ -54,7 +56,9 @@ class BoostParamsVars {
   scanLabel: string | undefined = ""
   scannerId: string | undefined = ""
   scanPath: string | undefined = ""
-  scanTimeout: string | undefined = ""
+  scanTimeout: string | undefined = "" // deprecated
+  scanDiffTimeout: string | undefined = ""
+  scanMainTimeout: string | undefined = ""
   tmpDir: string = ""
   workingDirectory: string | undefined = ""
 }
@@ -65,6 +69,13 @@ export class BoostParams extends BoostParamsVars {
     this.loadInputs(tl)
     this.loadEnv(env)
     this.loadDefaults(env)
+
+    if (this.scanTimeout !== undefined) {
+      if (this.scanDiffTimeout === undefined) {
+        this.scanDiffTimeout = this.scanTimeout
+        this.scanTimeout = undefined
+      }
+    }
   }
 
   public asBoostEnv(): Record<string, string> {
@@ -107,6 +118,8 @@ export class BoostParams extends BoostParamsVars {
     this.scannerId = tl.getInput("scannerId")
     this.scanPath = tl.getInput("scanPath")
     this.scanTimeout = tl.getInput("scanTimeout")
+    this.scanDiffTimeout = tl.getInput("scanDiffTimeout")
+    this.scanMainTimeout = tl.getInput("scanMainTimeout")
     this.workingDirectory = tl.getInput("workingDirectory")
   }
 

diff --git a/source/tests/params.ts b/source/tests/params.ts
@@ -62,6 +62,8 @@ describe("BoostParams", () => {
     ["BOOST_SCANNER_ID", "scannerId"],
     ["BOOST_SCAN_PATH", "scanPath"],
     ["BOOST_DIFF_SCAN_TIMEOUT", "scanTimeout"],
+    ["BOOST_DIFF_SCAN_TIMEOUT", "scanDiffTimeout"],
+    ["BOOST_MAIN_SCAN_TIMEOUT", "scanMainTimeout"],
     ["BOOST_WORKING_DIRECTORY", "workingDirectory"],
   ]