Move UploadTarget definitions to analyses.ts

src/analyses.ts

@@ -41,3 +41,34 @@ export async function parseAnalysisKinds(
 
 /** The queries to use for Code Quality analyses. */
 export const codeQualityQueries: string[] = ["code-quality"];
+
+// Enumerates API endpoints that accept SARIF files.
+export enum SARIF_UPLOAD_ENDPOINT {
+  CODE_SCANNING = "PUT /repos/:owner/:repo/code-scanning/analysis",
+  CODE_QUALITY = "PUT /repos/:owner/:repo/code-quality/analysis",
+}
+
+// Represents configurations for different services that we can upload SARIF to.
+export interface UploadTarget {
+  name: string;
+  target: SARIF_UPLOAD_ENDPOINT;
+  sarifPredicate: (name: string) => boolean;
+  sentinelPrefix: string;
+}
+
+// Represents the Code Scanning upload target.
+export const CodeScanningTarget: UploadTarget = {
+  name: "code scanning",
+  target: SARIF_UPLOAD_ENDPOINT.CODE_SCANNING,
+  sarifPredicate: (name) =>
+    name.endsWith(".sarif") && !CodeQualityTarget.sarifPredicate(name),
+  sentinelPrefix: "CODEQL_UPLOAD_SARIF_",
+};
+
+// Represents the Code Quality upload target.
+export const CodeQualityTarget: UploadTarget = {
+  name: "code quality",
+  target: SARIF_UPLOAD_ENDPOINT.CODE_QUALITY,
+  sarifPredicate: (name) => name.endsWith(".quality.sarif"),
+  sentinelPrefix: "CODEQL_UPLOAD_QUALITY_SARIF_",
+};

src/analyze-action.ts

@@ -5,6 +5,7 @@ import { performance } from "perf_hooks";
 import * as core from "@actions/core";
 
 import * as actionsUtil from "./actions-util";
+import * as analyses from "./analyses";
 import {
   CodeQLAnalysisError,
   dbIsFinalized,
@@ -332,7 +333,7 @@ async function run() {
         actionsUtil.getOptionalInput("category"),
         features,
         logger,
-        uploadLib.CodeScanningTarget,
+        analyses.CodeScanningTarget,
       );
       core.setOutput("sarif-id", uploadResult.sarifID);
 
@@ -346,7 +347,7 @@ async function run() {
           ),
           features,
           logger,
-          uploadLib.CodeQualityTarget,
+          analyses.CodeQualityTarget,
         );
         core.setOutput("quality-sarif-id", qualityUploadResult.sarifID);
       }

src/init-action-post-helper.ts

@@ -4,6 +4,7 @@ import * as core from "@actions/core";
 import * as github from "@actions/github";
 
 import * as actionsUtil from "./actions-util";
+import { CodeScanningTarget } from "./analyses";
 import { getApiClient } from "./api-client";
 import { CodeQL, getCodeQL } from "./codeql";
 import { Config } from "./config-utils";
