Merge pull request #71 from numtide/introduce-envtestutil

Add envtest utility package as a separate module

Author: rytswd

Makefile

@@ -5,25 +5,29 @@
 # Each module must be tagged with its directory path prefix for Go module resolution
 # Example tags: v0.1.0 (root), api/v0.1.0, pkg/cluster-handler/v0.1.0, etc.
 #
+# Auto-discovered modules: finds all directories with go.mod files
 # Can be overridden: MODULES="./api ./pkg/resource-handler" make test
-#                or: MODULES="$(make changed-modules)" make test
-MODULES ?= . ./api ./pkg/cluster-handler ./pkg/data-handler ./pkg/resource-handler
+#                or: MODULES="$(shell make changed-modules)" make test
+MODULES ?= $(shell find . -name go.mod -exec dirname {} \; | sort)
 
 # Detect changed modules compared to origin/main
 # Usage: make test MODULES="$(shell make changed-modules)"
 .PHONY: changed-modules
 changed-modules:
-	@if git rev-parse --verify origin/main >/dev/null 2>&1; then \
+	@changed_files=$$(if git rev-parse --verify origin/main >/dev/null 2>&1; then \
 		git diff --name-only origin/main...HEAD 2>/dev/null; \
 	else \
 		git diff --name-only HEAD 2>/dev/null; \
-	fi | awk -F/ '{ \
-		if ($$1 == "api") print "./api"; \
-		else if ($$1 == "pkg" && $$2 == "cluster-handler") print "./pkg/cluster-handler"; \
-		else if ($$1 == "pkg" && $$2 == "data-handler") print "./pkg/data-handler"; \
-		else if ($$1 == "pkg" && $$2 == "resource-handler") print "./pkg/resource-handler"; \
-		else if ($$1 == "cmd" || $$1 == "main.go" || $$1 == "Dockerfile") print "."; \
-	}' | sort -u | tr '\n' ' ' || echo "$(MODULES)"
+	fi); \
+	modules=$$(find . -name go.mod -exec dirname {} \;); \
+	for mod in $$modules; do \
+		modpath=$${mod#./}; \
+		if [ "$$mod" = "." ]; then \
+			echo "$$changed_files" | grep -qE '^[^/]+\.(go|mod|sum)$$|^(cmd|internal)/' && echo "$$mod"; \
+		elif echo "$$changed_files" | grep -q "^$$modpath/"; then \
+			echo "$$mod"; \
+		fi; \
+	done 2>/dev/null | sort -u | tr '\n' ' '
 
 # Version from git tags (for root module - operator binary)
 # Root module uses tags like v0.1.0 (without prefix)
@@ -281,7 +285,7 @@ test-integration: manifests generate fmt vet setup-envtest ## Run integration te
 		echo "==> Integration testing $$mod..."; \
 		(cd $$mod && \
 			KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" \
-			GOWORK=off go test -tags=integration $$(go list ./... | grep -v /e2e) -coverprofile=cover.out) || exit 1; \
+			GOWORK=off go test -tags=integration,verbose $$(go list ./... | grep -v /e2e) -coverprofile=cover.out) || exit 1; \
 	done
 
 .PHONY: test-coverage
@@ -295,7 +299,7 @@ test-coverage: manifests generate fmt vet setup-envtest ## Generate coverage rep
 		echo "==> Coverage for $$mod..."; \
 		(cd $$mod && \
 			KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" \
-			GOWORK=off go test -tags=integration ./... -coverprofile=$$project_root/coverage/$$modname.out -covermode=atomic && \
+			GOWORK=off go test -tags=integration,verbose ./... -coverprofile=$$project_root/coverage/$$modname.out -covermode=atomic && \
 			GOWORK=off go tool cover -html=$$project_root/coverage/$$modname.out -o=$$project_root/coverage/$$modname.html) || exit 1; \
 		echo "Generated: coverage/$$modname.html"; \
 	done

pkg/testutil/compare.go

@@ -0,0 +1,227 @@
+package testutil
+
+import (
+	"time"
+
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp/cmpopts"
+	appsv1 "k8s.io/api/apps/v1"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
+
+// IgnoreMetaRuntimeFields returns cmp.Options that ignore runtime-generated
+// Kubernetes fields. Use this when comparing expected vs actual Kubernetes
+// resources in tests.
+func IgnoreMetaRuntimeFields() cmp.Options {
+	return cmp.Options{
+		// Ignore ObjectMeta fields that are set by the API server
+		cmpopts.IgnoreFields(metav1.ObjectMeta{},
+			"UID",               // Generated by API server
+			"ResourceVersion",   // Changes on every update
+			"Generation",        // Auto-incremented
+			"CreationTimestamp", // Set at creation time
+			"DeletionTimestamp", // Set when deletion starts
+			"DeletionGracePeriodSeconds",
+			"ManagedFields", // Server-side apply tracking
+			"SelfLink",      // Deprecated but may exist
+		),
+
+		// Ignore TypeMeta fields (often empty in client responses)
+		// NOTE: This is commented out as this has no impact in most cases.
+		// Consider removing this altogether.
+		// cmpopts.IgnoreFields(metav1.TypeMeta{},
+		// 	"Kind",
+		// 	"APIVersion",
+		// ),
+
+		// Ignore Status subresource (tested separately)
+		cmpopts.IgnoreFields(metav1.Condition{},
+			"LastTransitionTime", // Time-based, always different
+		),
+
+		// Ignore time.Time fields (always different)
+		cmpopts.IgnoreTypes(time.Time{}),
+		cmpopts.IgnoreTypes(metav1.Time{}),
+
+		// Ignore UID type
+		cmpopts.IgnoreTypes(types.UID("")),
+	}
+}
+
+// IgnoreServiceRuntimeFields ignores Service fields that are assigned at
+// runtime by Kubernetes.
+func IgnoreServiceRuntimeFields() cmp.Option {
+	return cmpopts.IgnoreFields(corev1.ServiceSpec{},
+		// Randomly allocated by Kubernetes from service CIDR range
+		"ClusterIP",
+		"ClusterIPs",
+
+		// Derived from cluster IP stack configuration (IPv4, IPv6, or dual-stack)
+		"IPFamilies",
+		"IPFamilyPolicy",
+
+		// Default policy set based on cluster configuration
+		"InternalTrafficPolicy",
+
+		// Defaults to "None"
+		"SessionAffinity",
+	)
+}
+
+// IgnoreStatefulSetRuntimeFields ignores StatefulSet status fields that are
+// updated at runtime by the StatefulSet controller.
+func IgnoreStatefulSetRuntimeFields() cmp.Option {
+	return cmpopts.IgnoreFields(appsv1.StatefulSetStatus{},
+		// Replica state counters (updated by controller based on pod status)
+		"Replicas",
+		"ReadyReplicas",
+		"CurrentReplicas",
+		"UpdatedReplicas",
+		"AvailableReplicas",
+
+		// Revision tracking (generated hashes by controller for rolling updates)
+		"CurrentRevision",
+		"UpdateRevision",
+
+		// Controller reconciliation metadata
+		"ObservedGeneration", // Tracks which spec generation was reconciled
+		"CollisionCount",     // Counter for name collision avoidance
+		"Conditions",         // Status conditions updated by controller
+	)
+}
+
+// IgnoreDeploymentRuntimeFields ignores Deployment status fields that are
+// updated at runtime by the Deployment controller.
+func IgnoreDeploymentRuntimeFields() cmp.Option {
+	return cmpopts.IgnoreFields(appsv1.DeploymentStatus{},
+		// Replica state counters (updated by controller based on ReplicaSet status)
+		"Replicas",
+		"ReadyReplicas",
+		"AvailableReplicas",
+		"UnavailableReplicas",
+		"UpdatedReplicas",
+
+		// Controller reconciliation metadata
+		"ObservedGeneration", // Tracks which spec generation was reconciled
+		"CollisionCount",     // Counter for ReplicaSet name collision avoidance
+		"Conditions",         // Status conditions updated by controller
+	)
+}
+
+// IgnorePodSpecDefaults ignores all PodSpec and Container defaults applied by
+// Kubernetes, including ImagePullPolicy. Use when you only care about
+// explicitly set fields.
+func IgnorePodSpecDefaults() cmp.Option {
+	return cmp.Options{
+		cmpopts.IgnoreFields(corev1.PodSpec{},
+			// Pod lifecycle defaults
+			"RestartPolicy",                 // Defaults to "Always"
+			"TerminationGracePeriodSeconds", // Defaults to 30
+			"DNSPolicy",                     // Defaults to "ClusterFirst"
+			"SchedulerName",                 // Defaults to "default-scheduler"
+			"SecurityContext",               // Default PodSecurityContext applied
+		),
+		cmpopts.IgnoreFields(corev1.Container{},
+			// Container defaults
+			"TerminationMessagePath",   // Defaults to "/dev/termination-log"
+			"TerminationMessagePolicy", // Defaults to "File"
+			"ImagePullPolicy",          // Defaults: Always for :latest, IfNotPresent otherwise
+		),
+	}
+}
+
+// IgnorePodSpecDefaultsExceptPullPolicy ignores PodSpec defaults but preserves
+// ImagePullPolicy for verification. Use when you want to assert ImagePullPolicy
+// is correct.
+func IgnorePodSpecDefaultsExceptPullPolicy() cmp.Option {
+	return cmp.Options{
+		cmpopts.IgnoreFields(corev1.PodSpec{},
+			// Pod lifecycle defaults
+			"RestartPolicy",                 // Defaults to "Always"
+			"TerminationGracePeriodSeconds", // Defaults to 30
+			"DNSPolicy",                     // Defaults to "ClusterFirst"
+			"SchedulerName",                 // Defaults to "default-scheduler"
+			"SecurityContext",               // Default PodSecurityContext applied
+		),
+		cmpopts.IgnoreFields(corev1.Container{},
+			// Container termination logging
+			"TerminationMessagePath",   // Defaults to "/dev/termination-log"
+			"TerminationMessagePolicy", // Defaults to "File"
+			// Note: ImagePullPolicy NOT ignored - preserved for assertions
+		),
+	}
+}
+
+// IgnoreStatefulSetSpecDefaults ignores StatefulSetSpec fields that have
+// Kubernetes defaults applied.
+func IgnoreStatefulSetSpecDefaults() cmp.Option {
+	return cmpopts.IgnoreFields(appsv1.StatefulSetSpec{},
+		// StatefulSet-specific defaults
+		"PodManagementPolicy",                  // Defaults to "OrderedReady"
+		"RevisionHistoryLimit",                 // Defaults to 10
+		"UpdateStrategy",                       // Defaults to RollingUpdate with partition=0
+		"PersistentVolumeClaimRetentionPolicy", // Defaults to Retain/Retain
+	)
+}
+
+// IgnoreDeploymentSpecDefaults ignores DeploymentSpec fields that have
+// Kubernetes defaults applied.
+func IgnoreDeploymentSpecDefaults() cmp.Option {
+	return cmpopts.IgnoreFields(
+		appsv1.DeploymentSpec{},
+		// Deployment-specific defaults
+		"Strategy",                // Defaults to RollingUpdate with MaxSurge=25%, MaxUnavailable=25%
+		"RevisionHistoryLimit",    // Defaults to 10
+		"ProgressDeadlineSeconds", // Defaults to 600 seconds (10 minutes)
+	)
+}
+
+// filterByFieldName returns a filter function that checks if the last path element
+// is a struct field with the given name. Extracted for testability.
+func filterByFieldName(fieldName string) func(cmp.Path) bool {
+	return func(p cmp.Path) bool {
+		// Check if the current path step is a struct field with the target name
+		if len(p) == 0 {
+			return false
+		}
+		if sf, ok := p[len(p)-1].(cmp.StructField); ok {
+			return sf.Name() == fieldName
+		}
+		return false
+	}
+}
+
+// IgnoreObjectMetaCompletely ignores the entire ObjectMeta (use when you only
+// care about Spec).
+// Uses a filter function to match any struct field named "ObjectMeta".
+func IgnoreObjectMetaCompletely() cmp.Option {
+	return cmp.FilterPath(filterByFieldName("ObjectMeta"), cmp.Ignore())
+}
+
+// IgnoreStatus ignores the Status subresource completely.
+//
+// Because cmpopts.IgnoreFields requires the first param to be an actual struct
+// type, this uses a filter function to match any struct field named "Status".
+func IgnoreStatus() cmp.Option {
+	return cmp.FilterPath(filterByFieldName("Status"), cmp.Ignore())
+}
+
+// CompareOptions returns common options for comparing Kubernetes objects.
+// By default, ignores metadata and status.
+func CompareOptions() cmp.Options {
+	return cmp.Options{
+		IgnoreMetaRuntimeFields(),
+		IgnoreStatus(),
+	}
+}
+
+// CompareSpecOnly returns options for comparing only Spec fields.
+// Ignores all metadata and status.
+func CompareSpecOnly() cmp.Options {
+	return cmp.Options{
+		IgnoreObjectMetaCompletely(),
+		IgnoreStatus(),
+	}
+}

pkg/testutil/compare_internal_test.go

@@ -0,0 +1,70 @@
+package testutil
+
+import (
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+	corev1 "k8s.io/api/core/v1"
+)
+
+// TestFilterByFieldName tests the filter function directly.
+func TestFilterByFieldName(t *testing.T) {
+	t.Parallel()
+	tests := map[string]struct {
+		fieldName string
+		path      cmp.Path
+		want      bool
+	}{
+		"Status - empty path": {
+			fieldName: "Status",
+			path:      cmp.Path{},
+			want:      false,
+		},
+		"ObjectMeta - empty path": {
+			fieldName: "ObjectMeta",
+			path:      cmp.Path{},
+			want:      false,
+		},
+	}
+
+	for name, tc := range tests {
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+			filter := filterByFieldName(tc.fieldName)
+			got := filter(tc.path)
+			if got != tc.want {
+				t.Errorf(
+					"filterByFieldName(%s) with empty path = %v, want %v",
+					tc.fieldName,
+					got,
+					tc.want,
+				)
+			}
+		})
+	}
+}
+
+// TestFilterByFieldName_Integration verifies it works with real Service objects.
+func TestFilterByFieldName_Integration(t *testing.T) {
+	t.Parallel()
+	svc1 := &corev1.Service{
+		Status: corev1.ServiceStatus{
+			LoadBalancer: corev1.LoadBalancerStatus{
+				Ingress: []corev1.LoadBalancerIngress{{IP: "1.2.3.4"}},
+			},
+		},
+	}
+	svc2 := &corev1.Service{
+		Status: corev1.ServiceStatus{
+			LoadBalancer: corev1.LoadBalancerStatus{
+				Ingress: []corev1.LoadBalancerIngress{{IP: "5.6.7.8"}},
+			},
+		},
+	}
+
+	// Should match when ignoring Status
+	diff := cmp.Diff(svc1, svc2, IgnoreStatus())
+	if diff != "" {
+		t.Errorf("Services should match when ignoring Status, but found diff:\n%s", diff)
+	}
+}