Merge pull request #1426 from smallstep/herman/testscript

Refactor CLI to make it testable using `testscript`

Author: hslatman

Makefile

@@ -157,13 +157,6 @@ race:
 
 .PHONY: test race
 
-integrate: integration
-
-integration: build
-	$Q $(CGO_OVERRIDE) gotestsum -- -tags=integration ./integration/...
-
-.PHONY: integrate integration
-
 #########################################
 # Linting
 #########################################

cmd/step/main.go

@@ -1,48 +1,12 @@
 package main
 
 import (
-	"errors"
-	"fmt"
-	"io"
 	"os"
-	"reflect"
-	"regexp"
-	"strings"
-	"time"
-
-	"github.com/urfave/cli"
 
 	"github.com/smallstep/certificates/ca"
-	"github.com/smallstep/cli-utils/command"
 	"github.com/smallstep/cli-utils/step"
-	"github.com/smallstep/cli-utils/ui"
-	"github.com/smallstep/cli-utils/usage"
-	"go.step.sm/crypto/jose"
-	"go.step.sm/crypto/pemutil"
-
-	"github.com/smallstep/cli/command/version"
-	"github.com/smallstep/cli/internal/plugin"
-	"github.com/smallstep/cli/utils"
-
-	// Enabled cas interfaces.
-	_ "github.com/smallstep/certificates/cas/cloudcas"
-	_ "github.com/smallstep/certificates/cas/softcas"
-	_ "github.com/smallstep/certificates/cas/stepcas"
 
-	// Enabled commands
-	_ "github.com/smallstep/cli/command/api"
-	_ "github.com/smallstep/cli/command/base64"
-	_ "github.com/smallstep/cli/command/beta"
-	_ "github.com/smallstep/cli/command/ca"
-	_ "github.com/smallstep/cli/command/certificate"
-	_ "github.com/smallstep/cli/command/completion"
-	_ "github.com/smallstep/cli/command/context"
-	_ "github.com/smallstep/cli/command/crl"
-	_ "github.com/smallstep/cli/command/crypto"
-	_ "github.com/smallstep/cli/command/fileserver"
-	_ "github.com/smallstep/cli/command/oauth"
-	_ "github.com/smallstep/cli/command/path"
-	_ "github.com/smallstep/cli/command/ssh"
+	"github.com/smallstep/cli/internal/cmd"
 )
 
 // Version is set by an LDFLAG at build time representing the git tag or commit
@@ -53,143 +17,15 @@ var Version = "N/A"
 // the time of build
 var BuildTime = "N/A"
 
