Merge pull request #10 from blackduck-inc/SIGINT-2397

SIGINT-2397: few renaming activities and documentation changes
blackduck-inc · Oct 23, 2024 · 365db75 · 365db75
2 parents 8739e24 + 2027c77
commit 365db75
Show file tree

Hide file tree

Showing 9 changed files with 47 additions and 49 deletions.
diff --git a/blackduck-security-task/dist/index.js b/blackduck-security-task/dist/index.js
diff --git a/blackduck-security-task/dist/index.js.map b/blackduck-security-task/dist/index.js.map
diff --git a/blackduck-security-task/src/blackduck-security-task/application-constant.ts b/blackduck-security-task/src/blackduck-security-task/application-constant.ts
@@ -207,8 +207,8 @@ export const DETECT_EXECUTION_PATH_KEY_CLASSIC_EDITOR = "detectExecutionPath";
  * @deprecated Use detect_scan_full instead. This can be removed in future release.
  */
 export const BLACKDUCK_SCAN_FULL_KEY = "blackduck_scan_full";
-export const DETECT_SCAN_FULL_KEY = "detect_scan_full";
-export const DETECT_SCAN_FULL_KEY_CLASSIC_EDITOR = "detectScanFull";
+export const BLACKDUCKSCA_SCAN_FULL_KEY = "blackducksca_scan_full";
+export const BLACKDUCKSCA_SCAN_FULL_KEY_CLASSIC_EDITOR = "blackduckScaScanFull";
 /**
  * @deprecated Use blackducksca_scan_failure_severities instead. This can be removed in future release.
  */
@@ -217,7 +217,7 @@ export const BLACKDUCK_SCAN_FAILURE_SEVERITIES_KEY =
 export const BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES_KEY =
   "blackducksca_scan_failure_severities";
 export const BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES_KEY_CLASSIC_EDITOR =
-  "blackduckScaScaScanFailureSeverities";
+  "blackduckScaScanFailureSeverities";
 /**
  * @deprecated Use blackducksca_prComment_enabled instead. This can be removed in future release.
  */

diff --git a/blackduck-security-task/src/blackduck-security-task/input.ts b/blackduck-security-task/src/blackduck-security-task/input.ts
@@ -472,9 +472,9 @@ export const DETECT_EXECUTION_PATH = getPathInput(
   constants.DETECT_EXECUTION_PATH_KEY_CLASSIC_EDITOR,
   constants.BLACKDUCK_EXECUTION_PATH_KEY
 );
