detectExecuteScan - added parameter for diagnostic mode (#4937)

* detectExecuteScan - added parameter for diagnostic mode

* changed-syntax

* added-custom-output-path

* amended-directory-creation

cmd/detectExecuteScan.go

@@ -528,6 +528,21 @@ func addDetectArgs(args []string, config detectExecuteScanOptions, utils detectU
 		args = append(args, fmt.Sprintf("--detect.tools=%v", strings.Join(config.DetectTools, ",")))
 	}
 
+	if config.EnableDiagnostics {
+		args = append(args, fmt.Sprintf("\"--detect.diagnostic=true\""))
+		args = append(args, fmt.Sprintf("\"--detect.cleanup=false\""))
+
+		err := utils.MkdirAll("./blackduckDiagnostics", 0o755)
+		if err != nil {
+			return nil, errors.Wrap(err, "failed to create diagnostics directory")
+		}
+
+		log.Entry().Info("Diagnostics enabled, output will be stored in ./blackduckDiagnostics")
+
+		args = append(args, fmt.Sprintf("\"--detect.scan.output.path=./blackduckDiagnostics\""))
+		args = append(args, fmt.Sprintf("\"--detect.output.path=./blackduckDiagnostics\""))
+	}
+
 	// to exclude dependency types for npm
 	if len(config.NpmDependencyTypesExcluded) > 0 && !checkIfArgumentIsInScanProperties(config, "detect.npm.dependency.types.excluded") {
 		args = append(args, fmt.Sprintf("--detect.npm.dependency.types.excluded=%v", strings.ToUpper(strings.Join(config.NpmDependencyTypesExcluded, ","))))

resources/metadata/detectExecuteScan.yaml

@@ -266,6 +266,15 @@ spec:
           - STEPS
           - STAGES
           - PARAMETERS
+      - name: enableDiagnostics
+        type: bool
+        default: false
+        description:
+          "Parameter to enable diagnostics file generation by detect script"
+        scope:
+          - STEPS
+          - STAGES
+          - PARAMETERS
       - name: generateReportsForEmptyProjects
         type: bool
         default: false