Fix Progress Callback for Support Bundle Collection (#781)

diamonwiggins · web-flow · commit 04c7a18da374 · 2022-10-14T12:29:59.000-04:00
fix progress callback for support bundle and revert collector title changes
diff --git a/pkg/collect/cluster_info.go b/pkg/collect/cluster_info.go
@@ -26,7 +26,7 @@ type CollectClusterInfo struct {
 }
 
 func (c *CollectClusterInfo) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Cluster Info")
+	return getCollectorName(c)
 }
 
 func (c *CollectClusterInfo) IsExcluded() (bool, error) {
diff --git a/pkg/collect/cluster_resources.go b/pkg/collect/cluster_resources.go
@@ -43,7 +43,7 @@ type CollectClusterResources struct {
 }
 
 func (c *CollectClusterResources) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Cluster Resources")
+	return getCollectorName(c)
 }
 
 func (c *CollectClusterResources) IsExcluded() (bool, error) {
diff --git a/pkg/collect/collectd.go b/pkg/collect/collectd.go
@@ -19,7 +19,7 @@ type CollectCollectd struct {
 }
 
 func (c *CollectCollectd) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "CollectD")
+	return getCollectorName(c)
 }
 
 func (c *CollectCollectd) IsExcluded() (bool, error) {
diff --git a/pkg/collect/collector.go b/pkg/collect/collector.go
@@ -2,7 +2,9 @@ package collect
 
 import (
 	"context"
+	"fmt"
 	"strconv"
+	"strings"
 	"time"
 
 	"github.com/pkg/errors"
@@ -107,3 +109,83 @@ func collectorTitleOrDefault(meta troubleshootv1beta2.CollectorMeta, defaultTitl
 	}
 	return defaultTitle
 }
+
+func getCollectorName(c interface{}) string {
+	var collector, name, selector string
+
+	switch v := c.(type) {
+	case *CollectClusterInfo:
+		collector = "cluster-info"
+	case *CollectClusterResources:
+		collector = "cluster-resources"
+	case *CollectSecret:
+		collector = "secret"
+		name = v.Collector.CollectorName
+		selector = strings.Join(v.Collector.Selector, ",")
+	case *CollectConfigMap:
+		collector = "configmap"
+		name = v.Collector.CollectorName
+		selector = strings.Join(v.Collector.Selector, ",")
+	case *CollectLogs:
+		collector = "logs"
+		name = v.Collector.CollectorName
+		selector = strings.Join(v.Collector.Selector, ",")
+	case *CollectRun:
+		collector = "run"
+		name = v.Collector.CollectorName
+	case *CollectRunPod:
+		collector = "run-pod"
+		name = v.Collector.CollectorName
+	case *CollectExec:
+		collector = "exec"
+		name = v.Collector.CollectorName
+		selector = strings.Join(v.Collector.Selector, ",")
+	case *CollectData:
+		collector = "data"
+		name = v.Collector.CollectorName
+	case *CollectCopy:
+		collector = "copy"
+		name = v.Collector.CollectorName
+		selector = strings.Join(v.Collector.Selector, ",")
+	case *CollectCopyFromHost:
+		collector = "copy-from-host"
+		name = v.Collector.CollectorName
+	case *CollectHTTP:
+		collector = "http"
+		name = v.Collector.CollectorName
+	case *CollectPostgres:
+		collector = "postgres"
+		name = v.Collector.CollectorName
+	case *CollectMysql:
+		collector = "mysql"
+		name = v.Collector.CollectorName
+	case *CollectRedis:
+		collector = "redis"
+		name = v.Collector.CollectorName
+	case *CollectCollectd:
+		collector = "collectd"
+		name = v.Collector.CollectorName
+	case *CollectCeph:
+		collector = "ceph"
+		name = v.Collector.CollectorName
+	case *CollectLonghorn:
+		collector = "longhorn"
+		name = v.Collector.CollectorName
+	case *CollectRegistry:
+		collector = "registry-images"
+		name = v.Collector.CollectorName
+	case *CollectSysctl:
+		collector = "sysctl"
+		name = v.Collector.Name
+	default:
+		collector = "<none>"
+	}
+
+	if name != "" {
+		return fmt.Sprintf("%s/%s", collector, name)
+	}
+	if selector != "" {
+		return fmt.Sprintf("%s/%s", collector, selector)
+	}
+	return collector
+}
diff --git a/pkg/collect/configmap.go b/pkg/collect/configmap.go
@@ -38,7 +38,7 @@ type CollectConfigMap struct {
 }
 
 func (c *CollectConfigMap) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "ConfigMap")
