cli: fix the process exit status codes

pkg/cli/BUILD.bazel

@@ -311,11 +311,14 @@ go_test(
         "//pkg/base",
         "//pkg/build",
         "//pkg/cli/clicfg",
+        "//pkg/cli/clierror",
+        "//pkg/cli/clierrorplus",
         "//pkg/cli/cliflags",
         "//pkg/cli/clisqlcfg",
         "//pkg/cli/clisqlclient",
         "//pkg/cli/clisqlexec",
         "//pkg/cli/democluster",
+        "//pkg/cli/exit",
         "//pkg/gossip",
         "//pkg/jobs",
         "//pkg/jobs/jobspb",

pkg/cli/cli.go

@@ -67,16 +67,21 @@ func Main() {
 
 		// Finally, extract the error code, as optionally specified
 		// by the sub-command.
-		errCode = exit.UnspecifiedError()
-		var cliErr *clierror.Error
-		if errors.As(err, &cliErr) {
-			errCode = cliErr.GetExitCode()
-		}
+		errCode = getExitCode(err)
 	}
 
 	exit.WithCode(errCode)
 }
 
+func getExitCode(err error) (errCode exit.Code) {
+	errCode = exit.UnspecifiedError()
+	var cliErr *clierror.Error
+	if errors.As(err, &cliErr) {
+		errCode = cliErr.GetExitCode()
+	}
+	return errCode
+}
+
 func doMain(cmd *cobra.Command, cmdName string) error {
 	if cmd != nil {
 		// Apply the configuration defaults from environment variables.

pkg/cli/cli_test.go

@@ -14,9 +14,13 @@ import (
 	"fmt"
 	"testing"
 
+	"github.com/cockroachdb/cockroach/pkg/cli/clierror"
+	"github.com/cockroachdb/cockroach/pkg/cli/clierrorplus"
+	"github.com/cockroachdb/cockroach/pkg/cli/exit"
 	"github.com/cockroachdb/cockroach/pkg/testutils"
 	"github.com/cockroachdb/cockroach/pkg/util/leaktest"
 	"github.com/cockroachdb/errors"
+	"github.com/spf13/cobra"
 )
 
 func TestCLITimeout(t *testing.T) {
@@ -72,3 +76,26 @@ func TestJunkPositionalArguments(t *testing.T) {
 		}
 	}
 }
+
+func Example_exitcode() {
+	c := NewCLITest(TestCLIParams{NoServer: true})
+	defer c.Cleanup()
+
+	testCmd := &cobra.Command{
+		Use: "test-exit-code",
+		RunE: clierrorplus.MaybeDecorateError(
+			func(_ *cobra.Command, _ []string) error {
+				return clierror.NewError(errors.New("err"), exit.Interrupted())
+			}),
+	}
+	cockroachCmd.AddCommand(testCmd)
+	defer cockroachCmd.RemoveCommand(testCmd)
+
+	c.reportExitCode = true
+	c.Run("test-exit-code")
+
+	// Output:
+	// test-exit-code
+	// ERROR: err
+	// exit code: 3
+}

pkg/cli/clierror/formatted_error.go

@@ -57,6 +57,10 @@ type formattedError struct {
 	showSeverity, verbose bool
 }
 
+func (f *formattedError) Unwrap() error {
+	return f.err
+}
+
 // Error implements the error interface.
 func (f *formattedError) Error() string {
 	// If we're applying recursively, ignore what's there and display the original error.

pkg/cli/interactive_tests/test_server_sig.tcl

@@ -34,9 +34,9 @@ eexpect "shutdown completed"
 eexpect ":/# "
 end_test
 
-start_test "Check that Ctrl+C finishes with exit code 1. (#9051)"
+start_test "Check that Ctrl+C finishes with exit code 3. (#9051+#70673)"
 send "echo \$?\r"
-eexpect "1\r\n"
+eexpect "3\r\n"
 eexpect ":/# "
 end_test
 

pkg/cli/testutils.go

@@ -28,6 +28,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/cli/clierror"
 	"github.com/cockroachdb/cockroach/pkg/cli/cliflags"
 	"github.com/cockroachdb/cockroach/pkg/cli/clisqlexec"
+	"github.com/cockroachdb/cockroach/pkg/cli/exit"
 	"github.com/cockroachdb/cockroach/pkg/roachpb"
 	"github.com/cockroachdb/cockroach/pkg/security"
 	"github.com/cockroachdb/cockroach/pkg/security/securitytest"
@@ -61,15 +62,23 @@ type TestCLI struct {
 	logScope *log.TestLogScope
 	// if true, doesn't print args during RunWithArgs.
 	omitArgs bool
+	// if true, prints the requested exit code during RunWithArgs.
+	reportExitCode bool
 }
 
 // TestCLIParams contains parameters used by TestCLI.
 type TestCLIParams struct {
-	T           *testing.T
-	Insecure    bool
-	NoServer    bool
-	StoreSpecs  []base.StoreSpec
-	Locality    roachpb.Locality
+	T        *testing.T
+	Insecure bool
+	// NoServer, if true, starts the test without a DB server.
+	NoServer bool
+
+	// The store specifications for the in-memory server.
+	StoreSpecs []base.StoreSpec
+	// The locality tiers for the in-memory server.
+	Locality roachpb.Locality
+
+	// NoNodelocal, if true, disables node-local external I/O storage.
 	NoNodelocal bool
 }
 
@@ -350,6 +359,13 @@ func (c TestCLI) RunWithArgs(origArgs []string) {
 		return Run(args)
 	}(); err != nil {
 		clierror.OutputError(os.Stdout, err, true /*showSeverity*/, false /*verbose*/)
+		if c.reportExitCode {
+			fmt.Fprintln(os.Stdout, "exit code:", getExitCode(err))
+		}
+	} else {
+		if c.reportExitCode {
+			fmt.Fprintln(os.Stdout, "exit code:", exit.Success())
+		}
 	}
 }