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: Add more fields to verification response #1671

Merged
merged 2 commits into from
Aug 6, 2024

Conversation

binbin-li
Copy link
Collaborator

@binbin-li binbin-li commented Jul 29, 2024

Description

What this PR does / why we need it:

This PR is part of effort for addressing #1654

  1. Add VerifierType and VerifierName to replace type and name.
  2. Add ErrorReason field to indicate root cause of an error.
  3. Add Remediation field to include trouble shooting guide for the error.
  4. Fixed a bug that missing Subject value in verifier report when using config policy.
  5. Add ReferenceDigest to the verifierReport in V0 which is used by config poliy.

This PR does not change the usage of verification response, so the verifier report should look the same as before. We'll have separate PRs to update report generation logic to carry above values.

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 #1654

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

Copy link

codecov bot commented Jul 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files Coverage Δ
httpserver/types.go 100.00% <100.00%> (ø)
pkg/executor/core/executor.go 89.15% <100.00%> (+0.33%) ⬆️
pkg/verifier/cosign/cosign.go 78.55% <100.00%> (+0.44%) ⬆️
pkg/verifier/notation/notation.go 88.11% <100.00%> (+0.24%) ⬆️
pkg/verifier/types/types.go 91.66% <100.00%> (+2.19%) ⬆️

@binbin-li binbin-li mentioned this pull request Jul 31, 2024
12 tasks
@binbin-li binbin-li marked this pull request as ready for review August 1, 2024 03:26
@@ -22,9 +22,11 @@ import (

const (
VerificationResultVersion = "0.1.0"
ResultVersion0_2_0 = "0.2.0"
Copy link
Collaborator

Choose a reason for hiding this comment

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

do we have any documentation/Samples for each version of verification result?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, we have one for 0.1.0 and 1.0.0, I'll update 0.2.0 and 1.1.0 after this pr. https://ratify.dev/docs/next/reference/verification-result-version

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Discussed offline, will create an issue to track response version.

@binbin-li binbin-li force-pushed the verification-response branch 2 times, most recently from f560c1c to 09a091b Compare August 5, 2024 06:55
@binbin-li binbin-li merged commit 294a715 into ratify-project:dev Aug 6, 2024
18 checks passed
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.

Improve verification response
2 participants