Skip to content
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.

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

feat: fill ErrorReason and Remediation during verifierReport generation #1682

Merged
merged 14 commits into from
Aug 21, 2024

Conversation

binbin-li
Copy link
Collaborator

@binbin-li binbin-li commented Aug 2, 2024

Description

What this PR does / why we need it:

  1. Update Message and add ErrorReason and Remediation in all returned verifierResult.
  2. Add VerifierName and VerifierType fields in verifierResult to replace Name and `Type in next major release.
  3. Add unit tests for external plugins.

Example:
image

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):

Fixes #

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Helm Chart Change (any edit/addition/update that is necessary for changes merged to the main branch)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Checklist:

  • Does the affected code have corresponding tests?
  • Are the changes documented, not just with inline documentation, but also with conceptual documentation such as an overview of a new feature, or task-based documentation like a tutorial? Consider if this change should be announced on your project blog.
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have appropriate license header?

Post Merge Requirements

  • MAINTAINERS: manually trigger the "Publish Package" workflow after merging any PR that indicates Helm Chart Change

@binbin-li binbin-li marked this pull request as draft August 2, 2024 13:32
Copy link

codecov bot commented Aug 2, 2024

Codecov Report

Attention: Patch coverage is 89.06752% with 34 lines in your changes missing coverage. Please review.

Files Patch % Lines
...rifier/vulnerabilityreport/vulnerability_report.go 84.07% 32 Missing ⚠️
plugins/verifier/sbom/sbom.go 93.33% 2 Missing ⚠️
Files Coverage Δ
pkg/executor/core/executor.go 88.46% <100.00%> (-0.70%) ⬇️
pkg/executor/types/types.go 0.00% <ø> (ø)
pkg/policyprovider/configpolicy/configpolicy.go 93.22% <100.00%> (-0.23%) ⬇️
pkg/verifier/cosign/cosign.go 78.67% <100.00%> (+0.12%) ⬆️
pkg/verifier/notation/notation.go 87.09% <100.00%> (-1.03%) ⬇️
pkg/verifier/result.go 100.00% <100.00%> (ø)
pkg/verifier/types/types.go 90.69% <100.00%> (-0.97%) ⬇️
...ugins/verifier/schemavalidator/schema_validator.go 100.00% <100.00%> (+52.08%) ⬆️
plugins/verifier/sbom/sbom.go 97.93% <93.33%> (+32.14%) ⬆️
...rifier/vulnerabilityreport/vulnerability_report.go 88.03% <84.07%> (+0.08%) ⬆️

... and 6 files with indirect coverage changes

@binbin-li binbin-li changed the title [DO NOT REVIEW] feat: fill ErrorReason and Remediation during verifierReport generation feat: fill ErrorReason and Remediation during verifierReport generation Aug 6, 2024
@binbin-li binbin-li marked this pull request as ready for review August 6, 2024 04:53
@binbin-li binbin-li marked this pull request as draft August 6, 2024 04:54
@binbin-li binbin-li marked this pull request as ready for review August 6, 2024 08:59
Copy link
Collaborator

@susanshi susanshi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left some questions. thanks @binbin-li .

pkg/executor/core/executor.go Outdated Show resolved Hide resolved
@binbin-li binbin-li enabled auto-merge (squash) August 21, 2024 01:58
@binbin-li binbin-li merged commit 0b6aa67 into ratify-project:dev Aug 21, 2024
19 checks passed
duffney pushed a commit to duffney/ratify that referenced this pull request Aug 23, 2024
akashsinghal pushed a commit to akashsinghal/ratify that referenced this pull request Sep 13, 2024
binbin-li added a commit to binbin-li/ratify that referenced this pull request Sep 14, 2024
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.

3 participants