Add fixCategory to AnalysisConfig

Author: mbg

lib/analyze-action.js

@@ -1,3 +1,5 @@
+import { fixCodeQualityCategory } from "./actions-util";
+import { Logger } from "./logging";
 import { ConfigurationError } from "./util";
 
 export enum AnalysisKind {
@@ -61,6 +63,8 @@ export interface AnalysisConfig {
   /** A predicate on filenames to decide whether a SARIF file
    * belongs to this kind of analysis. */
   sarifPredicate: (name: string) => boolean;
+  /** Analysis-specific adjustment of the category. */
+  fixCategory: (logger: Logger, category?: string) => string | undefined;
   /** A prefix for environment variables used to track the uniqueness of SARIF uploads. */
   sentinelPrefix: string;
 }
@@ -74,6 +78,7 @@ export const CodeScanning: AnalysisConfig = {
   sarifPredicate: (name) =>
     name.endsWith(CodeScanning.sarifExtension) &&
     !CodeQuality.sarifPredicate(name),
+  fixCategory: (_, category) => category,
   sentinelPrefix: "CODEQL_UPLOAD_SARIF_",
 };
 
@@ -84,6 +89,7 @@ export const CodeQuality: AnalysisConfig = {
   target: SARIF_UPLOAD_ENDPOINT.CODE_QUALITY,
   sarifExtension: ".quality.sarif",
   sarifPredicate: (name) => name.endsWith(CodeQuality.sarifExtension),
+  fixCategory: fixCodeQualityCategory,
   sentinelPrefix: "CODEQL_UPLOAD_QUALITY_SARIF_",
 };
 

lib/init-action-post.js

@@ -345,16 +345,17 @@ async function run() {
       }
 
       if (isCodeQualityEnabled(config)) {
+        const analysis = analyses.CodeQuality;
         const qualityUploadResult = await uploadLib.uploadFiles(
           outputDir,
           actionsUtil.getRequiredInput("checkout_path"),
-          actionsUtil.fixCodeQualityCategory(
+          analysis.fixCategory(
             logger,
             actionsUtil.getOptionalInput("category"),
           ),
           features,
           logger,
-          analyses.CodeQuality,
+          analysis,
         );
         core.setOutput("quality-sarif-id", qualityUploadResult.sarifID);
       }

lib/upload-lib.js

@@ -7,7 +7,6 @@ import * as del from "del";
 import * as yaml from "js-yaml";
 
 import {
-  fixCodeQualityCategory,
   getRequiredInput,
   getTemporaryDirectory,
   PullRequestBranches,
@@ -781,7 +780,7 @@ export async function runQueries(
     // accepted by the Code Quality backend.
     let category = automationDetailsId;
     if (analysis.kind === analyses.AnalysisKind.CodeQuality) {
-      category = fixCodeQualityCategory(logger, automationDetailsId);
+      category = analysis.fixCategory(logger, automationDetailsId);
     }
 
     const sarifFile = path.join(

lib/upload-sarif-action.js

@@ -1,6 +1,5 @@
 import * as fs from "fs";
 
-import * as actionsUtil from "./actions-util";
 import * as analyses from "./analyses";
 import { FeatureEnablement } from "./feature-flags";
 import { Logger } from "./logging";
@@ -112,7 +111,7 @@ export async function uploadSarif(
     pathStats,
     checkoutPath,
     analyses.CodeQuality,
-    actionsUtil.fixCodeQualityCategory(logger, category),
+    analyses.CodeQuality.fixCategory(logger, category),
   );
   if (qualityUploadResult !== undefined) {
     uploadResults[analyses.AnalysisKind.CodeQuality] = qualityUploadResult;