feat: add `blob policy import` and `show` commands #1126

JeyJeyGao · 2024-12-24T07:26:36Z

Feat:

added notation blob import and notation blob show commands

Test:

added E2E test cases

Corresponding spec:
https://github.com/notaryproject/notation/blob/2ff8754717877adfd45266cfa8ba65705c397ea0/specs/commandline/blob.md

help example:

$ notation -h

Notation - a tool to sign and verify artifacts

Usage:
  notation [command]

Available Commands:
  blob        Sign, verify and inspect singatures associated with blobs
  certificate Manage certificates in trust store
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  inspect     Inspect all signatures associated with the signed artifact
  key         Manage keys used for signing
  list        List signatures of the signed artifact
  login       Login to registry
  logout      Log out from the logged in registries
  plugin      Manage plugins
  policy      Manage trust policy configuration
  sign        Sign artifacts
  verify      Verify OCI artifacts
  version     Show the notation version information

Flags:
  -h, --help   help for notation

Use "notation [command] --help" for more information about a command.

$ notation blob -h

Sign, inspect, and verify signatures and configure trust policies.

Usage:
  notation blob [command]

Available Commands:
  policy      Manage trust policy configuration for signed blobs

Flags:
  -h, --help   help for blob

Use "notation blob [command] --help" for more information about a command.

$ notation blob policy -h

Manage trust policy configuration for arbitrary blob signature verification.

Usage:
  notation blob policy [command]

Available Commands:
  import      Import trust policy configuration from a JSON file
  show        Show trust policy configuration

Flags:
  -h, --help   help for policy

Use "notation blob policy [command] --help" for more information about a command.

$ notation blob policy import -h

Import blob trust policy configuration from a JSON file.

Example - Import trust policy configuration from a file:
  notation blob policy import my_policy.json

Usage:
  notation blob policy import [flags] <file_path>

Flags:
      --force   override the existing trust policy configuration, never prompt
  -h, --help    help for import

$ notation blob policy show -h

Show blob trust policy configuration.

Example - Show current blob trust policy configuration:
  notation blob policy show

Example - Save current blob trust policy configuration to a file:
  notation blob policy show > my_policy.json

Usage:
  notation blob policy show [flags]

Flags:
  -h, --help   help for show

Signed-off-by: Junjie Gao <[email protected]>

codecov · 2024-12-24T07:28:26Z

Codecov Report

Attention: Patch coverage is 95.23810% with 6 lines in your changes missing coverage. Please review.

Project coverage is 71.80%. Comparing base (2ff8754) to head (4360cfb).
Report is 5 commits behind head on main.

Files with missing lines	Patch %	Lines
cmd/notation/blob/policy/import.go	89.65%	4 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1126      +/-   ##
==========================================
+ Coverage   70.79%   71.80%   +1.00%     
==========================================
  Files          48       52       +4     
  Lines        2945     3071     +126     
==========================================
+ Hits         2085     2205     +120     
- Misses        668      672       +4     
- Partials      192      194       +2

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Junjie Gao <[email protected]>

cmd/notation/blob/cmd.go

cmd/notation/blob/policy.go

cmd/notation/internal/policy/show.go

cmd/notation/internal/policy/import.go

Signed-off-by: Junjie Gao <[email protected]>

cmd/notation/policy/show.go

cmd/notation/blob/policy.go

Signed-off-by: Junjie Gao <[email protected]>

shizhMSFT

LGTM

cmd/notation/blob/cmd.go

cmd/notation/blob/policy/import.go

cmd/notation/blob/policy/show.go

cmd/notation/policy/show.go

cmd/notation/blob/policy/show.go

cmd/notation/policy/cmd.go

Signed-off-by: Junjie Gao <[email protected]>

yizha1 · 2024-12-30T23:53:39Z

@JeyJeyGao why the spec you referenced didnot point to main branch?

JeyJeyGao · 2024-12-31T01:23:39Z

@JeyJeyGao why the spec you referenced didnot point to main branch?

@yizha1 The link will be kept in the git history, so we need to pin the link to ensure the target file is not changed and remains accessible.

cmd/notation/blob/policy/show.go

cmd/notation/blob/cmd.go

cmd/notation/blob/policy/cmd.go

cmd/notation/blob/cmd.go

cmd/notation/blob/policy/import.go

cmd/notation/blob/policy/show.go

