include atomic collector statuses (#534)

Author: jeffreygolden

pkg/preflight/collect.go

@@ -30,6 +30,11 @@ type CollectProgress struct {
 	CurrentStatus  string
 	CompletedCount int
 	TotalCount     int
+	Collectors     map[string]CollectorStatus
+}
+
+type CollectorStatus struct {
+	Status string
 }
 
 func (cp *CollectProgress) String() string {
@@ -161,47 +166,71 @@ func Collect(opts CollectOpts, p *troubleshootv1beta2.Preflight) (CollectResult,
 		return collectResult, errors.New("insufficient permissions to run all collectors")
 	}
 
+	// generate a map of all collectors for atomic status messages
+	collectorList := map[string]CollectorStatus{}
+	for _, collector := range collectors {
+		collectorList[collector.GetDisplayName()] = CollectorStatus{
+			Status: "pending",
+		}
+	}
+
 	// Run preflights collectors synchronously
 	for i, collector := range collectors {
 		if len(collector.RBACErrors) > 0 {
 			// don't skip clusterResources collector due to RBAC issues
 			if collector.Collect.ClusterResources == nil {
+				collectorList[collector.GetDisplayName()] = CollectorStatus{
+					Status: "skipped",
+				}
 				collectResult.isRBACAllowed = false // not failing, but going to report this
 				opts.ProgressChan <- fmt.Sprintf("skipping collector %s with insufficient RBAC permissions", collector.GetDisplayName())
 				opts.ProgressChan <- CollectProgress{
 					CurrentName:    collector.GetDisplayName(),
 					CurrentStatus:  "skipped",
 					CompletedCount: i + 1,
 					TotalCount:     len(collectors),
+					Collectors:     collectorList,
 				}
 				continue
 			}
 		}
 
+		collectorList[collector.GetDisplayName()] = CollectorStatus{
+			Status: "running",
+		}
 		opts.ProgressChan <- CollectProgress{
 			CurrentName:    collector.GetDisplayName(),
 			CurrentStatus:  "running",
 			CompletedCount: i,
 			TotalCount:     len(collectors),
+			Collectors:     collectorList,
 		}
 
 		result, err := collector.RunCollectorSync(opts.KubernetesRestConfig, k8sClient, nil)
 		if err != nil {
+			collectorList[collector.GetDisplayName()] = CollectorStatus{
+				Status: "failed",
+			}
 			opts.ProgressChan <- errors.Errorf("failed to run collector %s: %v\n", collector.GetDisplayName(), err)
 			opts.ProgressChan <- CollectProgress{
 				CurrentName:    collector.GetDisplayName(),
 				CurrentStatus:  "failed",
 				CompletedCount: i + 1,
 				TotalCount:     len(collectors),
+				Collectors:     collectorList,
 			}
 			continue
 		}
 
+		collectorList[collector.GetDisplayName()] = CollectorStatus{
+			Status: "completed",
+		}
 		opts.ProgressChan <- CollectProgress{
 			CurrentName:    collector.GetDisplayName(),
 			CurrentStatus:  "completed",
 			CompletedCount: i + 1,
 			TotalCount:     len(collectors),
+			Collectors:     collectorList,
 		}
 
 		for k, v := range result {
@@ -240,32 +269,55 @@ func CollectRemote(opts CollectOpts, p *troubleshootv1beta2.HostPreflight) (Coll
 		Spec:       p,
 	}
 
+	// generate a map of all collectors for atomic status messages
+	collectorList := map[string]CollectorStatus{}
+	for _, collector := range collectors {
+		collectorList[collector.GetDisplayName()] = CollectorStatus{
+			Status: "pending",
+		}
+	}
+
 	// Run preflights collectors synchronously
 	for i, collector := range collectors {
+		collectorList[collector.GetDisplayName()] = CollectorStatus{
+			Status: "running",
+		}
+
 		opts.ProgressChan <- CollectProgress{
 			CurrentName:    collector.GetDisplayName(),
 			CurrentStatus:  "running",
 			CompletedCount: i,
 			TotalCount:     len(collectors),
+			Collectors:     collectorList,
 		}
 
 		result, err := collector.RunCollectorSync(nil)
 		if err != nil {
+			collectorList[collector.GetDisplayName()] = CollectorStatus{
+				Status: "failed",
+			}
+
 			opts.ProgressChan <- errors.Errorf("failed to run collector %s: %v\n", collector.GetDisplayName(), err)
 			opts.ProgressChan <- CollectProgress{
 				CurrentName:    collector.GetDisplayName(),
 				CurrentStatus:  "failed",
 				CompletedCount: i + 1,
 				TotalCount:     len(collectors),
+				Collectors:     collectorList,
 			}
 			continue
 		}
 
+		collectorList[collector.GetDisplayName()] = CollectorStatus{
+			Status: "completed",
+		}
+
 		opts.ProgressChan <- CollectProgress{
 			CurrentName:    collector.GetDisplayName(),
 			CurrentStatus:  "completed",
 			CompletedCount: i + 1,
 			TotalCount:     len(collectors),
+			Collectors:     collectorList,
 		}
 
 		for k, v := range result {