Skip to content

use cobra for notation cli #255

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.

Sign up for GitHub

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

Merged
shizhMSFT merged 6 commits into from
Jul 27, 2022
Merged

use cobra for notation cli #255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
39aa10c
use cobra for notation cli
Jul 20, 2022
0639810
typo fix
Jul 21, 2022
27d692e
clean some code
Jul 21, 2022
24c1f6c
fix naming and indention
Jul 22, 2022
c931819
better error message when args checker failed
Jul 25, 2022
4a0f2d8
nit:delete space
Jul 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions cmd/docker-notation/sign.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,15 @@ var signCommand = &cli.Command{
}

func signImage(ctx *cli.Context) error {
signer, err := cmd.GetSigner(ctx)
// TODO: make this change only to make sure the code can be compiled
// According to the https://github.com/notaryproject/notation/discussions/251,
// we can update/deprecate it later
signerOpts := &cmd.SignerFlagOpts{
Key: ctx.String(cmd.FlagKey.Name),
KeyFile: ctx.String(cmd.FlagKeyFile.Name),
CertFile: ctx.String(cmd.FlagCertFile.Name),
}
signer, err := cmd.GetSigner(signerOpts)
if err != nil {
return err
}
Expand All @@ -55,7 +63,7 @@ func signImage(ctx *cli.Context) error {
}
}
sig, err := signer.Sign(ctx.Context, desc, notation.SignOptions{
Expiry: cmd.GetExpiry(ctx),
Expiry: cmd.GetExpiry(ctx.Duration(cmd.FlagExpiry.Name)),
})
if err != nil {
return err
Expand Down
190 changes: 108 additions & 82 deletions cmd/notation/cache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"bufio"
"context"
"errors"
"fmt"
"io/fs"
Expand All @@ -11,80 +12,118 @@ import (

"github.com/notaryproject/notation/pkg/config"
"github.com/opencontainers/go-digest"
"github.com/urfave/cli/v2"
"github.com/spf13/cobra"
"oras.land/oras-go/v2/registry"
)

var (
cacheCommand = &cli.Command{
Name: "cache",
Usage: "Manage signature cache",
Subcommands: []*cli.Command{
cacheListCommand,
cachePruneCommand,
cacheRemoveCommand,
},
type cacheListOpts struct {
RemoteFlagOpts
reference string
}

type cachePruneOpts struct {
RemoteFlagOpts
references []string
all bool
purge bool
force bool
}

type cacheRemoveOpts struct {
RemoteFlagOpts
reference string
sigDigests []string
}

func cacheCommand() *cobra.Command {
command := &cobra.Command{
Use: "cache",
Short: "Manage signature cache",
}
command.AddCommand(cacheListCommand(nil), cachePruneCommand(nil), cacheRemoveCommand(nil))
return command
}

cacheListCommand = &cli.Command{
Name: "list",
Usage: "List signatures in cache",
func cacheListCommand(opts *cacheListOpts) *cobra.Command {
if opts == nil {
opts = &cacheListOpts{}
}
command := &cobra.Command{
Use: "list [reference|manifest_digest]",
Aliases: []string{"ls"},
Flags: []cli.Flag{
flagLocal,
flagUsername,
flagPassword,
Short: "List signatures in cache",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) > 0 {
opts.reference = args[0]
}
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
return listCachedSignatures(cmd, opts)
},
ArgsUsage: "[reference|manifest_digest]",
Action: listCachedSignatures,
}
opts.ApplyFlags(command.Flags())
return command
}

cachePruneCommand = &cli.Command{
Name: "prune",
Usage: "Prune signature from cache",
ArgsUsage: "[reference|manifest_digest] ...",
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "all",
Aliases: []string{"a"},
Usage: "prune all cached signatures",
},
&cli.BoolFlag{
Name: "purge",
Usage: "remove the signature directory, combined with --all",
},
&cli.BoolFlag{
Name: "force",
Aliases: []string{"f"},
Usage: "do not prompt for confirmation",
},
flagLocal,
flagUsername,
flagPassword,
func cachePruneCommand(opts *cachePruneOpts) *cobra.Command {
if opts == nil {
opts = &cachePruneOpts{}
}
command := &cobra.Command{
Use: "prune [reference|manifest_digest]...",
Short: "Prune signature from cache",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return errors.New("nothing to prune")
}
opts.references = args
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
return pruneCachedSignatures(cmd, opts)
},
Action: pruneCachedSignatures,
}
command.Flags().BoolVarP(&opts.all, "all", "a", false, "prune all cached signatures")
command.Flags().BoolVar(&opts.purge, "purge", false, "remove the signature directory, combined with --all")
command.Flags().BoolVarP(&opts.force, "force", "f", false, "do not prompt for confirmation")
opts.ApplyFlags(command.Flags())
return command
}

cacheRemoveCommand = &cli.Command{
Name: "remove",
Usage: "Remove signature from cache",
Aliases: []string{"rm"},
ArgsUsage: "<reference|manifest_digest> <signature_digest> ...",
Flags: []cli.Flag{
flagLocal,
flagUsername,
flagPassword,
func cacheRemoveCommand(opts *cacheRemoveOpts) *cobra.Command {
if opts == nil {
opts = &cacheRemoveOpts{}
}
command := &cobra.Command{
Use: "remove [reference|manifest_digest] [signature_digest]...",
Aliases: []string{"rm"},
Short: "Remove signature from cache",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return errors.New("missing target manifest")
}
opts.reference = args[0]
if len(args) == 1 {
return errors.New("no signature specified")
}
opts.sigDigests = args[1:]
return nil
},
RunE: func(cmd *cobra.Command, args []string) error {
return removeCachedSignatures(cmd, opts)
},
Action: removeCachedSignatures,
}
)
opts.ApplyFlags(command.Flags())
return command
}

