From 3a33735da89ba45e5310e57ae58f13674a8c31ea Mon Sep 17 00:00:00 2001
From: vilmibm <vilmibm@neongrid.space>
Date: Fri, 7 Aug 2020 11:34:41 -0500
Subject: [PATCH] be more helpful

---
 pkg/cmd/auth/status/status.go      | 42 ++++++++++++++++++++++++++----
 pkg/cmd/auth/status/status_test.go |  6 +++--
 2 files changed, 41 insertions(+), 7 deletions(-)

diff --git a/pkg/cmd/auth/status/status.go b/pkg/cmd/auth/status/status.go
index b94f94b0b..d1c5b8f2a 100644
--- a/pkg/cmd/auth/status/status.go
+++ b/pkg/cmd/auth/status/status.go
@@ -88,16 +88,31 @@ func statusRun(opts *StatusOptions) error {
 		if err != nil {
 			var missingScopes *api.MissingScopesError
 			if errors.As(err, &missingScopes) {
-				return fmt.Errorf("%s %s: %s", utils.Red("X"), hostname, err)
+				fmt.Fprintf(stderr, "%s %s: %s\n", utils.Red("X"), hostname, err)
+				fmt.Fprintln(stderr,
+					"The token in GITHUB_TOKEN is valid but missing scopes that gh requires to function.")
 			} else {
-				return fmt.Errorf("%s %s: authentication failed", utils.Red("X"), hostname)
+				fmt.Fprintf(stderr, "%s %s: authentication failed\n", utils.Red("X"), hostname)
+				fmt.Fprintln(stderr)
+				fmt.Fprintf(stderr,
+					"The token in GITHUB_TOKEN is invalid.\n")
 			}
+			fmt.Fprintf(stderr,
+				"Please visit https://%s/settings/tokens and create a new token with 'repo', 'read:org', and 'gist' scopes.\n", hostname)
+			return cmdutil.SilentError
 		} else {
 			username, err := api.CurrentLoginName(apiClient, hostname)
 			if err != nil {
 				return fmt.Errorf("%s %s: api call failed: %s\n", utils.Red("X"), hostname, err)
 			}
-			fmt.Fprintf(stderr, "%s token valid for %s as %s\n", utils.GreenCheck(), hostname, utils.Bold(username))
+			fmt.Fprintf(stderr,
+				"%s token valid for %s as %s\n", utils.GreenCheck(), hostname, utils.Bold(username))
+			proto, _ := cfg.Get(hostname, "git_protocol")
+			if proto != "" {
+				fmt.Fprintln(stderr)
+				fmt.Fprintf(stderr,
+					"Git operations for %s configured to use %s protocol.\n", hostname, utils.Bold(proto))
+			}
 		}
 
 		return nil
@@ -105,8 +120,9 @@ func statusRun(opts *StatusOptions) error {
 
 	hostnames, err := cfg.Hosts()
 	if len(hostnames) == 0 || err != nil {
-		fmt.Fprintf(stderr, "You are not logged into any GitHub hosts. Run 'gh auth login' to authenticate.\n")
-		return nil
+		fmt.Fprintf(stderr,
+			"You are not logged into any GitHub hosts. Run %s to authenticate.\n", utils.Bold("gh auth login"))
+		return cmdutil.SilentError
 	}
 
 	httpClient, err := opts.HttpClient()
@@ -126,8 +142,17 @@ func statusRun(opts *StatusOptions) error {
 			var missingScopes *api.MissingScopesError
 			if errors.As(err, &missingScopes) {
 				fmt.Fprintf(stderr, "%s %s: %s\n", utils.Red("X"), hostname, err)
+				fmt.Fprintf(stderr, "To enable the missing scopes, please run %s %s\n",
+					utils.Bold("gh auth refresh -h"),
+					utils.Bold(hostname))
 			} else {
 				fmt.Fprintf(stderr, "%s %s: authentication failed\n", utils.Red("X"), hostname)
+				fmt.Fprintln(stderr)
+				fmt.Fprintf(stderr, "The configured token for %s is no longer valid.\n", utils.Bold(hostname))
+				fmt.Fprintf(stderr, "To re-authenticate, please run %s %s\n",
+					utils.Bold("gh auth login -h"), utils.Bold(hostname))
+				fmt.Fprintf(stderr, "To forget about this host, please run %s %s\n",
+					utils.Bold("gh auth logout -h"), utils.Bold(hostname))
 			}
 			failed = true
 		} else {
@@ -136,6 +161,13 @@ func statusRun(opts *StatusOptions) error {
 				fmt.Fprintf(stderr, "%s %s: api call failed: %s\n", utils.Red("X"), hostname, err)
 			}
 			fmt.Fprintf(stderr, "%s Logged in to %s as %s\n", utils.GreenCheck(), hostname, utils.Bold(username))
+			proto, _ := cfg.Get(hostname, "git_protocol")
+			if proto != "" {
+				fmt.Fprintln(stderr)
+				fmt.Fprintf(stderr,
+					"Git operations for %s configured to use %s protocol.\n", hostname, utils.Bold(proto))
+				fmt.Fprintln(stderr)
+			}
 		}
 
 		// NB we could take this opportunity to add or fix the "user" key in the hosts config. I chose
diff --git a/pkg/cmd/auth/status/status_test.go b/pkg/cmd/auth/status/status_test.go
index df12350af..d75d5d70f 100644
--- a/pkg/cmd/auth/status/status_test.go
+++ b/pkg/cmd/auth/status/status_test.go
@@ -113,7 +113,8 @@ func Test_statusRun(t *testing.T) {
 					httpmock.StatusStringResponse(400, "no bueno"),
 				)
 			},
-			wantErr: regexp.MustCompile(`authentication failed`),
+			wantErr:    regexp.MustCompile(``),
+			wantErrOut: regexp.MustCompile(`authentication failed`),
 		},
 		{
 			name: "token set, missing scope",
@@ -124,7 +125,8 @@ func Test_statusRun(t *testing.T) {
 			httpStubs: func(reg *httpmock.Registry) {
 				reg.Register(httpmock.REST("GET", ""), httpmock.ScopesResponder("repo,"))
 			},
-			wantErr: regexp.MustCompile(`missing required scope 'read:org'`),
+			wantErr:    regexp.MustCompile(``),
+			wantErrOut: regexp.MustCompile(`missing required scope 'read:org'`),
 		},
 		{
 			name: "token set, good token",