Set Available condition to Unknown on archived revisions

Signed-off-by: Per Goncalves da Silva <[email protected]>

Author: Per Goncalves da Silva

internal/operator-controller/controllers/clusterextensionrevision_controller.go

@@ -118,52 +118,8 @@ func (c *ClusterExtensionRevisionReconciler) reconcile(ctx context.Context, rev
 
 	revision, opts, previous := toBoxcutterRevision(rev)
 
-	if !rev.DeletionTimestamp.IsZero() ||
-		rev.Spec.LifecycleState == ocv1.ClusterExtensionRevisionLifecycleStateArchived {
-		//
-		// Teardown
-		//
-		tres, err := c.RevisionEngine.Teardown(ctx, *revision)
-		if err != nil {
-			meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
-				Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
-				Status:             metav1.ConditionFalse,
-				Reason:             ocv1.ClusterExtensionRevisionReasonReconcileFailure,
-				Message:            err.Error(),
-				ObservedGeneration: rev.Generation,
-			})
-			return ctrl.Result{}, fmt.Errorf("revision teardown: %v", err)
-		}
-
-		l.Info("teardown report", "report", tres.String())
-		if !tres.IsComplete() {
-			// TODO: If it is not complete, it seems like it would be good to update
-			//  the status in some way to tell the user that the teardown is still
-			//  in progress.
-			return ctrl.Result{}, nil
-		}
-
-		if err := c.TrackingCache.Free(ctx, rev); err != nil {
-			meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
-				Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
-				Status:             metav1.ConditionFalse,
-				Reason:             ocv1.ClusterExtensionRevisionReasonReconcileFailure,
-				Message:            err.Error(),
-				ObservedGeneration: rev.Generation,
-			})
-			return ctrl.Result{}, fmt.Errorf("error stopping informers: %v", err)
-		}
-		if err := c.removeFinalizer(ctx, rev, clusterExtensionRevisionTeardownFinalizer); err != nil {
-			meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
-				Type:               "Available",
-				Status:             metav1.ConditionFalse,
-				Reason:             "ReconcileFailure",
-				Message:            err.Error(),
-				ObservedGeneration: rev.Generation,
-			})
-			return ctrl.Result{}, fmt.Errorf("error removing teardown finalizer: %v", err)
-		}
-		return ctrl.Result{}, nil
+	if !rev.DeletionTimestamp.IsZero() || rev.Spec.LifecycleState == ocv1.ClusterExtensionRevisionLifecycleStateArchived {
+		return c.teardown(ctx, rev, revision)
 	}
 
 	//
@@ -339,6 +295,66 @@ func (c *ClusterExtensionRevisionReconciler) reconcile(ctx context.Context, rev
 	return ctrl.Result{}, nil
 }
 
+func (c *ClusterExtensionRevisionReconciler) teardown(ctx context.Context, rev *ocv1.ClusterExtensionRevision, revision *boxcutter.Revision) (ctrl.Result, error) {
+	l := log.FromContext(ctx)
+
+	tres, err := c.RevisionEngine.Teardown(ctx, *revision)
+	if err != nil {
+		meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
+			Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
+			Status:             metav1.ConditionFalse,
+			Reason:             ocv1.ClusterExtensionRevisionReasonReconcileFailure,
+			Message:            err.Error(),
+			ObservedGeneration: rev.Generation,
+		})
+		return ctrl.Result{}, fmt.Errorf("revision teardown: %v", err)
+	}
+
+	l.Info("teardown report", "report", tres.String())
+	if !tres.IsComplete() {
+		// TODO: If it is not complete, it seems like it would be good to update
+		//  the status in some way to tell the user that the teardown is still
+		//  in progress.
+		return ctrl.Result{}, nil
+	}
+
+	if err := c.TrackingCache.Free(ctx, rev); err != nil {
+		meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
+			Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
+			Status:             metav1.ConditionFalse,
+			Reason:             ocv1.ClusterExtensionRevisionReasonReconcileFailure,
+			Message:            err.Error(),
+			ObservedGeneration: rev.Generation,
+		})
+		return ctrl.Result{}, fmt.Errorf("error stopping informers: %v", err)
+	}
+
+	// Ensure Available condition is set to Unknown before removing the finalizer when archiving
+	if rev.Spec.LifecycleState == ocv1.ClusterExtensionRevisionLifecycleStateArchived &&
+		!meta.IsStatusConditionPresentAndEqual(rev.Status.Conditions, ocv1.ClusterExtensionRevisionTypeAvailable, metav1.ConditionUnknown) {
+		meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
+			Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
+			Status:             metav1.ConditionUnknown,
+			Reason:             ocv1.ClusterExtensionRevisionReasonArchived,
+			Message:            "revision is archived",
+			ObservedGeneration: rev.Generation,
+		})
+		return ctrl.Result{}, nil
+	}
+
+	if err := c.removeFinalizer(ctx, rev, clusterExtensionRevisionTeardownFinalizer); err != nil {
+		meta.SetStatusCondition(&rev.Status.Conditions, metav1.Condition{
+			Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
+			Status:             metav1.ConditionFalse,
+			Reason:             ocv1.ClusterExtensionRevisionReasonReconcileFailure,
+			Message:            err.Error(),
+			ObservedGeneration: rev.Generation,
+		})
+		return ctrl.Result{}, fmt.Errorf("error removing teardown finalizer: %v", err)
+	}
+	return ctrl.Result{}, nil
+}
+
 type Sourcerer interface {
 	Source(handler handler.EventHandler, predicates ...predicate.Predicate) source.Source
 }

