Skip to content

feat: add review metadata to ufm sarif - #677

Open
cbill-s wants to merge 1 commit into
mainfrom
feat/add-review-metadata-to-ufm-sarif
Open

feat: add review metadata to ufm sarif#677
cbill-s wants to merge 1 commit into
mainfrom
feat/add-review-metadata-to-ufm-sarif

Conversation

@cbill-s

@cbill-s cbill-s commented Jul 30, 2026

Copy link
Copy Markdown

Description

Add review metadata to ufm sarif

Checklist

  • Tests added and all succeed (make test)
  • Regenerated mocks, etc. (make generate)
  • Linted (make lint)
  • Test your changes work for the CLI
    1. Clone / pull the latest CLI main.
    2. Run go get github.com/snyk/go-application-framework@YOUR_LATEST_GAF_COMMIT in the cliv2 directory.
      • Tip: for local testing, you can uncomment the line near the bottom of the CLI's go.mod to point to your local GAF code.
    3. Run go mod tidy in the cliv2 directory.
    4. Run the CLI tests and do any required manual testing.
    5. Open a PR in the CLI repo now with the go.mod and go.sum changes.
    • Once this PR is merged, repeat these steps, but pointing to the latest GAF commit on main and update your CLI PR.

Note

Low Risk
Changes are additive SARIF fields and test API accessors with broad test coverage; no auth or runtime behavior changes beyond richer export metadata.

Overview
UFM SARIF output now includes policy rule review metadata on ignore suppressions when the applied policy rule was reviewed.

The test API client exposes GetReviewedOn and GetReviewedBy on ignore details (sourced from the policy rule’s reviewed_at / reviewed_by). The UFM SARIF template adds matching reviewedOn and reviewedBy fields in suppression properties, mirroring the existing ignoredOn / ignoredBy shape. Unreviewed ignores do not emit those keys.

OpenAPI models and generated client code are updated for PolicyRuleReviewer and rule review fields; a dedicated presenter test asserts valid JSON and the property bag (including comma handling in the template).

Reviewed by Cursor Bugbot for commit c876c48. Bugbot is set up for automated code reviews on this repo. Configure here.

@cbill-s
cbill-s requested review from a team as code owners July 30, 2026 14:02
@snyk-io

snyk-io Bot commented Jul 30, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues
Secrets 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@snyk-io

snyk-io Bot commented Jul 30, 2026

Copy link
Copy Markdown

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@snyk-pr-review-bot

This comment has been minimized.

@cbill-s
cbill-s force-pushed the feat/add-review-metadata-to-ufm-sarif branch from 6ad6365 to c876c48 Compare July 30, 2026 14:13
@snyk-pr-review-bot

Copy link
Copy Markdown

PR Reviewer Guide 🔍

🧪 PR contains tests
🔒 No security concerns identified
⚡ No major issues detected
📚 Repository Context Analyzed

This review considered 12 relevant code sections from 11 files (average relevance: 1.00)

🤖 Repository instructions applied (from AGENTS.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants