Support HCP labels

Author: muraee

pkg/driver/common/operator/hooks.go

@@ -39,7 +39,7 @@ func NewDefaultOperatorControllerConfig(flavour generator.ClusterFlavour, c *cli
 		cfg.AddDeploymentHookBuilders(c, withClusterWideProxy, withStandaloneReplicas)
 	} else {
 		// HyperShift
-		cfg.AddDeploymentHookBuilders(c, withHyperShiftReplicas, withHyperShiftNodeSelector, withHyperShiftControlPlaneImages, withHyperShiftCustomTolerations)
+		cfg.AddDeploymentHookBuilders(c, withHyperShiftReplicas, withHyperShiftNodeSelector, withHyperShiftLabels, withHyperShiftControlPlaneImages, withHyperShiftCustomTolerations)
 	}
 
 	return cfg
@@ -141,6 +141,49 @@ func getHostedControlPlaneTolerations(hostedControlPlaneLister hypev1beta1lister
 	return tolerations, nil
 }
 
+// withHyperShiftLabels sets Deployment labels on a HyperShift hosted control-plane.
+func withHyperShiftLabels(c *clients.Clients) (dc.DeploymentHookFunc, []factory.Informer) {
+	hook := func(_ *opv1.OperatorSpec, deployment *appsv1.Deployment) error {
+		labels, err := getHostedControlLabels(
+			c.ControlPlaneHypeInformer.Hypershift().V1beta1().HostedControlPlanes().Lister(),
+			c.ControlPlaneNamespace)
+		if err != nil {
+			return err
+		}
+
+		if deployment.Spec.Template.Labels == nil {
+			deployment.Spec.Template.Labels = map[string]string{}
+		}
+
+		for key, value := range labels {
+			// don't replace existing labels as they are used in the deployment's labelSelector.
+			if _, exist := deployment.Spec.Template.Labels[key]; !exist {
+				deployment.Spec.Template.Labels[key] = value
+			}
+		}
+		return nil
+	}
+	informers := []factory.Informer{
+		c.ControlPlaneHypeInformer.Hypershift().V1beta1().HostedControlPlanes().Informer(),
+	}
+	return hook, informers
+}
+
+// getHostedControlLabels returns the labels from the HostedControlPlane CR.
+func getHostedControlLabels(hostedControlPlaneLister hypev1beta1listers.HostedControlPlaneLister, namespace string) (map[string]string, error) {
+	hcp, err := getHostedControlPlane(hostedControlPlaneLister, namespace)
+	if err != nil {
+		return nil, err
+	}
+	labels := hcp.Spec.Labels
+	if len(labels) == 0 {
+		return nil, nil
+	}
+	klog.V(4).Infof("Using labels %v", labels)
+	return labels, nil
+
+}
+
 // getHostedControlPlane returns the HostedControlPlane CR.
 func getHostedControlPlane(hostedControlPlaneLister hypev1beta1listers.HostedControlPlaneLister, namespace string) (*hypev1beta1api.HostedControlPlane, error) {
 	list, err := hostedControlPlaneLister.List(labels.Everything())

pkg/driver/common/operator/hooks_test.go

@@ -146,6 +146,63 @@ func Test_WithHyperShiftNodeSelector(t *testing.T) {
 	}
 }
 
+func Test_WithHyperShiftLabels(t *testing.T) {
+	tests := []struct {
+		name           string
+		hcp            *hypev1beta1api.HostedControlPlane
+		expectedLabels map[string]string
+	}{
+		{
+			name:           "no labels",
+			hcp:            getTestHostedControlPlane("hcp_no_labels.yaml"),
+			expectedLabels: nil,
+		},
+		{
+			name: "labels",
+			hcp:  getTestHostedControlPlane("hcp_labels.yaml"),
+			expectedLabels: map[string]string{
+				"foo": "bar",
+				"baz": "",
+			},
+		},
+		{
+			name: "existing labels should not be replaced",
+			hcp:  getTestHostedControlPlane("hcp_no_labels.yaml"),
+			expectedLabels: map[string]string{
+				"app": "aws-ebs-csi-driver-controller",
+				"hypershift.openshift.io/hosted-control-plane": "clusters-test",
+			},
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			cr := clients.GetFakeOperatorCR()
+			c := clients.NewFakeClients("clusters-test", cr)
+			// Arrange: inject HostedControlPlane to the clients
+			c.ControlPlaneHypeClient.(*fakehype.Clientset).Tracker().Add(tt.hcp)
+
+			hook, _ := withHyperShiftLabels(c)
+			deployment := getTestDeployment()
+			// Sync the informers with the client as the last step, withHyperShiftLabels()
+			// must create necessary informers before.
+			clients.SyncFakeInformers(t, c)
+
+			// Act
+			err := hook(&cr.Spec.OperatorSpec, deployment)
+			if err != nil {
+				t.Fatalf("unexpected hook error: %v", err)
+			}
+			// Assert
+			for key, expectedValue := range tt.expectedLabels {
+				value, exist := deployment.Spec.Template.Labels[key]
+				if !exist || value != expectedValue {
+					t.Errorf("expected labels %s to exist with value %s", key, expectedValue)
+				}
+			}
+		})
+	}
+}
+
 func Test_WithHyperShiftControlPlaneImages(t *testing.T) {
 	tests := []struct {
 		name string

pkg/driver/common/operator/test_manifests/hcp_labels.yaml

@@ -0,0 +1,9 @@
+apiVersion: hypershift.openshift.io/v1beta1
+kind: HostedControlPlane
+metadata:
+  name: test
+  namespace: clusters-test
+spec:
+  labels:
+    foo: bar
+    baz: ""

pkg/driver/common/operator/test_manifests/hcp_no_labels.yaml

@@ -0,0 +1,6 @@
+apiVersion: hypershift.openshift.io/v1beta1
+kind: HostedControlPlane
+metadata:
+  name: test
+  namespace: clusters-test
+spec: {}