Prefactor: extract matchers.BeFunc

Author: timebertt

pkg/sharding/key/key_test.go

@@ -17,18 +17,15 @@ limitations under the License.
 package key_test
 
 import (
-	"reflect"
-
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
-	"github.com/onsi/gomega/gcustom"
-	gomegatypes "github.com/onsi/gomega/types"
 	appsv1 "k8s.io/api/apps/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/utils/ptr"
 
 	shardingv1alpha1 "github.com/timebertt/kubernetes-controller-sharding/pkg/apis/sharding/v1alpha1"
 	. "github.com/timebertt/kubernetes-controller-sharding/pkg/sharding/key"
+	. "github.com/timebertt/kubernetes-controller-sharding/pkg/utils/test/matchers"
 )
 
 var _ = Describe("#FuncForResource", func() {
@@ -76,7 +73,7 @@ var _ = Describe("#FuncForResource", func() {
 			Group:    "operator",
 			Resource: "foo",
 		}, controllerRing)).To(
-			beFunc(ForObject),
+			BeFunc(ForObject),
 		)
 	})
 
@@ -85,15 +82,15 @@ var _ = Describe("#FuncForResource", func() {
 			Group:    "operator",
 			Resource: "controlled",
 		}, controllerRing)).To(
-			beFunc(ForController),
+			BeFunc(ForController),
 		)
 	})
 
 	It("should return ForObject if the resource is a main and controlled resource of the ring", func() {
 		Expect(FuncForResource(metav1.GroupResource{
 			Resource: "foo",
 		}, controllerRing)).To(
-			beFunc(ForObject),
+			BeFunc(ForObject),
 		)
 	})
 })
@@ -177,9 +174,3 @@ var _ = Describe("#ForController", func() {
 		Expect(ForController(obj)).To(Equal("operator/Foo/bar/foo"))
 	})
 })
-
-func beFunc(expected Func) gomegatypes.GomegaMatcher {
-	return gcustom.MakeMatcher(func(actual Func) (bool, error) {
-		return reflect.ValueOf(expected).Pointer() == reflect.ValueOf(actual).Pointer(), nil
-	})
-}

pkg/utils/test/matchers/matchers.go

@@ -17,6 +17,10 @@ limitations under the License.
 package matchers
 
 import (
+	"fmt"
+	"reflect"
+
+	"github.com/onsi/gomega/gcustom"
 	gomegatypes "github.com/onsi/gomega/types"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 )
@@ -28,3 +32,22 @@ func BeNotFoundError() gomegatypes.GomegaMatcher {
 		message: "NotFound",
 	}
 }
+
+// BeFunc is a matcher that returns true if expected and actual are the same func.
+func BeFunc(expected any) gomegatypes.GomegaMatcher {
+	return gcustom.MakeMatcher(func(actual any) (bool, error) {
+		var (
+			valueExpected = reflect.ValueOf(expected)
+			valueActual   = reflect.ValueOf(actual)
+		)
+
+		if valueExpected.Kind() != reflect.Func {
+			return false, fmt.Errorf("expected should be a func, got %v", valueExpected.Kind())
+		}
+		if valueActual.Kind() != reflect.Func {
+			return false, fmt.Errorf("actual should be a func, got %v", valueActual.Kind())
+		}
+
+		return valueExpected.Pointer() == valueActual.Pointer(), nil
+	})
+}