feat: only print "running preflights" if preflights exist (#386)

* feat: only print "running preflights" if preflights exist

only print "running preflights" if preflights exist.

* feat: rename progressbar to spinner

it is neither a bar neither indicates progress.

Author: ricardomaraschini

cmd/embedded-cluster/install.go

@@ -21,9 +21,9 @@ import (
 	"github.com/replicatedhq/embedded-cluster/pkg/helpers"
 	"github.com/replicatedhq/embedded-cluster/pkg/metrics"
 	"github.com/replicatedhq/embedded-cluster/pkg/preflights"
-	"github.com/replicatedhq/embedded-cluster/pkg/progressbar"
 	"github.com/replicatedhq/embedded-cluster/pkg/prompts"
 	"github.com/replicatedhq/embedded-cluster/pkg/release"
+	"github.com/replicatedhq/embedded-cluster/pkg/spinner"
 )
 
 // ErrNothingElseToAdd is an error returned when there is nothing else to add to the
@@ -70,17 +70,15 @@ func runPostInstall() error {
 // on all configured hosts. We attempt to read HostPreflights from all the
 // embedded Helm Charts and from the Kots Application Release files.
 func runHostPreflights(c *cli.Context) error {
-	pb := progressbar.Start()
-	pb.Infof("Running host preflights on node")
 	hpf, err := addons.NewApplier().HostPreflights()
 	if err != nil {
-		pb.CloseWithError()
 		return fmt.Errorf("unable to read host preflights: %w", err)
 	}
 	if len(hpf.Collectors) == 0 && len(hpf.Analyzers) == 0 {
-		pb.Close()
 		return nil
 	}
+	pb := spinner.Start()
+	pb.Infof("Running host preflights on node")
 	output, err := preflights.Run(c.Context, hpf)
 	if err != nil {
 		pb.CloseWithError()
@@ -213,9 +211,9 @@ func installK0s(c *cli.Context) error {
 // waitForK0s waits for the k0s API to be available. We wait for the k0s socket to
 // appear in the system and until the k0s status command to finish.
 func waitForK0s(ctx context.Context) error {
-	pb := progressbar.Start()
-	defer pb.Close()
-	pb.Infof("Waiting for %s node to be ready", defaults.BinaryName())
+	loading := spinner.Start()
+	defer loading.Close()
+	loading.Infof("Waiting for %s node to be ready", defaults.BinaryName())
 	var success bool
 	for i := 0; i < 30; i++ {
 		time.Sleep(2 * time.Second)
@@ -232,7 +230,7 @@ func waitForK0s(ctx context.Context) error {
 	if _, err := runCommand(defaults.K0sBinaryPath(), "status"); err != nil {
 		return fmt.Errorf("unable to get status: %w", err)
 	}
-	pb.Infof("Node installation finished")
+	loading.Infof("Node installation finished")
 	return nil
 }
 

pkg/addons/adminconsole/adminconsole.go

@@ -20,9 +20,9 @@ import (
 	"github.com/replicatedhq/embedded-cluster/pkg/defaults"
 	"github.com/replicatedhq/embedded-cluster/pkg/kubeutils"
 	"github.com/replicatedhq/embedded-cluster/pkg/metrics"
-	pb "github.com/replicatedhq/embedded-cluster/pkg/progressbar"
 	"github.com/replicatedhq/embedded-cluster/pkg/prompts"
 	"github.com/replicatedhq/embedded-cluster/pkg/release"
+	"github.com/replicatedhq/embedded-cluster/pkg/spinner"
 )
 
 const (
@@ -239,7 +239,7 @@ func (a *AdminConsole) GenerateHelmConfig(onlyDefaults bool) ([]v1beta1.Chart, [
 
 // Outro waits for the adminconsole to be ready.
 func (a *AdminConsole) Outro(ctx context.Context, cli client.Client) error {
-	loading := pb.Start()
+	loading := spinner.Start()
 	backoff := wait.Backoff{Steps: 60, Duration: 5 * time.Second, Factor: 1.0, Jitter: 0.1}
 	loading.Infof("Waiting for Admin Console to deploy: 0/3 ready")
 

pkg/addons/applier.go

@@ -19,7 +19,7 @@ import (
 	"github.com/replicatedhq/embedded-cluster/pkg/addons/embeddedclusteroperator"
 	"github.com/replicatedhq/embedded-cluster/pkg/addons/openebs"
 	"github.com/replicatedhq/embedded-cluster/pkg/kubeutils"
-	pb "github.com/replicatedhq/embedded-cluster/pkg/progressbar"
+	"github.com/replicatedhq/embedded-cluster/pkg/spinner"
 )
 
 // AddOn is the interface that all addons must implement.
@@ -169,7 +169,7 @@ func (a *Applier) Versions(additionalCharts []v1beta1.Chart) (map[string]string,
 // waitForKubernetes waits until we manage to make a successful connection to the
 // Kubernetes API server.
 func (a *Applier) waitForKubernetes(ctx context.Context) error {
-	loading := pb.Start()
+	loading := spinner.Start()
 	defer func() {
 		loading.Closef("Kubernetes API server is ready")
 	}()

pkg/addons/embeddedclusteroperator/embeddedclusteroperator.go

@@ -19,8 +19,8 @@ import (
 	"github.com/replicatedhq/embedded-cluster/pkg/defaults"
 	"github.com/replicatedhq/embedded-cluster/pkg/kubeutils"
 	"github.com/replicatedhq/embedded-cluster/pkg/metrics"
-	pb "github.com/replicatedhq/embedded-cluster/pkg/progressbar"
 	"github.com/replicatedhq/embedded-cluster/pkg/release"
+	"github.com/replicatedhq/embedded-cluster/pkg/spinner"
 )
 
 const (
@@ -96,7 +96,7 @@ func (e *EmbeddedClusterOperator) GenerateHelmConfig(onlyDefaults bool) ([]v1bet
 
 // Outro is executed after the cluster deployment.
 func (e *EmbeddedClusterOperator) Outro(ctx context.Context, cli client.Client) error {
-	loading := pb.Start()
+	loading := spinner.Start()
 	loading.Infof("Waiting for Embedded Cluster Operator to be ready")
 	if err := kubeutils.WaitForDeployment(ctx, cli, e.namespace, e.deployName); err != nil {
 		loading.Close()

pkg/progressbar/options.go renamed to pkg/spinner/options.go

@@ -1,4 +1,4 @@
-package progressbar
+package spinner
 
 // Option is a function that sets an option on a MessageWriter.
 type Option func(*MessageWriter)

pkg/progressbar/progressbar.go renamed to pkg/spinner/spinner.go

@@ -1,7 +1,5 @@
-// Package progressbar provides a simple progress bar for the CLI. This
-// should have been called "loadingbar" instead as there is no progress
-// at all.
-package progressbar
+// Package spinner provides a simple spinner for the CLI.
+package spinner
 
 import (
 	"fmt"

pkg/progressbar/progressbar_test.go renamed to pkg/spinner/spinner_test.go

@@ -1,4 +1,4 @@
-package progressbar
+package spinner
 
 import (
 	"bytes"