Merge pull request #7218 from killianmuldoon/test/use-upstream-matchers

k8s-ci-robot · web-flow · commit df3f6e8181ee · 2022-09-15T07:13:25.000-07:00
🌱  Replace CAPI Matcher with Controller Runtime implementation
diff --git a/docs/book/src/developer/testing.md b/docs/book/src/developer/testing.md
@@ -74,7 +74,7 @@ easily readable, well documented and consistent across the code base.
 In light of continuing improving our practice around this ambitious goal, we are starting to introduce a shared set of:
 
 - Builders (`sigs.k8s.io/cluster-api/internal/test/builder`), allowing to create test objects in a simple and consistent way.
-- Matchers (`sigs.k8s.io/cluster-api/internal/test/matchers`), improving how we write test assertions.
+- Matchers (`sigs.k8s.io/controller-runtime/pkg/envtest/komega`), improving how we write test assertions.
 
 Each contribution in growing this set of utilities or their adoption across the codebase is more than welcome!
 
diff --git a/internal/controllers/machine/machine_controller_test.go b/internal/controllers/machine/machine_controller_test.go
@@ -2058,7 +2058,7 @@ func addConditionsToExternal(u *unstructured.Unstructured, newConditions cluster
 }
 
 // asserts the conditions set on the Getter object.
-// TODO: replace this with util.condition.MatchConditions (or a new matcher in internal/matchers).
+// TODO: replace this with util.condition.MatchConditions (or a new matcher in controller runtime komega).
 func assertConditions(t *testing.T, from conditions.Getter, conditions ...*clusterv1.Condition) {
 	t.Helper()
 
diff --git a/internal/controllers/machinedeployment/machinedeployment_sync_test.go b/internal/controllers/machinedeployment/machinedeployment_sync_test.go
@@ -496,7 +496,7 @@ func TestSyncDeploymentStatus(t *testing.T) {
 }
 
 // asserts the conditions set on the Getter object.
-// TODO: replace this with util.condition.MatchConditions (or a new matcher in internal/matchers).
+// TODO: replace this with util.condition.MatchConditions (or a new matcher in controller runtime komega).
 func assertConditions(t *testing.T, from conditions.Getter, conditions ...*clusterv1.Condition) {
 	t.Helper()
 
diff --git a/internal/controllers/topology/cluster/blueprint_test.go b/internal/controllers/topology/cluster/blueprint_test.go
@@ -25,11 +25,11 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/internal/controllers/topology/cluster/scope"
 	"sigs.k8s.io/cluster-api/internal/test/builder"
-	. "sigs.k8s.io/cluster-api/internal/test/matchers"
 )
 
 func TestGetBlueprint(t *testing.T) {
diff --git a/internal/controllers/topology/cluster/current_state_test.go b/internal/controllers/topology/cluster/current_state_test.go
@@ -26,11 +26,11 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	"sigs.k8s.io/cluster-api/internal/controllers/topology/cluster/scope"
 	"sigs.k8s.io/cluster-api/internal/test/builder"
-	. "sigs.k8s.io/cluster-api/internal/test/matchers"
 )
 
 func TestGetCurrentState(t *testing.T) {
diff --git a/internal/controllers/topology/cluster/patches/engine_test.go b/internal/controllers/topology/cluster/patches/engine_test.go
@@ -30,6 +30,7 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	utilfeature "k8s.io/component-base/featuregate/testing"
 	"k8s.io/utils/pointer"
+	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	runtimecatalog "sigs.k8s.io/cluster-api/exp/runtime/catalog"
@@ -38,7 +39,6 @@ import (
 	"sigs.k8s.io/cluster-api/internal/controllers/topology/cluster/scope"
 	fakeruntimeclient "sigs.k8s.io/cluster-api/internal/runtime/client/fake"
 	"sigs.k8s.io/cluster-api/internal/test/builder"
-	. "sigs.k8s.io/cluster-api/internal/test/matchers"
 )
 
 func TestApply(t *testing.T) {
diff --git a/internal/controllers/topology/cluster/reconcile_state_test.go b/internal/controllers/topology/cluster/reconcile_state_test.go
@@ -35,6 +35,7 @@ import (
 	"k8s.io/utils/pointer"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 
 	clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"
 	runtimev1 "sigs.k8s.io/cluster-api/exp/runtime/api/v1alpha1"
@@ -46,12 +47,11 @@ import (
 	"sigs.k8s.io/cluster-api/internal/hooks"
 	fakeruntimeclient "sigs.k8s.io/cluster-api/internal/runtime/client/fake"
 	"sigs.k8s.io/cluster-api/internal/test/builder"
-	. "sigs.k8s.io/cluster-api/internal/test/matchers"
 )
 
 var (
 	IgnoreNameGenerated = IgnorePaths{
-		{"metadata", "name"},
+		"metadata.name",
 	}
 )
 
@@ -1580,7 +1580,7 @@ func TestReconcileControlPlaneMachineHealthCheck(t *testing.T) {
 			}
 
 			g.Expect(err).ToNot(HaveOccurred())
-			g.Expect(gotMHC).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{{"kind"}, {"apiVersion"}}))
+			g.Expect(gotMHC).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{".kind", ".apiVersion"}))
 		})
 	}
 }
