snyk 1.1191.0 → 1.1192.0

package/dist/cli/784.index.js

@@ -4712,31 +4712,19 @@ const chalk_1 = __webpack_require__(32589);
 const debugLib = __webpack_require__(15158);
 const code_config_1 = __webpack_require__(55203);
 const debug = debugLib('snyk-code');
+/**
+ * Bootstrap and trigger a Code test, then return the results.
+ */
 async function getCodeTestResults(root, options, sastSettings, requestId) {
     await spinner_1.spinner.clearAll();
     utils_1.analysisProgressUpdate();
-    const codeAnalysis = await getCodeAnalysis(root, options, sastSettings, requestId);
-    spinner_1.spinner.clearAll();
-    if (!codeAnalysis) {
-        return null;
-    }
-    return {
-        reportResults: codeAnalysis.reportResults,
-        analysisResults: codeAnalysis.analysisResults,
-    };
-}
-exports.getCodeTestResults = getCodeTestResults;
-async function getCodeAnalysis(root, options, sastSettings, requestId) {
-    var _a, _b;
     const isLocalCodeEngineEnabled = isLocalCodeEngine(sastSettings);
     if (isLocalCodeEngineEnabled) {
         validateLocalCodeEngineUrl(sastSettings.localCodeEngine.url);
     }
-    const source = 'snyk-cli';
     const baseURL = isLocalCodeEngineEnabled
         ? sastSettings.localCodeEngine.url
         : code_config_1.getCodeClientProxyUrl();
-    const org = sastSettings.org;
     // TODO(james) This mirrors the implementation in request.ts and we need to use this for deeproxy calls
     // This ensures we support lowercase http(s)_proxy values as well
     // The weird IF around it ensures we don't create an envvar with
@@ -4754,46 +4742,100 @@ async function getCodeAnalysis(root, options, sastSettings, requestId) {
             environmentVariableNamespace: '',
         });
     }
-    const sessionToken = api_token_1.getAuthHeader();
-    const severity = options.severityThreshold
-        ? severityToAnalysisSeverity(options.severityThreshold)
-        : code_client_1.AnalysisSeverity.info;
-    const result = await code_client_1.analyzeFolders({
-        connection: {
+    const analysisArgs = {
+        options,
+        fileOptions: {
+            paths: [root],
+        },
+        connectionOptions: {
             baseURL,
-            sessionToken,
-            source,
+            sessionToken: api_token_1.getAuthHeader(),
+            source: 'snyk-cli',
             requestId,
-            org,
+            org: sastSettings.org,
+        },
+        analysisOptions: {
+            severity: options.severityThreshold
+                ? severityToAnalysisSeverity(options.severityThreshold)
+                : code_client_1.AnalysisSeverity.info,
+        },
+        supportedLanguages: sastSettings.supportedLanguages,
+    };
+    const codeAnalysis = await getCodeAnalysis(analysisArgs);
+    spinner_1.spinner.clearAll();
+    if (!codeAnalysis) {
+        return null;
+    }
+    return {
+        reportResults: codeAnalysis.reportResults,
+        analysisResults: codeAnalysis.analysisResults,
+    };
+}
+exports.getCodeTestResults = getCodeTestResults;
+/**
+ * Performs Code analysis and returns normalised results.
+ * Analysis method (i.e. file-based or SCM) is chosen based on flow options.
+ */
+async function getCodeAnalysis(args) {
+    var _a, _b;
+    const { options, fileOptions, analysisOptions, connectionOptions, supportedLanguages, } = args;
+    const analysisContext = {
+        initiator: 'CLI',
+        flow: connectionOptions.source,
+        projectName: config_1.default.PROJECT_NAME,
+        project: {
+            name: options['project-name'] || config_1.default.PROJECT_NAME || 'unknown',
+            publicId: options['project-id'] || 'unknown',
+            type: 'sast',
         },
-        analysisOptions: { severity },
-        fileOptions: { paths: [root] },
-        ...(options.report && {
+        org: {
+            name: connectionOptions.org || 'unknown',
+            displayName: 'unknown',
+            publicId: 'unknown',
+            flags: {},
+        },
+    };
+    let result = null;
+    // When the "report" arg is provided the test results are published on the platform.
+    const isReportFlow = (_a = options.report) !== null && _a !== void 0 ? _a : false;
+    // We differentiate between file-based reporting flows
+    // and SCM-based ones by looking at the "project-id" arg.
+    const isScmReportFlow = isReportFlow && options['project-id'];
+    if (isScmReportFlow) {
+        // Run an SCM analysis test with reporting.
+        result = await code_client_1.analyzeScmProject({
+            connection: connectionOptions,
+            analysisOptions,
             reportOptions: {
-                enabled: (_a = options.report) !== null && _a !== void 0 ? _a : false,
-                projectName: options['project-name'],
-                targetName: options['target-name'],
-                targetRef: options['target-reference'],
-                remoteRepoUrl: options['remote-repo-url'],
+                projectId: options['project-id'],
+                commitId: options['commit-id'],
             },
-        }),
-        analysisContext: {
-            initiator: 'CLI',
-            flow: source,
-            projectName: config_1.default.PROJECT_NAME,
-            org: {
-                name: sastSettings.org || 'unknown',
-                displayName: 'unknown',
-                publicId: 'unknown',
-                flags: {},
-            },
-        },
-        languages: sastSettings.supportedLanguages,
-    });
-    if ((_b = result === null || result === void 0 ? void 0 : result.fileBundle.skippedOversizedFiles) === null || _b === void 0 ? void 0 : _b.length) {
-        debug('\n', chalk_1.default.yellow(`Warning!\nFiles were skipped in the analysis due to their size being greater than ${code_client_1.MAX_FILE_SIZE}B. Skipped files: ${[
-            ...result.fileBundle.skippedOversizedFiles,
-        ].join(', ')}`));
+            analysisContext,
+        });
+    }
+    else {
+        // Run a file-based test, optionally with reporting.
+        result = await code_client_1.analyzeFolders({
+            connection: connectionOptions,
+            analysisOptions,
+            fileOptions,
+            ...(isReportFlow && {
+                reportOptions: {
+                    enabled: true,
+                    projectName: options['project-name'],
+                    targetName: options['target-name'],
+                    targetRef: options['target-reference'],
+                    remoteRepoUrl: options['remote-repo-url'],
+                },
+            }),
+            analysisContext,
+            languages: supportedLanguages,
+        });
+        if ((_b = result === null || result === void 0 ? void 0 : result.fileBundle.skippedOversizedFiles) === null || _b === void 0 ? void 0 : _b.length) {
+            debug('\n', chalk_1.default.yellow(`Warning!\nFiles were skipped in the analysis due to their size being greater than ${code_client_1.MAX_FILE_SIZE}B. Skipped files: ${[
+                ...result.fileBundle.skippedOversizedFiles,
+            ].join(', ')}`));
+        }
     }
     if (!result || result.analysisResults.type !== 'sarif') {
         return null;