Signed-off-by: Junjie Gao <[email protected]>

cmd/notation/blob/cmd.go

cmd/notation/blob/policy/import.go

cmd/notation/blob/policy/show.go

Signed-off-by: Junjie Gao <[email protected]>

Two-Hearts

LGTM

cmd/notation/blob/policy/import.go

shizhMSFT · 2025-01-07T08:30:49Z

cmd/notation/blob/policy/show.go

-		fmt.Fprintf(os.Stderr, "Error: %s\n", err.Error())
-		fmt.Fprintf(os.Stderr, "Existing blob trust policy configuration is invalid, you may update or create a new one via `notation blob policy import <path-to-policy.json>`\n")
-		// not returning to show the invalid policy configuration
+		fmt.Fprintf(os.Stderr, "Existing blob trust policy file is invalid, you may update or create a new one via `notation blob policy import <path-to-policy.json>`. See https://github.com/notaryproject/specifications/blob/main/specs/trust-store-trust-policy.md#trust-policy-for-blobs for a blob trust policy example.\n")


main is referenced. Do we have a tagged version?

#1126 (comment)
We don't have a tagged version for now. Can we merge it now and update the link before next release which is suggested by @Two-Hearts ?

Updated to use digested link

Added issue #1138 to update it before v1.4

shizhMSFT · 2025-01-07T08:32:23Z

cmd/notation/blob/policy/show.go

+		fmt.Fprintf(os.Stderr, "Existing blob trust policy file is invalid, you may update or create a new one via `notation blob policy import <path-to-policy.json>`. See https://github.com/notaryproject/specifications/blob/main/specs/trust-store-trust-policy.md#trust-policy-for-blobs for a blob trust policy example.\n")
+		os.Stdout.Write(policyJSON)
+		return err


The behavior differs with the OCI policy show. Do you want to make them consistent?

#1126 (comment)
As suggested by @Two-Hearts , OCI policy command related changes have been removed. Can we send another PR for update OCI policy command?

Added issue #1138 to update it before v1.4

shizhMSFT

Please address the comments in the last review.

Signed-off-by: Junjie Gao <[email protected]>

shizhMSFT

LGTM

JeyJeyGao added 2 commits December 24, 2024 06:04

feat: add blob policy commands

e067e69

Signed-off-by: Junjie Gao <[email protected]>

fix: add e2e test cases

588f3e5

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao changed the title ~~feat: blob policy import & show commands~~ feat: add blob policy import and show commands Dec 24, 2024

JeyJeyGao added 5 commits December 24, 2024 08:03

fix: improve code

1ff8547

Signed-off-by: Junjie Gao <[email protected]>

fix: improve code

88aee76

Signed-off-by: Junjie Gao <[email protected]>

fix: improve code

8fe215e

Signed-off-by: Junjie Gao <[email protected]>

fix: improve code

e67b5fd

Signed-off-by: Junjie Gao <[email protected]>

fix: improve code

1eb1908

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao marked this pull request as ready for review December 24, 2024 08:41

JeyJeyGao requested review from gokarnm, NiazFK, priteshbandi, rgnote, shizhMSFT, toddysm, Two-Hearts, vaninrao10 and yizha1 as code owners December 24, 2024 08:41

shizhMSFT requested changes Dec 27, 2024

View reviewed changes

JeyJeyGao added 6 commits December 27, 2024 07:36

fix: split blob and OCI policy commands

77d87e5

Signed-off-by: Junjie Gao <[email protected]>

fix: simplify code

b1ed2fa

Signed-off-by: Junjie Gao <[email protected]>

fix: simplify code

91be43c

Signed-off-by: Junjie Gao <[email protected]>

fix: update error message

d70dd18

Signed-off-by: Junjie Gao <[email protected]>

fix: optimize readability

62c874c

Signed-off-by: Junjie Gao <[email protected]>

fix: improve readability

3494909

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao requested a review from shizhMSFT December 27, 2024 08:12

shizhMSFT reviewed Dec 30, 2024

View reviewed changes

cmd/notation/policy/show.go Outdated Show resolved Hide resolved

cmd/notation/blob/policy.go Outdated Show resolved Hide resolved

JeyJeyGao added 2 commits December 30, 2024 03:15

fix: replace os.IsNotExist(err) with errors.Is(err, fs.ErrNotExist)

5ab618b

Signed-off-by: Junjie Gao <[email protected]>

