github/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action.git synced 2026-10-31 09:59:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Tests: ensure uploadSpecifiedFiles wasn't called if we don't expect it to be

Browse Source
This commit is contained in:
Michael B. Gale
2025-09-26 15:32:57 +01:00
parent 5b3f0ded91
commit 2adc894410
1 changed files with 21 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/upload-sarif.test.ts
View File

@@ -109,7 +109,7 @@ const uploadSarifMacro = test.macro({
"uploadSpecifiedFiles",
);
for (const analysisKind of Object.keys(expectedResult)) {
for (const analysisKind of Object.values(AnalysisKind)) {
uploadSpecifiedFiles
.withArgs(
sinon.match.any,
@@ -134,8 +134,10 @@ const uploadSarifMacro = test.macro({
for (const analysisKind of Object.values(AnalysisKind)) {
const analyisKindResult = expectedResult[analysisKind];
if (analyisKindResult) {
// We are expecting a result for this analysis kind, check that we have it.
t.deepEqual(actual[analysisKind], analyisKindResult.uploadResult);
// Additionally, check that the mocked `uploadSpecifiedFiles` was called with only the file paths
// that we expected it to be called with.
t.assert(
uploadSpecifiedFiles.calledWith(
analyisKindResult.expectedFiles?.map(toFullPath) ??
@@ -150,7 +152,24 @@ const uploadSarifMacro = test.macro({
),
);
} else {
// Otherwise, we are not expecting a result for this analysis kind. However, note that `undefined`
// is also returned by our mocked `uploadSpecifiedFiles` when there is no expected result for this
// analysis kind.
t.is(actual[analysisKind], undefined);
// Therefore, we also check that the mocked `uploadSpecifiedFiles` was not called for this analysis kind.
t.assert(
!uploadSpecifiedFiles.calledWith(
sinon.match.any,
sinon.match.any,
sinon.match.any,
features,
logger,
analysisKind === AnalysisKind.CodeScanning
? CodeScanning
: CodeQuality,
),
`uploadSpecifiedFiles was called for ${analysisKind}, but should not have been.`,
);
}
}
});