-export const DETECT_SCAN_FULL = getInput(
-  constants.DETECT_SCAN_FULL_KEY,
-  constants.DETECT_SCAN_FULL_KEY_CLASSIC_EDITOR,
+export const BLACKDUCKSCA_SCAN_FULL = getInput(
+  constants.BLACKDUCKSCA_SCAN_FULL_KEY,
+  constants.BLACKDUCKSCA_SCAN_FULL_KEY_CLASSIC_EDITOR,
   constants.BLACKDUCK_SCAN_FULL_KEY
 );
 export const BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES = getDelimitedInput(

diff --git a/blackduck-security-task/src/blackduck-security-task/model/blackduckSCA.ts b/blackduck-security-task/src/blackduck-security-task/model/blackduckSCA.ts
@@ -37,7 +37,6 @@ export interface BlackduckSCAData extends AsyncMode {
 }
 
 export interface BlackDuckDetect {
-  scan?: { full?: boolean };
   install?: Install;
   search?: Search;
   config?: Config;

diff --git a/blackduck-security-task/src/blackduck-security-task/tools-parameter.ts b/blackduck-security-task/src/blackduck-security-task/tools-parameter.ts
@@ -285,7 +285,22 @@ export class BridgeToolsParameter {
         directory: inputs.BLACKDUCKSCA_PROJECT_DIRECTORY,
       };
     }
-
+    if (inputs.BLACKDUCKSCA_SCAN_FULL) {
+      if (
+        inputs.BLACKDUCKSCA_SCAN_FULL.toLowerCase() === "true" ||
+        inputs.BLACKDUCKSCA_SCAN_FULL.toLowerCase() === "false"
+      ) {
+        const scanFullValue =
+          inputs.BLACKDUCKSCA_SCAN_FULL.toLowerCase() === "true";
+        blackduckData.data.blackducksca.scan = { full: scanFullValue };
+      } else {
+        throw new Error(
+          MISSING_BOOL_VALUE.concat(constants.BLACKDUCKSCA_SCAN_FULL_KEY)
+            .concat(constants.SPACE)
+            .concat(ErrorCode.MISSING_BOOLEAN_VALUE.toString())
+        );
+      }
+    }
     blackduckData.data.detect = this.setBlackDuckDetectArgs();
 
     if (failureSeverities && failureSeverities.length > 0) {
@@ -1053,22 +1068,6 @@ export class BridgeToolsParameter {
       };
     }
 
-    if (inputs.DETECT_SCAN_FULL) {
-      if (
-        inputs.DETECT_SCAN_FULL.toLowerCase() === "true" ||
-        inputs.DETECT_SCAN_FULL.toLowerCase() === "false"
-      ) {
-        const scanFullValue = inputs.DETECT_SCAN_FULL.toLowerCase() === "true";
-        blackDuckDetectInputData.data.scan = { full: scanFullValue };
-      } else {
-        throw new Error(
-          MISSING_BOOL_VALUE.concat(constants.DETECT_SCAN_FULL_KEY)
-            .concat(constants.SPACE)
-            .concat(ErrorCode.MISSING_BOOLEAN_VALUE.toString())
-        );
-      }
-    }
-
     if (
       inputs.DETECT_SEARCH_DEPTH &&
       Number.isInteger(parseInt(inputs.DETECT_SEARCH_DEPTH))

diff --git a/blackduck-security-task/task.json b/blackduck-security-task/task.json
@@ -879,7 +879,7 @@
       "groupName": "blackduckScaSarifReport"
     },
     {
-      "name": "detectScanFull",
+      "name": "blackduckScaScanFull",
       "type": "boolean",
       "label": "Full Scan",
       "defaultValue": "",

diff --git a/blackduck-security-task/test/unit/blackduck-security-task/tools-parameter.spec.ts b/blackduck-security-task/test/unit/blackduck-security-task/tools-parameter.spec.ts
@@ -851,7 +851,7 @@ describe("Bridge CLI Tools Parameter test", () => {
             Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: ''})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: ''})
             Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: ''})
-            Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: ''})
+            Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: ''})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value: ''})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_FIXPR_ENABLED', {value: ''})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_FIXPR_MAXCOUNT', {value: ''})
@@ -865,7 +865,7 @@ describe("Bridge CLI Tools Parameter test", () => {
             Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: 'https://test.com'})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: 'token'})
             Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: 'test'})
-            Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: 'true'})
+            Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: 'true'})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value : ["BLOCKER","CRITICAL","TRIVIAL"]})
 
              sandbox.stub(validator, "validateBlackduckFailureSeverities").returns(true);
@@ -1287,7 +1287,7 @@ describe("Bridge CLI Tools Parameter test", () => {
             Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: 'https://test.com'})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: 'token'})
             Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: '/test'})
-            Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: 'false'})
+            Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: 'false'})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value : ["BLOCKER","CRITICAL","TRIVIAL"]})
 
             sandbox.stub(validator, "validateBlackduckFailureSeverities").returns(false);

diff --git a/blackduck-security-task/test/unit/blackduck-security-task/validator.spec.ts b/blackduck-security-task/test/unit/blackduck-security-task/validator.spec.ts
@@ -164,7 +164,7 @@ describe("Validator test", () => {
             Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: ''})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: ''})
             Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: ''})
-            Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: true})
+            Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: true})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value: []})
 
             Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: ''})
@@ -185,7 +185,7 @@ describe("Validator test", () => {
         it('should return empty array for validateBlackDuckSCAInputs', function () {
             Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: 'server_url'})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: 'access_token'})
-            Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: true})
+            Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: true})
             Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value: ["BLOCKER","CRITICAL","TRIVIAL"]});
 
             const bdValidationErrors = validator.validateBlackDuckSCAInputs();