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 <junjiegao@microsoft.com>

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

Codecov Report

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

Project coverage is 73.30%. Comparing base (cd933da) to head (6b9922a).
Report is 4 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   72.38%   73.30%   +0.91%     
==========================================
  Files          50       53       +3     
  Lines        3125     3240     +115     
==========================================
+ Hits         2262     2375     +113     
- Misses        670      671       +1     
- Partials      193      194       +1

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

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

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 <junjiegao@microsoft.com>

cmd/notation/policy/show.go

cmd/notation/blob/policy.go

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

cmd/notation/blob/cmd.go

cmd/notation/blob/policy/import.go

cmd/notation/blob/policy/show.go

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

Two-Hearts

LGTM

cmd/notation/blob/policy/import.go

cmd/notation/blob/policy/show.go

shizhMSFT

Please address the comments in the last review.

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

shizhMSFT

LGTM

Two-Hearts

LGTM

Two-Hearts

This PR depends on: notaryproject/notation-go#502 which fixes an error message of blob trust policy.

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao · 2025-01-14T09:23:32Z

This PR depends on: notaryproject/notation-go#502 which fixes an error message of blob trust policy.

Updated.

shizhMSFT

LGTM

Two-Hearts

LGTM

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 <junjiegao@microsoft.com>

JeyJeyGao added 2 commits December 24, 2024 06:04

feat: add blob policy commands

e067e69

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: add e2e test cases

588f3e5

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

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 <junjiegao@microsoft.com>

fix: improve code

88aee76

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: improve code

8fe215e

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: improve code

e67b5fd

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: improve code

1eb1908

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

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 <junjiegao@microsoft.com>

fix: simplify code

b1ed2fa

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: simplify code

91be43c

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: update error message

d70dd18

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: optimize readability

62c874c

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: improve readability

3494909

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

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 <junjiegao@microsoft.com>

fix: update help doc

cf1fc19

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao mentioned this pull request Jan 6, 2025

Update blob spec #1134

Closed

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 <junjiegao@microsoft.com>

Two-Hearts previously approved these changes Jan 7, 2025

View reviewed changes

shizhMSFT approved these changes Jan 7, 2025

View reviewed changes

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

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

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

shizhMSFT requested changes Jan 7, 2025

View reviewed changes

fix: resolve comment

b76c4eb

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

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 <junjiegao@microsoft.com>

JeyJeyGao mentioned this pull request Jan 7, 2025

OCI policy command update #1138

Closed

shizhMSFT previously approved these changes Jan 7, 2025

View reviewed changes

Two-Hearts previously approved these changes Jan 8, 2025

View reviewed changes

Two-Hearts reviewed Jan 9, 2025

View reviewed changes

Two-Hearts self-requested a review January 9, 2025 07:54

JeyJeyGao added 2 commits January 14, 2025 05:13

Merge remote-tracking branch 'upstream/main' into feat/blob_policy_cmd

15d940e

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

fix: bump up

0cb99f7

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao dismissed stale reviews from Two-Hearts and shizhMSFT via 0cb99f7 January 14, 2025 05:15

Merge remote-tracking branch 'upstream/main' into feat/blob_policy_cmd

6b9922a

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

JeyJeyGao requested a review from shizhMSFT January 14, 2025 09:24

shizhMSFT approved these changes Jan 14, 2025

View reviewed changes

Two-Hearts approved these changes Jan 15, 2025

View reviewed changes

JeyJeyGao merged commit 2920cae into notaryproject:main Jan 15, 2025
7 checks passed

JeyJeyGao deleted the feat/blob_policy_cmd branch January 15, 2025 05:37

This was referenced Mar 12, 2025

bump: release v2.0.0-alpha.1 #1215

Closed

bump: release v2.0.0-alpha.1 #1218

Merged

feat: add blob policy import and show commands #1126

feat: add blob policy import and show commands #1126

Uh oh!

Conversation

JeyJeyGao commented Dec 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Dec 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Two-Hearts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Two-Hearts left a comment

Choose a reason for hiding this comment

Uh oh!

Two-Hearts left a comment

Choose a reason for hiding this comment

Uh oh!

JeyJeyGao commented Jan 14, 2025

Uh oh!

shizhMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Two-Hearts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

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