Update golden test framework

* Move to envtest by default (instead of mock-kubeapiserver)

* Create shared code for capturing requests / normalization.

* Use a more conventional env var WRITE_GOLDEN_OUTPUT

* Support object rewriting

Author: justinsb

dev/test

@@ -27,6 +27,9 @@ cd "${REPO_ROOT}"
 
 set -x
 
+# Download the kubebuilder assets for envtest
+export KUBEBUILDER_ASSETS=$(go run sigs.k8s.io/controller-runtime/tools/setup-envtest@latest use -p path)
+
 pushd mockkubeapiserver
 CGO_ENABLED=0 go test -count=1 -v ./...
 popd

docs/addon/walkthrough/tests.md

@@ -33,7 +33,7 @@ This means that the output is materialized and checked in to the repo; this
 proves to be very handy for understanding the impact of a change.
 
 There's also a helpful "cheat" function, which rewrite the output when you run
-the tests locally - set the HACK_AUTOFIX_EXPECTED_OUTPUT env var to a non-empty
+the tests locally - set the WRITE_GOLDEN_OUTPUT env var to a non-empty
 string.  This is useful when you have a big set of changes; it's just as easy to
 review the changes yourself in the diff and there's not a ton of value in typing
 them out.
@@ -87,7 +87,7 @@ the env-var cheat code.
    ```bash
    cd pkg/controller/{{operator}}/tests
    touch tests/simple.out.yaml
-   HACK_AUTOFIX_EXPECTED_OUTPUT=1 go test ./...
+   WRITE_GOLDEN_OUTPUT=1 go test ./...
    ```
 
 1. Verify the output is reproducible

examples/guestbook-operator/controllers/guestbook_controller_test.go

@@ -17,14 +17,28 @@ limitations under the License.
 package controllers
 
 import (
+	"path/filepath"
 	"testing"
 
+	"k8s.io/klog/v2/klogr"
+	"sigs.k8s.io/controller-runtime/pkg/envtest"
+	"sigs.k8s.io/controller-runtime/pkg/log"
 	api "sigs.k8s.io/kubebuilder-declarative-pattern/examples/guestbook-operator/api/v1alpha1"
 	"sigs.k8s.io/kubebuilder-declarative-pattern/pkg/test/golden"
 )
 
 func TestGuestbook(t *testing.T) {
-	v := golden.NewValidator(t, api.SchemeBuilder)
+	log.SetLogger(klogr.New())
+
+	env := &envtest.Environment{
+		CRDInstallOptions: envtest.CRDInstallOptions{
+			ErrorIfPathMissing: true,
+			Paths: []string{
+				filepath.Join("..", "config", "crd", "bases"),
+			},
+		},
+	}
+	v := golden.NewValidator(t, env, api.AddToScheme)
 	dr := &GuestbookReconciler{
 		Client: v.Client(),
 	}
@@ -33,5 +47,5 @@ func TestGuestbook(t *testing.T) {
 		t.Fatalf("creating reconciler: %v", err)
 	}
 
-	v.Validate(dr.Reconciler)
+	v.Validate(&dr.Reconciler, golden.ValidateOptions{})
 }

examples/guestbook-operator/controllers/tests/patches-stable.in.yaml

@@ -2,6 +2,7 @@ apiVersion: addons.example.org/v1alpha1
 kind: Guestbook
 metadata:
   name: guestbook-sample
+  namespace: default
 spec:
   channel: stable
   patches:

examples/guestbook-operator/controllers/tests/simple-stable.in.yaml

@@ -2,5 +2,6 @@ apiVersion: addons.example.org/v1alpha1
 kind: Guestbook
 metadata:
   name: guestbook-sample
+  namespace: default
 spec:
   channel: stable

examples/guestbook-operator/go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/go-logr/logr v1.4.2
 	k8s.io/apimachinery v0.31.1
 	k8s.io/client-go v0.31.1
+	k8s.io/klog/v2 v2.130.1
 	sigs.k8s.io/controller-runtime v0.19.0
 	sigs.k8s.io/kubebuilder-declarative-pattern v0.0.0-20210922163802-cac4a6cf1977
 )