internal/operator-controller/controllers/clusterextensionrevision_controller_test.go

@@ -544,6 +544,40 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_Deletion(t *testing.T) {
 				require.NotContains(t, "olm.operatorframework.io/teardown", rev.Finalizers)
 			},
 		},
+		{
+			name:           "set Available condition to Unknown with reason Archived when archiving revision",
+			revisionResult: mockRevisionResult{},
+			existingObjs: func() []client.Object {
+				ext := newTestClusterExtension()
+				rev1 := newTestClusterExtensionRevision(clusterExtensionRevisionName)
+				rev1.Finalizers = []string{
+					"olm.operatorframework.io/teardown",
+				}
+				rev1.Spec.LifecycleState = ocv1.ClusterExtensionRevisionLifecycleStateArchived
+				require.NoError(t, controllerutil.SetControllerReference(ext, rev1, testScheme))
+				return []client.Object{rev1, ext}
+			},
+			revisionEngineTeardownFn: func(t *testing.T) func(ctx context.Context, rev machinerytypes.Revision, opts ...machinerytypes.RevisionTeardownOption) (machinery.RevisionTeardownResult, error) {
+				return func(ctx context.Context, rev machinerytypes.Revision, opts ...machinerytypes.RevisionTeardownOption) (machinery.RevisionTeardownResult, error) {
+					return &mockRevisionTeardownResult{
+						isComplete: true,
+					}, nil
+				}
+			},
+			validate: func(t *testing.T, c client.Client) {
+				rev := &ocv1.ClusterExtensionRevision{}
+				err := c.Get(t.Context(), client.ObjectKey{
+					Name: clusterExtensionRevisionName,
+				}, rev)
+				require.NoError(t, err)
+				cond := meta.FindStatusCondition(rev.Status.Conditions, ocv1.ClusterExtensionRevisionTypeAvailable)
+				require.NotNil(t, cond)
+				require.Equal(t, metav1.ConditionUnknown, cond.Status)
+				require.Equal(t, ocv1.ClusterExtensionRevisionReasonArchived, cond.Reason)
+				require.Equal(t, "revision is archived", cond.Message)
+				require.Equal(t, int64(1), cond.ObservedGeneration)
+			},
+		},
 		{
 			name:           "revision is torn down when in archived state and finalizer is removed",
 			revisionResult: mockRevisionResult{},
@@ -554,6 +588,13 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_Deletion(t *testing.T) {
 					"olm.operatorframework.io/teardown",
 				}
 				rev1.Spec.LifecycleState = ocv1.ClusterExtensionRevisionLifecycleStateArchived
+				meta.SetStatusCondition(&rev1.Status.Conditions, metav1.Condition{
+					Type:               ocv1.ClusterExtensionRevisionTypeAvailable,
+					Status:             metav1.ConditionUnknown,
+					Reason:             ocv1.ClusterExtensionRevisionReasonArchived,
+					Message:            "revision is archived",
+					ObservedGeneration: rev1.Generation,
+				})
 				require.NoError(t, controllerutil.SetControllerReference(ext, rev1, testScheme))
 				return []client.Object{rev1, ext}
 			},
@@ -570,7 +611,7 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_Deletion(t *testing.T) {
 					Name: clusterExtensionRevisionName,
 				}, rev)
 				require.NoError(t, err)
-				require.NotContains(t, "olm.operatorframework.io/teardown", rev.Finalizers)
+				require.NotContains(t, rev.Finalizers, "olm.operatorframework.io/teardown")
 			},
 		},
 		{