scaffold: add support for envtest

Author: cbarbian-sap

scaffold/scaffold.go

@@ -51,6 +51,7 @@ type Config struct {
 	KubernetesVersion              string `json:"kubernetesVersion,omitempty"`
 	ControllerRuntimeVersion       string `json:"controllerRuntimeVersion,omitempty"`
 	AdmissionWebhookRuntimeVersion string `json:"admissionWebhookRuntimeVersion,omitempty"`
+	EnvtestKubernetesVersion       string `json:"envtestKubernetesVersion,omitempty"`
 	Image                          string `json:"image,omitempty"`
 }
 
@@ -81,6 +82,7 @@ var (
 	kubernetesVersion              = "v0.27.2"
 	controllerRuntimeVersion       = "v0.15.0"
 	admissionWebhookRuntimeVersion = "v0.1.0"
+	envtestKubernetesVersion       = "1.26.1"
 )
 
 func main() {
@@ -105,6 +107,7 @@ func main() {
 	pflag.StringVar(&config.KubernetesVersion, "kubernetes-version", kubernetesVersion, "Kubernetes go-client version to be used")
 	pflag.StringVar(&config.ControllerRuntimeVersion, "controller-runtime-version", controllerRuntimeVersion, "Controller-runtime version to be used")
 	pflag.StringVar(&config.AdmissionWebhookRuntimeVersion, "admission-webhook-runtime-version", admissionWebhookRuntimeVersion, "Admission-webhook-runtime version to be used")
+	pflag.StringVar(&config.EnvtestKubernetesVersion, "envtest-kubernetes-version", envtestKubernetesVersion, "Kubernetes version to be used by envtest")
 	pflag.StringVar(&config.Image, "image", "controller:latest", "Name of the Docker/OCI image produced by this project")
 	pflag.BoolVar(&skipPostProcessing, "skip-post-processing", false, "Skip post-processing")
 	pflag.CommandLine.SortFlags = false

scaffold/templates/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "go.testEnvVars": {
+      "KUBEBUILDER_ASSETS": "${workspaceFolder}/bin/k8s/current"
+    }
+}

scaffold/templates/Dockerfile.tpl

@@ -15,20 +15,21 @@ RUN go mod download
 COPY main.go main.go
 COPY api/ api/
 COPY pkg/ pkg/
+COPY hack/ hack/
+COPY Makefile Makefile
 
 # Build
 # the GOARCH has not a default value to allow the binary be built according to the host where the command
 # was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
 # the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
 # by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
-RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager main.go
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} make test build
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details
 FROM gcr.io/distroless/static:nonroot
 WORKDIR /
-COPY --from=builder /workspace/manager .
+COPY --from=builder /workspace/bin/manager .
 USER 65532:65532
 
 ENTRYPOINT ["/manager"]
-

scaffold/templates/Makefile.tpl

@@ -1,5 +1,7 @@
 # Image URL to use all building/pushing image targets
 IMG ?= {{ .image }}
+# K8s version used by envtest
+ENVTEST_K8S_VERSION = {{ .envtestKubernetesVersion }}
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -51,6 +53,12 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
+##@ Testing
+
+.PHONY: test
+test: manifests generate fmt vet envtest ## Run tests.
+	KUBEBUILDER_ASSETS="$(LOCALBIN)/k8s/current" go test ./... -coverprofile cover.out
+
 ##@ Build
 
 .PHONY: build
@@ -74,7 +82,7 @@ docker-push: ## Push docker image with the manager.
 # Build and push docker image for all given platforms.
 PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
 .PHONY: docker-buildx
-docker-buildx: ## Build and push docker image for the manager for cross-platform support
+docker-buildx: ## Build and push docker image for the manager for cross-platform support.
 	# copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile
 	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross
 	- docker buildx create --name project-v3-builder
@@ -92,11 +100,24 @@ $(LOCALBIN):
 
 ## Tool Binaries
 CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
+SETUP_ENVTEST ?= $(LOCALBIN)/setup-envtest
 
 ## Tool Versions
 CONTROLLER_TOOLS_VERSION ?= v0.9.2
+SETUP_ENVTEST_VERSION ?= latest
 
 .PHONY: controller-gen
 controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
 $(CONTROLLER_GEN): $(LOCALBIN)
 	test -s $(LOCALBIN)/controller-gen || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
+
+.PHONY: setup-envtest
+setup-envtest: $(SETUP_ENVTEST) ## Download setup-envtest locally if necessary.
+$(SETUP_ENVTEST): $(LOCALBIN)
+	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@$(SETUP_ENVTEST_VERSION)
+
+.PHONY: envtest
+envtest: setup-envtest
+	ENVTESTDIR=$$($(SETUP_ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path) ;\
+	rm -f $(LOCALBIN)/k8s/current ;\
+	ln -s $$ENVTESTDIR $(LOCALBIN)/k8s/current