Add additional revision controller unit tests

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

Author: Per Goncalves da Silva

internal/operator-controller/controllers/clusterextensionrevision_controller_test.go

@@ -2,13 +2,14 @@ package controllers_test
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
 	corev1 "k8s.io/api/core/v1"
-	"k8s.io/apimachinery/pkg/api/errors"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/api/meta"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
@@ -32,18 +33,19 @@ import (
 	"github.com/operator-framework/operator-controller/internal/operator-controller/labels"
 )
 
-func Test_ClusterExtensionRevisionReconciler_Reconcile_RevisionProgression(t *testing.T) {
+func Test_ClusterExtensionRevisionReconciler_Reconcile_RevisionReconciliation(t *testing.T) {
 	const (
 		clusterExtensionRevisionName = "test-ext-1"
 	)
 
 	testScheme := newScheme(t)
 
 	for _, tc := range []struct {
-		name           string
-		existingObjs   func() []client.Object
-		revisionResult machinery.RevisionResult
-		validate       func(*testing.T, client.Client)
+		name                 string
+		existingObjs         func() []client.Object
+		revisionResult       machinery.RevisionResult
+		revisionReconcileErr error
+		validate             func(*testing.T, client.Client)
 	}{
 		{
 			name:           "sets teardown finalizer",
@@ -87,8 +89,10 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_RevisionProgression(t *te
 			},
 		},
 		{
-			name: "set Available:False:ProbeFailure condition when probe failures are detected",
+			name: "set Available:False:ProbeFailure condition when probe failures are detected and revision is in transition ",
 			revisionResult: mockRevisionResult{
+				inTransition: true,
+				isComplete:   false,
 				phases: []machinery.PhaseResult{
 					mockPhaseResult{
 						name:       "somephase",
@@ -175,6 +179,121 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_RevisionProgression(t *te
 				require.Equal(t, int64(1), cond.ObservedGeneration)
 			},
 		},
+		{
+			name: "set Available:False:ProbeFailure condition when probe failures are detected and revision is not in transition",
+			revisionResult: mockRevisionResult{
+				inTransition: false,
+				isComplete:   false,
+				phases: []machinery.PhaseResult{
+					mockPhaseResult{
+						name:       "somephase",
+						isComplete: false,
+						objects: []machinery.ObjectResult{
+							mockObjectResult{
+								success: true,
+								probes: map[string]machinery.ObjectProbeResult{
+									boxcutter.ProgressProbeType: {
+										Success: true,
+									},
+								},
+							},
+							mockObjectResult{
+								success: false,
+								object: func() client.Object {
+									obj := &corev1.Service{
+										ObjectMeta: metav1.ObjectMeta{
+											Name:      "my-service",
+											Namespace: "my-namespace",
+										},
+									}
+									obj.SetGroupVersionKind(corev1.SchemeGroupVersion.WithKind("Service"))
+									return obj
+								}(),
+								probes: map[string]machinery.ObjectProbeResult{
+									boxcutter.ProgressProbeType: {
+										Success: false,
+										Messages: []string{
+											"something bad happened",
+											"something worse happened",
+										},
+									},
+								},
+							},
+						},
+					},
+					mockPhaseResult{
+						name:       "someotherphase",
+						isComplete: false,
+						objects: []machinery.ObjectResult{
+							mockObjectResult{
+								success: false,
+								object: func() client.Object {
+									obj := &corev1.ConfigMap{
+										ObjectMeta: metav1.ObjectMeta{
+											Name:      "my-configmap",
+											Namespace: "my-namespace",
+										},
+									}
+									obj.SetGroupVersionKind(corev1.SchemeGroupVersion.WithKind("ConfigMap"))
+									return obj
+								}(),
+								probes: map[string]machinery.ObjectProbeResult{
+									boxcutter.ProgressProbeType: {
+										Success: false,
+										Messages: []string{
+											"we have a problem",
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+			existingObjs: func() []client.Object {
+				ext := newTestClusterExtension()
+				rev1 := newTestClusterExtensionRevision(clusterExtensionRevisionName)
+				require.NoError(t, controllerutil.SetControllerReference(ext, rev1, testScheme))
+				return []client.Object{ext, rev1}
+			},
+			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.ConditionFalse, cond.Status)
+				require.Equal(t, ocv1.ClusterExtensionRevisionReasonProbeFailure, cond.Reason)
+				require.Equal(t, "Object Service.v1 my-namespace/my-service: something bad happened and something worse happened\nObject ConfigMap.v1 my-namespace/my-configmap: we have a problem", cond.Message)
+				require.Equal(t, int64(1), cond.ObservedGeneration)
+			},
+		},
+		{
+			name:                 "set Progressing:True:RolloutError when there's an error reconciling the revision",
+			revisionReconcileErr: errors.New("some error"),
+
+			existingObjs: func() []client.Object {
+				ext := newTestClusterExtension()
+				rev1 := newTestClusterExtensionRevision(clusterExtensionRevisionName)
+				require.NoError(t, controllerutil.SetControllerReference(ext, rev1, testScheme))
+				return []client.Object{ext, rev1}
+			},
+			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.TypeProgressing)
+				require.NotNil(t, cond)
+				require.Equal(t, metav1.ConditionTrue, cond.Status)
+				require.Equal(t, ocv1.ClusterExtensionRevisionReasonRolloutError, cond.Reason)
+				require.Equal(t, "some error", cond.Message)
+				require.Equal(t, int64(1), cond.ObservedGeneration)
+			},
+		},
 		{
 			name: "set Progressing:True:RollingOut condition while revision is transitioning",
 			revisionResult: mockRevisionResult{
@@ -317,7 +436,7 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_RevisionProgression(t *te
 				Client: testClient,
 				RevisionEngine: &mockRevisionEngine{
 					reconcile: func(ctx context.Context, rev machinerytypes.Revision, opts ...machinerytypes.RevisionReconcileOption) (machinery.RevisionResult, error) {
-						return tc.revisionResult, nil
+						return tc.revisionResult, tc.revisionReconcileErr
 					},
 				},
 				TrackingCache: &mockTrackingCache{},
@@ -327,9 +446,13 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_RevisionProgression(t *te
 				},
 			})
 
-			// reconcile cluster extensionr evision
+			// reconcile cluster extension revision
 			require.Equal(t, ctrl.Result{}, result)
-			require.NoError(t, err)
+			if tc.revisionReconcileErr == nil {
+				require.NoError(t, err)
+			} else {
+				require.Contains(t, err.Error(), tc.revisionReconcileErr.Error())
+			}
 
 			// validate test case
 			tc.validate(t, testClient)
@@ -517,7 +640,7 @@ func Test_ClusterExtensionRevisionReconciler_Reconcile_Deletion(t *testing.T) {
 					Name: clusterExtensionRevisionName,
 				}, rev)
 				require.Error(t, err)
-				require.True(t, errors.IsNotFound(err))
+				require.True(t, apierrors.IsNotFound(err))
 			},
 		},
 		{