feat: Introduces a new help error

cli/app/deploy.go

@@ -3,7 +3,6 @@ package app
 import (
 	"context"
 	"fmt"
-	"strings"
 
 	"coopcloud.tech/abra/cli/internal"
 	"coopcloud.tech/abra/pkg/app"
@@ -276,9 +275,6 @@ func getDeployVersion(cliArgs []string, deployMeta stack.DeployMeta, app app.App
 
 	// Check if the recipe has a version in the .env file
 	if app.Recipe.EnvVersion != "" && !internal.IgnoreEnvVersion {
-		if strings.HasSuffix(app.Recipe.EnvVersionRaw, "+U") {
-			return "", fmt.Errorf("version: can not redeploy chaos version %s", app.Recipe.EnvVersionRaw)
-		}
 		log.Debugf("version: taking version from .env file: %s", app.Recipe.EnvVersion)
 		return app.Recipe.EnvVersion, nil
 	}

cli/app/rollback.go

@@ -242,7 +242,7 @@ func validateDowngradeVersionArg(
 ) error {
 	parsedDeployedVersion, err := tagcmp.Parse(deployMeta.Version)
 	if err != nil {
-		return fmt.Errorf("current deployment '%s' is not a known version for %s", deployMeta.Version, app.Recipe.Name)
+		return fmt.Errorf("'%s' is not a known version for %s", deployMeta.Version, app.Recipe.Name)
 	}
 
 	parsedSpecificVersion, err := tagcmp.Parse(specificVersion)

cli/internal/error.go

@@ -0,0 +1,64 @@
+package internal
+
+import (
+	"fmt"
+	"runtime"
+
+	"github.com/charmbracelet/log"
+)
+
+func Error(msg string) HelpError {
+	caller := ""
+	if Debug {
+		_, file, line, _ := runtime.Caller(1)
+		caller = log.ShortCallerFormatter(file, line, "")
+
+	}
+	return HelpError{err: msg, caller: caller}
+}
+
+func Errorf(format string, a ...any) HelpError {
+	caller := ""
+	if Debug {
+		_, file, line, _ := runtime.Caller(1)
+		caller = log.ShortCallerFormatter(file, line, "")
+
+	}
+	return HelpError{err: fmt.Sprintf(format, a...), caller: caller}
+}
+
+type HelpError struct {
+	err    string
+	caller string
+	help   string
+}
+
+func (e HelpError) Help(help string) HelpError {
+	e.help = help
+	return e
+}
+
+func (e HelpError) Helpf(format string, a ...any) HelpError {
+	e.help = fmt.Sprintf(format, a...)
+	return e
+}
+
+func (e HelpError) Error() string {
+	return e.format()
+}
+
+func (e HelpError) format() string {
+	msg := ""
+	if e.caller != "" {
+		msg += fmt.Sprintf("<%s> ", e.caller)
+	}
+
+	msg += e.err
+	if e.help == "" {
+		return msg
+	}
+
+	return fmt.Sprintf(`%s
+
+Help: %s `, msg, e.help)
+}

cli/run.go

@@ -3,6 +3,7 @@ package cli
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"coopcloud.tech/abra/cli/app"
 	"coopcloud.tech/abra/cli/catalogue"
@@ -40,7 +41,7 @@ func Run(version, commit string) {
 			}
 
 			for _, path := range paths {
-				if err := os.Mkdir(path, 0764); err != nil {
+				if err := os.Mkdir(path, 0o764); err != nil {
 					if !os.IsExist(err) {
 						log.Fatal(err)
 					}
@@ -66,6 +67,9 @@ func Run(version, commit string) {
 	}
 
 	rootCmd.CompletionOptions.DisableDefaultCmd = true
+	// We handle errors ourself
+	rootCmd.SilenceUsage = true
+	rootCmd.SilenceErrors = true
 
 	manCommand := &cobra.Command{
 		Use:     "man [flags]",
@@ -212,7 +216,15 @@ func Run(version, commit string) {
 		app.AppEnvCommand,
 	)
 
-	if err := rootCmd.Execute(); err != nil {
+	if cmd, err := rootCmd.ExecuteC(); err != nil {
+		fmt.Printf("Error: %s\n", err)
+		if strings.HasPrefix(err.Error(), "unknown flag") {
+			fmt.Println()
+			cmd.Usage()
+		} else if !internal.Debug {
+			fmt.Println()
+			fmt.Printf("Run with --debug for more info.\n")
+		}
 		os.Exit(1)
 	}
 }

cli/server/add.go

@@ -1,6 +1,8 @@
 package server
 
 import (
+	"errors"
+	"fmt"
 	"os"
 	"path/filepath"
 
@@ -41,19 +43,20 @@ developer machine. The domain is then set to "default".`,
 	ValidArgsFunction: func(
 		cmd *cobra.Command,
 		args []string,
-		toComplete string) ([]string, cobra.ShellCompDirective) {
+		toComplete string,
+	) ([]string, cobra.ShellCompDirective) {
 		if !local {
 			return autocomplete.ServerNameComplete()
 		}
 		return nil, cobra.ShellCompDirectiveDefault
 	},
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		if len(args) > 0 && local {
-			log.Fatal("cannot use [server] and --local together")
+			return errors.New("cannot use [server] and --local together")
 		}
 
 		if len(args) == 0 && !local {
-			log.Fatal("missing argument or --local/-l flag")
+			return errors.New("missing argument or --local/-l flag")
 		}
 
 		name := "default"
@@ -69,14 +72,14 @@ developer machine. The domain is then set to "default".`,
 		if local {
 			created, err := createServerDir(name)
 			if err != nil {
-				log.Fatal(err)
+				return err
 			}
 
 			log.Debugf("attempting to create client for %s", name)
 
 			if _, err := client.New(name, timeout); err != nil {
 				cleanUp(name)
-				log.Fatal(err)
+				return err
 			}
 
 			if created {
@@ -85,18 +88,18 @@ developer machine. The domain is then set to "default".`,
 				log.Warn("local server already exists")
 			}
 
-			return
+			return nil
 		}
 
 		_, err := createServerDir(name)
 		if err != nil {
-			log.Fatal(err)
+			return err
 		}
 
 		created, err := newContext(name)
 		if err != nil {
 			cleanUp(name)
-			log.Fatalf("unable to create local context: %s", err)
+			return fmt.Errorf("unable to create local context: %s", err)
 		}
 
 		log.Debugf("attempting to create client for %s", name)
@@ -104,7 +107,7 @@ developer machine. The domain is then set to "default".`,
 		if _, err := client.New(name, timeout); err != nil {
 			cleanUp(name)
 			log.Debugf("ssh %s error: %s", name, sshPkg.Fatal(name, err))
-			log.Fatalf("can't ssh to %s, make sure \"ssh %s\" works", name, name)
+			return internal.Errorf("can't ssh to %s", name).Helpf("make sure \"ssh %s\" works", name)
 		}
 
 		if created {
@@ -114,10 +117,11 @@ developer machine. The domain is then set to "default".`,
 				log.Warnf("unable to resolve IPv4 for %s", name)
 			}
 
-			return
+			return nil
 		}
 
 		log.Warnf("%s already exists", name)
+		return nil
 	},
 }
 
@@ -189,9 +193,7 @@ func createServerDir(name string) (bool, error) {
 	return true, nil
 }
 
-var (
-	local bool
-)
+var local bool
 
 func init() {
 	ServerAddCommand.Flags().BoolVarP(

tests/integration/app_deploy_overview.bats

@@ -154,7 +154,7 @@ teardown(){
   assert_not_exists "$ABRA_DIR/recipes/$TEST_RECIPE/foo"
 
   run $ABRA app deploy "$TEST_APP_DOMAIN" \
-    --no-input --no-converge-checks --force --debug
+    --no-input --no-converge-checks --force
   assert_failure
   assert_output --regexp 'can not redeploy chaos version .*' + "${headHash:0:8}+U"
 }
@@ -249,7 +249,7 @@ teardown(){
     --no-input --no-converge-checks --force
   assert_success
 
-  assert_output --partial 'REDEPLOY OVERVIEW'
+  assert_output --partial 'CHAOS DEPLOY OVERVIEW'
   assert_output --partial "CURRENT DEPLOYMENT    ${headHash:0:8}"
   assert_output --partial "ENV VERSION           ${headHash:0:8}"
   assert_output --partial "NEW DEPLOYMENT        ${headHash:0:8}"

tests/integration/app_rollback.bats

@@ -164,7 +164,8 @@ teardown(){
 
   run $ABRA app rollback "$TEST_APP_DOMAIN" "0.1.1+1.20.2" --no-input --no-converge-checks
   assert_failure
-  assert_output --partial 'current deployment' + "${tagHash:0:8}" + 'is not a known version'
+  assert_output --partial "0.1.1+1.20.2"
+  assert_output --partial "${tagHash:0:8}" + 'is not a known version'
 }
 
 # bats test_tags=slow