robojerk/codeql-action

Merge pull request #2464 from github/henrymercer/tools-url-status-report

Browse source 
Add standard tools URLs to status report
This commit is contained in:
Henry Mercer 2024-09-05 19:43:52 +01:00 • committed by GitHub
commit 9b41ced437
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 24 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
lib/setup-codeql.js generated
View file

@ -413,6 +413,7 @@ const downloadCodeQL = async function (codeqlURL, maybeBundleVersion, maybeCliVe
compressionMethod,
downloadDurationMs,
extractionDurationMs,
toolsUrl: sanitizeUrlForStatusReport(codeqlURL),
},
toolsVersion: maybeCliVersion ?? "unknown",
};
@ -430,6 +431,7 @@ const downloadCodeQL = async function (codeqlURL, maybeBundleVersion, maybeCliVe
compressionMethod,
downloadDurationMs,
extractionDurationMs,
toolsUrl: sanitizeUrlForStatusReport(codeqlURL),
},
toolsVersion: maybeCliVersion ?? toolcacheVersion,
};
@ -518,4 +520,9 @@ async function cleanUpGlob(glob, name, logger) {
logger.warning(`Failed to clean up ${name}: ${e}.`);
}
}
function sanitizeUrlForStatusReport(url) {
return ["github/codeql-action", "dsp-testing/codeql-cli-nightlies"].some((repo) => url.startsWith(`https://github.com/${repo}/releases/download/`))
? url
: "sanitized-value";
}
//# sourceMappingURL=setup-codeql.js.map

2
lib/setup-codeql.js.map
View file

File diff suppressed because one or more lines are too long

2
lib/setup-codeql.test.js generated
View file

@ -119,6 +119,7 @@ ava_1.default.beforeEach(() => {
compressionMethod: "gzip",
downloadDurationMs: 200,
extractionDurationMs: 300,
toolsUrl: "toolsUrl",
},
toolsVersion: testing_utils_1.LINKED_CLI_VERSION.cliVersion,
});
@ -147,6 +148,7 @@ ava_1.default.beforeEach(() => {
compressionMethod: "gzip",
downloadDurationMs: 200,
extractionDurationMs: 300,
toolsUrl: bundleUrl,
},
toolsVersion: expectedVersion,
});

2
lib/setup-codeql.test.js.map
View file

File diff suppressed because one or more lines are too long

2
src/setup-codeql.test.ts
View file

@ -157,6 +157,7 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to use
compressionMethod: "gzip",
downloadDurationMs: 200,
extractionDurationMs: 300,
toolsUrl: "toolsUrl",
},
toolsVersion: LINKED_CLI_VERSION.cliVersion,
});
@ -204,6 +205,7 @@ test("setupCodeQLBundle logs the CodeQL CLI version being used when asked to dow
compressionMethod: "gzip",
downloadDurationMs: 200,
extractionDurationMs: 300,
toolsUrl: bundleUrl,
},
toolsVersion: expectedVersion,
});

11
src/setup-codeql.ts
View file

@ -466,6 +466,7 @@ export interface ToolsDownloadStatusReport {
compressionMethod: tar.CompressionMethod;
downloadDurationMs: number;
extractionDurationMs: number;
toolsUrl: string;
}
// Exported using `export const` for testing purposes. Specifically, we want to
@ -553,6 +554,7 @@ export const downloadCodeQL = async function (
compressionMethod,
downloadDurationMs,
extractionDurationMs,
toolsUrl: sanitizeUrlForStatusReport(codeqlURL),
},
toolsVersion: maybeCliVersion ?? "unknown",
};
@ -585,6 +587,7 @@ export const downloadCodeQL = async function (
compressionMethod,
downloadDurationMs,
extractionDurationMs,
toolsUrl: sanitizeUrlForStatusReport(codeqlURL),
},
toolsVersion: maybeCliVersion ?? toolcacheVersion,
};
@ -711,3 +714,11 @@ async function cleanUpGlob(glob: string, name: string, logger: Logger) {
logger.warning(`Failed to clean up ${name}: ${e}.`);
}
}
function sanitizeUrlForStatusReport(url: string): string {
return ["github/codeql-action", "dsp-testing/codeql-cli-nightlies"].some(
(repo) => url.startsWith(`https://github.com/${repo}/releases/download/`),
)
? url
: "sanitized-value";
}