@@ -2718,7 +2718,7 @@ func TestReconciler_reconcileMachineHealthCheck(t *testing.T) {
 				}
 			}
 
-			g.Expect(got).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{{"kind"}, {"apiVersion"}}))
+			g.Expect(got).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{".kind", ".apiVersion"}))
 		})
 	}
 }
diff --git a/internal/controllers/topology/cluster/util_test.go b/internal/controllers/topology/cluster/util_test.go
@@ -25,10 +25,10 @@ import (
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/client/fake"
+	. "sigs.k8s.io/controller-runtime/pkg/envtest/komega"
 
 	"sigs.k8s.io/cluster-api/internal/contract"
 	"sigs.k8s.io/cluster-api/internal/test/builder"
-	. "sigs.k8s.io/cluster-api/internal/test/matchers"
 )
 
 func TestGetReference(t *testing.T) {
diff --git a/internal/test/matchers/doc.go b/internal/test/matchers/doc.go
diff --git a/internal/test/matchers/matchers.go b/internal/test/matchers/matchers.go
diff --git a/internal/test/matchers/matchers_test.go b/internal/test/matchers/matchers_test.go
diff --git a/test/extension/handlers/topologymutation/handler_test.go b/test/extension/handlers/topologymutation/handler_test.go

Original file line number	Diff line number	Diff line change
`@@ -2058,7 +2058,7 @@ func addConditionsToExternal(u *unstructured.Unstructured, newConditions cluster`
`2058`	`2058`	`}`
`2059`	`2059`
`2060`	`2060`	`// asserts the conditions set on the Getter object.`
`2061`		`-// TODO: replace this with util.condition.MatchConditions (or a new matcher in internal/matchers).`
	`2061`	`+// TODO: replace this with util.condition.MatchConditions (or a new matcher in controller runtime komega).`
`2062`	`2062`	`func assertConditions(t testing.T, from conditions.Getter, conditions ...clusterv1.Condition) {`
`2063`	`2063`	`t.Helper()`
`2064`	`2064`
Original file line number	Diff line number	Diff line change
`@@ -496,7 +496,7 @@ func TestSyncDeploymentStatus(t *testing.T) {`
`496`	`496`	`}`
`497`	`497`
`498`	`498`	`// asserts the conditions set on the Getter object.`
`499`		`-// TODO: replace this with util.condition.MatchConditions (or a new matcher in internal/matchers).`
	`499`	`+// TODO: replace this with util.condition.MatchConditions (or a new matcher in controller runtime komega).`
`500`	`500`	`func assertConditions(t testing.T, from conditions.Getter, conditions ...clusterv1.Condition) {`
`501`	`501`	`t.Helper()`
`502`	`502`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ import (`
`35`	`35`	`"k8s.io/utils/pointer"`
`36`	`36`	`"sigs.k8s.io/controller-runtime/pkg/client"`
`37`	`37`	`"sigs.k8s.io/controller-runtime/pkg/client/fake"`
	`38`	`+ . "sigs.k8s.io/controller-runtime/pkg/envtest/komega"`
`38`	`39`
`39`	`40`	`clusterv1 "sigs.k8s.io/cluster-api/api/v1beta1"`
`40`	`41`	`runtimev1 "sigs.k8s.io/cluster-api/exp/runtime/api/v1alpha1"`
`@@ -46,12 +47,11 @@ import (`
`46`	`47`	`"sigs.k8s.io/cluster-api/internal/hooks"`
`47`	`48`	`fakeruntimeclient "sigs.k8s.io/cluster-api/internal/runtime/client/fake"`
`48`	`49`	`"sigs.k8s.io/cluster-api/internal/test/builder"`
`49`		`- . "sigs.k8s.io/cluster-api/internal/test/matchers"`
`50`	`50`	`)`
`51`	`51`
`52`	`52`	`var (`
`53`	`53`	`IgnoreNameGenerated = IgnorePaths{`
`54`		`- {"metadata", "name"},`
	`54`	`+ "metadata.name",`
`55`	`55`	`}`
`56`	`56`	`)`
`57`	`57`
`@@ -1580,7 +1580,7 @@ func TestReconcileControlPlaneMachineHealthCheck(t *testing.T) {`
`1580`	`1580`	`}`
`1581`	`1581`
`1582`	`1582`	`g.Expect(err).ToNot(HaveOccurred())`
`1583`		`- g.Expect(gotMHC).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{{"kind"}, {"apiVersion"}}))`
	`1583`	`+ g.Expect(gotMHC).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{".kind", ".apiVersion"}))`
`1584`	`1584`	`})`
`1585`	`1585`	`}`
`1586`	`1586`	`}`
`@@ -2718,7 +2718,7 @@ func TestReconciler_reconcileMachineHealthCheck(t *testing.T) {`
`2718`	`2718`	`}`
`2719`	`2719`	`}`
`2720`	`2720`
`2721`		`- g.Expect(got).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{{"kind"}, {"apiVersion"}}))`
	`2721`	`+ g.Expect(got).To(EqualObject(tt.want, IgnoreAutogeneratedMetadata, IgnorePaths{".kind", ".apiVersion"}))`
`2722`	`2722`	`})`
`2723`	`2723`	`}`
`2724`	`2724`	`}`