Skip to content

update: based on spec, updated messages of notation key command #684

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
priteshbandi merged 4 commits into from May 25, 2023
Merged

update: based on spec, updated messages of notation key command #684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f5127e
based on spec, updated messages of notation key command
May 25, 2023
34d44e1
updated per code review
May 25, 2023
f164ecb
Merge branch 'notaryproject:main' into key
May 25, 2023
61f4a8e
update
May 25, 2023
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
27 changes: 19 additions & 8 deletions cmd/notation/key.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ import (
"context"
"errors"
"fmt"
"github.com/notaryproject/notation-go/config"
"os"

"github.com/notaryproject/notation-go/config"

"github.com/notaryproject/notation-go/log"
"github.com/notaryproject/notation/internal/cmd"
"github.com/notaryproject/notation/internal/ioutil"
Expand Down Expand Up @@ -74,7 +75,7 @@ func keyAddCommand(opts *keyAddOpts) *cobra.Command {
}
command := &cobra.Command{
Use: "add --plugin <plugin_name> [flags] <key_name>",
Short: "Add key to signing key list",
Short: "Add key to Notation signing key list",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) != 1 {
return errors.New("either missing key name or unnecessary parameters passed")
Expand Down Expand Up @@ -105,7 +106,7 @@ func keyUpdateCommand(opts *keyUpdateOpts) *cobra.Command {
command := &cobra.Command{
Use: "update [flags] <key_name>",
Aliases: []string{"set"},
Short: "Update key in signing key list",
Short: "Update key in Notation signing key list",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return errors.New("missing key name")
Expand Down Expand Up @@ -142,7 +143,7 @@ func keyDeleteCommand(opts *keyDeleteOpts) *cobra.Command {

command := &cobra.Command{
Use: "delete [flags] <key_name>...",
Short: "Delete key from signing key list",
Short: "Remove key from Notation signing key list",
Args: func(cmd *cobra.Command, args []string) error {
if len(args) == 0 {
return errors.New("missing key names")
Expand Down Expand Up @@ -243,11 +244,21 @@ func deleteKeys(ctx context.Context, opts *keyDeleteOpts) error {
}

// write out
for _, name := range deletedNames {
if prevDefault == name {
fmt.Printf("%s: unmarked as default\n", name)
if len(deletedNames) == 1 {
name := deletedNames[0]
if name == prevDefault {
fmt.Printf("Removed default key %s from Notation signing key list. The source key still exists.\n", name)
} else {
fmt.Println(name)
fmt.Printf("Removed %s from Notation signing key list. The source key still exists.\n", name)
}
} else if len(deletedNames) > 1 {
fmt.Println("Removed the following keys from Notation signing key list. The source keys still exist.")
for _, name := range deletedNames {
if name == prevDefault {
fmt.Println(name, "(default)")
} else {
fmt.Println(name)
}
}
}
return nil
Expand Down
8 changes: 7 additions & 1 deletion specs/commandline/key.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,12 @@ Removed <key_name> from Notation signing key list. The source key still exists.
Removed <key_name> from Notation signing key list. The source key still exists.
```

- Upon successful removal of the default key, the output message is printed out as follows:

```text
Removed default key <key_name> from Notation signing key list. The source key still exists.
```

### Remove two keys from Notation signing key list

```shell
Expand All @@ -143,5 +149,5 @@ Upon successful execution, the output message is printed out as follows. Please
```text
Removed the following keys from Notation signing key list. The source keys still exist.
<key_name_1>
<key_name_2>
<key_name_2> (default)
```