WIP feat: Introduces a new help error #512

Open
p4u1 wants to merge 1 commits from p4u1/abra:better-error-handling into main
3 changed files with 94 additions and 16 deletions

64
cli/internal/error.go Normal file
View File

@ -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)
}

View File

@ -3,6 +3,7 @@ package cli
import ( import (
"fmt" "fmt"
"os" "os"
"strings"
"coopcloud.tech/abra/cli/app" "coopcloud.tech/abra/cli/app"
"coopcloud.tech/abra/cli/catalogue" "coopcloud.tech/abra/cli/catalogue"
@ -40,7 +41,7 @@ func Run(version, commit string) {
} }
for _, path := range paths { for _, path := range paths {
if err := os.Mkdir(path, 0764); err != nil { if err := os.Mkdir(path, 0o764); err != nil {
if !os.IsExist(err) { if !os.IsExist(err) {
log.Fatal(err) log.Fatal(err)
} }
@ -66,6 +67,9 @@ func Run(version, commit string) {
} }
rootCmd.CompletionOptions.DisableDefaultCmd = true rootCmd.CompletionOptions.DisableDefaultCmd = true
// We handle errors ourself
rootCmd.SilenceUsage = true
rootCmd.SilenceErrors = true
manCommand := &cobra.Command{ manCommand := &cobra.Command{
Use: "man [flags]", Use: "man [flags]",
@ -212,7 +216,15 @@ func Run(version, commit string) {
app.AppEnvCommand, 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) os.Exit(1)
} }
} }

View File

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