Add dry-run parameter

Author: tylercamp

README.md

@@ -32,6 +32,7 @@ The workflow will be set to fail if:
 | `tool-outputs-glob`        | A comma-separated list of file globs matching tool output/scan result files                              | `undefined`   | No       |
 | `wait-for-completion`      | Whether to wait for the analysis to complete before exiting                                              | `false`       | No       |
 | `ca-cert`                  | A custom CA cert to use for HTTPS connections to Code Dx                                                 | `undefined`   | No       |
+| `dry-run`                  | Whether to submit an analysis (false/undefined) or only test the connection and credentials (true)       | `undefined`   | No       |
 
 ## Sample Workflow
 

action.yml

@@ -26,6 +26,8 @@ inputs:
   ca-cert:
     description: 'a custom CA cert to use for HTTPS requests to Code Dx'
     required: false
+  dry-run:
+    description: 'whether to submit an analysis (false/undefined), or only test the connection and credentials (true). an error in validation will fail the build.'
 runs:
   using: 'node12'
   main: 'dist/index.js'

analyze.js

@@ -105,6 +105,11 @@ module.exports = async function run() {
   await client.validatePermissions(config.projectId)
   core.info("Connection to Code Dx server is OK.")
 
+  if (config.dryRun) {
+    core.info("dry-run is enabled, exiting without analysis")
+    return
+  }
+
   const formData = new FormData()
 
   core.info("Preparing source/binaries ZIP...")

config.js

@@ -1,5 +1,17 @@
 const core = require('@actions/core');
 
+function isYamlTrue(value) {
+    value = value.toLowerCase().trim()
+    return ["yes", "on", "true"].indexOf(value) >= 0
+}
+
+function fixBoolean(target, field) {
+    const value = target[field]
+    if (typeof value == 'string') {
+        target[field] = isYamlTrue(value)
+    }
+}
+
 class Config {
     constructor() {
         this.serverUrl = core.getInput('server-url', { required: true })
@@ -10,20 +22,15 @@ class Config {
 
         this.waitForCompletion = core.getInput('wait-for-completion')
         this.caCert = core.getInput('ca-cert')
+        this.dryRun = core.getInput('dry-run')
 
         // debug vars
         this.tmpDir = ""
     }
 
     sanitize() {
-        function isYamlTrue(value) {
-            value = value.toLowerCase().trim()
-            return ["yes", "on", "true"].indexOf(value) >= 0
-        }
-
-        if (typeof this.waitForCompletion == 'string') {
-            this.waitForCompletion = isYamlTrue(this.waitForCompletion)
-        }
+        fixBoolean(this, 'waitForCompletion')
+        fixBoolean(this, 'dryRun')
 
         if (typeof this.projectId != 'number') {
             try {

dist/index.js

@@ -112,6 +112,11 @@ module.exports = async function run() {
   await client.validatePermissions(config.projectId)
   core.info("Connection to Code Dx server is OK.")
 
+  if (config.dryRun) {
+    core.info("dry-run is enabled, exiting without analysis")
+    return
+  }
+
   const formData = new FormData()
 
   core.info("Preparing source/binaries ZIP...")
@@ -278,6 +283,18 @@ module.exports = CodeDxApiClient
 
 const core = __nccwpck_require__(2186);
 
+function isYamlTrue(value) {
+    value = value.toLowerCase().trim()
+    return ["yes", "on", "true"].indexOf(value) >= 0
+}
+
+function fixBoolean(target, field) {
+    const value = target[field]
+    if (typeof value == 'string') {
+        target[field] = isYamlTrue(value)
+    }
+}
+
 class Config {
     constructor() {
         this.serverUrl = core.getInput('server-url', { required: true })
@@ -288,20 +305,15 @@ class Config {
 
         this.waitForCompletion = core.getInput('wait-for-completion')
         this.caCert = core.getInput('ca-cert')
+        this.dryRun = core.getInput('dry-run')
 
         // debug vars
         this.tmpDir = ""
     }
 
     sanitize() {
-        function isYamlTrue(value) {
-            value = value.toLowerCase().trim()
-            return ["yes", "on", "true"].indexOf(value) >= 0
-        }
-
-        if (typeof this.waitForCompletion == 'string') {
-            this.waitForCompletion = isYamlTrue(this.waitForCompletion)
-        }
+        fixBoolean(this, 'waitForCompletion')
+        fixBoolean(this, 'dryRun')
 
         if (typeof this.projectId != 'number') {
             try {