Add olm gomega assertions and matchers

Signed-off-by: perdasilva <[email protected]>

Author: perdasilva

Diff for: test/e2e/util/gomega/assertions.go

@@ -0,0 +1,24 @@
+package gomega
+
+import (
+	"context"
+
+	. "github.com/onsi/gomega"
+	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/ctx"
+	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/util"
+	k8scontrollerclient "sigs.k8s.io/controller-runtime/pkg/client"
+)
+
+func EventuallyResource(actual k8scontrollerclient.Object, intervals ...interface{}) AsyncAssertion {
+	client := ctx.Ctx().Client()
+	clone := actual.DeepCopyObject().(k8scontrollerclient.Object)
+	key := k8scontrollerclient.ObjectKeyFromObject(actual)
+	getObjectFn := func() k8scontrollerclient.Object {
+		if err := client.Get(context.Background(), key, clone); err != nil {
+			util.Logf("ERROR getting resource '%s'", util.ObjectToJsonString(key), err)
+			return nil
+		}
+		return clone
+	}
+	return Eventually(getObjectFn, intervals...)
+}

Diff for: test/e2e/util/gomega/catalogsource_matchers.go

@@ -0,0 +1,44 @@
+package gomega
+
+import (
+	"fmt"
+
+	"github.com/onsi/gomega/matchers"
+	"github.com/onsi/gomega/types"
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/util"
+	"google.golang.org/grpc/connectivity"
+)
+
+func HaveGrpcConnectionWithLastConnectionState(state connectivity.State) types.GomegaMatcher {
+	return &CatalogSourceGrpcConnectionLastConnectionStateMatcher{
+		EqualMatcher: &matchers.EqualMatcher{
+			Expected: state.String(),
+		},
+	}
+}
+
+type CatalogSourceGrpcConnectionLastConnectionStateMatcher struct {
+	*matchers.EqualMatcher
+}
+
+func (s *CatalogSourceGrpcConnectionLastConnectionStateMatcher) FailureMessage(actual interface{}) (message string) {
+	return fmt.Sprintf("expected catalog source status.grpcConnectionState.lastObservedState to be '%s'\n%s\n", s.Expected, util.ObjectToPrettyJsonString(actual))
+}
+
+func (s *CatalogSourceGrpcConnectionLastConnectionStateMatcher) NegatedFailureMessage(actual interface{}) (message string) {
+	return fmt.Sprintf("expected catalog  status.grpcConnectionState.lastObservedState to NOT be '%s':\n%s\n ", s.Expected, util.ObjectToPrettyJsonString(actual))
+}
+
+func (s *CatalogSourceGrpcConnectionLastConnectionStateMatcher) Match(actual interface{}) (bool, error) {
+	switch actual := actual.(type) {
+	case *v1alpha1.CatalogSource:
+		if actual.Status.GRPCConnectionState == nil {
+			return false, fmt.Errorf("catalog source does not have a grpc connection state")
+		}
+		util.Logf("expecting catalog source last connection state '%s' to be '%s'", actual.Status.GRPCConnectionState.LastObservedState, s.Expected)
+		return s.EqualMatcher.Match(actual.Status.GRPCConnectionState.LastObservedState)
+	default:
+		return false, fmt.Errorf("actual %v is not a subscription", actual)
+	}
+}

Diff for: test/e2e/util/gomega/subscription_matchers.go

@@ -0,0 +1,66 @@
+package gomega
+
+import (
+	"fmt"
+
+	"github.com/onsi/gomega/matchers"
+	"github.com/onsi/gomega/types"
+	"github.com/operator-framework/api/pkg/operators/v1alpha1"
+	"github.com/operator-framework/operator-lifecycle-manager/test/e2e/util"
+)
+
+func HaveSubscriptionState(state v1alpha1.SubscriptionState) types.GomegaMatcher {
+	return &SubscriptionStateMatcher{
+		EqualMatcher: &matchers.EqualMatcher{
+			Expected: state,
+		},
+	}
+}
+
+type SubscriptionStateMatcher struct {
+	*matchers.EqualMatcher
+}
+
+func (s *SubscriptionStateMatcher) FailureMessage(actual interface{}) (message string) {
+	return fmt.Sprintf("expected subscription status.subscriptionState to be '%s':\n%s\n", s.Expected, util.ObjectToJsonString(actual))
+}
+
+func (s *SubscriptionStateMatcher) NegatedFailureMessage(actual interface{}) (message string) {
+	return fmt.Sprintf("expected subscription status.subscriptionState to NOT be '%s'\n%s\n", s.Expected, util.ObjectToJsonString(actual))
+}
+
+func (s *SubscriptionStateMatcher) Match(actual interface{}) (bool, error) {
+	switch actual := actual.(type) {
+	case *v1alpha1.Subscription:
+		util.Logf("expecting subscription state '%s' to be '%s'", actual.Status.State, s.Expected)
+		return s.EqualMatcher.Match(actual.Status.State)
+	default:
+		return false, fmt.Errorf("actual %v is not a subscription", actual)
+	}
+}
+
+type ContainSubscriptionConditionOfTypeMatcher struct {
+	*matchers.ContainElementMatcher
+}
+
+func ContainSubscriptionConditionOfType(conditionType v1alpha1.SubscriptionConditionType) types.GomegaMatcher {
+	return &ContainSubscriptionConditionOfTypeMatcher{
+		ContainElementMatcher: &matchers.ContainElementMatcher{
+			Element: conditionType,
+		},
+	}
+}
+
+func (s *ContainSubscriptionConditionOfTypeMatcher) Match(actual interface{}) (bool, error) {
+	switch actual := actual.(type) {
+	case *v1alpha1.Subscription:
+		var conditionTypes []v1alpha1.SubscriptionConditionType
+		for _, condition := range actual.Status.Conditions {
+			conditionTypes = append(conditionTypes, condition.Type)
+		}
+		util.Logf("expecting subscription condition type '%s' to be in %s", s.Element, conditionTypes)
+		return s.ContainElementMatcher.Match(conditionTypes)
+	default:
+		return false, fmt.Errorf("actual %v is not a subscription", actual)
+	}
+}

Diff for: test/e2e/util/test_logging.go

@@ -0,0 +1,26 @@
+package util
+
+import (
+	"encoding/json"
+	"fmt"
+	"strings"
+
+	g "github.com/onsi/ginkgo/v2"
+)
+
+func Logf(f string, v ...interface{}) {
+	if !strings.HasSuffix(f, "\n") {
+		f += "\n"
+	}
+	_, _ = fmt.Fprintf(g.GinkgoWriter, f, v...)
+}
+
+func ObjectToPrettyJsonString(obj interface{}) string {
+	data, _ := json.MarshalIndent(obj, "", " ")
+	return string(data)
+}
+
+func ObjectToJsonString(obj interface{}) string {
+	data, _ := json.MarshalIndent(obj, "", " ")
+	return string(data)
+}