feat(keys): add an optional name support for keys:add (#257)

This arg can be used interchangably with the key arg to keep backwards compatibility

That allows a user to do deis keys:add ~/.ssh/secret.pub and the name is detected or keys:add magic ~/.ssh/magic.pub or deis keys:add travis and then get the choice list to pick from

Closes #256

Author: helgi

cmd/cmd.go

@@ -51,7 +51,7 @@ type Commander interface {
 	HealthchecksUnset(string, string, []string) error
 	KeysList(int) error
 	KeyRemove(string) error
-	KeyAdd(string) error
+	KeyAdd(string, string) error
 	LimitsList(string) error
 	LimitsSet(string, []string, string) error
 	LimitsUnset(string, []string, string) error

cmd/keys.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"io"
 	"io/ioutil"
+	"os"
 	"path/filepath"
 	"strconv"
 	"strings"
@@ -63,7 +64,7 @@ func (d *DeisCmd) KeyRemove(keyID string) error {
 }
 
 // KeyAdd adds keys.
-func (d *DeisCmd) KeyAdd(keyLocation string) error {
+func (d *DeisCmd) KeyAdd(name string, keyLocation string) error {
 	s, err := settings.Load(d.ConfigFile)
 
 	if err != nil {
@@ -72,6 +73,16 @@ func (d *DeisCmd) KeyAdd(keyLocation string) error {
 
 	var key api.KeyCreateRequest
 
+	// check if name is the key
+	if name != "" && keyLocation == "" {
+		// detect of name is a file
+		_, err := os.Stat(name)
+		if err == nil {
+			keyLocation = name
+			name = ""
+		}
+	}
+
 	if keyLocation == "" {
 		ks, err := listKeys(d.WOut)
 		if err != nil {
@@ -88,6 +99,11 @@ func (d *DeisCmd) KeyAdd(keyLocation string) error {
 		}
 	}
 
+	// if name is provided by user then overwrite that in the key object
+	if name != "" {
+		key.ID = name
+	}
+
 	d.Printf("Uploading %s to deis...", filepath.Base(key.Name))
 
 	if _, err = keys.New(s.Client, key.ID, key.Public); d.checkAPICompatibility(s.Client, err) != nil {

cmd/keys_test.go

@@ -330,15 +330,54 @@ func TestKeyAdd(t *testing.T) {
 
 	out := fmt.Sprintf("Uploading %s to deis... done\n", filepath.Base(keyFile.Name()))
 
-	err = cmdr.KeyAdd(keyFile.Name())
+	err = cmdr.KeyAdd("", keyFile.Name())
 	assert.NoErr(t, err)
 	assert.Equal(t, testutil.StripProgress(b.String()), out, "output")
 
 	b.Reset()
 	cmdr.WIn = strings.NewReader("0\n" + keyFile.Name())
-	err = cmdr.KeyAdd("")
+	err = cmdr.KeyAdd("", "")
 	assert.NoErr(t, err)
 	assert.Equal(t, testutil.StripProgress(b.String()), `Found the following SSH public keys:
 0) Enter path to pubfile (or use keys:add <key_path>)
 Which would you like to use with Deis? Enter the path to the pubkey file: `+out, "output")
 }
+
+func TestKeyAddName(t *testing.T) {
+	// Set temp home dir so no unknown files are listed.
+	name, err := ioutil.TempDir("", "deis-key")
+	assert.NoErr(t, err)
+	settings.SetHome(name)
+	folder := filepath.Join(name, ".ssh")
+	err = os.Mkdir(folder, 0755)
+	assert.NoErr(t, err)
+
+	cf, server, err := testutil.NewTestServerAndClient()
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer server.Close()
+	var b bytes.Buffer
+	cmdr := DeisCmd{WOut: &b, ConfigFile: cf}
+
+	keyFile, err := ioutil.TempFile("", "deis-cli-unit-test-ssh-key")
+	assert.NoErr(t, err)
+	// generate with one name but used another in the add
+	toWrite := []byte("ssh-rsa abc test@example.com")
+	_, err = keyFile.Write(toWrite)
+	assert.NoErr(t, err)
+	keyFile.Close()
+
+	server.Mux.HandleFunc("/v2/keys/", func(w http.ResponseWriter, r *http.Request) {
+		testutil.SetHeaders(w)
+		testutil.AssertBody(t, api.KeyCreateRequest{ID: "deis-test-key", Public: string(toWrite)}, r)
+		w.WriteHeader(http.StatusCreated)
+		fmt.Fprintf(w, "{}")
+	})
+
+	out := fmt.Sprintf("Uploading %s to deis... done\n", filepath.Base(keyFile.Name()))
+
+	err = cmdr.KeyAdd("deis-test-key", keyFile.Name())
+	assert.NoErr(t, err)
+	assert.Equal(t, testutil.StripProgress(b.String()), out, "output")
+}

parser/keys.go

@@ -69,9 +69,13 @@ func keyAdd(argv []string, cmdr cmd.Commander) error {
 	usage := `
 Adds SSH keys for the logged in user.
 
-Usage: deis keys:add [<key>]
+Usage: deis keys:add [<name>] [<key>]
+
+<name> and <key> can be used in either order and are both optional
 
 Arguments:
+  <name>
+    name of the SSH key
   <key>
     a local file path to an SSH public key used to push application code.
 `
@@ -81,7 +85,7 @@ Arguments:
 		return err
 	}
 
-	return cmdr.KeyAdd(safeGetValue(args, "<key>"))
+	return cmdr.KeyAdd(safeGetValue(args, "<name>"), safeGetValue(args, "<key>"))
 }
 
 func keyRemove(argv []string, cmdr cmd.Commander) error {

parser/keys_test.go

@@ -20,7 +20,7 @@ func (d FakeDeisCmd) KeyRemove(string) error {
 	return errors.New("keys:remove")
 }
 
-func (d FakeDeisCmd) KeyAdd(string) error {
+func (d FakeDeisCmd) KeyAdd(string, string) error {
 	return errors.New("keys:add")
 }
 
@@ -46,7 +46,7 @@ func TestKeys(t *testing.T) {
 			expected: "",
 		},
 		{
-			args:     []string{"keys:add", "key"},
+			args:     []string{"keys:add", "name", "key"},
 			expected: "",
 		},
 		{