Don't add empty elements to the list of configs.

Previusly, we added strings.Split() which when there is no "," was
returning the original string which was "".

This mean that we got an empty element in the set, and so the generated
annotation looked like ,test-ns/test-name with a leading comma for the
empty element.

This strips out empty elements, this has no technical change, it's
purely aesthetic.

Author: bigkevmcd

controllers/clusterbootstrapconfig_controller.go

@@ -105,6 +105,7 @@ func (r *ClusterBootstrapConfigReconciler) Reconcile(ctx context.Context, req ct
 				return ctrl.Result{RequeueAfter: clusterBootstrapConfig.ClusterReadinessRequeue()}, nil
 			}
 		}
+
 		if err := bootstrapClusterWithConfig(ctx, logger, r.Client, cluster, &clusterBootstrapConfig); err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to bootstrap cluster config: %w", err)
 		}
@@ -116,9 +117,11 @@ func (r *ClusterBootstrapConfigReconciler) Reconcile(ctx context.Context, req ct
 				},
 			},
 		})
+
 		if err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to create a patch to update the cluster annotations: %w", err)
 		}
+
 		if err := r.Client.Patch(ctx, cluster, client.RawPatch(types.MergePatchType, mergePatch)); err != nil {
 			return ctrl.Result{}, fmt.Errorf("failed to annotate cluster %s/%s as bootstrapped: %w", cluster.ObjectMeta.Name, cluster.ObjectMeta.Namespace, err)
 		}
@@ -127,10 +130,22 @@ func (r *ClusterBootstrapConfigReconciler) Reconcile(ctx context.Context, req ct
 }
 
 func appendClusterConfigToBootstrappedList(config capiv1alpha1.ClusterBootstrapConfig, cluster *clustersv1.GitopsCluster) string {
-	current := cluster.GetAnnotations()[capiv1alpha1.BootstrapConfigsAnnotation]
-	set := sets.NewString(strings.Split(current, ",")...)
-	id := fmt.Sprintf("%s/%s", config.GetNamespace(), config.GetName())
-	set.Insert(id)
+	set := sets.NewString()
+
+	current := func(ann string) []string {
+		nonempty := []string{}
+		for _, s := range strings.Split(ann, ",") {
+			if s != "" {
+				nonempty = append(nonempty, s)
+			}
+		}
+
+		return nonempty
+	}(cluster.GetAnnotations()[capiv1alpha1.BootstrapConfigsAnnotation])
+	set.Insert(current...)
+
+	set.Insert(fmt.Sprintf("%s/%s", config.GetNamespace(), config.GetName()))
+
 	return strings.Join(set.List(), ",")
 }
 

controllers/clusterbootstrapconfig_controller_test.go

@@ -139,6 +139,15 @@ func TestReconcile_when_cluster_ready(t *testing.T) {
 	if l := len(jobs.Items); l != 1 {
 		t.Fatalf("found %d jobs, want %d", l, 1)
 	}
+
+	// reload the Cluster to check the state
+	if err := reconciler.Get(context.TODO(), client.ObjectKeyFromObject(cl), cl); err != nil {
+		t.Fatal(err)
+	}
+
+	if v := cl.ObjectMeta.Annotations[capiv1alpha1.BootstrapConfigsAnnotation]; v != "testing/test-config" {
+		t.Fatalf("got bootstrapped configs %q, want %q", v, "testing/test-config")
+	}
 }
 
 func TestReconcile_when_cluster_ready_bootstrapped_with_same_config(t *testing.T) {

go.mod

@@ -1,6 +1,6 @@
 module github.com/weaveworks/cluster-bootstrap-controller
 
-go 1.19
+go 1.20
 
 require (
 	github.com/fluxcd/pkg/runtime v0.35.0