migrate login to urfave/cli

Author: burmudar

cmd/src/login.go

@@ -2,19 +2,18 @@ package main
 
 import (
 	"context"
-	"flag"
 	"fmt"
 	"io"
 	"net/url"
-	"os"
 
 	"github.com/sourcegraph/src-cli/internal/api"
+	"github.com/sourcegraph/src-cli/internal/clicompat"
 	"github.com/sourcegraph/src-cli/internal/cmderrors"
 	"github.com/sourcegraph/src-cli/internal/oauth"
+	"github.com/urfave/cli/v3"
 )
 
-func init() {
-	usage := `'src login' helps you authenticate 'src' to access a Sourcegraph instance with your user credentials.
+const loginExamples = `'src login' helps you authenticate 'src' to access a Sourcegraph instance with your user credentials.
 
 Usage:
 
@@ -35,49 +34,37 @@ Examples:
     $ src login https://sourcegraph.com
 `
 
-	flagSet := flag.NewFlagSet("login", flag.ExitOnError)
-	usageFunc := func() {
-		fmt.Fprintln(flag.CommandLine.Output(), usage)
-		flagSet.PrintDefaults()
-	}
-
-	var (
-		apiFlags = api.NewFlags(flagSet)
-	)
-
-	handler := func(args []string) error {
-		if err := flagSet.Parse(args); err != nil {
-			return err
-		}
-
+var loginCommand = clicompat.Wrap(&cli.Command{
+	Name:        "login",
+	Usage:       "authenticate to a Sourcegraph instance with your user credentials",
+	UsageText:   "src login [command options] [SOURCEGRAPH_URL]",
+	Description: loginExamples,
+	HideVersion: true,
+	Flags:       clicompat.WithAPIFlags(),
+	Action: func(ctx context.Context, cmd *cli.Command) error {
 		var loginEndpointURL *url.URL
-		if flagSet.NArg() >= 1 {
-			arg := flagSet.Arg(0)
+		if cmd.Args().Present() {
+			arg := cmd.Args().First()
 			u, err := parseEndpoint(arg)
 			if err != nil {
 				return cmderrors.Usage(fmt.Sprintf("invalid endpoint URL: %s", arg))
 			}
 			loginEndpointURL = u
 		}
 
+		apiFlags := clicompat.APIFlagsFromCmd(cmd)
 		client := cfg.apiClient(apiFlags, io.Discard)
 
-		return loginCmd(context.Background(), loginParams{
+		return loginCmd(ctx, loginParams{
 			cfg:              cfg,
 			client:           client,
-			out:              os.Stdout,
+			out:              cmd.Writer,
 			apiFlags:         apiFlags,
 			oauthClient:      oauth.NewClient(oauth.DefaultClientID),
 			loginEndpointURL: loginEndpointURL,
 		})
-	}
-
-	commands = append(commands, &command{
-		flagSet:   flagSet,
-		handler:   handler,
-		usageFunc: usageFunc,
-	})
-}
+	},
+})
 
 type loginParams struct {
 	cfg              *config

cmd/src/login_test.go

@@ -14,6 +14,7 @@ import (
 
 	"github.com/sourcegraph/src-cli/internal/cmderrors"
 	"github.com/sourcegraph/src-cli/internal/oauth"
+	"github.com/urfave/cli/v3"
 )
 
 func mustParseURL(t *testing.T, raw string) *url.URL {
@@ -164,6 +165,37 @@ func TestLogin(t *testing.T) {
 	})
 }
 
+func TestLoginCommand(t *testing.T) {
+	prevCfg := cfg
+	defer func() { cfg = prevCfg }()
+
+	s := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintln(w, `{"data":{"currentUser":{"username":"alice"}}}`)
+	}))
+	defer s.Close()
+
+	cfg = &config{
+		endpointURL: mustParseURL(t, s.URL),
+		accessToken: "x",
+	}
+
+	var out bytes.Buffer
+	cmd := *loginCommand
+	cmd.Writer = &out
+	cmd.ErrWriter = &out
+	cmd.ExitErrHandler = func(context.Context, *cli.Command, error) {}
+
+	err := cmd.Run(context.Background(), []string{"login", s.URL})
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	want := "\n✔︎ Authenticated as alice on " + s.URL + "\n\n\n💡 Tip: To use this endpoint in your shell, run:\n\n   export SRC_ENDPOINT=" + s.URL + "\n\n"
+	if out.String() != want {
+		t.Fatalf("output = %q, want %q", out.String(), want)
+	}
+}
+
 type fakeOAuthClient struct {
 	startErr    error
 	startCalled *bool

cmd/src/run_migration_compat.go

@@ -18,6 +18,7 @@ import (
 var migratedCommands = map[string]*cli.Command{
 	"abc":     abcCommand,
 	"auth":    authCommand,
+	"login":   loginCommand,
 	"version": versionCommand,
 }