Merge pull request #43 from replicatedhq/progress

Show progress when collecting support bundle

Author: divolgin

cmd/preflight/cli/run_nocrd.go

@@ -14,6 +14,7 @@ import (
 	"strings"
 	"time"
 
+	"github.com/ahmetalpbalkan/go-cursor"
 	"github.com/pkg/errors"
 	analyzerunner "github.com/replicatedhq/troubleshoot/pkg/analyze"
 	troubleshootv1beta1 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta1"
@@ -36,6 +37,9 @@ import (
 )
 
 func runPreflightsNoCRD(v *viper.Viper, arg string) error {
+	fmt.Print(cursor.Hide())
+	defer fmt.Print(cursor.Show())
+
 	preflightContent := ""
 	if !isURL(arg) {
 		if _, err := os.Stat(arg); os.IsNotExist(err) {

cmd/troubleshoot/cli/run_nocrd.go

@@ -13,11 +13,13 @@ import (
 	"path/filepath"
 	"time"
 
+	"github.com/ahmetalpbalkan/go-cursor"
 	"github.com/mholt/archiver"
 	troubleshootv1beta1 "github.com/replicatedhq/troubleshoot/pkg/apis/troubleshoot/v1beta1"
 	collectrunner "github.com/replicatedhq/troubleshoot/pkg/collect"
 	"github.com/replicatedhq/troubleshoot/pkg/logger"
 	"github.com/spf13/viper"
+	"github.com/tj/go-spin"
 	"gopkg.in/yaml.v2"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -31,6 +33,9 @@ import (
 )
 
 func runTroubleshootNoCRD(v *viper.Viper, arg string) error {
+	fmt.Print(cursor.Hide())
+	defer fmt.Print(cursor.Show())
+
 	collectorContent := ""
 	if !isURL(arg) {
 		if _, err := os.Stat(arg); os.IsNotExist(err) {
@@ -68,17 +73,43 @@ func runTroubleshootNoCRD(v *viper.Viper, arg string) error {
 		return fmt.Errorf("unable to parse %s collectors", arg)
 	}
 
-	archivePath, err := runCollectors(v, collector)
+	s := spin.New()
+	finishedCh := make(chan bool, 1)
+	progressChan := make(chan string, 1)
+	go func() {
+		currentDir := ""
+		for {
+			select {
+			case dir := <-progressChan:
+				currentDir = filepath.Base(dir)
+			case <-finishedCh:
+				fmt.Printf("\r")
+				return
+			case <-time.After(time.Millisecond * 100):
+				if currentDir == "" {
+					fmt.Printf("\r%s \033[36mCollecting support bundle\033[m %s", cursor.ClearEntireLine(), s.Next())
+				} else {
+					fmt.Printf("\r%s \033[36mCollecting support bundle\033[m %s: %s", cursor.ClearEntireLine(), s.Next(), currentDir)
+				}
+			}
+		}
+	}()
+	defer func() {
+		finishedCh <- true
+	}()
+
+	archivePath, err := runCollectors(v, collector, progressChan)
 	if err != nil {
 		return err
 	}
 
+	fmt.Printf("\r%s", cursor.ClearEntireLine())
 	fmt.Printf("%s\n", archivePath)
 
 	return nil
 }
 
-func runCollectors(v *viper.Viper, collector troubleshootv1beta1.Collector) (string, error) {
+func runCollectors(v *viper.Viper, collector troubleshootv1beta1.Collector, progressChan chan string) (string, error) {
 	cfg, err := config.GetConfig()
 	if err != nil {
 		return "", err
@@ -218,6 +249,7 @@ func runCollectors(v *viper.Viper, collector troubleshootv1beta1.Collector) (str
 					return
 				}
 
+				progressChan <- collectorDir
 				collectorDirs = append(collectorDirs, collectorDir)
 
 				if err := client.Delete(context.Background(), newPod); err != nil {

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/Masterminds/goutils v1.1.0 // indirect
 	github.com/Masterminds/semver v1.4.2 // indirect
 	github.com/Masterminds/sprig v2.20.0+incompatible // indirect
+	github.com/ahmetalpbalkan/go-cursor v0.0.0-20131010032410-8136607ea412
 	github.com/andrewchambers/go-jqpipe v0.0.0-20180509223707-2d54cef8cd94 // indirect
 	github.com/blang/semver v3.5.1+incompatible
 	github.com/docker/distribution v2.7.1+incompatible // indirect

go.sum

@@ -25,6 +25,8 @@ github.com/NYTimes/gziphandler v0.0.0-20170623195520-56545f4a5d46/go.mod h1:3wb0
 github.com/OneOfOne/xxhash v1.2.2/go.mod h1:HSdplMjZKSmBqAxg5vPj2TmRDmfkzw+cTzAElWljhcU=
 github.com/PuerkitoBio/purell v1.0.0/go.mod h1:c11w/QuzBsJSee3cPx9rAFu61PvFxuPbtSwDGJws/X0=
 github.com/PuerkitoBio/urlesc v0.0.0-20160726150825-5bd2802263f2/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE=
+github.com/ahmetalpbalkan/go-cursor v0.0.0-20131010032410-8136607ea412 h1:vOVO0ypMfTt6tZacyI0kp+iCZb1XSNiYDqnzBWYgfe4=
+github.com/ahmetalpbalkan/go-cursor v0.0.0-20131010032410-8136607ea412/go.mod h1:AI9hp1tkp10pAlK5TCwL+7yWbRgtDm9jhToq6qij2xs=
 github.com/alecthomas/gometalinter v2.0.11+incompatible/go.mod h1:qfIpQGGz3d+NmgyPBqv+LSh50emm1pt72EtcX2vKYQk=
 github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=
 github.com/alecthomas/units v0.0.0-20151022065526-2efee857e7cf/go.mod h1:ybxpYRFXyAe+OPACYpWeL0wqObRcbAqCMya13uyzqw0=