+	return getCollectorName(c)
 }
 
 func (c *CollectConfigMap) IsExcluded() (bool, error) {
diff --git a/pkg/collect/copy.go b/pkg/collect/copy.go
@@ -31,7 +31,7 @@ type CollectCopy struct {
 }
 
 func (c *CollectCopy) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Copy")
+	return getCollectorName(c)
 }
 
 func (c *CollectCopy) IsExcluded() (bool, error) {
diff --git a/pkg/collect/copy_from_host.go b/pkg/collect/copy_from_host.go
@@ -37,7 +37,7 @@ type CollectCopyFromHost struct {
 }
 
 func (c *CollectCopyFromHost) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Copy from Host")
+	return getCollectorName(c)
 }
 
 func (c *CollectCopyFromHost) IsExcluded() (bool, error) {
diff --git a/pkg/collect/data.go b/pkg/collect/data.go
@@ -21,7 +21,7 @@ type CollectData struct {
 }
 
 func (c *CollectData) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Data")
+	return getCollectorName(c)
 }
 
 func (c *CollectData) IsExcluded() (bool, error) {
diff --git a/pkg/collect/exec.go b/pkg/collect/exec.go
@@ -27,7 +27,7 @@ type CollectExec struct {
 }
 
 func (c *CollectExec) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Exec")
+	return getCollectorName(c)
 }
 
 func (c *CollectExec) IsExcluded() (bool, error) {
diff --git a/pkg/collect/http.go b/pkg/collect/http.go
@@ -45,7 +45,7 @@ type CollectHTTP struct {
 }
 
 func (c *CollectHTTP) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "HTTP")
