feat: move join and reset commands to top level (#406)

* move join and reset commands to top level

* test both 'reset' and 'uninstall' aliases

* point to new reset command

* add 'sudo ./' to join command reset suggestion

* remove alias, improve descriptions

* add a make command to build darwin binaries for testing

Author: laverya

Makefile

@@ -89,6 +89,11 @@ static: pkg/goods/bins/k0s \
 embedded-cluster-linux-amd64: static
 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags "$(LD_FLAGS)" -o ./output/bin/$(APP_NAME) ./cmd/embedded-cluster
 
+# for testing
+.PHONY: embedded-cluster-darwin-amd64
+embedded-cluster-darwin-amd64:
+	CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags "$(LD_FLAGS)" -o ./output/bin/$(APP_NAME) ./cmd/embedded-cluster
+
 .PHONY: unit-tests
 unit-tests:
 	go test -v $(shell go list ./... | grep -v /e2e)

cmd/embedded-cluster/install.go

@@ -301,7 +301,7 @@ func runOutro(c *cli.Context) error {
 // file is created. Resulting kubeconfig is stored in the configuration dir.
 var installCommand = &cli.Command{
 	Name:  "install",
-	Usage: fmt.Sprintf("Install %s", defaults.BinaryName()),
+	Usage: fmt.Sprintf("Install %s", binName),
 	Before: func(c *cli.Context) error {
 		if os.Getuid() != 0 {
 			return fmt.Errorf("install command must be run as root")
@@ -326,14 +326,14 @@ var installCommand = &cli.Command{
 		},
 	},
 	Action: func(c *cli.Context) error {
-		logrus.Debugf("checking if %s is already installed", defaults.BinaryName())
+		logrus.Debugf("checking if %s is already installed", binName)
 		if installed, err := isAlreadyInstalled(); err != nil {
 			return err
 		} else if installed {
 			logrus.Errorf("An installation has been detected on this machine.")
 			logrus.Infof("If you want to reinstall you need to remove the existing installation")
 			logrus.Infof("first. You can do this by running the following command:")
-			logrus.Infof("\n  sudo ./%s node reset\n", defaults.BinaryName())
+			logrus.Infof("\n  sudo ./%s uninstall\n", binName)
 			return ErrNothingElseToAdd
 		}
 		metrics.ReportApplyStarted(c)

cmd/embedded-cluster/join.go

@@ -95,7 +95,7 @@ func getJoinToken(ctx context.Context, baseURL, shortToken string) (*JoinCommand
 
 var joinCommand = &cli.Command{
 	Name:      "join",
-	Usage:     "Join the current node to an existing cluster",
+	Usage:     fmt.Sprintf("Join the current node to a %s cluster", binName),
 	ArgsUsage: "<url> <token>",
 	Before: func(c *cli.Context) error {
 		if os.Getuid() != 0 {
@@ -104,20 +104,19 @@ var joinCommand = &cli.Command{
 		return nil
 	},
 	Action: func(c *cli.Context) error {
-		logrus.Debugf("checking if %s is already installed", defaults.BinaryName())
+		logrus.Debugf("checking if %s is already installed", binName)
 		if installed, err := isAlreadyInstalled(); err != nil {
 			return err
 		} else if installed {
 			logrus.Errorf("An installation has been detected on this machine.")
 			logrus.Infof("If you want to reinstall you need to remove the existing installation")
 			logrus.Infof("first. You can do this by running the following command:")
-			logrus.Infof("\n  %s node reset\n", defaults.BinaryName())
+			logrus.Infof("\n  sudo ./%s uninstall\n", binName)
 			return ErrNothingElseToAdd
 		}
 
-		binname := defaults.BinaryName()
 		if c.Args().Len() != 2 {
-			return fmt.Errorf("usage: %s node join <url> <token>", binname)
+			return fmt.Errorf("usage: %s node join <url> <token>", binName)
 		}
 
 		logrus.Infof("Fetching join token remotely")
@@ -127,7 +126,7 @@ var joinCommand = &cli.Command{
 		}
 
 		metrics.ReportJoinStarted(c.Context, jcmd.MetricsBaseURL, jcmd.ClusterID)
-		logrus.Infof("Materializing %s binaries", binname)
+		logrus.Infof("Materializing %s binaries", binName)
 		if err := goods.Materialize(); err != nil {
 			err := fmt.Errorf("unable to materialize binaries: %w", err)
 			metrics.ReportJoinFailed(c.Context, jcmd.MetricsBaseURL, jcmd.ClusterID, err)
@@ -147,7 +146,7 @@ var joinCommand = &cli.Command{
 			return err
 		}
 
-		logrus.Infof("Installing %s binaries", binname)
+		logrus.Infof("Installing %s binaries", binName)
 		if err := installK0sBinary(); err != nil {
 			err := fmt.Errorf("unable to install k0s binary: %w", err)
 			metrics.ReportJoinFailed(c.Context, jcmd.MetricsBaseURL, jcmd.ClusterID, err)
@@ -175,7 +174,7 @@ var joinCommand = &cli.Command{
 			return err
 		}
 
-		logrus.Infof("Starting %s service", binname)
+		logrus.Infof("Starting %s service", binName)
 		if err := startK0sService(); err != nil {
 			err := fmt.Errorf("unable to start service: %w", err)
 			metrics.ReportJoinFailed(c.Context, jcmd.MetricsBaseURL, jcmd.ClusterID, err)

cmd/embedded-cluster/main.go

@@ -31,6 +31,8 @@ func main() {
 			shellCommand,
 			nodeCommands,
 			versionCommand,
+			joinCommand,
+			uninstallCommand,
 		},
 	}
 	if err := app.RunContext(ctx, os.Args); err != nil {

cmd/embedded-cluster/node.go

@@ -5,10 +5,11 @@ import (
 )
 
 var nodeCommands = &cli.Command{
-	Name:  "node",
-	Usage: "Manage cluster nodes",
+	Name:   "node",
+	Usage:  "Manage cluster nodes",
+	Hidden: true, // this has been replaced by top-level commands
 	Subcommands: []*cli.Command{
 		joinCommand,
-		resetCommand,
+		uninstallCommand,
 	},
 }

cmd/embedded-cluster/reset.go renamed to cmd/embedded-cluster/uninstall.go

@@ -194,7 +194,7 @@ func (h *hostInfo) checkResetSafety(c *cli.Context) (bool, string, error) {
 		}
 	}
 	if len(workers) > 0 && len(controllers) == 1 {
-		message := fmt.Sprintf("Cannot reset the last %s node when there are other nodes in the cluster.", h.RoleName)
+		message := fmt.Sprintf("Cannot uninstall the last %s node when there are other nodes in the cluster.", h.RoleName)
 		return false, message, nil
 	}
 	return true, "", nil
@@ -284,19 +284,19 @@ func checkErrPrompt(c *cli.Context, err error) bool {
 	if c.Bool("force") {
 		return true
 	}
-	logrus.Info("An error occurred while trying to reset this node.")
+	logrus.Info("An error occurred while trying to uninstall this node.")
 	if c.Bool("no-prompt") {
 		return false
 	}
 	logrus.Info("Continuing may leave the cluster in an unexpected state.")
 	return prompts.New().Confirm("Do you want to continue anyway?", false)
 }
 
-var resetCommand = &cli.Command{
-	Name: "reset",
+var uninstallCommand = &cli.Command{
+	Name: "uninstall",
 	Before: func(c *cli.Context) error {
 		if os.Getuid() != 0 {
-			return fmt.Errorf("node reset command must be run as root")
+			return fmt.Errorf("uninstall command must be run as root")
 		}
 		return nil
 	},
@@ -309,14 +309,14 @@ var resetCommand = &cli.Command{
 		},
 		&cli.BoolFlag{
 			Name:  "force",
-			Usage: "Ignore errors encountered when resetting the node (implies --no-prompt)",
+			Usage: "Ignore errors encountered when uninstalling the node (implies --no-prompt)",
 			Value: false,
 		},
 	},
-	Usage: "Reset the current node",
+	Usage: fmt.Sprintf("Uninstall %s from the current node", binName),
 	Action: func(c *cli.Context) error {
 		logrus.Info("This will remove this node from the cluster and completely reset it.")
-		logrus.Info("Do not reset another node until this reset is complete.")
+		logrus.Info("Do not uninstall another node until this is complete.")
 		if !c.Bool("force") && !c.Bool("no-prompt") && !prompts.New().Confirm("Do you want to continue?", false) {
 			return fmt.Errorf("Aborting")
 		}
@@ -374,7 +374,7 @@ var resetCommand = &cli.Command{
 		}
 
 		// reset
-		logrus.Infof("Resetting %s...", binName)
+		logrus.Infof("Uninstalling %s...", binName)
 		err = stopAndResetK0s()
 		if !checkErrPrompt(c, err) {
 			return err

e2e/reset_test.go

@@ -104,7 +104,7 @@ func TestMultiNodeReset(t *testing.T) {
 	bin := strings.Split(command, " ")[0]
 	// reset worker node
 	t.Logf("%s: resetting worker node", time.Now().Format(time.RFC3339))
-	stdout, stderr, err = RunCommandOnNode(t, tc, 3, []string{bin, "node", "reset", "--no-prompt"})
+	stdout, stderr, err = RunCommandOnNode(t, tc, 3, []string{bin, "uninstall", "--no-prompt"})
 	if err != nil {
 		t.Logf("stdout: %s\nstderr: %s", stdout, stderr)
 		t.Fatalf("fail to reset worker node")
@@ -114,7 +114,7 @@ func TestMultiNodeReset(t *testing.T) {
 	// reset a controller node
 	// this should fail with a prompt to override
 	t.Logf("%s: resetting controller node", time.Now().Format(time.RFC3339))
-	stdout, stderr, err = RunCommandOnNode(t, tc, 2, []string{bin, "node", "reset", "--no-prompt"})
+	stdout, stderr, err = RunCommandOnNode(t, tc, 2, []string{bin, "uninstall", "--no-prompt"})
 	if err != nil {
 		t.Logf("stdout: %s\nstderr: %s", stdout, stderr)
 		t.Fatalf("fail to remove controller node %s:", err)

e2e/scripts/reset-installation.sh

@@ -2,8 +2,8 @@
 set -euo pipefail
 
 main() {
-    if ! embedded-cluster node reset --no-prompt | tee /tmp/log ; then
-        echo "Failed to reset embedded-cluster"
+    if ! embedded-cluster uninstall --no-prompt | tee /tmp/log ; then
+        echo "Failed to uninstall embedded-cluster"
         exit 1
     fi
 

e2e/sudo_test.go

@@ -25,7 +25,8 @@ func TestCommandsRequireSudo(t *testing.T) {
 	}
 	for _, cmd := range [][]string{
 		{"embedded-cluster", "node", "join", "https://test", "token"},
-		{"embedded-cluster", "node", "reset", "--force"},
+		{"embedded-cluster", "join", "https://test", "token"},
+		{"embedded-cluster", "uninstall", "--force"},
 		{"embedded-cluster", "shell"},
 		{"embedded-cluster", "install", "--no-prompt"},
 	} {