Merge pull request #515 from adityasharad/analyze/summary-logging

Analyze: Improve log grouping and log the analysis summary in its own group

Author: adityasharad

CHANGELOG.md

@@ -3,3 +3,4 @@
 ## [UNRELEASED]
 
 - Add this changelog file. [#507](https://github.com/github/codeql-action/pull/507)
+- Improve grouping of analysis logs. Add a new log group containing a summary of metrics and diagnostics, if they were produced by CodeQL builtin queries. [#515](https://github.com/github/codeql-action/pull/515)

lib/analyze.js

@@ -76,6 +76,7 @@ test("status report fields and search path setting", async (t) => {
             })
           );
           searchPathsUsed.push(searchPath!);
+          return "";
         },
       });
 

lib/analyze.js.map

@@ -169,15 +169,17 @@ export async function runQueries(
     }
 
     try {
+      let analysisSummary = "";
       if (queries["builtin"].length > 0) {
         const startTimeBuliltIn = new Date().getTime();
-        const sarifFile = await runQueryGroup(
+        const { sarifFile, stdout } = await runQueryGroup(
           language,
           "builtin",
           queries["builtin"],
           sarifFolder,
           undefined
         );
+        analysisSummary = stdout;
         await injectLinesOfCode(sarifFile, language, locPromise);
 
         statusReport[`analyze_builtin_queries_${language}_duration_ms`] =
@@ -188,7 +190,7 @@ export async function runQueries(
       const temporarySarifFiles: string[] = [];
       for (let i = 0; i < queries["custom"].length; ++i) {
         if (queries["custom"][i].queries.length > 0) {
-          const sarifFile = await runQueryGroup(
+          const { sarifFile } = await runQueryGroup(
             language,
             `custom-${i}`,
             queries["custom"][i].queries,
@@ -206,8 +208,13 @@ export async function runQueries(
         statusReport[`analyze_custom_queries_${language}_duration_ms`] =
           new Date().getTime() - startTimeCustom;
       }
+      logger.endGroup();
 
+      // Print the LoC baseline and the summary results from database analyze.
+      logger.startGroup(`Analysis summary for ${language}`);
       printLinesOfCodeSummary(logger, language, await locPromise);
+      logger.info(analysisSummary);
+      logger.endGroup();
     } catch (e) {
       logger.info(e);
       statusReport.analyze_failure_language = language;
@@ -226,7 +233,7 @@ export async function runQueries(
     queries: string[],
     destinationFolder: string,
     searchPath: string | undefined
-  ): Promise<string> {
+  ): Promise<{ sarifFile: string; stdout: string }> {
     const databasePath = util.getCodeQLDatabasePath(config, language);
     // Pass the queries to codeql using a file instead of using the command
     // line to avoid command line length restrictions, particularly on windows.
@@ -240,7 +247,7 @@ export async function runQueries(
     const sarifFile = path.join(destinationFolder, `${language}-${type}.sarif`);
 
     const codeql = getCodeQL(config.codeQLCmd);
-    await codeql.databaseAnalyze(
+    const databaseAnalyzeStdout = await codeql.databaseAnalyze(
       databasePath,
       sarifFile,
       searchPath,
@@ -254,9 +261,7 @@ export async function runQueries(
     logger.debug(
       `SARIF results for database ${language} created at "${sarifFile}"`
     );
-    logger.endGroup();
-
-    return sarifFile;
+    return { sarifFile, stdout: databaseAnalyzeStdout };
   }
 }
 

lib/analyze.test.js

@@ -96,7 +96,7 @@ export interface CodeQL {
     addSnippetsFlag: string,
     threadsFlag: string,
     automationDetailsId: string | undefined
-  ): Promise<void>;
+  ): Promise<string>;
 }
 
 export interface ResolveQueriesOutput {
@@ -688,7 +688,7 @@ function getCodeQLForCmd(cmd: string): CodeQL {
       addSnippetsFlag: string,
       threadsFlag: string,
       automationDetailsId: string | undefined
-    ) {
+    ): Promise<string> {
       const args = [
         "database",
         "analyze",
@@ -712,7 +712,16 @@ function getCodeQLForCmd(cmd: string): CodeQL {
         args.push("--sarif-category", automationDetailsId);
       }
       args.push(querySuite);
-      await new toolrunner.ToolRunner(cmd, args).exec();
+      // capture stdout, which contains analysis summaries
+      let output = "";
+      await new toolrunner.ToolRunner(cmd, args, {
+        listeners: {
+          stdout: (data: Buffer) => {
+            output += data.toString("utf8");
+          },
+        },
+      }).exec();
+      return output;
     },
   };
 }

lib/analyze.test.js.map

@@ -342,7 +342,8 @@ async function uploadFiles(
   mode: util.Mode,
   logger: Logger
 ): Promise<UploadStatusReport> {
-  logger.info(`Uploading sarif files: ${JSON.stringify(sarifFiles)}`);
+  logger.startGroup("Uploading results");
+  logger.info(`Processing sarif files: ${JSON.stringify(sarifFiles)}`);
 
   if (mode === "actions") {
     // This check only works on actions as env vars don't persist between calls to the runner
@@ -403,6 +404,8 @@ async function uploadFiles(
   // Make the upload
   await uploadPayload(payload, repositoryNwo, apiDetails, mode, logger);
 
+  logger.endGroup();
+
   return {
     raw_upload_size_bytes: rawUploadSizeBytes,
     zipped_upload_size_bytes: zippedUploadSizeBytes,