refactor: Add cmd.Execute function which properly tears down after a panic

Author: gabe565

cmd/cmd.go

@@ -1,11 +1,14 @@
 package cmd
 
 import (
+	"errors"
+	"fmt"
 	"log/slog"
 	"net/http"
 	"os"
 	"os/signal"
 	"path/filepath"
+	"runtime/debug"
 	"syscall"
 
 	"github.com/clevyr/kubedb/cmd/dump"
@@ -22,7 +25,7 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func NewCommand() *cobra.Command {
+func New() *cobra.Command {
 	name := "kubedb"
 	var annotations map[string]string
 	if filepath.Base(os.Args[0]) == "kubectl-db" {
@@ -40,6 +43,7 @@ func NewCommand() *cobra.Command {
 		Version:           buildVersion(),
 		DisableAutoGenTag: true,
 		Annotations:       annotations,
+		SilenceErrors:     true,
 
 		PersistentPreRunE: preRun,
 	}
@@ -90,7 +94,6 @@ func preRun(cmd *cobra.Command, _ []string) error {
 	cmd.SetContext(ctx)
 
 	log.InitGlobal(cmd)
-	cmd.Root().SilenceErrors = true
 
 	if config.Global.HealthchecksPingURL != "" {
 		if handler, err := notifier.NewHealthchecks(config.Global.HealthchecksPingURL); err != nil {
@@ -113,10 +116,29 @@ func preRun(cmd *cobra.Command, _ []string) error {
 	return nil
 }
 
+var errPanic = errors.New("panic")
+
 func buildVersion() string {
 	result := util.GetVersion()
 	if commit := util.GetCommit(); commit != "" {
 		result += " (" + commit + ")"
 	}
 	return result
 }
+
+func Execute(cmd *cobra.Command) (err error) {
+	if cmd == nil {
+		cmd = New()
+	}
+
+	defer finalizer.PostRun(err)
+	defer func() {
+		if msg := recover(); msg != nil {
+			slog.Error("Recovered from panic", "error", msg)
+			err = fmt.Errorf("%w: %v\n\n%s", errPanic, msg, string(debug.Stack()))
+		}
+	}()
+
+	err = cmd.Execute()
+	return
+}

internal/generate/completions/main.go

@@ -16,7 +16,7 @@ const (
 )
 
 func main() {
-	rootCmd := cmd.NewCommand()
+	rootCmd := cmd.New()
 	var buf bytes.Buffer
 	rootCmd.SetOut(&buf)
 

internal/generate/docs/main.go

@@ -23,7 +23,7 @@ func main() {
 		log.Fatal(fmt.Errorf("failed to mkdir: %w", err))
 	}
 
-	rootCmd := cmd.NewCommand()
+	rootCmd := cmd.New()
 
 	err = doc.GenMarkdownTree(rootCmd, output)
 	if err != nil {

internal/generate/manpages/main.go

@@ -35,7 +35,7 @@ func main() {
 		panic(err)
 	}
 
-	rootCmd := cmd.NewCommand()
+	rootCmd := cmd.New()
 	rootName := rootCmd.Name()
 
 	date, err := time.Parse(time.RFC3339, dateParam)

main.go

@@ -1,42 +1,18 @@
 package main
 
 import (
-	"errors"
-	"fmt"
-	"io"
 	"log/slog"
 	"os"
-	"runtime/debug"
 
 	"gabe565.com/utils/slogx"
 	"github.com/clevyr/kubedb/cmd"
-	"github.com/clevyr/kubedb/internal/finalizer"
 	"github.com/clevyr/kubedb/internal/log"
 )
 
-var errPanic = errors.New("panic")
-
 func main() {
-	defer func() {
-		var err error
-		var status int
-		if msg := recover(); msg != nil {
-			status = 1
-			slog.Error("Recovered from panic", "error", msg)
-			err = fmt.Errorf("%w: %v\n\n%s", errPanic, msg, string(debug.Stack()))
-			_, _ = io.WriteString(os.Stderr, err.Error())
-		}
-		finalizer.PostRun(err)
-		os.Exit(status)
-	}()
-
 	log.Init(os.Stderr, slogx.LevelInfo, slogx.FormatAuto)
-	rootCmd := cmd.NewCommand()
-	if err := rootCmd.Execute(); err != nil {
-		if rootCmd.SilenceErrors {
-			slog.Error(err.Error())
-		}
-		finalizer.PostRun(err)
-		os.Exit(1) //nolint:gocritic
+	if err := cmd.Execute(cmd.New()); err != nil {
+		slog.Error(err.Error())
+		os.Exit(1)
 	}
 }