flags.go and parse.go complete

Version2-Ideas.md

@@ -19,6 +19,7 @@ These are the things I'd like to change someday.
 There should be one program, with subcommands that have names that make more sense:
 
 * `blackbox init`
+* `blackbox info`
 * `blackbox admin add <key>`
 * `blackbox admin remove <key>`
 * `blackbox admin list`
@@ -27,14 +28,33 @@ There should be one program, with subcommands that have names that make more sen
 * `blackbox files remove`
 * `blackbox encrypt <filename> ...`
 * `blackbox decrypt <filename> ...`
-* `blackbox decrypt_all`
 * `blackbox cat <filename> ...`
 * `blackbox edit <filename> ...`
-* `blackbox reencrypt_all`
-* `blackbox shred_all`
+* `blackbox reencrypt`
+* `blackbox shred`
 * `blackbox diff <filename> ...`
-* `blackbox files unchanged`
-* `blackbox files changed`
+* `blackbox files list-unchanged`
+* `blackbox files list-changed`
+
+* `blackbox admin add <key>`
+* `blackbox admin list`
+* `blackbox admin remove <key>`
+* `blackbox cat <filename> ...`
+* `blackbox decrypt <filename> ...`
+* `blackbox diff <filename> ...`
+* `blackbox edit <filename> ...`
+* `blackbox encrypt <filename> ...`
+* `blackbox file add`
+* `blackbox file list`
+* `blackbox file remove`
+* `blackbox info`
+* `blackbox init`
+* `blackbox reencrypt`
+* `blackbox shred`
+* `blackbox status all`
+* `blackbox status changed`
+* `blackbox status unchanged`
+
 
 Flags where appropriate
 

cmd/blackbox/flags.go

@@ -145,23 +145,9 @@ func flags() *cli.App {
 			Usage:    "Print status of files",
 			Flags: []cli.Flag{
 				&cli.BoolFlag{Name: "name-only", Usage: "Show only names of the files"},
-			},
-			Subcommands: []*cli.Command{
-				{
-					Name:   "all",
-					Usage:  "All registered files",
-					Action: func(c *cli.Context) error { return cmdStatusAll(c) },
-				},
-				{
-					Name:   "changed",
-					Usage:  "Only include files that are newer than their .gpg file",
-					Action: func(c *cli.Context) error { return cmdStatusChanged(c) },
-				},
-				{
-					Name:   "unchanged",
-					Usage:  "Only include files that 'status changed' wouldn't list",
-					Action: func(c *cli.Context) error { return cmdStatusUnchanged(c) },
-				},
+				&cli.BoolFlag{Name: "all", Usage: "All registered files"},
+				&cli.BoolFlag{Name: "changed", Usage: "Only files newer than their .gpg"},
+				&cli.BoolFlag{Name: "unchanged", Usage: "Only files older than their .gpg"},
 			},
 		},
 

cmd/blackbox/parse.go

@@ -1,6 +1,7 @@
 package main
 
-// All the "blackbox admin" subcommands.
+// Processes the flags and arguments and calls the appropriate
+// business logic.
 
 import (
 	"fmt"
@@ -19,10 +20,23 @@ func init() {
 	}
 }
 