fix: update help doc

cf1fc19

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao requested a review from shizhMSFT December 30, 2024 03:22

fix: add E2E test cases

8ecf320

Signed-off-by: Junjie Gao <[email protected]>

shizhMSFT previously approved these changes Dec 30, 2024

View reviewed changes

Two-Hearts reviewed Dec 30, 2024

View reviewed changes

JeyJeyGao added 2 commits December 30, 2024 07:26

fix: resolve comments

b595f64

Signed-off-by: Junjie Gao <[email protected]>

fix: remove the change of oci policy commands

43878ed

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao dismissed shizhMSFT’s stale review via 43878ed December 30, 2024 07:30

JeyJeyGao added 2 commits December 30, 2024 07:33

fix: remove unused file

fad665c

Signed-off-by: Junjie Gao <[email protected]>

fix: E2E test

71f522a

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao requested review from Two-Hearts and shizhMSFT December 30, 2024 07:48

Two-Hearts reviewed Jan 6, 2025

View reviewed changes

cmd/notation/blob/policy/show.go Outdated Show resolved Hide resolved

Two-Hearts reviewed Jan 6, 2025

View reviewed changes

fix: resolve comment for Two-Hearts

ec7fe13

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao mentioned this pull request Jan 6, 2025

Update blob spec #1134

Open

JeyJeyGao requested a review from Two-Hearts January 6, 2025 06:52

Two-Hearts reviewed Jan 7, 2025

View reviewed changes

fix: resolve comments for Patrick

4d13267

Signed-off-by: Junjie Gao <[email protected]>

Two-Hearts previously approved these changes Jan 7, 2025

View reviewed changes

shizhMSFT approved these changes Jan 7, 2025

View reviewed changes

shizhMSFT requested changes Jan 7, 2025

View reviewed changes

fix: resolve comment

b76c4eb

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao dismissed Two-Hearts’s stale review via b76c4eb January 7, 2025 09:04

fix: update error message link

4360cfb

Signed-off-by: Junjie Gao <[email protected]>

JeyJeyGao mentioned this pull request Jan 7, 2025

OCI policy command update #1138

Open

shizhMSFT approved these changes Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `blob policy import` and `show` commands #1126

feat: add `blob policy import` and `show` commands #1126

JeyJeyGao commented Dec 24, 2024 •

edited

Loading

codecov bot commented Dec 24, 2024 •

edited

Loading

shizhMSFT left a comment

yizha1 commented Dec 30, 2024

JeyJeyGao commented Dec 31, 2024

Two-Hearts left a comment

shizhMSFT Jan 7, 2025

JeyJeyGao Jan 7, 2025

JeyJeyGao Jan 7, 2025

JeyJeyGao Jan 7, 2025

shizhMSFT Jan 7, 2025

JeyJeyGao Jan 7, 2025

JeyJeyGao Jan 7, 2025

shizhMSFT left a comment

shizhMSFT left a comment

feat: add blob policy import and show commands #1126

Are you sure you want to change the base?

feat: add blob policy import and show commands #1126

Conversation

JeyJeyGao commented Dec 24, 2024 • edited Loading

codecov bot commented Dec 24, 2024 • edited Loading

Codecov Report

shizhMSFT left a comment

Choose a reason for hiding this comment

yizha1 commented Dec 30, 2024

JeyJeyGao commented Dec 31, 2024

Two-Hearts left a comment

Choose a reason for hiding this comment

shizhMSFT Jan 7, 2025

Choose a reason for hiding this comment

JeyJeyGao Jan 7, 2025

Choose a reason for hiding this comment

JeyJeyGao Jan 7, 2025

Choose a reason for hiding this comment

JeyJeyGao Jan 7, 2025

Choose a reason for hiding this comment

shizhMSFT Jan 7, 2025

Choose a reason for hiding this comment

JeyJeyGao Jan 7, 2025

Choose a reason for hiding this comment

JeyJeyGao Jan 7, 2025

Choose a reason for hiding this comment

shizhMSFT left a comment

Choose a reason for hiding this comment

shizhMSFT left a comment

Choose a reason for hiding this comment

feat: add `blob policy import` and `show` commands #1126

feat: add `blob policy import` and `show` commands #1126

JeyJeyGao commented Dec 24, 2024 •

edited

Loading

codecov bot commented Dec 24, 2024 •

edited

Loading