@@ -104,14 +105,13 @@ require (
 	k8s.io/apiextensions-apiserver v0.31.1 // indirect
 	k8s.io/cli-runtime v0.29.1 // indirect
 	k8s.io/component-base v0.31.1 // indirect
-	k8s.io/klog/v2 v2.130.1 // indirect
 	k8s.io/kube-openapi v0.0.0-20240903163716-9e1beecbcb38 // indirect
 	k8s.io/kubectl v0.29.1 // indirect
 	k8s.io/utils v0.0.0-20240902221715-702e33fdd3c3 // indirect
 	sigs.k8s.io/cli-utils v0.33.0 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/kubebuilder-declarative-pattern/applylib v0.0.0-20230420203711-4abaa68e1923 // indirect
-	sigs.k8s.io/kubebuilder-declarative-pattern/mockkubeapiserver v0.0.0-20230303024857-d1f76c15e05b // indirect
+	sigs.k8s.io/kubebuilder-declarative-pattern/ktest v0.0.0-20240909164454-57a043fb3ad5 // indirect
 	sigs.k8s.io/kustomize/api v0.14.0 // indirect
 	sigs.k8s.io/kustomize/kstatus v0.0.2-0.20200509233124-065f70705d4d // indirect
 	sigs.k8s.io/kustomize/kyaml v0.14.3 // indirect

go.work.sum

@@ -430,6 +430,7 @@ golang.org/x/tools v0.21.1-0.20240508182429-e35e4ccd0d2d/go.mod h1:aiJjzUbINMkxb
 golang.org/x/tools v0.24.0/go.mod h1:YhNqVBIfWHdzvTLs0d8LCuMhkKUgSUKldakyV7W/WDQ=
 golang.org/x/xerrors v0.0.0-20220907171357-04be3eba64a2/go.mod h1:K8+ghG5WaK9qNqU5K3HdILfMLy1f3aNYFI/wnl100a8=
 google.golang.org/api v0.126.0/go.mod h1:mBwVAtz+87bEN6CbA1GtZPDOqY2R5ONPqJeIlvyo4Aw=
+google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
 google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc=
 google.golang.org/genproto v0.0.0-20200423170343-7949de9c1215/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=
 google.golang.org/genproto v0.0.0-20200513103714-09dca8ec2884/go.mod h1:55QSHmfGQM9UVYDPBsyGGes0y52j32PQ3BqQfXhyH3c=

ktest/go.mod

@@ -7,25 +7,53 @@ toolchain go1.23.5
 require (
 	github.com/google/go-cmp v0.6.0
 	k8s.io/apimachinery v0.31.1
+	k8s.io/client-go v0.31.1
 	k8s.io/klog/v2 v2.130.1
+	sigs.k8s.io/controller-runtime v0.19.0
+	sigs.k8s.io/kubebuilder-declarative-pattern/applylib v0.0.0-20250315190147-cfd0b42f94ef
 	sigs.k8s.io/yaml v1.4.0
 )
 
 require (
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
+	github.com/emicklei/go-restful/v3 v3.12.1 // indirect
+	github.com/evanphx/json-patch/v5 v5.9.0 // indirect
 	github.com/fxamacker/cbor/v2 v2.7.0 // indirect
 	github.com/go-logr/logr v1.4.2 // indirect
+	github.com/go-openapi/jsonpointer v0.21.0 // indirect
+	github.com/go-openapi/jsonreference v0.21.0 // indirect
+	github.com/go-openapi/swag v0.23.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/google/gnostic-models v0.6.8 // indirect
 	github.com/google/gofuzz v1.2.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/imdario/mergo v0.3.16 // indirect
+	github.com/josharian/intern v1.0.0 // indirect
 	github.com/json-iterator/go v1.1.12 // indirect
-	github.com/kr/text v0.2.0 // indirect
+	github.com/mailru/easyjson v0.7.7 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
+	github.com/prometheus/client_golang v1.20.4 // indirect
+	github.com/prometheus/common v0.59.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
 	golang.org/x/net v0.29.0 // indirect
+	golang.org/x/oauth2 v0.23.0 // indirect
+	golang.org/x/sys v0.25.0 // indirect
+	golang.org/x/term v0.24.0 // indirect
 	golang.org/x/text v0.18.0 // indirect
-	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	golang.org/x/time v0.6.0 // indirect
+	golang.org/x/tools v0.25.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	k8s.io/api v0.31.1 // indirect
+	k8s.io/apiextensions-apiserver v0.31.1 // indirect
+	k8s.io/kube-openapi v0.0.0-20240903163716-9e1beecbcb38 // indirect
 	k8s.io/utils v0.0.0-20240902221715-702e33fdd3c3 // indirect
 	sigs.k8s.io/json v0.0.0-20221116044647-bc3834ca7abd // indirect
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.1 // indirect