+	return getCollectorName(c)
 }
 
 func (c *CollectHTTP) IsExcluded() (bool, error) {
diff --git a/pkg/collect/logs.go b/pkg/collect/logs.go
@@ -28,7 +28,7 @@ type CollectLogs struct {
 }
 
 func (c *CollectLogs) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Logs")
+	return getCollectorName(c)
 }
 
 func (c *CollectLogs) IsExcluded() (bool, error) {
diff --git a/pkg/collect/longhorn.go b/pkg/collect/longhorn.go
@@ -40,7 +40,7 @@ type CollectLonghorn struct {
 }
 
 func (c *CollectLonghorn) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Longhorn")
+	return getCollectorName(c)
 }
 
 func (c *CollectLonghorn) IsExcluded() (bool, error) {
diff --git a/pkg/collect/mysql.go b/pkg/collect/mysql.go
@@ -25,7 +25,7 @@ type CollectMysql struct {
 }
 
 func (c *CollectMysql) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Mysql")
+	return getCollectorName(c)
 }
 
 func (c *CollectMysql) IsExcluded() (bool, error) {
diff --git a/pkg/collect/postgres.go b/pkg/collect/postgres.go
@@ -26,7 +26,7 @@ type CollectPostgres struct {
 }
 
 func (c *CollectPostgres) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Postgres")
+	return getCollectorName(c)
 }
 
 func (c *CollectPostgres) IsExcluded() (bool, error) {
diff --git a/pkg/collect/redis.go b/pkg/collect/redis.go
@@ -25,7 +25,7 @@ type CollectRedis struct {
 }
 
 func (c *CollectRedis) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Cluster Info")
+	return getCollectorName(c)
 }
 
 func (c *CollectRedis) IsExcluded() (bool, error) {
diff --git a/pkg/collect/registry.go b/pkg/collect/registry.go
@@ -48,7 +48,7 @@ type CollectRegistry struct {
 }
 
 func (c *CollectRegistry) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Registry Images")
+	return getCollectorName(c)
 }
 
 func (c *CollectRegistry) IsExcluded() (bool, error) {
diff --git a/pkg/collect/run.go b/pkg/collect/run.go
@@ -20,7 +20,7 @@ type CollectRun struct {
 }
 
 func (c *CollectRun) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Run")
+	return getCollectorName(c)
 }
 
 func (c *CollectRun) IsExcluded() (bool, error) {
diff --git a/pkg/collect/run_pod.go b/pkg/collect/run_pod.go
@@ -33,7 +33,7 @@ type CollectRunPod struct {
 }
 
 func (c *CollectRunPod) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Run Pod")
+	return getCollectorName(c)
 }
 
 func (c *CollectRunPod) IsExcluded() (bool, error) {
diff --git a/pkg/collect/secret.go b/pkg/collect/secret.go
@@ -37,7 +37,7 @@ type CollectSecret struct {
 }
 
 func (c *CollectSecret) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Secret")
+	return getCollectorName(c)
 }
 
 func (c *CollectSecret) IsExcluded() (bool, error) {
diff --git a/pkg/collect/sysctl.go b/pkg/collect/sysctl.go
@@ -27,7 +27,7 @@ type CollectSysctl struct {
 }
 
 func (c *CollectSysctl) Title() string {
-	return collectorTitleOrDefault(c.Collector.CollectorMeta, "Sysctl")
+	return getCollectorName(c)
 }
 
 func (c *CollectSysctl) IsExcluded() (bool, error) {
diff --git a/pkg/supportbundle/collect.go b/pkg/supportbundle/collect.go
@@ -131,7 +131,7 @@ func runCollectors(collectors []*troubleshootv1beta2.Collect, additionalRedactor
 			}
 		}
 
-		opts.ProgressChan <- fmt.Sprintf("[%s] Running collector...", collector.Title())
+		opts.CollectorProgressCallback(opts.ProgressChan, collector.Title())
 		result, err := collector.Collect(opts.ProgressChan)
 		if err != nil {
 			opts.ProgressChan <- errors.Errorf("failed to run collector: %s: %v", collector.Title(), err)

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ type CollectClusterInfo struct {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`func (c *CollectClusterInfo) Title() string {`
`29`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "Cluster Info")`
	`29`	`+ return getCollectorName(c)`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`func (c *CollectClusterInfo) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ type CollectClusterResources struct {`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`func (c *CollectClusterResources) Title() string {`
`46`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "Cluster Resources")`
	`46`	`+ return getCollectorName(c)`
`47`	`47`	`}`
`48`	`48`
`49`	`49`	`func (c *CollectClusterResources) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ type CollectCollectd struct {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`func (c *CollectCollectd) Title() string {`
`22`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "CollectD")`
	`22`	`+ return getCollectorName(c)`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`func (c *CollectCollectd) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ type CollectConfigMap struct {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`func (c *CollectConfigMap) Title() string {`
`41`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "ConfigMap")`
	`41`	`+ return getCollectorName(c)`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`func (c *CollectConfigMap) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ type CollectCopy struct {`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`func (c *CollectCopy) Title() string {`
`34`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "Copy")`
	`34`	`+ return getCollectorName(c)`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`func (c *CollectCopy) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ type CollectCopyFromHost struct {`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`func (c *CollectCopyFromHost) Title() string {`
`40`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "Copy from Host")`
	`40`	`+ return getCollectorName(c)`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`func (c *CollectCopyFromHost) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ type CollectData struct {`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`func (c *CollectData) Title() string {`
`24`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "Data")`
	`24`	`+ return getCollectorName(c)`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`func (c *CollectData) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ type CollectExec struct {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`func (c *CollectExec) Title() string {`
`30`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "Exec")`
	`30`	`+ return getCollectorName(c)`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`func (c *CollectExec) IsExcluded() (bool, error) {`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ type CollectHTTP struct {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`func (c *CollectHTTP) Title() string {`
`48`		`- return collectorTitleOrDefault(c.Collector.CollectorMeta, "HTTP")`
	`48`	`+ return getCollectorName(c)`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`func (c *CollectHTTP) IsExcluded() (bool, error) {`