Silence cobra error handling and use flog.Fatal (#134)

cmoog · web-flow · commit c9043b79ad00 · 2020-10-20T23:32:11.000-05:00
* Silence cobra error handling and use flog.Fatal

* Improve environment not found error message
diff --git a/cmd/coder/main.go b/cmd/coder/main.go
@@ -42,8 +42,6 @@ func main() {
 	app.Version = fmt.Sprintf("%s %s %s/%s", version, runtime.Version(), runtime.GOOS, runtime.GOARCH)
 
 	if err := app.ExecuteContext(ctx); err != nil {
-		// NOTE: The returned error is already handled and logged by the cmd lib (cobra), so no need to re-handle it here.
-		//       As we are in the main, if there was an error, exit the process with an error code.
-		os.Exit(1)
+		flog.Fatal("%v", err)
 	}
 }
diff --git a/internal/cmd/ceapi.go b/internal/cmd/ceapi.go
@@ -2,11 +2,10 @@ package cmd
 
 import (
 	"context"
+	"fmt"
 
 	"cdr.dev/coder-cli/coder-sdk"
 	"golang.org/x/xerrors"
-
-	"go.coder.com/flog"
 )
 
 // Helpers for working with the Coder Enterprise API.
@@ -73,7 +72,18 @@ func findEnv(ctx context.Context, client *coder.Client, envName, userEmail strin
 		// Keep track of what we found for the logs.
 		found = append(found, env.Name)
 	}
-	flog.Error("found %q", found)
-	flog.Error("%q not found", envName)
-	return nil, coder.ErrNotFound
+
+	return nil, notFoundButDidFind{
+		needle:   envName,
+		haystack: found,
+	}
+}
+
+type notFoundButDidFind struct {
+	needle   string
+	haystack []string
+}
+
+func (n notFoundButDidFind) Error() string {
+	return fmt.Sprintf("\"%s\" not found in %q: %v", n.needle, n.haystack, coder.ErrNotFound)
 }
diff --git a/internal/cmd/cmd.go b/internal/cmd/cmd.go
@@ -13,8 +13,10 @@ var verbose bool = false
 // Make constructs the "coder" root command
 func Make() *cobra.Command {
 	app := &cobra.Command{
-		Use:   "coder",
-		Short: "coder provides a CLI for working with an existing Coder Enterprise installation",
+		Use:           "coder",
+		Short:         "coder provides a CLI for working with an existing Coder Enterprise installation",
+		SilenceErrors: true,
+		SilenceUsage:  true,
 	}
 
 	app.AddCommand(
diff --git a/internal/cmd/envs.go b/internal/cmd/envs.go
@@ -111,7 +111,7 @@ coder envs --user charlie@coder.com ls -o json \
 			}
 
 			if err = egroup.Wait(); err != nil {
-				return xerrors.Errorf("some stop operations failed: %w", err)
+				return xerrors.Errorf("some stop operations failed")
 			}
 			return nil
 		},
diff --git a/internal/cmd/login.go b/internal/cmd/login.go
@@ -6,7 +6,6 @@ import (
 	"net"
 	"net/http"
 	"net/url"
-	"os"
 	"strings"
 
 	"cdr.dev/coder-cli/coder-sdk"
@@ -42,10 +41,8 @@ func makeLoginCmd() *cobra.Command {
 			// Don't return errors as it would print the usage.
 
 			if err := login(cmd, u, config.URL, config.Session); err != nil {
-				flog.Error("Login error: %s.", err)
-				os.Exit(1)
+				return xerrors.Errorf("Login error", err)
 			}
-
 			return nil
 		},
 	}
diff --git a/internal/cmd/shell.go b/internal/cmd/shell.go
@@ -71,7 +71,7 @@ func shell(_ *cobra.Command, cmdArgs []string) error {
 		if exitErr, ok := err.(wsep.ExitError); ok {
 			os.Exit(exitErr.Code)
 		}
-		flog.Fatal("%+v", err)
+		return xerrors.Errorf("run command: %w", err)
 	}
 	return nil
 }
@@ -153,7 +153,7 @@ func runCommand(ctx context.Context, envName, command string, args []string) err
 	if err != nil {
 		var closeErr websocket.CloseError
 		if xerrors.As(err, &closeErr) {
-			return xerrors.Errorf("network error, is %q online? (%w)", envName, err)
+			return xerrors.Errorf("network error, is %q online?", envName)
 		}
 		return xerrors.Errorf("start remote command: %w", err)
 	}
diff --git a/internal/cmd/urls.go b/internal/cmd/urls.go
@@ -75,8 +75,7 @@ func validatePort(port string) (int, error) {
 	}
 	if p < 1 {
 		// Port 0 means 'any free port', which we don't support.
-		flog.Error("Port must be > 0")
-		return 0, strconv.ErrRange
+		return 0, xerrors.New("Port must be > 0")
 	}
 	return int(p), nil
 }

Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,6 @@ func main() {`
`42`	`42`	`app.Version = fmt.Sprintf("%s %s %s/%s", version, runtime.Version(), runtime.GOOS, runtime.GOARCH)`
`43`	`43`
`44`	`44`	`if err := app.ExecuteContext(ctx); err != nil {`
`45`		`- // NOTE: The returned error is already handled and logged by the cmd lib (cobra), so no need to re-handle it here.`
`46`		`- // As we are in the main, if there was an error, exit the process with an error code.`
`47`		`- os.Exit(1)`
	`45`	`+ flog.Fatal("%v", err)`
`48`	`46`	`}`
`49`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,7 @@ coder envs --user charlie@coder.com ls -o json \`
`111`	`111`	`}`
`112`	`112`
`113`	`113`	`if err = egroup.Wait(); err != nil {`
`114`		`- return xerrors.Errorf("some stop operations failed: %w", err)`
	`114`	`+ return xerrors.Errorf("some stop operations failed")`
`115`	`115`	`}`
`116`	`116`	`return nil`
`117`	`117`	`},`
Original file line number	Diff line number	Diff line change
`@@ -71,7 +71,7 @@ func shell(_ *cobra.Command, cmdArgs []string) error {`
`71`	`71`	`if exitErr, ok := err.(wsep.ExitError); ok {`
`72`	`72`	`os.Exit(exitErr.Code)`
`73`	`73`	`}`
`74`		`- flog.Fatal("%+v", err)`
	`74`	`+ return xerrors.Errorf("run command: %w", err)`
`75`	`75`	`}`
`76`	`76`	`return nil`
`77`	`77`	`}`
`@@ -153,7 +153,7 @@ func runCommand(ctx context.Context, envName, command string, args []string) err`
`153`	`153`	`if err != nil {`
`154`	`154`	`var closeErr websocket.CloseError`
`155`	`155`	`if xerrors.As(err, &closeErr) {`
`156`		`- return xerrors.Errorf("network error, is %q online? (%w)", envName, err)`
	`156`	`+ return xerrors.Errorf("network error, is %q online?", envName)`
`157`	`157`	`}`
`158`	`158`	`return xerrors.Errorf("start remote command: %w", err)`
`159`	`159`	`}`
Original file line number	Diff line number	Diff line change
`@@ -75,8 +75,7 @@ func validatePort(port string) (int, error) {`
`75`	`75`	`}`
`76`	`76`	`if p < 1 {`
`77`	`77`	`// Port 0 means 'any free port', which we don't support.`
`78`		`- flog.Error("Port must be > 0")`
`79`		`- return 0, strconv.ErrRange`
	`78`	`+ return 0, xerrors.New("Port must be > 0")`
`80`	`79`	`}`
`81`	`80`	`return int(p), nil`
`82`	`81`	`}`