test: verify that crossplane has flags set/unset and pod stays running

Signed-off-by: Jared Watts <[email protected]>

Author: jbw976

test/e2e/apiextensions_test.go

@@ -304,7 +304,9 @@ func TestPropagateFieldsRemovalToXRAfterUpgrade(t *testing.T) {
 			// explicitly disable them first before we create anything.
 			WithSetup("DisableSSAClaims", funcs.AllOf(
 				funcs.AsFeaturesFunc(environment.HelmUpgradeCrossplaneToSuite(config.TestSuiteDefault)), // Disable our feature flag.
+				funcs.ArgUnsetWithin(1*time.Minute, "--enable-ssa-claims", namespace, "crossplane"),
 				funcs.ReadyToTestWithin(1*time.Minute, namespace),
+				funcs.DeploymentPodIsRunningMustNotChangeWithin(10*time.Second, namespace, "crossplane"),
 			)).
 			WithSetup("PrerequisitesAreCreated", funcs.AllOf(
 				funcs.ApplyResources(FieldManager, manifests, "setup/*.yaml"),
@@ -323,7 +325,9 @@ func TestPropagateFieldsRemovalToXRAfterUpgrade(t *testing.T) {
 			// would end up sharing ownership with the old CSA field manager.
 			Assess("EnableSSAClaims", funcs.AllOf(
 				funcs.AsFeaturesFunc(environment.HelmUpgradeCrossplaneToSuite(SuiteSSAClaims)),
+				funcs.ArgSetWithin(1*time.Minute, "--enable-ssa-claims", namespace, "crossplane"),
 				funcs.ReadyToTestWithin(1*time.Minute, namespace),
+				funcs.DeploymentPodIsRunningMustNotChangeWithin(10*time.Second, namespace, "crossplane"),
 			)).
 			Assess("UpdateClaim", funcs.AllOf(
 				funcs.ApplyClaim(FieldManager, manifests, "claim-update.yaml"),

test/e2e/funcs/feature.go

@@ -133,6 +133,100 @@ func DeploymentBecomesAvailableWithin(d time.Duration, namespace, name string) f
 	}
 }
 
+// DeploymentPodIsRunningMustNotChangeWithin fails a test if the supplied Deployment does
+// not have a running Pod that stays running for the supplied duration.
+func DeploymentPodIsRunningMustNotChangeWithin(d time.Duration, namespace, name string) features.Func {
+	return func(ctx context.Context, t *testing.T, c *envconf.Config) context.Context {
+		t.Helper()
+
+		dp := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Namespace: namespace, Name: name}}
+		t.Logf("Ensuring deployment %s/%s has running pod that does not change within %s", dp.GetNamespace(), dp.GetName(), d.String())
+		start := time.Now()
+
+		pod, err := podForDeployment(ctx, t, c, dp)
+		if err != nil {
+			t.Errorf("Failed to get pod for deployment %s/%s: %s", dp.GetNamespace(), dp.GetName(), err)
+			return ctx
+		}
+
+		// first wait for pod to be running
+		if err := wait.For(conditions.New(c.Client().Resources()).PodConditionMatch(pod, corev1.PodReady, corev1.ConditionTrue), wait.WithTimeout(d), wait.WithInterval(DefaultPollInterval)); err != nil {
+			t.Errorf("Deployment %s/%s never got a running pod after %s", dp.GetNamespace(), dp.GetName(), since(start))
+			return ctx
+		}
+
+		// now wait to make sure the pod stays running (does not change)
+		start = time.Now()
+		if err := wait.For(conditions.New(c.Client().Resources()).PodConditionMatch(pod, corev1.PodReady, corev1.ConditionFalse), wait.WithTimeout(d), wait.WithInterval(DefaultPollInterval)); err != nil {
+			if deadlineExceed(err) {
+				t.Logf("Deployment %s/%s had running pod that did not change after %s", dp.GetNamespace(), dp.GetName(), since(start))
+			} else {
+				t.Errorf("Error while observing pod for deployment %s/%s", dp.GetNamespace(), dp.GetName())
+			}
+			return ctx
+		}
+		t.Errorf("Deployment %s/%s had pod that changed within %s, but it should not have", dp.GetNamespace(), dp.GetName(), d.String())
+		return ctx
+	}
+}
+
+// ArgSetWithin fails a test if the supplied Deployment does not have a Pod with
+// the given argument set within the supplied duration.
+func ArgSetWithin(d time.Duration, arg, namespace, name string) features.Func {
+	return checkArgSetWithin(d, arg, true, namespace, name)
+}
+
+// ArgUnsetWithin fails a test if the supplied Deployment does not have a Pod with
+// the given argument unset within the supplied duration.
+func ArgUnsetWithin(d time.Duration, arg, namespace, name string) features.Func {
+	return checkArgSetWithin(d, arg, false, namespace, name)
+}
+
+// checkArgSetWithin implements a check for the supplied Deployment having a Pod
+// with the given argument being either set or unset within the supplied
+// duration.
+func checkArgSetWithin(d time.Duration, arg string, wantSet bool, namespace, name string) features.Func {
+	return func(ctx context.Context, t *testing.T, c *envconf.Config) context.Context {
+		t.Helper()
+
+		dp := &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Namespace: namespace, Name: name}}
+		t.Logf("Waiting %s for pod in deployment %s/%s to have arg %s set=%t...", d, dp.GetNamespace(), dp.GetName(), arg, wantSet)
+		start := time.Now()
+
+		if err := wait.For(func(ctx context.Context) (done bool, err error) {
+			pod, err := podForDeployment(ctx, t, c, dp)
+			if err != nil {
+				t.Logf("failed to get pod for deployment %s/%s: %s", dp.GetNamespace(), dp.GetName(), err)
+				return false, nil
+			}
+
+			found := false
+			c := pod.Spec.Containers[0]
+			for _, a := range c.Args {
+				if a == arg {
+					found = true
+				}
+			}
+
+			if wantSet && !found {
+				t.Logf("did not find arg %s within %s", arg, c.Args)
+				return false, nil
+			} else if !wantSet && found {
+				t.Logf("unexpectedly found arg %s within %s", arg, c.Args)
+				return false, nil
+			}
+
+			return true, nil
+		}, wait.WithTimeout(d), wait.WithInterval(DefaultPollInterval)); err != nil {
+			t.Fatal(err)
+			return ctx
+		}
+
+		t.Logf("Deployment %s/%s has pod with arg %s set=%t after %s", dp.GetNamespace(), dp.GetName(), arg, wantSet, since(start))
+		return ctx
+	}
+}
+
 // ResourcesCreatedWithin fails a test if the supplied resources are not found
 // to exist within the supplied duration.
 func ResourcesCreatedWithin(d time.Duration, dir, pattern string, options ...decoder.DecodeOption) features.Func {
@@ -727,7 +821,7 @@ func CompositeResourceHasFieldValueWithin(d time.Duration, dir, claimFile, path
 			return got != ""
 		}
 
-		if err := wait.For(conditions.New(c.Client().Resources()).ResourceMatch(cm, hasResourceRef), wait.WithTimeout(d), wait.WithInterval(DefaultPollInterval)); err != nil {
+		if err := wait.For(conditions.New(c.Client().Resources()).ResourceMatch(cm, hasResourceRef), wait.WithTimeout(d), wait.WithInterval(DefaultPollInterval), wait.WithImmediate()); err != nil {
 			t.Errorf("Claim %q does not have a resourceRef to an XR: %v", cm.GetName(), err)
 			return ctx
 		}
@@ -1168,3 +1262,33 @@ func since(t time.Time) string {
 func deadlineExceed(err error) bool {
 	return errors.Is(err, context.DeadlineExceeded) || strings.Contains(err.Error(), "would exceed context deadline")
 }
+
+// podForDeployment returns the pod for a given Deployment. If the number of
+// pods found is not exactly one, or that one pod does not have exactly one
+// container, then this function returns an error.
+func podForDeployment(ctx context.Context, t *testing.T, c *envconf.Config, dp *appsv1.Deployment) (*corev1.Pod, error) {
+	t.Helper()
+	if err := c.Client().Resources().Get(ctx, dp.GetName(), dp.GetNamespace(), dp); err != nil {
+		t.Logf("failed to get deployment %s/%s: %s", dp.GetNamespace(), dp.GetName(), err)
+		return nil, err
+	}
+
+	// use the deployment's selector to list all pods belonging to the deployment
+	selector := metav1.FormatLabelSelector(dp.Spec.Selector)
+	pods := &corev1.PodList{}
+	if err := c.Client().Resources().List(ctx, pods, resources.WithLabelSelector(selector)); err != nil {
+		t.Logf("failed to list pods for deployment %s/%s: %s", dp.GetNamespace(), dp.GetName(), err)
+		return nil, err
+	}
+
+	if len(pods.Items) != 1 {
+		return nil, errors.Errorf("expected 1 pod, found %d", len(pods.Items))
+	}
+
+	pod := pods.Items[0]
+	if len(pod.Spec.Containers) != 1 {
+		return nil, errors.Errorf("expected 1 container, found %d", len(pod.Spec.Containers))
+	}
+
+	return &pod, nil
+}