+// AppName is the name of the binary. Defaults to "step" if not set.
+var AppName = ""
+
 func init() {
 	step.Set("Smallstep CLI", Version, BuildTime)
 	ca.UserAgent = step.Version()
+	cmd.SetName(AppName)
 }
 
 func main() {
-	// initialize step environment.
-	if err := step.Init(); err != nil {
-		fmt.Fprintln(os.Stderr, err.Error())
-		os.Exit(1)
-	}
-
-	defer panicHandler()
-
-	// create new instance of app
-	app := newApp(os.Stdout, os.Stderr)
-
-	if err := app.Run(os.Args); err != nil {
-		var messenger interface {
-			Message() string
-		}
-		if errors.As(err, &messenger) {
-			if os.Getenv("STEPDEBUG") == "1" {
-				fmt.Fprintf(os.Stderr, "%+v\n\n%s", err, messenger.Message())
-			} else {
-				fmt.Fprintln(os.Stderr, messenger.Message())
-				fmt.Fprintln(os.Stderr, "Re-run with STEPDEBUG=1 for more info.")
-			}
-		} else {
-			if os.Getenv("STEPDEBUG") == "1" {
-				fmt.Fprintf(os.Stderr, "%+v\n", err)
-			} else {
-				fmt.Fprintln(os.Stderr, err)
-			}
-		}
-		//nolint:gocritic // ignore exitAfterDefer error because the defer is required for recovery.
-		os.Exit(1)
-	}
-}
-
-func newApp(stdout, stderr io.Writer) *cli.App {
-	// Define default file writers and prompters for go.step.sm/crypto
-	pemutil.WriteFile = utils.WriteFile
-	pemutil.PromptPassword = func(msg string) ([]byte, error) {
-		return ui.PromptPassword(msg)
-	}
-	jose.PromptPassword = func(msg string) ([]byte, error) {
-		return ui.PromptPassword(msg)
-	}
-
-	// Override global framework components
-	cli.VersionPrinter = func(c *cli.Context) {
-		version.Command(c)
-	}
-	cli.AppHelpTemplate = usage.AppHelpTemplate
-	cli.SubcommandHelpTemplate = usage.SubcommandHelpTemplate
-	cli.CommandHelpTemplate = usage.CommandHelpTemplate
-	cli.HelpPrinter = usage.HelpPrinter
-	cli.FlagNamePrefixer = usage.FlagNamePrefixer
-	cli.FlagStringer = stringifyFlag
-
-	// Configure cli app
-	app := cli.NewApp()
-	app.Name = "step"
-	app.HelpName = "step"
-	app.Usage = "plumbing for distributed systems"
-	app.Version = step.Version()
-	app.Commands = command.Retrieve()
-	app.Flags = append(app.Flags, cli.HelpFlag)
-	app.EnableBashCompletion = true
-	app.Copyright = fmt.Sprintf("(c) 2018-%d Smallstep Labs, Inc.", time.Now().Year())
-
-	// Flag of custom configuration flag
-	app.Flags = append(app.Flags, cli.StringFlag{
-		Name:  "config",
-		Usage: "path to the config file to use for CLI flags",
-	})
-
-	// Action runs on `step` or `step <command>` if the command is not enabled.
-	app.Action = func(ctx *cli.Context) error {
-		args := ctx.Args()
-		if name := args.First(); name != "" {
-			if file, err := plugin.LookPath(name); err == nil {
-				return plugin.Run(ctx, file)
-			}
-			if u := plugin.GetURL(name); u != "" {
-				//nolint:staticcheck // this is a top level error - capitalization is ok
-				return fmt.Errorf("The plugin %q was not found on this system.\nDownload it from %s", name, u)
-			}
-			return cli.ShowCommandHelp(ctx, name)
-		}
-		return cli.ShowAppHelp(ctx)
-	}
-
-	// All non-successful output should be written to stderr
-	app.Writer = stdout
-	app.ErrWriter = stderr
-
-	return app
-}
-
-func panicHandler() {
-	if r := recover(); r != nil {
-		if os.Getenv("STEPDEBUG") == "1" {
-			fmt.Fprintf(os.Stderr, "%s\n", step.Version())
-			fmt.Fprintf(os.Stderr, "Release Date: %s\n\n", step.ReleaseDate())
-			panic(r)
-		}
-
-		fmt.Fprintln(os.Stderr, "Something unexpected happened.")
-		fmt.Fprintln(os.Stderr, "If you want to help us debug the problem, please run:")
-		fmt.Fprintf(os.Stderr, "STEPDEBUG=1 %s\n", strings.Join(os.Args, " "))
-		fmt.Fprintln(os.Stderr, "and send the output to [email protected]")
-		os.Exit(2)
-	}
-}
-
-func flagValue(f cli.Flag) reflect.Value {
-	fv := reflect.ValueOf(f)
-	for fv.Kind() == reflect.Ptr {
-		fv = reflect.Indirect(fv)
-	}
-	return fv
-}
-
-var placeholderString = regexp.MustCompile(`<.*?>`)
-
-func stringifyFlag(f cli.Flag) string {
-	fv := flagValue(f)
-	usg := fv.FieldByName("Usage").String()
-	placeholder := placeholderString.FindString(usg)
-	if placeholder == "" {
-		switch f.(type) {
-		case cli.BoolFlag, cli.BoolTFlag:
-		default:
-			placeholder = "<value>"
-		}
-	}
-	return cli.FlagNamePrefixer(fv.FieldByName("Name").String(), placeholder) + "\t" + usg
+	os.Exit(cmd.Run())
 }

docs/local-development.md

@@ -52,14 +52,6 @@ Run the unit tests:
 make test
 ```
 
-#### Integration Tests
-
-Run the integration tests:
-
-```
-make integration
-```
-
 #### And coding style tests
 
 The currently enabled linters are defined in our shared [golangci-lint config](https://raw.githubusercontent.com/smallstep/workflows/master/.golangci.yml)

go.mod

@@ -15,6 +15,7 @@ require (
 	github.com/manifoldco/promptui v0.9.0
 	github.com/pkg/errors v0.9.1
 	github.com/pquerna/otp v1.5.0
+	github.com/rogpeppe/go-internal v1.13.1
 	github.com/slackhq/nebula v1.9.5
 	github.com/smallstep/assert v0.0.0-20200723003110-82e2b9b3b262
 	github.com/smallstep/certificates v0.28.3
@@ -137,6 +138,7 @@ require (
 	golang.org/x/sync v0.15.0 // indirect
 	golang.org/x/text v0.26.0 // indirect
 	golang.org/x/time v0.11.0 // indirect
+	golang.org/x/tools v0.33.0 // indirect
 	google.golang.org/api v0.234.0 // indirect
 	google.golang.org/genproto v0.0.0-20250505200425-f936aa4a68b2 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20250505200425-f936aa4a68b2 // indirect

go.sum

@@ -473,6 +473,8 @@ golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc
 golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
 golang.org/x/tools v0.13.0/go.mod h1:HvlwmtVNQAhOuCjW7xxvovg8wbNq7LwfXh/k7wXUl58=
 golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxbQROHiO6hDPo2LHcIPhhQsa9DLh0yGk=
+golang.org/x/tools v0.33.0 h1:4qz2S3zmRxbGIhDIAgjxvFutSvH5EfnsYrRBj0UI0bc=
+golang.org/x/tools v0.33.0/go.mod h1:CIJMaWEY88juyUfo7UbgPqbC8rU2OqfAV1h2Qp0oMYI=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/api v0.234.0 h1:d3sAmYq3E9gdr2mpmiWGbm9pHsA/KJmyiLkwKfHBqU4=
 google.golang.org/api v0.234.0/go.mod h1:QpeJkemzkFKe5VCE/PMv7GsUfn9ZF+u+q1Q7w6ckxTg=