Merge pull request crossplane#269 from silotrd/master

[ISSUE crossplane#264] Bug fixed, should not pass annotations into podTemplate
silotrd · Oct 27, 2020 · ad311db · ad311db
2 parents 696eb7b + d26cc36
commit ad311db
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 12 deletions.
diff --git a/...pha2/core/workloads/containerizedworkload/containerizedworkload_controller_helper_test.go b/...pha2/core/workloads/containerizedworkload/containerizedworkload_controller_helper_test.go
@@ -81,10 +81,6 @@ func TestRenderDeployment(t *testing.T) {
 		t.Errorf("\nReason: %s\ncontainerizedWorkloadTranslator(...): -want, +got:\n%s", "pass label", diff)
 	}
 
-	if diff := cmp.Diff(dmAnnotation, deploy.Spec.Template.GetAnnotations()); diff != "" {
-		t.Errorf("\nReason: %s\ncontainerizedWorkloadTranslator(...): -want, +got:\n%s", "pass annotation", diff)
-	}
-
 	if len(deploy.GetOwnerReferences()) != 1 {
 		t.Errorf("deplyment should have one owner reference")
 	}

diff --git a/pkg/controller/v1alpha2/core/workloads/containerizedworkload/translate.go b/pkg/controller/v1alpha2/core/workloads/containerizedworkload/translate.go
@@ -258,8 +258,8 @@ func TranslateContainerWorkload(ctx context.Context, w oam.Workload) ([]oam.Obje
 
 	// pass through label and annotation from the workload to the deployment
 	util.PassLabelAndAnnotation(w, d)
-	// pass through label and annotation from the workload to the pod template too
-	util.PassLabelAndAnnotation(w, &d.Spec.Template)
+	// pass through label from the workload to the pod template
+	util.PassLabel(w, &d.Spec.Template)
 
 	return []oam.Object{d}, nil
 }

diff --git a/pkg/controller/v1alpha2/core/workloads/containerizedworkload/translate_test.go b/pkg/controller/v1alpha2/core/workloads/containerizedworkload/translate_test.go
@@ -55,7 +55,6 @@ func dmWithLabel(label map[string]string) deploymentModifier {
 func dmWithAnnotation(annotation map[string]string) deploymentModifier {
 	return func(cw *appsv1.Deployment) {
 		cw.Annotations = annotation
-		cw.Spec.Template.Annotations = annotation
 	}
 }
 

diff --git a/pkg/oam/util/helper.go b/pkg/oam/util/helper.go
@@ -268,6 +268,12 @@ type labelAnnotationObject interface {
 	SetAnnotations(annotations map[string]string)
 }
 
+// PassLabel passes through labels from the parent to the child object
+func PassLabel(parentObj oam.Object, childObj labelAnnotationObject) {
+	// pass app-config labels
+	childObj.SetLabels(MergeMap(parentObj.GetLabels(), childObj.GetLabels()))
+}
+
 // PassLabelAndAnnotation passes through labels and annotation objectMeta from the parent to the child object
 func PassLabelAndAnnotation(parentObj oam.Object, childObj labelAnnotationObject) {
 	// pass app-config labels

diff --git a/test/e2e-test/containerized_workload_test.go b/test/e2e-test/containerized_workload_test.go
@@ -23,11 +23,12 @@ import (
 
 var _ = Describe("ContainerizedWorkload", func() {
 	ctx := context.TODO()
-	var namespace, fakeLabelKey, componentName, workloadInstanceName, imageName string
+	var namespace, fakeLabelKey, fakeAnnotationKey, componentName, workloadInstanceName, imageName string
 	var replica int32
 	var ns corev1.Namespace
 	var wd v1alpha2.WorkloadDefinition
 	var label map[string]string
+	var annotations map[string]string
 	var wl v1alpha2.ContainerizedWorkload
 	var comp v1alpha2.Component
 	var appConfig v1alpha2.ApplicationConfiguration
@@ -37,6 +38,7 @@ var _ = Describe("ContainerizedWorkload", func() {
 		// init the strings
 		namespace = "containerized-workload-test"
 		fakeLabelKey = "workload"
+		fakeAnnotationKey = "kubectl.kubernetes.io/last-applied-configuration"
 		componentName = "example-component"
 		workloadInstanceName = "example-appconfig-workload"
 		imageName = "wordpress:php7.2"
@@ -159,11 +161,13 @@ var _ = Describe("ContainerizedWorkload", func() {
 		// Create application configuration
 		workloadInstanceName := "example-appconfig-workload"
 		imageName := "wordpress:php7.2"
+		annotations = map[string]string{fakeAnnotationKey: "fake-annotation-key-item"}
 		appConfig = v1alpha2.ApplicationConfiguration{
 			ObjectMeta: metav1.ObjectMeta{
-				Name:      "example-appconfig",
-				Namespace: namespace,
-				Labels:    label,
+				Name:        "example-appconfig",
+				Namespace:   namespace,
+				Labels:      label,
+				Annotations: annotations,
 			},
 			Spec: v1alpha2.ApplicationConfigurationSpec{
 				Components: []v1alpha2.ApplicationConfigurationComponent{
@@ -268,7 +272,17 @@ var _ = Describe("ContainerizedWorkload", func() {
 			},
 			time.Second*60, time.Second*5).Should(BeEquivalentTo(replica))
 		Expect(*deploy.Spec.Replicas).Should(BeEquivalentTo(replica))
-
+		By("Verify pod annotations should not contain kubectl.kubernetes.io/last-applied-configuration")
+		Eventually(
+			func() bool {
+				k8sClient.Get(ctx, objectKey, deploy)
+				annotations := deploy.Spec.Template.Annotations
+				if _, ok := annotations[fakeAnnotationKey]; ok {
+					return false
+				}
+				return true
+			},
+			time.Second*15, time.Millisecond*500).Should(BeTrue())
 	})
 
 	It("checking appConfig status changed outside of the controller loop is preserved", func() {