func listCachedSignatures(ctx *cli.Context) error {
if !ctx.Args().Present() {
func listCachedSignatures(command *cobra.Command, opts *cacheListOpts) error {
if command.Flags().NArg() == 0 {
return listManifestsWithCachedSignature()
}

manifestDigest, err := getManifestDigestFromContext(ctx, ctx.Args().First())
manifestDigest, err := getManifestDigestFromContext(command.Context(), &opts.RemoteFlagOpts, opts.reference)
if err != nil {
return err
}
Expand Down Expand Up @@ -113,12 +152,12 @@ func listManifestsWithCachedSignature() error {
})
}

func pruneCachedSignatures(ctx *cli.Context) error {
if ctx.Bool("all") {
if !ctx.Bool("force") {
func pruneCachedSignatures(command *cobra.Command, opts *cachePruneOpts) error {
if opts.all {
if !opts.force {
fmt.Println("WARNING! This will remove:")
fmt.Println("- all cached signatures")
if ctx.Bool("purge") {
if opts.purge {
fmt.Println("- all files in the cache signature directory")
}
fmt.Println()
Expand All @@ -144,17 +183,13 @@ func pruneCachedSignatures(ctx *cli.Context) error {
); err != nil {
return err
}
if ctx.Bool("purge") {
if opts.purge {
return os.RemoveAll(config.SignatureStoreDirPath)
}
return nil
}

if !ctx.Args().Present() {
return errors.New("nothing to prune")
}
refs := ctx.Args().Slice()
if !ctx.Bool("force") {
refs := opts.references
if !opts.force {
fmt.Println("WARNING! This will remove cached signatures for manifests below:")
for _, ref := range refs {
fmt.Println("-", ref)
Expand All @@ -165,7 +200,7 @@ func pruneCachedSignatures(ctx *cli.Context) error {
}
}
for _, ref := range refs {
manifestDigest, err := getManifestDigestFromContext(ctx, ref)
manifestDigest, err := getManifestDigestFromContext(command.Context(), &opts.RemoteFlagOpts, ref)
if err != nil {
return err
}
Expand All @@ -180,24 +215,15 @@ func pruneCachedSignatures(ctx *cli.Context) error {
return nil
}

func removeCachedSignatures(ctx *cli.Context) error {
func removeCachedSignatures(command *cobra.Command, opts *cacheRemoveOpts) error {
// initialize
sigDigests := ctx.Args().Slice()
if len(sigDigests) == 0 {
return errors.New("missing target manifest")
}
sigDigests = sigDigests[1:]
if len(sigDigests) == 0 {
return errors.New("no signature specified")
}

manifestDigest, err := getManifestDigestFromContext(ctx, ctx.Args().First())
manifestDigest, err := getManifestDigestFromContext(command.Context(), &opts.RemoteFlagOpts, opts.reference)
if err != nil {
return err
}

// core process
for _, sigDigest := range sigDigests {
for _, sigDigest := range opts.sigDigests {
path := config.SignaturePath(manifestDigest, digest.Digest(sigDigest))
if err := os.Remove(path); err != nil {
return err
Expand Down Expand Up @@ -235,7 +261,7 @@ func walkCachedSignatureTree(root string, fn func(algorithm string, encodedEntry
return nil
}

func getManifestDigestFromContext(ctx *cli.Context, ref string) (manifestDigest digest.Digest, err error) {
func getManifestDigestFromContext(ctx context.Context, opts *RemoteFlagOpts, ref string) (manifestDigest digest.Digest, err error) {
manifestDigest, err = digest.Parse(ref)
if err == nil {
return
Expand All @@ -250,7 +276,7 @@ func getManifestDigestFromContext(ctx *cli.Context, ref string) (manifestDigest
return
}

manifest, err := getManifestDescriptorFromContextWithReference(ctx, ref)
manifest, err := getManifestDescriptorFromContextWithReference(ctx, opts, ref)
if err != nil {
return
}
Expand Down
Loading