refactor!: server add/rm has better UI/UX

Less confusing logging messages, clear "is created" / "already exists"
output. Move the majority of logging to debug output to not confuse the
situation. Some code cleanups also in there.
This commit is contained in:
decentral1se 2024-06-25 09:48:53 +02:00
parent 1a12bef53e
commit 7b7e1bfa97
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
4 changed files with 63 additions and 48 deletions

View File

@ -23,29 +23,29 @@ var localFlag = &cli.BoolFlag{
Destination: &local, Destination: &local,
} }
func cleanUp(domainName string) { // cleanUp cleans up the partially created context/client details for a failed
if domainName != "default" { // "server add" attempt.
logrus.Infof("cleaning up context for %s", domainName) func cleanUp(name string) {
if err := client.DeleteContext(domainName); err != nil { if name != "default" {
logrus.Debugf("serverAdd: cleanUp: cleaning up context for %s", name)
if err := client.DeleteContext(name); err != nil {
logrus.Fatal(err) logrus.Fatal(err)
} }
} }
logrus.Infof("attempting to clean up server directory for %s", domainName) serverDir := filepath.Join(config.SERVERS_DIR, name)
serverDir := filepath.Join(config.SERVERS_DIR, domainName)
files, err := config.GetAllFilesInDirectory(serverDir) files, err := config.GetAllFilesInDirectory(serverDir)
if err != nil { if err != nil {
logrus.Fatalf("unable to list files in %s: %s", serverDir, err) logrus.Fatalf("serverAdd: cleanUp: unable to list files in %s: %s", serverDir, err)
} }
if len(files) > 0 { if len(files) > 0 {
logrus.Warnf("aborting clean up of %s because it is not empty", serverDir) logrus.Debugf("serverAdd: cleanUp: %s is not empty, aborting cleanup", serverDir)
return return
} }
if err := os.RemoveAll(serverDir); err != nil { if err := os.RemoveAll(serverDir); err != nil {
logrus.Fatal(err) logrus.Fatalf("serverAdd: cleanUp: failed to remove %s: %s", serverDir, err)
} }
} }
@ -53,39 +53,42 @@ func cleanUp(domainName string) {
// Docker manages SSH connection details. These are stored to disk in // Docker manages SSH connection details. These are stored to disk in
// ~/.docker. Abra can manage this completely for the user, so it's an // ~/.docker. Abra can manage this completely for the user, so it's an
// implementation detail. // implementation detail.
func newContext(c *cli.Context, domainName string) error { func newContext(name string) (bool, error) {
store := contextPkg.NewDefaultDockerContextStore() store := contextPkg.NewDefaultDockerContextStore()
contexts, err := store.Store.List() contexts, err := store.Store.List()
if err != nil { if err != nil {
return err return false, err
} }
for _, context := range contexts { for _, context := range contexts {
if context.Name == domainName { if context.Name == name {
logrus.Debugf("context for %s already exists", domainName) logrus.Debugf("context for %s already exists", name)
return nil return false, nil
} }
} }
logrus.Debugf("creating context with domain %s", domainName) logrus.Debugf("creating context with domain %s", name)
if err := client.CreateContext(domainName); err != nil { if err := client.CreateContext(name); err != nil {
return err return false, nil
} }
return nil return true, nil
} }
// createServerDir creates the ~/.abra/servers/... directory for a new server. // createServerDir creates the ~/.abra/servers/... directory for a new server.
func createServerDir(domainName string) error { func createServerDir(name string) (bool, error) {
if err := server.CreateServerDir(domainName); err != nil { if err := server.CreateServerDir(name); err != nil {
if !os.IsExist(err) { if !os.IsExist(err) {
return err return false, err
} }
logrus.Debugf("server dir for %s already created", domainName)
logrus.Debugf("server dir for %s already created", name)
return false, nil
} }
return nil return true, nil
} }
var serverAddCommand = cli.Command{ var serverAddCommand = cli.Command{
@ -130,56 +133,68 @@ of your ~/.ssh/config. Checks for a valid online domain will be skipped:
ArgsUsage: "<name>", ArgsUsage: "<name>",
Action: func(c *cli.Context) error { Action: func(c *cli.Context) error {
if len(c.Args()) > 0 && local || !internal.ValidateSubCmdFlags(c) { if len(c.Args()) > 0 && local || !internal.ValidateSubCmdFlags(c) {
err := errors.New("cannot use <domain> and --local together") err := errors.New("cannot use <name> and --local together")
internal.ShowSubcommandHelpAndError(c, err) internal.ShowSubcommandHelpAndError(c, err)
} }
var domainName string var name string
if local { if local {
domainName = "default" name = "default"
} else { } else {
domainName = internal.ValidateDomain(c) name = internal.ValidateDomain(c)
} }
if local { if local {
if err := createServerDir(domainName); err != nil { created, err := createServerDir(name)
if err != nil {
logrus.Fatal(err) logrus.Fatal(err)
} }
logrus.Infof("attempting to create client for %s", domainName) logrus.Debugf("attempting to create client for %s", name)
if _, err := client.New(domainName); err != nil {
cleanUp(domainName) if _, err := client.New(name); err != nil {
cleanUp(name)
logrus.Fatal(err) logrus.Fatal(err)
} }
logrus.Info("local server added") if created {
logrus.Info("local server successfully added")
} else {
logrus.Warn("local server already exists")
}
return nil return nil
} }
if !internal.NoDomainChecks { if !internal.NoDomainChecks {
if _, err := dns.EnsureIPv4(domainName); err != nil { if _, err := dns.EnsureIPv4(name); err != nil {
logrus.Fatal(err) logrus.Fatal(err)
} }
} }
if err := createServerDir(domainName); err != nil { _, err := createServerDir(name)
if err != nil {
logrus.Fatal(err) logrus.Fatal(err)
} }
if err := newContext(c, domainName); err != nil { created, err := newContext(name)
cleanUp(domainName) if err != nil {
cleanUp(name)
logrus.Fatal(err) logrus.Fatal(err)
} }
logrus.Infof("attempting to create client for %s", domainName) logrus.Debugf("attempting to create client for %s", name)
if _, err := client.New(domainName); err != nil { if _, err := client.New(name); err != nil {
cleanUp(domainName) cleanUp(name)
logrus.Debugf("failed to construct client for %s, saw %s", domainName, err.Error()) logrus.Debugf("failed to construct client for %s, saw %s", name, err.Error())
logrus.Fatal(sshPkg.Fatal(domainName, err)) logrus.Fatal(sshPkg.Fatal(name, err))
} }
logrus.Infof("%s added", domainName) if created {
logrus.Infof("%s successfully added", name)
} else {
logrus.Warnf("%s already exists", name)
}
return nil return nil
}, },

View File

@ -41,7 +41,7 @@ rain.
logrus.Fatal(err) logrus.Fatal(err)
} }
logrus.Infof("server at %s has been lost in time, like tears in rain", serverName) logrus.Infof("%s is now lost in time, like tears in rain", serverName)
return nil return nil
}, },

View File

@ -75,9 +75,9 @@ func New(serverName string) (*client.Client, error) {
if info.Swarm.LocalNodeState == "inactive" { if info.Swarm.LocalNodeState == "inactive" {
if serverName != "default" { if serverName != "default" {
return cl, fmt.Errorf("swarm mode not enabled on %s?", serverName) return cl, fmt.Errorf("swarm mode not enabled on %s?", serverName)
} else {
return cl, errors.New("swarm mode not enabled on local server?")
} }
return cl, errors.New("swarm mode not enabled on local server?")
} }
return cl, nil return cl, nil

View File

@ -17,11 +17,11 @@ func CreateServerDir(serverName string) error {
return err return err
} }
logrus.Infof("%s already exists", serverPath) logrus.Debugf("%s already exists", serverPath)
return nil return nil
} }
logrus.Infof("successfully created %s", serverPath) logrus.Debugf("successfully created %s", serverPath)
return nil return nil
} }