Merge pull request ernoaapa#15 from arnested/comment

Add comment to top and bottom of generated content

Author: ernoaapa

.travis.yml

@@ -1,7 +1,7 @@
 language: go
 
 go:
-  - 1.9
+  - '1.10'
 
 before_install:
   - go get github.com/mitchellh/gox

README.md

@@ -32,6 +32,7 @@ Tool can be used for example to automatically update `.ssh/authorized_keys` file
 |----------------|-------------------|-----------------------------------------------------------------------------------------------------------|
 | --format       | No (default ssh)  | Output format. Only ssh authorized_keys format supported for now                                          |
 | --file-mode    | No (default 0600) | File permissions when writing to a file                                                                   |
+| --comment      | No (default none) | Include COMMENT at top and bottom                                                                         |
 
 #### GitHub
 | Parameter      | Description                                                                                               |

fetch/github.go

@@ -78,7 +78,7 @@ func fetchUsers(client *github.Client, organizationName string, params GithubFet
 	return users, err
 }
 
-func resolveTeamID(client *github.Client, organizationName, teamName string) (int, error) {
+func resolveTeamID(client *github.Client, organizationName, teamName string) (int64, error) {
 	ctx := context.Background()
 
 	teams, _, err := client.Organizations.ListTeams(ctx, organizationName, &github.ListOptions{})

format/builder.go

@@ -3,10 +3,10 @@ package format
 import log "github.com/Sirupsen/logrus"
 
 // Build builds output in given formatName format
-func Build(formatName string, keysByUsername map[string][]string) string {
+func Build(formatName string, keysByUsername map[string][]string, comment string) string {
 	switch formatName {
 	case "ssh":
-		return ssh(keysByUsername)
+		return ssh(keysByUsername, comment)
 	}
 	log.Fatalf("Invalid output format name: %s", formatName)
 	return ""

format/ssh.go

@@ -6,13 +6,22 @@ import (
 )
 
 // ssh produces output in .ssh/authorized_keys compatible format
-func ssh(keysByUsername map[string][]string) string {
+func ssh(keysByUsername map[string][]string, comment string) string {
 	stringBuffer := bytes.NewBufferString("")
 
+	if len(comment) > 0 {
+		stringBuffer.WriteString(fmt.Sprintf("# %s\n", comment))
+	}
+
 	for username, keys := range keysByUsername {
 		for _, key := range keys {
 			stringBuffer.WriteString(fmt.Sprintf("%s %s\n", key, username))
 		}
 	}
+
+	if len(comment) > 0 {
+		stringBuffer.WriteString(fmt.Sprintf("# %s\n", comment))
+	}
+
 	return stringBuffer.String()
 }

format/ssh_test.go

@@ -8,7 +8,7 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
-func TestSsh(t *testing.T) {
+func TestSshWithoutComment(t *testing.T) {
 	log.SetLevel(log.DebugLevel)
 
 	keys := map[string][]string{
@@ -17,7 +17,21 @@ func TestSsh(t *testing.T) {
 		},
 	}
 
-	result := ssh(keys)
+	result := ssh(keys, "")
 
 	assert.Equal(t, "ssh-rsa AAAAB3NzsshPublicKeyBlah ernoaapa\n", result, "Returned invalid ssh output")
 }
+
+func TestSshWithComment(t *testing.T) {
+	log.SetLevel(log.DebugLevel)
+
+	keys := map[string][]string{
+		"ernoaapa": {
+			"ssh-rsa AAAAB3NzsshPublicKeyBlah",
+		},
+	}
+
+	result := ssh(keys, "Generated file")
+
+	assert.Equal(t, "# Generated file\nssh-rsa AAAAB3NzsshPublicKeyBlah ernoaapa\n# Generated file\n", result, "Returned invalid ssh output")
+}

main.go

@@ -33,6 +33,10 @@ func main() {
 			Usage: "File permissions for file",
 			Value: "0600",
 		},
+		cli.StringFlag{
+			Name:  "comment",
+			Usage: "Include `COMMENT` at top and bottom",
+		},
 	}
 	app.Version = VersionString
 	app.Commands = []cli.Command{
@@ -77,6 +81,7 @@ func main() {
 					target   = c.Args().Get(0)
 					fileMode = os.FileMode(c.GlobalInt("file-mode"))
 					format   = c.GlobalString("format")
+					comment  = c.GlobalString("comment")
 
 					err error
 				)
@@ -103,7 +108,7 @@ func main() {
 					}
 				}
 
-				return output.Write(format, target, fileMode, utils.MergeKeys(orgKeys, userKeys))
+				return output.Write(format, target, fileMode, utils.MergeKeys(orgKeys, userKeys), comment)
 			},
 		},
 	}

output/writer.go

@@ -1,8 +1,9 @@
 package output
 
 import (
-	"github.com/ernoaapa/fetch-ssh-keys/format"
 	"os"
+
+	"github.com/ernoaapa/fetch-ssh-keys/format"
 )
 
 // Writer is interface for all output writers
@@ -11,9 +12,9 @@ type Writer interface {
 }
 
 // Write writes keys to given outputName in given formatName
-func Write(formatName, target string, perm os.FileMode, keysByUsername map[string][]string) error {
+func Write(formatName, target string, perm os.FileMode, keysByUsername map[string][]string, comment string) error {
 	writer := getWriter(target, perm)
-	return writer.write(format.Build(formatName, keysByUsername))
+	return writer.write(format.Build(formatName, keysByUsername, comment))
 }
 
 func getWriter(target string, perm os.FileMode) Writer {