Add and use checkCompliance helper function

This will help tests that check the overall compliance of a policy.

There are more tests that seem like they might be able to utilize this,
but they use the managed policy retrieved inside the step later in the
test, and might rely on the updated object.

Signed-off-by: Justin Kulikauskas <[email protected]>

Author: JustinKuli

test/e2e/case1_mutation_recovery_test.go

@@ -158,17 +158,7 @@ var _ = Describe("Test mutation recovery", func() {
 			"policy: managed/case1-test-policy-configurationpolicy",
 			"Compliant; No violation detected")
 		By("Checking if policy status is compliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case1PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
+		Eventually(checkCompliance(case1PolicyName), defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 
 		By("Update status to NonCompliant")
 		Eventually(
@@ -188,17 +178,7 @@ var _ = Describe("Test mutation recovery", func() {
 		).Should(BeNil())
 		Expect(getCompliant(managedPlc)).To(Equal("NonCompliant"))
 		By("Checking if policy status was recovered to compliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case1PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
+		Eventually(checkCompliance(case1PolicyName), defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 		By("clean up all events")
 		_, err := kubectlManaged("delete", "events", "-n", clusterNamespace, "--all")
 		Expect(err).Should(BeNil())

test/e2e/case2_status_sync_test.go

@@ -96,18 +96,10 @@ var _ = Describe("Test status sync", func() {
 			"Warning",
 			"policy: managed/case2-test-policy-configurationpolicy",
 			"NonCompliant; there is violation")
+
 		By("Checking if policy status is noncompliant")
-		Eventually(func() interface{} {
-			managedPlc := utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case2PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
+		Eventually(checkCompliance(case2PolicyName), defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
 
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
 		By("Checking if policy history is correct")
 		managedPlc = utils.GetWithTimeout(
 			clientManagedDynamic,
@@ -150,18 +142,10 @@ var _ = Describe("Test status sync", func() {
 			"Normal",
 			"policy: managed/case2-test-policy-configurationpolicy",
 			"Compliant; No violation detected")
+
 		By("Checking if policy status is compliant")
-		Eventually(func() interface{} {
-			managedPlc := utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case2PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
+		Eventually(checkCompliance(case2PolicyName), defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 		By("Checking if policy history is correct")
 		managedPlc = utils.GetWithTimeout(
 			clientManagedDynamic,

test/e2e/case3_multiple_templates_test.go

@@ -494,17 +494,7 @@ var _ = Describe("Test status sync with multiple templates", func() {
 			"policy: managed/case3-test-policy-configurationpolicy2",
 			"Compliant; there is no violation")
 		By("Checking if policy overall status is compliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case3PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
+		Eventually(checkCompliance(case3PolicyName), defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 		By("Patching policy template to remove template: case3-test-policy-configurationpolicy2")
 		_, err := kubectlHub(
 			"apply",

test/e2e/case6_event_msg_test.go

@@ -139,17 +139,7 @@ var _ = Describe("Test event message handling", func() {
 			return plc.Status.Details[0].History[0].Message
 		}, defaultTimeoutSeconds, 1).Should(Equal("NonCompliant; Violation detected"))
 		By("Checking if policy status is noncompliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case6PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
+		Eventually(checkCompliance(case6PolicyName), defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
 	})
 	It("Should remove `(combined from similar events):` prefix but still compliant", func() {
 		By("Generating an event in ns:" + clusterNamespace + " that contains `(combined from similar events):` prefix")
@@ -201,17 +191,7 @@ var _ = Describe("Test event message handling", func() {
 			return plc.Status.Details[0].History[0].Message
 		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant; no violation detected"))
 		By("Checking if policy status is compliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case6PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
+		Eventually(checkCompliance(case6PolicyName), defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 	})
 	It("Should handle violation msg with just NonCompliant", func() {
 		By("Generating an event in ns:" + clusterNamespace + " that only contains `NonCompliant`")
@@ -263,17 +243,7 @@ var _ = Describe("Test event message handling", func() {
 			return plc.Status.Details[0].History[0].Message
 		}, defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
 		By("Checking if policy status is noncompliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case6PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
+		Eventually(checkCompliance(case6PolicyName), defaultTimeoutSeconds, 1).Should(Equal("NonCompliant"))
 	})
 	It("Should handle violation msg with just Compliant", func() {
 		By("Generating an event in ns:" + clusterNamespace + " that only contains `Compliant`")
@@ -325,16 +295,6 @@ var _ = Describe("Test event message handling", func() {
 			return plc.Status.Details[0].History[0].Message
 		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 		By("Checking if policy status is compliant")
-		Eventually(func() interface{} {
-			managedPlc = utils.GetWithTimeout(
-				clientManagedDynamic,
-				gvrPolicy,
-				case6PolicyName,
-				clusterNamespace,
-				true,
-				defaultTimeoutSeconds)
-
-			return getCompliant(managedPlc)
-		}, defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
+		Eventually(checkCompliance(case6PolicyName), defaultTimeoutSeconds, 1).Should(Equal("Compliant"))
 	})
 })

test/e2e/e2e_suite_test.go

@@ -243,3 +243,26 @@ func patchRemediationAction(
 		context.TODO(), plc.GetName(), types.JSONPatchType, patch, metav1.PatchOptions{},
 	)
 }
+
+func checkCompliance(name string) func() string {
+	return func() string {
+		getter := clientManagedDynamic.Resource(gvrPolicy).Namespace(clusterNamespace)
+
+		policy, err := getter.Get(context.TODO(), name, metav1.GetOptions{})
+		if err != nil {
+			return "policy not found"
+		}
+
+		status, statusOk := policy.Object["status"].(map[string]interface{})
+		if !statusOk {
+			return "policy has no status"
+		}
+
+		compliant, compliantOk := status["compliant"].(string)
+		if !compliantOk {
+			return "policy status has no complianceState"
+		}
+
+		return compliant
+	}
+}