[ws-manager] PodRejected: Add test for phase transitions

Author: geropl

components/ws-manager-mk2/controllers/suite_test.go

@@ -49,9 +49,10 @@ func TestAPIs(t *testing.T) {
 }
 
 var (
-	ctx       context.Context
-	cancel    context.CancelFunc
-	wsMetrics *controllerMetrics
+	ctx                context.Context
+	cancel             context.CancelFunc
+	wsMetrics          *controllerMetrics
+	RegisterSubscriber func(func(*workspacev1.Workspace))
 )
 
 var _ = BeforeSuite(func() {
@@ -116,6 +117,15 @@ var _ = BeforeSuite(func() {
 	Expect(timeoutReconciler.SetupWithManager(k8sManager)).To(Succeed())
 
 	ctx, cancel = context.WithCancel(context.Background())
+	subscriberReconciler, err := NewSubscriberReconciler(k8sManager.GetClient(), &conf)
+	Expect(err).ToNot(HaveOccurred())
+	Expect(subscriberReconciler.SetupWithManager(ctx, k8sManager)).To(Succeed())
+	RegisterSubscriber = func(onReconcile func(*workspacev1.Workspace)) {
+		subscriberReconciler.OnReconcile = func(ctx context.Context, ws *workspacev1.Workspace) {
+			onReconcile(ws)
+		}
+	}
+
 	_ = createNamespace(secretsNamespace)
 
 	go func() {

components/ws-manager-mk2/controllers/workspace_controller.go

@@ -235,6 +235,7 @@ func (r *WorkspaceReconciler) actOnStatus(ctx context.Context, workspace *worksp
 			// Reset status
 			sc := workspace.Status.DeepCopy()
 			workspace.Status = workspacev1.WorkspaceStatus{}
+			workspace.Status.Phase = workspacev1.WorkspacePhasePending
 			workspace.Status.OwnerToken = sc.OwnerToken
 			workspace.Status.PodStarts = sc.PodStarts
 			workspace.Status.PodRecreated = sc.PodRecreated + 1

components/ws-manager-mk2/controllers/workspace_controller_test.go

@@ -392,6 +392,7 @@ var _ = Describe("WorkspaceController", func() {
 		It("pod rejection should result in a retry", func() {
 			ws := newWorkspace(uuid.NewString(), "default")
 			m := collectMetricCounts(wsMetrics, ws)
+			su := collectSubscriberUpdates()
 
 			// ### prepare block start
 			By("creating workspace")
@@ -530,6 +531,8 @@ var _ = Describe("WorkspaceController", func() {
 				starts:         1, // this is NOT PodStarts, but merely an artifact of how we count it in the tests
 				recreations:    map[int]int{1: 1},
 			})
+
+			expectPhaseTransitions(su, []workspacev1.WorkspacePhase{workspacev1.WorkspacePhasePending, workspacev1.WorkspacePhaseCreating, workspacev1.WorkspacePhaseInitializing, workspacev1.WorkspacePhaseRunning})
 			// ### validate end
 		})
 	})
@@ -1042,3 +1045,35 @@ func expectMetricsDelta(initial metricCounts, cur metricCounts, expectedDelta me
 	Expect(cur.restores-initial.restores).To(Equal(expectedDelta.restores), "expected metric count delta for restores")
 	Expect(cur.restoreFailures-initial.restoreFailures).To(Equal(expectedDelta.restoreFailures), "expected metric count delta for restoreFailures")
 }
+
+type subscriberUpdates struct {
+	phaseTransitions []workspacev1.WorkspacePhase
+}
+
+func collectSubscriberUpdates() *subscriberUpdates {
+	su := subscriberUpdates{}
+	recordPhaseTransition := func(su *subscriberUpdates, ws *workspacev1.Workspace) {
+		phase := ws.Status.Phase
+
+		var lastPhase workspacev1.WorkspacePhase
+		lenPhases := len(su.phaseTransitions)
+		if lenPhases > 0 {
+			lastPhase = su.phaseTransitions[lenPhases-1]
+		}
+
+		if lastPhase != phase {
+			su.phaseTransitions = append(su.phaseTransitions, phase)
+		}
+	}
+
+	RegisterSubscriber(func(ws *workspacev1.Workspace) {
+		recordPhaseTransition(&su, ws)
+	})
+	return &su
+}
+
+func expectPhaseTransitions(su *subscriberUpdates, expectation []workspacev1.WorkspacePhase) {
+	GinkgoHelper()
+	By("checking recorded phase transitions")
+	Expect(su.phaseTransitions).To(HaveExactElements(expectation), "expected list of recorded phase transitions")
+}