Skip to content

Perform SARIF post-processing independently of upload #3222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbg merged 18 commits into from
Oct 24, 2025
Merged

Perform SARIF post-processing independently of upload #3222

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
489ed91
Split SARIF post-processing steps from `uploadSpecifiedFiles` into a …
mbg Oct 13, 2025
6fbdd5f
Split SARIF uploading steps from `uploadSpecifiedFiles` into a function
mbg Oct 21, 2025
899bf2f
Use `postProcessSarifFiles` and `uploadProcessedFiles` in `uploadSarif`
mbg Oct 21, 2025
596de7f
Move `UploadKind` check into `uploadSarif`
mbg Oct 21, 2025
14139c9
Add test for `uploadSarif` with `upload: never`
mbg Oct 21, 2025
c2bec36
Add `post-process-output` input to `analyze` action
mbg Oct 21, 2025
12f3cfe
Write processed SARIF files if `post-process-output` input is provided
mbg Oct 21, 2025
def04c1
Add test for `uploadSarif` with output directory
mbg Oct 21, 2025
5e37670
Use `post-process-output` in PR check
mbg Oct 22, 2025
d79c0a1
Fix incomplete comment
mbg Oct 22, 2025
89d3359
Improve test name
mbg Oct 22, 2025
6f0fcbe
Rename `uploadSarif`
mbg Oct 22, 2025
8ff870a
Rename new input to `processed-sarif-path`
mbg Oct 22, 2025
aed27f7
Fix linter issue
mbg Oct 22, 2025
f48b54a
Fix fallback not being guarded by `uploadKind` check
mbg Oct 23, 2025
b9cd368
Merge remote-tracking branch 'origin/main' into mbg/upload-lib/post-p…
mbg Oct 24, 2025
f0452d5
Consistently use "post-processing"
mbg Oct 24, 2025
710606c
Check that `outputPath` is non-empty
mbg Oct 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add test for uploadSarif with output directory
  • Loading branch information
@mbg
mbg committed Oct 22, 2025
commit def04c1c0ec9589b3a2943faa40a555c80a7a1a7
86 changes: 54 additions & 32 deletions src/upload-sarif.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,26 @@ interface UploadSarifExpectedResult {
expectedFiles?: string[];
}

function mockPostProcessSarifFiles() {
const postProcessSarifFiles = sinon.stub(uploadLib, "postProcessSarifFiles");

for (const analysisKind of Object.values(AnalysisKind)) {
const analysisConfig = getAnalysisConfig(analysisKind);
postProcessSarifFiles
.withArgs(
sinon.match.any,
sinon.match.any,
sinon.match.any,
sinon.match.any,
sinon.match.any,
analysisConfig,
)
.resolves({ sarif: { runs: [] }, analysisKey: "", environment: "" });
}

return postProcessSarifFiles;
}

const uploadSarifMacro = test.macro({
exec: async (
t: ExecutionContext<unknown>,
Expand All @@ -33,27 +53,14 @@ const uploadSarifMacro = test.macro({

const toFullPath = (filename: string) => path.join(tempDir, filename);

const postProcessSarifFiles = sinon.stub(
uploadLib,
"postProcessSarifFiles",
);
const postProcessSarifFiles = mockPostProcessSarifFiles();
const uploadProcessedFiles = sinon.stub(
uploadLib,
"uploadProcessedFiles",
);

for (const analysisKind of Object.values(AnalysisKind)) {
const analysisConfig = getAnalysisConfig(analysisKind);
postProcessSarifFiles
.withArgs(
logger,
sinon.match.any,
sinon.match.any,
sinon.match.any,
sinon.match.any,
analysisConfig,
)
.resolves({ sarif: { runs: [] }, analysisKey: "", environment: "" });
uploadProcessedFiles
.withArgs(logger, sinon.match.any, analysisConfig, sinon.match.any)
.resolves(expectedResult[analysisKind as AnalysisKind]?.uploadResult);
Expand Down Expand Up @@ -203,26 +210,9 @@ test("uploadSarif doesn't upload if `upload` != `always`", async (t) => {

const toFullPath = (filename: string) => path.join(tempDir, filename);

const postProcessSarifFiles = sinon.stub(
uploadLib,
"postProcessSarifFiles",
);
const postProcessSarifFiles = mockPostProcessSarifFiles();
const uploadProcessedFiles = sinon.stub(uploadLib, "uploadProcessedFiles");

for (const analysisKind of Object.values(AnalysisKind)) {
const analysisConfig = getAnalysisConfig(analysisKind);
postProcessSarifFiles
.withArgs(
logger,
sinon.match.any,
sinon.match.any,
sinon.match.any,
sinon.match.any,
analysisConfig,
)
.resolves({ sarif: { runs: [] }, analysisKey: "", environment: "" });
}

fs.writeFileSync(toFullPath("test.sarif"), "");
fs.writeFileSync(toFullPath("test.quality.sarif"), "");

Expand All @@ -233,3 +223,35 @@ test("uploadSarif doesn't upload if `upload` != `always`", async (t) => {
t.assert(uploadProcessedFiles.notCalled);
});
});

test("uploadSarif writes processed SARIF files if output directory is provided", async (t) => {
await util.withTmpDir(async (tempDir) => {
const logger = getRunnerLogger(true);
const features = createFeatures([]);

const toFullPath = (filename: string) => path.join(tempDir, filename);

const postProcessSarifFiles = mockPostProcessSarifFiles();

fs.writeFileSync(toFullPath("test.sarif"), "");
fs.writeFileSync(toFullPath("test.quality.sarif"), "");

const processedOutPath = path.join(tempDir, "processed");
const actual = await uploadSarif(
logger,
features,
"never",
"",
tempDir,
"",
processedOutPath,
);

t.truthy(actual);
t.assert(postProcessSarifFiles.calledTwice);
t.assert(fs.existsSync(path.join(processedOutPath, "upload.sarif")));
t.assert(
fs.existsSync(path.join(processedOutPath, "upload.quality.sarif")),
);
});
});