Skip to content

Commit 2027c77

Browse files
SIGINT-2397: few renaming activities and documentation changes
1 parent 8739e24 commit 2027c77

File tree

9 files changed

+47
-49
lines changed

9 files changed

+47
-49
lines changed

blackduck-security-task/dist/index.js

+18-18
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

blackduck-security-task/dist/index.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

blackduck-security-task/src/blackduck-security-task/application-constant.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,8 @@ export const DETECT_EXECUTION_PATH_KEY_CLASSIC_EDITOR = "detectExecutionPath";
207207
* @deprecated Use detect_scan_full instead. This can be removed in future release.
208208
*/
209209
export const BLACKDUCK_SCAN_FULL_KEY = "blackduck_scan_full";
210-
export const DETECT_SCAN_FULL_KEY = "detect_scan_full";
211-
export const DETECT_SCAN_FULL_KEY_CLASSIC_EDITOR = "detectScanFull";
210+
export const BLACKDUCKSCA_SCAN_FULL_KEY = "blackducksca_scan_full";
211+
export const BLACKDUCKSCA_SCAN_FULL_KEY_CLASSIC_EDITOR = "blackduckScaScanFull";
212212
/**
213213
* @deprecated Use blackducksca_scan_failure_severities instead. This can be removed in future release.
214214
*/
@@ -217,7 +217,7 @@ export const BLACKDUCK_SCAN_FAILURE_SEVERITIES_KEY =
217217
export const BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES_KEY =
218218
"blackducksca_scan_failure_severities";
219219
export const BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES_KEY_CLASSIC_EDITOR =
220-
"blackduckScaScaScanFailureSeverities";
220+
"blackduckScaScanFailureSeverities";
221221
/**
222222
* @deprecated Use blackducksca_prComment_enabled instead. This can be removed in future release.
223223
*/

