Merge pull request #217 from Ankit152/phase-observe-csv-unit-test

Added mock unit test for phase_observe_csv.go

internal/controllers/addon/phase_observe_csv_test.go

@@ -0,0 +1,125 @@
+package addon
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	operatorsv1alpha1 "github.com/operator-framework/api/pkg/operators/v1alpha1"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	addonsv1alpha1 "github.com/openshift/addon-operator/apis/addons/v1alpha1"
+	"github.com/openshift/addon-operator/internal/testutil"
+)
+
+func TestObserveCurrentCSV(t *testing.T) {
+	type Expected struct {
+		Conditions []metav1.Condition
+		Result     requeueResult
+	}
+
+	for name, tc := range map[string]struct {
+		CSV      *operatorsv1alpha1.ClusterServiceVersion
+		expected Expected
+	}{
+		"No CSV present": {
+			CSV: &operatorsv1alpha1.ClusterServiceVersion{},
+			expected: Expected{
+				Conditions: []metav1.Condition{unreadyCSVCondition("unkown/pending")},
+				Result:     resultRetry,
+			},
+		},
+		"Phase failed": {
+			CSV: &operatorsv1alpha1.ClusterServiceVersion{
+				Status: operatorsv1alpha1.ClusterServiceVersionStatus{
+					Phase: operatorsv1alpha1.CSVPhaseFailed,
+				},
+			},
+			expected: Expected{
+				Conditions: []metav1.Condition{unreadyCSVCondition("failed")},
+				Result:     resultRetry,
+			},
+		},
+		"Phase succeded": {
+			CSV: &operatorsv1alpha1.ClusterServiceVersion{
+				Status: operatorsv1alpha1.ClusterServiceVersionStatus{
+					Phase: operatorsv1alpha1.CSVPhaseSucceeded,
+				},
+			},
+			expected: Expected{
+				Conditions: []metav1.Condition{},
+				Result:     resultNil,
+			},
+		},
+	} {
+		tc := tc
+
+		t.Run(name, func(t *testing.T) {
+			c := testutil.NewClient()
+			c.
+				On("Get",
+					mock.Anything,
+					mock.IsType(client.ObjectKey{}),
+					testutil.IsOperatorsV1Alpha1ClusterServiceVersionPtr,
+				).
+				Run(func(args mock.Arguments) {
+					tc.CSV.DeepCopyInto(args.Get(2).(*operatorsv1alpha1.ClusterServiceVersion))
+				}).
+				Return(nil)
+
+			r := &olmReconciler{
+				client: c,
+				scheme: testutil.NewTestSchemeWithAddonsv1alpha1(),
+			}
+			var addon addonsv1alpha1.Addon
+			res, err := r.observeCurrentCSV(context.Background(), &addon, client.ObjectKey{})
+			require.NoError(t, err)
+
+			c.AssertExpectations(t)
+
+			assert.Equal(t, tc.expected.Result, res)
+			assertEqualConditions(t, tc.expected.Conditions, addon.Status.Conditions)
+		})
+	}
+}
+
+func unreadyCSVCondition(msg string) metav1.Condition {
+	return metav1.Condition{
+		Type:    addonsv1alpha1.Available,
+		Status:  metav1.ConditionFalse,
+		Reason:  addonsv1alpha1.AddonReasonUnreadyCSV,
+		Message: fmt.Sprintf("ClusterServiceVersion is not ready: %s", msg),
+	}
+}
+
+func assertEqualConditions(t *testing.T, expected []metav1.Condition, actual []metav1.Condition) {
+	t.Helper()
+
+	assert.ElementsMatch(t, dropConditionTransients(expected...), dropConditionTransients(actual...))
+}
+
+func dropConditionTransients(conds ...metav1.Condition) []nonTransientCondition {
+	res := make([]nonTransientCondition, 0, len(conds))
+
+	for _, c := range conds {
+		res = append(res, nonTransientCondition{
+			Type:    c.Type,
+			Status:  c.Status,
+			Reason:  c.Reason,
+			Message: c.Message,
+		})
+	}
+
+	return res
+}
+
+type nonTransientCondition struct {
+	Type    string
+	Status  metav1.ConditionStatus
+	Reason  string
+	Message string
+}

internal/testutil/matchers.go

@@ -24,9 +24,10 @@ var (
 	IsNetworkingV1NetworkPolicyPtr = mock.IsType(&networkingv1.NetworkPolicy{})
 
 	// olm
-	IsOperatorsV1OperatorGroupPtr       = mock.IsType(&operatorsv1.OperatorGroup{})
-	IsOperatorsV1Alpha1CatalogSourcePtr = mock.IsType(&operatorsv1alpha1.CatalogSource{})
-	IsOperatorsV1Alpha1SubscriptionPtr  = mock.IsType(&operatorsv1alpha1.Subscription{})
+	IsOperatorsV1OperatorGroupPtr               = mock.IsType(&operatorsv1.OperatorGroup{})
+	IsOperatorsV1Alpha1CatalogSourcePtr         = mock.IsType(&operatorsv1alpha1.CatalogSource{})
+	IsOperatorsV1Alpha1ClusterServiceVersionPtr = mock.IsType(&operatorsv1alpha1.ClusterServiceVersion{})
+	IsOperatorsV1Alpha1SubscriptionPtr          = mock.IsType(&operatorsv1alpha1.Subscription{})
 
 	// prom
 	IsMonitoringV1ServiceMonitorPtr = mock.IsType(&monitoringv1.ServiceMonitor{})