@@ -104,7 +105,7 @@ async function maybeUploadFailedSarif(
     category,
     features,
     logger,
-    uploadLib.CodeScanningTarget,
+    CodeScanningTarget,
   );
   await uploadLib.waitForProcessing(
     repositoryNwo,

src/upload-lib.test.ts

@@ -3,6 +3,7 @@ import * as path from "path";
 
 import test from "ava";
 
+import { CodeQualityTarget, CodeScanningTarget } from "./analyses";
 import { getRunnerLogger, Logger } from "./logging";
 import { setupTests } from "./testing-utils";
 import * as uploadLib from "./upload-lib";
@@ -128,7 +129,7 @@ test("finding SARIF files", async (t) => {
 
     const sarifFiles = uploadLib.findSarifFilesInDir(
       tmpDir,
-      uploadLib.CodeScanningTarget.sarifPredicate,
+      CodeScanningTarget.sarifPredicate,
     );
 
     t.deepEqual(sarifFiles, [
@@ -140,7 +141,7 @@ test("finding SARIF files", async (t) => {
 
     const qualitySarifFiles = uploadLib.findSarifFilesInDir(
       tmpDir,
-      uploadLib.CodeQualityTarget.sarifPredicate,
+      CodeQualityTarget.sarifPredicate,
     );
 
     t.deepEqual(qualitySarifFiles, [
@@ -335,7 +336,7 @@ test("validateUniqueCategory with different prefixes", (t) => {
   t.notThrows(() =>
     uploadLib.validateUniqueCategory(
       createMockSarif(),
-      uploadLib.CodeQualityTarget.sentinelPrefix,
+      CodeQualityTarget.sentinelPrefix,
     ),
   );
 });

src/upload-lib.ts

@@ -8,6 +8,7 @@ import { OctokitResponse } from "@octokit/types";
 import * as jsonschema from "jsonschema";
 
 import * as actionsUtil from "./actions-util";
+import * as analyses from "./analyses";
 import * as api from "./api-client";
 import { getGitHubVersion, wrapApiConfigurationError } from "./api-client";
 import { CodeQL, getCodeQL } from "./codeql";
@@ -345,19 +346,13 @@ function getAutomationID(
   return api.computeAutomationID(analysis_key, environment);
 }
 
-// Enumerates API endpoints that accept SARIF files.
-export enum SARIF_UPLOAD_ENDPOINT {
-  CODE_SCANNING = "PUT /repos/:owner/:repo/code-scanning/analysis",
-  CODE_QUALITY = "PUT /repos/:owner/:repo/code-quality/analysis",
-}
-
 // Upload the given payload.
 // If the request fails then this will retry a small number of times.
 async function uploadPayload(
   payload: any,
   repositoryNwo: RepositoryNwo,
   logger: Logger,
-  target: SARIF_UPLOAD_ENDPOINT,
+  target: analyses.SARIF_UPLOAD_ENDPOINT,
 ): Promise<string> {
   logger.info("Uploading results");
 
@@ -616,31 +611,6 @@ export function buildPayload(
   return payloadObj;
 }
 
-// Represents configurations for different services that we can upload SARIF to.
-export interface UploadTarget {
-  name: string;
-  target: SARIF_UPLOAD_ENDPOINT;
-  sarifPredicate: (name: string) => boolean;
-  sentinelPrefix: string;
-}
-
-// Represents the Code Scanning upload target.
-export const CodeScanningTarget: UploadTarget = {
-  name: "code scanning",
-  target: SARIF_UPLOAD_ENDPOINT.CODE_SCANNING,
-  sarifPredicate: (name) =>
-    name.endsWith(".sarif") && !CodeQualityTarget.sarifPredicate(name),
-  sentinelPrefix: "CODEQL_UPLOAD_SARIF_",
-};
-
-// Represents the Code Quality upload target.
-export const CodeQualityTarget: UploadTarget = {
-  name: "code quality",
-  target: SARIF_UPLOAD_ENDPOINT.CODE_QUALITY,
-  sarifPredicate: (name) => name.endsWith(".quality.sarif"),
-  sentinelPrefix: "CODEQL_UPLOAD_QUALITY_SARIF_",
-};
-
 /**
  * Uploads a single SARIF file or a directory of SARIF files depending on what `inputSarifPath` refers
  * to.
@@ -651,7 +621,7 @@ export async function uploadFiles(
   category: string | undefined,
   features: FeatureEnablement,
   logger: Logger,
-  uploadTarget: UploadTarget,
+  uploadTarget: analyses.UploadTarget,
 ): Promise<UploadResult> {
   const sarifPaths = getSarifFilePaths(
     inputSarifPath,
@@ -677,7 +647,7 @@ export async function uploadSpecifiedFiles(
   category: string | undefined,
   features: FeatureEnablement,
   logger: Logger,
-  uploadTarget: UploadTarget = CodeScanningTarget,
+  uploadTarget: analyses.UploadTarget = analyses.CodeScanningTarget,
 ): Promise<UploadResult> {
   logger.startGroup(`Uploading ${uploadTarget.name} results`);
   logger.info(`Processing sarif files: ${JSON.stringify(sarifPaths)}`);
@@ -943,7 +913,7 @@ function handleProcessingResultForUnsuccessfulExecution(
 
 export function validateUniqueCategory(
   sarif: SarifFile,
-  sentinelPrefix: string = CodeScanningTarget.sentinelPrefix,
+  sentinelPrefix: string = analyses.CodeScanningTarget.sentinelPrefix,
 ): void {
   // duplicate categories are allowed in the same sarif file
   // but not across multiple sarif files

src/upload-sarif-action.ts

@@ -4,6 +4,7 @@ import * as core from "@actions/core";
 
 import * as actionsUtil from "./actions-util";
 import { getActionVersion, getTemporaryDirectory } from "./actions-util";
+import * as analyses from "./analyses";
 import { getGitHubVersion } from "./api-client";
 import { Features } from "./feature-flags";
 import { Logger, getActionsLogger } from "./logging";
@@ -95,7 +96,7 @@ async function run() {
       category,
       features,
       logger,
-      upload_lib.CodeScanningTarget,
+      analyses.CodeScanningTarget,
     );
     core.setOutput("sarif-id", uploadResult.sarifID);
 
@@ -105,7 +106,7 @@ async function run() {
     if (fs.lstatSync(sarifPath).isDirectory()) {
       const qualitySarifFiles = upload_lib.findSarifFilesInDir(
         sarifPath,
-        upload_lib.CodeQualityTarget.sarifPredicate,
+        analyses.CodeQualityTarget.sarifPredicate,
       );
 
       if (qualitySarifFiles.length !== 0) {
@@ -115,7 +116,7 @@ async function run() {
           actionsUtil.fixCodeQualityCategory(logger, category),
           features,
           logger,
-          upload_lib.CodeQualityTarget,
+          analyses.CodeQualityTarget,
         );
       }
     }