blackduck-security-task/src/blackduck-security-task/input.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -472,9 +472,9 @@ export const DETECT_EXECUTION_PATH = getPathInput(
472472
constants.DETECT_EXECUTION_PATH_KEY_CLASSIC_EDITOR,
473473
constants.BLACKDUCK_EXECUTION_PATH_KEY
474474
);
475-
export const DETECT_SCAN_FULL = getInput(
476-
constants.DETECT_SCAN_FULL_KEY,
477-
constants.DETECT_SCAN_FULL_KEY_CLASSIC_EDITOR,
475+
export const BLACKDUCKSCA_SCAN_FULL = getInput(
476+
constants.BLACKDUCKSCA_SCAN_FULL_KEY,
477+
constants.BLACKDUCKSCA_SCAN_FULL_KEY_CLASSIC_EDITOR,
478478
constants.BLACKDUCK_SCAN_FULL_KEY
479479
);
480480
export const BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES = getDelimitedInput(

blackduck-security-task/src/blackduck-security-task/model/blackduckSCA.ts

-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@ export interface BlackduckSCAData extends AsyncMode {
3737
}
3838

3939
export interface BlackDuckDetect {
40-
scan?: { full?: boolean };
4140
install?: Install;
4241
search?: Search;
4342
config?: Config;

blackduck-security-task/src/blackduck-security-task/tools-parameter.ts

+16-17
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,22 @@ export class BridgeToolsParameter {
285285
directory: inputs.BLACKDUCKSCA_PROJECT_DIRECTORY,
286286
};
287287
}
288-
288+
if (inputs.BLACKDUCKSCA_SCAN_FULL) {
289+
if (
290+
inputs.BLACKDUCKSCA_SCAN_FULL.toLowerCase() === "true" ||
291+
inputs.BLACKDUCKSCA_SCAN_FULL.toLowerCase() === "false"
292+
) {
293+
const scanFullValue =
294+
inputs.BLACKDUCKSCA_SCAN_FULL.toLowerCase() === "true";
295+
blackduckData.data.blackducksca.scan = { full: scanFullValue };
296+
} else {
297+
throw new Error(
298+
MISSING_BOOL_VALUE.concat(constants.BLACKDUCKSCA_SCAN_FULL_KEY)
299+
.concat(constants.SPACE)
300+
.concat(ErrorCode.MISSING_BOOLEAN_VALUE.toString())
301+
);
302+
}
303+
}
289304
blackduckData.data.detect = this.setBlackDuckDetectArgs();
290305

291306
if (failureSeverities && failureSeverities.length > 0) {
@@ -1053,22 +1068,6 @@ export class BridgeToolsParameter {
10531068
};
10541069
}
10551070

1056-
if (inputs.DETECT_SCAN_FULL) {
1057-
if (
1058-
inputs.DETECT_SCAN_FULL.toLowerCase() === "true" ||
1059-
inputs.DETECT_SCAN_FULL.toLowerCase() === "false"
1060-
) {
1061-
const scanFullValue = inputs.DETECT_SCAN_FULL.toLowerCase() === "true";
1062-
blackDuckDetectInputData.data.scan = { full: scanFullValue };
1063-
} else {
1064-
throw new Error(
1065-
MISSING_BOOL_VALUE.concat(constants.DETECT_SCAN_FULL_KEY)
1066-
.concat(constants.SPACE)
1067-
.concat(ErrorCode.MISSING_BOOLEAN_VALUE.toString())
1068-
);
1069-
}
1070-
}
1071-
10721071
if (
10731072
inputs.DETECT_SEARCH_DEPTH &&
10741073
Number.isInteger(parseInt(inputs.DETECT_SEARCH_DEPTH))

blackduck-security-task/task.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -879,7 +879,7 @@
879879
"groupName": "blackduckScaSarifReport"
880880
},
881881
{
882-
"name": "detectScanFull",
882+
"name": "blackduckScaScanFull",
883883
"type": "boolean",
884884
"label": "Full Scan",
885885
"defaultValue": "",

blackduck-security-task/test/unit/blackduck-security-task/tools-parameter.spec.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -851,7 +851,7 @@ describe("Bridge CLI Tools Parameter test", () => {
851851
Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: ''})
852852
Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: ''})
853853
Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: ''})
854-
Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: ''})
854+
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: ''})
855855
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value: ''})
856856
Object.defineProperty(inputs, 'BLACKDUCKSCA_FIXPR_ENABLED', {value: ''})
857857
Object.defineProperty(inputs, 'BLACKDUCKSCA_FIXPR_MAXCOUNT', {value: ''})
@@ -865,7 +865,7 @@ describe("Bridge CLI Tools Parameter test", () => {
865865
Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: 'https://test.com'})
866866
Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: 'token'})
867867
Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: 'test'})
868-
Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: 'true'})
868+
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: 'true'})
869869
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value : ["BLOCKER","CRITICAL","TRIVIAL"]})
870870

871871
sandbox.stub(validator, "validateBlackduckFailureSeverities").returns(true);
@@ -1287,7 +1287,7 @@ describe("Bridge CLI Tools Parameter test", () => {
12871287
Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: 'https://test.com'})
12881288
Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: 'token'})
12891289
Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: '/test'})
1290-
Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: 'false'})
1290+
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: 'false'})
12911291
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value : ["BLOCKER","CRITICAL","TRIVIAL"]})
12921292

12931293
sandbox.stub(validator, "validateBlackduckFailureSeverities").returns(false);

blackduck-security-task/test/unit/blackduck-security-task/validator.spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ describe("Validator test", () => {
164164
Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: ''})
165165
Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: ''})
166166
Object.defineProperty(inputs, 'DETECT_INSTALL_DIRECTORY', {value: ''})
167-
Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: true})
167+
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: true})
168168
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value: []})
169169

170170
Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: ''})
@@ -185,7 +185,7 @@ describe("Validator test", () => {
185185
it('should return empty array for validateBlackDuckSCAInputs', function () {
186186
Object.defineProperty(inputs, 'BLACKDUCKSCA_URL', {value: 'server_url'})
187187
Object.defineProperty(inputs, 'BLACKDUCKSCA_API_TOKEN', {value: 'access_token'})
188-
Object.defineProperty(inputs, 'DETECT_SCAN_FULL', {value: true})
188+
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FULL', {value: true})
189189
Object.defineProperty(inputs, 'BLACKDUCKSCA_SCAN_FAILURE_SEVERITIES', {value: ["BLOCKER","CRITICAL","TRIVIAL"]});
190190

191191
const bdValidationErrors = validator.validateBlackDuckSCAInputs();

0 commit comments

Comments
 (0)