Merge pull request #156 from equinix/ssh-project

add "ssh-key get --project-id $ID"
equinix · Sep 26, 2022 · f6c65ae · f6c65ae
2 parents 713116a + cde98c2
commit f6c65ae
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 10 deletions.
diff --git a/docs/metal_ssh-key_get.md b/docs/metal_ssh-key_get.md
@@ -7,7 +7,7 @@ Retrieves a list of SSH keys or a specified SSH key.
 Retrieves a list of SSH keys associated with the current user's account or the details of single SSH key.
 
 ```
-metal ssh-key get [-i <SSH-key_UUID>] [flags]
+metal ssh-key get [-i <SSH-key_UUID>] [-P] [-p <project_id>] [flags]
 ```
 
 ### Examples
@@ -18,13 +18,18 @@ metal ssh-key get [-i <SSH-key_UUID>] [flags]
   
   # Returns the details of SSH key 5cb96463-88fd-4d68-94ba-2c9505ff265e:
   metal ssh-key get --id 5cb96463-88fd-4d68-94ba-2c9505ff265e
+
+  # Retrieve all project SSH keys
+  metal ssh-key get --project-ssh-keys --project-id [project_UUID]
 ```
 
 ### Options
 
 ```
-  -h, --help        help for get
-  -i, --id string   The UUID of an SSH key.
+  -h, --help                help for get
+  -i, --id string           The UUID of an SSH key.
+  -p, --project-id string   List SSH Keys for the project identified by Project ID (ignored without -P)
+  -P, --project-ssh-keys    List SSH Keys for projects
 ```
 
 ### Options inherited from parent commands

diff --git a/internal/ssh/retrieve.go b/internal/ssh/retrieve.go
@@ -21,29 +21,52 @@
 package ssh
 
 import (
+	"fmt"
+
+	"github.com/packethost/packngo"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 )
 
 func (c *Client) Retrieve() *cobra.Command {
-	var sshKeyID string
+	var (
+		sshKeyID string
+		projKeys bool
+	)
 
 	// retrieveSshKeysCmd represents the retrieveSshKeys command
 	retrieveSSHKeysCmd := &cobra.Command{
-		Use:     `get [-i <SSH-key_UUID>]`,
+		Use:     `get [-i <SSH-key_UUID>] [-P] [-p <project_id>]`,
 		Aliases: []string{"list"},
 		Short:   "Retrieves a list of SSH keys or a specified SSH key.",
 		Long:    "Retrieves a list of SSH keys associated with the current user's account or the details of single SSH key.",
 		Example: `  # Retrieves the SSH keys of the current user: 
   metal ssh-key get
   
   # Returns the details of SSH key 5cb96463-88fd-4d68-94ba-2c9505ff265e:
-  metal ssh-key get --id 5cb96463-88fd-4d68-94ba-2c9505ff265e`,
+  metal ssh-key get --id 5cb96463-88fd-4d68-94ba-2c9505ff265e
 
+  # Retrieve all project SSH keys
+  metal ssh-key get --project-ssh-keys --project-id [project_UUID]`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cmd.SilenceUsage = true
 			if sshKeyID == "" {
-				sshKeys, _, err := c.Service.List()
+				projectID, _ := cmd.LocalFlags().GetString("project-id")
+				listFn := func() ([]packngo.SSHKey, *packngo.Response, error) {
+					return c.Service.List()
+				}
+
+				if projKeys {
+					if projectID == "" {
+						return fmt.Errorf("Project (--project-id) is required with --project-keys")
+					}
+
+					listFn = func() ([]packngo.SSHKey, *packngo.Response, error) {
+						return c.Service.ProjectList(projectID)
+					}
+				}
+				sshKeys, _, err := listFn()
+
 				if err != nil {
 					return errors.Wrap(err, "Could not list SSH Keys")
 				}
@@ -73,5 +96,7 @@ func (c *Client) Retrieve() *cobra.Command {
 	}
 
 	retrieveSSHKeysCmd.Flags().StringVarP(&sshKeyID, "id", "i", "", "The UUID of an SSH key.")
+	retrieveSSHKeysCmd.Flags().BoolVarP(&projKeys, "project-ssh-keys", "P", false, "List SSH Keys for projects")
+	retrieveSSHKeysCmd.Flags().StringP("project-id", "p", "", "List SSH Keys for the project identified by Project ID (ignored without -P)")
 	return retrieveSSHKeysCmd
 }
diff --git a/internal/ssh/ssh.go b/internal/ssh/ssh.go
@@ -34,9 +34,10 @@ type Client struct {
 
 func (c *Client) NewCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use:   `ssh-key`,
-		Short: "SSH key operations. For more information on SSH keys, visit https://metal.equinix.com/developers/docs/accounts/ssh-keys/ in the Equinix Metal documentation.",
-		Long:  "SSH key operations: create, get, update, and delete.",
+		Use:     `ssh-key`,
+		Aliases: []string{`ssh-keys`},
+		Short:   "SSH key operations. For more information on SSH keys, visit https://metal.equinix.com/developers/docs/accounts/ssh-keys/ in the Equinix Metal documentation.",
+		Long:    "SSH key operations: create, get, update, and delete.",
 
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			if root := cmd.Root(); root != nil {