diff --git a/lib/analyze-action.js b/lib/analyze-action.js index 5e8fe46fe..18725b2fa 100644 --- a/lib/analyze-action.js +++ b/lib/analyze-action.js @@ -89773,14 +89773,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -95541,13 +95535,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path18.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs18.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/init-action-post.js b/lib/init-action-post.js index b12435b4d..71c258809 100644 --- a/lib/init-action-post.js +++ b/lib/init-action-post.js @@ -128072,14 +128072,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -133017,13 +133011,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path17.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs17.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -133593,13 +133586,9 @@ async function maybeUploadFailedSarif(config, repositoryNwo, features, logger) { const shouldUpload = getUploadInputOrThrow(workflow, jobName, matrix); if (!["always", "failure-only"].includes( getUploadValue(shouldUpload) - )) { + ) || shouldSkipSarifUpload()) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - return { upload_failed_run_skipped_because: skipReason }; - } const category = getCategoryInputOrThrow(workflow, jobName, matrix); const checkoutPath = getCheckoutPathInputOrThrow(workflow, jobName, matrix); const databasePath = config.dbLocation; diff --git a/lib/upload-lib.js b/lib/upload-lib.js index d35b895ce..e8db57e5f 100644 --- a/lib/upload-lib.js +++ b/lib/upload-lib.js @@ -88340,14 +88340,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -92376,13 +92370,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path14.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs13.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/lib/upload-sarif-action.js b/lib/upload-sarif-action.js index 7bf15775a..e768a7fe9 100644 --- a/lib/upload-sarif-action.js +++ b/lib/upload-sarif-action.js @@ -88457,14 +88457,8 @@ function isGoodVersion(versionSpec) { function isInTestMode() { return process.env["CODEQL_ACTION_TEST_MODE" /* TEST_MODE */] === "true"; } -function getSarifUploadSkipReason() { - if (isInTestMode()) { - return `SARIF upload is disabled via ${"CODEQL_ACTION_TEST_MODE" /* TEST_MODE */}`; - } - if (process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true") { - return `SARIF upload is disabled via ${"CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */}`; - } - return null; +function shouldSkipSarifUpload() { + return isInTestMode() || process.env["CODEQL_ACTION_SKIP_SARIF_UPLOAD" /* SKIP_SARIF_UPLOAD */] === "true"; } function getTestingEnvironment() { const testingEnvironment = process.env["CODEQL_ACTION_TESTING_ENVIRONMENT" /* TESTING_ENVIRONMENT */] || ""; @@ -93048,13 +93042,12 @@ function getAutomationID2(category, analysis_key, environment) { } async function uploadPayload(payload, repositoryNwo, logger, target) { logger.info("Uploading results"); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { + if (shouldSkipSarifUpload()) { const payloadSaveFile = path15.join( getTemporaryDirectory(), "payload.json" ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs14.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; @@ -93578,9 +93571,8 @@ async function run() { core13.setOutput("sarif-id", codeScanningResult.sarifID); } core13.setOutput("sarif-ids", JSON.stringify(uploadResults)); - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - core13.debug(`${skipReason}. Waiting for processing is disabled.`); + if (shouldSkipSarifUpload()) { + core13.debug("SARIF upload disabled. Waiting for processing is disabled."); } else if (getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== void 0) { await waitForProcessing( diff --git a/src/environment.ts b/src/environment.ts index 6713f57e6..d9b66b67d 100644 --- a/src/environment.ts +++ b/src/environment.ts @@ -131,7 +131,7 @@ export enum EnvVar { /** * Whether to skip uploading SARIF results to GitHub. Intended for testing purposes. - * This setting is implied by `CODEQL_ACTION_TEST_MODE`, but is more specific. + * This setting is implied by but is more specific than `CODEQL_ACTION_TEST_MODE`. */ SKIP_SARIF_UPLOAD = "CODEQL_ACTION_SKIP_SARIF_UPLOAD", } diff --git a/src/init-action-post-helper.ts b/src/init-action-post-helper.ts index f084e6415..7d46095e9 100644 --- a/src/init-action-post-helper.ts +++ b/src/init-action-post-helper.ts @@ -20,7 +20,7 @@ import { getErrorMessage, getRequiredEnvParam, parseMatrixInput, - getSarifUploadSkipReason, + shouldSkipSarifUpload, wrapError, } from "./util"; import { @@ -80,14 +80,11 @@ async function maybeUploadFailedSarif( if ( !["always", "failure-only"].includes( actionsUtil.getUploadValue(shouldUpload), - ) + ) || + shouldSkipSarifUpload() ) { return { upload_failed_run_skipped_because: "SARIF upload is disabled" }; } - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - return { upload_failed_run_skipped_because: skipReason }; - } const category = getCategoryInputOrThrow(workflow, jobName, matrix); const checkoutPath = getCheckoutPathInputOrThrow(workflow, jobName, matrix); const databasePath = config.dbLocation; diff --git a/src/upload-lib.ts b/src/upload-lib.ts index ac87b296f..98d8439ec 100644 --- a/src/upload-lib.ts +++ b/src/upload-lib.ts @@ -357,13 +357,12 @@ async function uploadPayload( logger.info("Uploading results"); // If in test mode we don't want to upload the results, - const skipReason = util.getSarifUploadSkipReason(); - if (skipReason) { + if (util.shouldSkipSarifUpload()) { const payloadSaveFile = path.join( actionsUtil.getTemporaryDirectory(), "payload.json", ); - logger.info(`${skipReason}. Saving to ${payloadSaveFile}`); + logger.info(`SARIF upload disabled. Saving to ${payloadSaveFile}`); logger.info(`Payload: ${JSON.stringify(payload, null, 2)}`); fs.writeFileSync(payloadSaveFile, JSON.stringify(payload, null, 2)); return "dummy-sarif-id"; diff --git a/src/upload-sarif-action.ts b/src/upload-sarif-action.ts index 60d18c876..5e6897ada 100644 --- a/src/upload-sarif-action.ts +++ b/src/upload-sarif-action.ts @@ -23,7 +23,7 @@ import { checkDiskUsage, getErrorMessage, initializeEnvironment, - getSarifUploadSkipReason, + shouldSkipSarifUpload, wrapError, } from "./util"; @@ -113,9 +113,8 @@ async function run() { core.setOutput("sarif-ids", JSON.stringify(uploadResults)); // We don't upload results in test mode, so don't wait for processing - const skipReason = getSarifUploadSkipReason(); - if (skipReason) { - core.debug(`${skipReason}. Waiting for processing is disabled.`); + if (shouldSkipSarifUpload()) { + core.debug("SARIF upload disabled. Waiting for processing is disabled."); } else if (actionsUtil.getRequiredInput("wait-for-processing") === "true") { if (codeScanningResult !== undefined) { await upload_lib.waitForProcessing( diff --git a/src/util.ts b/src/util.ts index 1a27bb690..e1f7a15ec 100644 --- a/src/util.ts +++ b/src/util.ts @@ -771,16 +771,10 @@ export function isInTestMode(): boolean { } /** - * Returns whether we specifically want to skip uploading SARIF files, and if so, why. + * Returns whether we specifically want to skip uploading SARIF files. */ -export function getSarifUploadSkipReason(): string | null { - if (isInTestMode()) { - return `SARIF upload is disabled via ${EnvVar.TEST_MODE}`; - } - if (process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true") { - return `SARIF upload is disabled via ${EnvVar.SKIP_SARIF_UPLOAD}`; - } - return null; +export function shouldSkipSarifUpload(): boolean { + return isInTestMode() || process.env[EnvVar.SKIP_SARIF_UPLOAD] === "true"; } /**