+func allOrSomeFiles(c *cli.Context) error {
+	if c.Bool("all") {
+		if c.Args().Present() {
+			return fmt.Errorf("Can not specify filenames and --all")
+		}
+	} else {
+		if !c.Args().Present() {
+			return fmt.Errorf("Must specify at least one file name")
+		}
+	}
+	return nil
+}
+
 // Keep these functions in alphabetical order.
 
 func cmdAdminAdd(c *cli.Context) error {
-	if c.Args().Present() {
+	if !c.Args().Present() {
 		return fmt.Errorf(
 			"Must specify at least one admin's GnuPG user-id (i.e. email address)")
 	}
@@ -31,91 +45,168 @@ func cmdAdminAdd(c *cli.Context) error {
 }
 
 func cmdAdminList(c *cli.Context) error {
-	if !c.Args().Present() {
+	if c.Args().Present() {
 		return fmt.Errorf("This command takes zero arguments")
 	}
 	bx := box.NewFromFlags(c)
-	return bx.AdminList(bx)
+	return bx.AdminList()
 }
 
 func cmdAdminRemove(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if !c.Args().Present() {
+		return fmt.Errorf("Must specify at least one admin's GnuPG user-id (i.e. email address)")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.AdminRemove(c.Args().Slice())
 }
 
 func cmdCat(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if !c.Args().Present() {
+		return fmt.Errorf("Must specify at least one file name")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Cat(c.Args().Slice())
 }
 
 func cmdDecrypt(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if err := allOrSomeFiles(c); err != nil {
+		return err
+	}
+	bulk := false
+	if c.Bool("all") {
+		bulk = c.Bool("bulk") // Only applies to --all
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Decrypt(c.Args().Slice(),
+		c.Bool("overwrite"),
+		bulk,
+		c.String("group"),
+	)
 }
 
 func cmdDiff(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if err := allOrSomeFiles(c); err != nil {
+		return err
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Diff(c.Args().Slice())
 }
 
 func cmdEdit(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if !c.Args().Present() {
+		return fmt.Errorf("Must specify at least one file name")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Edit(c.Args().Slice())
 }
 
 func cmdEncrypt(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if err := allOrSomeFiles(c); err != nil {
+		return err
+	}
+	bulk := false
+	if c.Bool("all") {
+		bulk = c.Bool("bulk") // Only applies to --all
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Encrypt(c.Args().Slice(), bulk, c.String("group"), c.Bool("overwrite"))
 }
 
 func cmdFileAdd(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if !c.Args().Present() {
+		return fmt.Errorf("Must specify at least one file name")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.FileAdd(c.Args().Slice(), c.Bool("overwrite"))
 }
 
 func cmdFileList(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if c.Args().Present() {
+		return fmt.Errorf("This command takes zero arguments")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.FileList()
 }
 
 func cmdFileRemove(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if !c.Args().Present() {
+		return fmt.Errorf("Must specify at least one file name")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.FileRemove(c.Args().Slice())
 }
 
 func cmdInfo(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if c.Args().Present() {
+		return fmt.Errorf("This command takes zero arguments")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Info()
 }
 
 func cmdInit(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if c.Args().Present() {
+		return fmt.Errorf("This command takes zero arguments")
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Init()
 }
 
 func cmdReencrypt(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if err := allOrSomeFiles(c); err != nil {
+		return err
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Reencrypt(c.Args().Slice())
 }
 
 func cmdShred(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if err := allOrSomeFiles(c); err != nil {
+		return err
+	}
+	bx := box.NewFromFlags(c)
+	return bx.Shred(c.Args().Slice())
 }
 
-func cmdStatusAll(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
-}
+func cmdStatus(c *cli.Context) error {
+	if err := allOrSomeFiles(c); err != nil {
+		return err
+	}
 
-func cmdStatusChanged(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
-}
+	mode := box.Itemized
 
-func cmdStatusUnchanged(c *cli.Context) error {
-	logErr.Println("NOT IMPLEMENTED")
-	return nil
+	if c.Bool("all") {
+		if c.Args().Present() {
+			return fmt.Errorf("Can not specify filenames and --all")
+		}
+		if mode != box.Itemized {
+			return fmt.Errorf("--all can not be mixed with other flags")
+		}
+		mode = box.All
+	}
+
+	if c.Bool("changed") {
+		if c.Args().Present() {
+			return fmt.Errorf("Can not specify filenames and --changed")
+		}
+		if mode != box.Itemized {
+			return fmt.Errorf("--changed can not be mixed with other flags")
+		}
+		mode = box.Changed
+	}
+
+	if c.Bool("unchanged") {
+		if c.Args().Present() {
+			return fmt.Errorf("Can not specify filenames and --unchanged")
+		}
+		if mode != box.Itemized {
+			return fmt.Errorf("--unchanged can not be mixed with other flags")
+		}
+		mode = box.Unchanged
+	}
+
+	bx := box.NewFromFlags(c)
+	return bx.Status(c.Args().Slice(), mode, c.Bool("name-only"))
 }
 
 //func cmdInfo(c *cli.Context) error {

cmd/blackbox/runbash.go

@@ -1,4 +1,5 @@
-// package main
+package main
+
 //
 // import (
 // 	"fmt"

go.mod

@@ -0,0 +1,5 @@
+module github.com/StackExchange/blackbox
+
+go 1.14
+
+require github.com/urfave/cli/v2 v2.2.0

go.sum

@@ -0,0 +1,13 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
+github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
+github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/urfave/cli/v2 v2.2.0 h1:JTTnM6wKzdA0Jqodd966MVj4vWbbquZykeX1sKbe2C4=
+github.com/urfave/cli/v2 v2.2.0/go.mod h1:SE9GqnLQmjVa0iPEY0f1w3ygNIYcIJ0OKPMoW2caLfQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

pkg/bbgit/discover.go

@@ -1,4 +1,5 @@
-// package bbgit
+package bbgit
+
 //
 // import (
 // 	"os/exec"

pkg/bbutil/admin.go

@@ -1,4 +1,5 @@
-// package bbutil
+package bbutil
+
 //
 // // Administrator is a description of the admininstrators.
 // type Administrator struct {

pkg/bbutil/adminplain.go

@@ -1,4 +1,5 @@
-// package bbutil
+package bbutil
+
 //
 // import (
 // 	"io/ioutil"

pkg/bbutil/decrypt.go

@@ -1,4 +1,5 @@
-// package bbutil
+package bbutil
+
 //
 // import (
 // 	"fmt"

pkg/bbutil/iterator.go

@@ -1,5 +1,5 @@
-// package bbutil
-//
+package bbutil
+
 // import (
 // 	"sort"
 // )

pkg/bbutil/reg.go

@@ -1,4 +1,5 @@
-// package bbutil
+package bbutil
+
 //
 // import (
 // 	"io/ioutil"

pkg/bbutil/repoinfo.go

@@ -1,5 +1,5 @@
-// package bbutil
-//
+package bbutil
+
 // import (
 // 	"os"
 // 	"path/filepath"