chore: restructure Makefile

maximiliantech · maximiliantech · commit c740a6df90ed · 2025-06-05T16:03:07.000+02:00
diff --git a/Makefile b/Makefile
@@ -30,7 +30,6 @@ SHELL = /usr/bin/env bash -o pipefail
 all: build
 
 ##@ General
-
 # The help target prints out all targets with their descriptions organized
 # beneath their categories. The categories are represented by '##@' and the
 # target descriptions by '##'. The awk commands is responsible for reading the
@@ -44,10 +43,72 @@ all: build
 
 .PHONY: help
 help: ## Display this help.
-	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-25s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
+
+#----------------------------------------------------------------------------------------------
+##@ Build Dependencies
+
+## Location to install dependencies to
+LOCALBIN ?= $(shell pwd)/bin
+$(LOCALBIN):
+	mkdir -p $(LOCALBIN)
+
+## Tool Binaries
+KUBECTL ?= kubectl
+KIND ?= kind # fix this to use tools
+KUSTOMIZE ?= $(LOCALBIN)/kustomize
+CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
+ENVTEST ?= $(LOCALBIN)/setup-envtest
+GOTESTSUM ?= $(LOCALBIN)/gotestsum
+GOLANGCILINT ?= $(LOCALBIN)/golangci-lint
+
+
+
+## Tool Versions
+KUSTOMIZE_VERSION ?= v5.4.1
+CONTROLLER_TOOLS_VERSION ?= v0.17.2
+GOLANGCILINT_VERSION ?= v2.0.2
+
+.PHONY: kustomize
+kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
+$(KUSTOMIZE): $(LOCALBIN)
+	@if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version | grep -q $(KUSTOMIZE_VERSION); then \
+		echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \
+		rm -rf $(LOCALBIN)/kustomize; \
+	fi
+	test -s $(LOCALBIN)/kustomize || GOBIN=$(LOCALBIN) GO111MODULE=on go install sigs.k8s.io/kustomize/kustomize/v5@$(KUSTOMIZE_VERSION)
 
-##@ Development
+.PHONY: controller-gen
+controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
+$(CONTROLLER_GEN): $(LOCALBIN)
+	test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION) || \
+	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
 
+.PHONY: envtest
+envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
+$(ENVTEST): $(LOCALBIN)
+	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
+
+.PHONY: envtest-bins
+envtest-bins: envtest ## Download envtest binaries
+	$(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN)
+
+.PHONY: gotestsum
+gotestsum: $(GOTESTSUM) ## Download gotestsum locally if necessary.
+$(GOTESTSUM): $(LOCALBIN)
+	test -s $(LOCALBIN)/gotestsum || GOBIN=$(LOCALBIN) go install gotest.tools/gotestsum@latest
+
+.PHONY: lint
+lint: $(GOLANGCILINT) ## Run golangci-lint against code.
+	$(GOLANGCILINT) config verify
+	$(GOLANGCILINT) run ./...
+
+.PHONY: lint-fix
+lint-fix: ## Run golangci-lint with --fix option to automatically fix issues.
+	$(GOLANGCILINT) run --fix
+
+#----------------------------------------------------------------------------------------------
+##@ Code Generation & Formatting
 .PHONY: manifests
 manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
 	$(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases
@@ -65,28 +126,16 @@ fmt: ## Run go fmt against code.
 vet: ## Run go vet against code.
 	go vet ./...
 
-.PHONY: test
-test: manifests generate fmt vet envtest ## Run tests.
-	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
-
+#----------------------------------------------------------------------------------------------
 ##@ Build
-
 .PHONY: build
 build: manifests generate fmt vet ## Build manager binary.
 	go build -o bin/manager cmd/main.go
 
-.PHONY: run
-run: manifests generate fmt vet ## Run a controller from your host.
-	OPERATOR_CONFIG_NAMESPACE=metrics-operator-system go run ./cmd/main.go start
-
 .PHONY: build-docker-binary
-build-docker-binary: manifests generate fmt vet ## Build manager binary.
+build-docker-binary: manifests generate fmt vet ## Build manager binary for Docker image.
 	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o bin/manager-linux.amd64 cmd/main.go
 
-
-# If you wish built the manager image targeting other platforms you can use the --platform flag.
-# (i.e. docker build --platform linux/arm64 ). However, you must enable docker buildKit for it.
-# More info: https://docs.docker.com/develop/develop-images/build_enhancements/
 .PHONY: docker-build
 docker-build: build-docker-binary test ## Build docker image with the manager.
 	$(CONTAINER_TOOL) build -t ${IMG} .
@@ -103,7 +152,7 @@ docker-push: ## Push docker image with the manager.
 # To properly provided solutions that supports more than one platform you should use this option.
 PLATFORMS ?= linux/arm64 linux/amd64
 .PHONY: docker-buildx
-docker-buildx: #test ## Build and tag docker image for each platform locally using --load
+docker-buildx: ## Build and tag docker image for each platform locally using --load
 	sed '1 s/^FROM/FROM --platform=$${BUILDPLATFORM}/' Dockerfile > Dockerfile.cross
 	$(CONTAINER_TOOL) buildx create --name project-v3-builder || true
 	$(CONTAINER_TOOL) buildx use project-v3-builder
@@ -115,12 +164,8 @@ docker-buildx: #test ## Build and tag docker image for each platform locally usi
 	$(CONTAINER_TOOL) buildx rm project-v3-builder
 	rm Dockerfile.cross
 
+#----------------------------------------------------------------------------------------------
 ##@ Deployment
-
-ifndef ignore-not-found
-  ignore-not-found = false
-endif
-
 .PHONY: install
 install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config.
 	$(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f -
@@ -138,98 +183,46 @@ deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in
 undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion.
 	$(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -
 
-##@ Build Dependencies
-
-## Location to install dependencies to
-LOCALBIN ?= $(shell pwd)/bin
-$(LOCALBIN):
-	mkdir -p $(LOCALBIN)
-
-## Tool Binaries
-KUBECTL ?= kubectl
-KIND ?= kind # fix this to use tools
-KUSTOMIZE ?= $(LOCALBIN)/kustomize
-CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
-ENVTEST ?= $(LOCALBIN)/setup-envtest
-GOTESTSUM ?= $(LOCALBIN)/gotestsum
-GOLANGCILINT ?= $(LOCALBIN)/golangci-lint
-
-
-
-## Tool Versions
-KUSTOMIZE_VERSION ?= v5.4.1
-CONTROLLER_TOOLS_VERSION ?= v0.17.2
-GOLANGCILINT_VERSION ?= v2.0.2
-
-.PHONY: kustomize
-kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
-$(KUSTOMIZE): $(LOCALBIN)
-	@if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version | grep -q $(KUSTOMIZE_VERSION); then \
-		echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \
-		rm -rf $(LOCALBIN)/kustomize; \
-	fi
-	test -s $(LOCALBIN)/kustomize || GOBIN=$(LOCALBIN) GO111MODULE=on go install sigs.k8s.io/kustomize/kustomize/v5@$(KUSTOMIZE_VERSION)
-
-.PHONY: controller-gen
-controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
-$(CONTROLLER_GEN): $(LOCALBIN)
-	test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION) || \
-	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)
-
-.PHONY: envtest
-envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
-$(ENVTEST): $(LOCALBIN)
-	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
-
-.PHONY: envtest-bins
-envtest-bins: envtest ## Download envtest binaries
-	$(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN)
-
-.PHONY: gotestsum
-gotestsum: $(GOTESTSUM) ## Download gotestsum locally if necessary.
-$(GOTESTSUM): $(LOCALBIN)
-	test -s $(LOCALBIN)/gotestsum || GOBIN=$(LOCALBIN) go install gotest.tools/gotestsum@latest
-
-
-### ------------------------------------ DEVELOPMENT - LOCAL ------------------------------------ ###
-##@ Local Development
-.PHONY: dev-all
-dev-all-deploy: # Build the Docker image, create a local kind cluster, deploy the Operator, and install Crossplane and Helm provider.
-	$(MAKE) dev-deploy
-	$(MAKE) crossplane-install
-	$(MAKE) crossplane-provider-install
-	$(MAKE) helm-provider-sample
-
-
-.PHONY: dev-deploy
-dev-deploy: manifests kustomize dev-clean ## Deploy the Operator to a local kind cluster via Kustomize.
-	$(KIND) create cluster --name=$(PROJECT_NAME)-dev
-	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
-	$(KUSTOMIZE) build config/default | kubectl apply -f -
-	$(KIND) load docker-image ${IMG} --name=$(PROJECT_NAME)-dev
-
-
+#----------------------------------------------------------------------------------------------
+##@ Local Development Utilities
 .PHONY: dev-build
 dev-build: docker-build ## Build the Docker image for local development.
 	@echo "Finished building docker image" ${IMG}
 
-.PHONY: dev-base
-dev-base: manifests kustomize dev-build dev-clean dev-cluster helm-install-local # Build the Docker image, create a local kind cluster, and deploys the Operator.
+.PHONY: kind-load-image
+kind-load-image: ## Load the Docker image into the local kind cluster for development.
+	$(KIND) load docker-image ${IMG} --name=$(PROJECT_FULL_NAME)-dev
 
-.PHONY: dev-cluster
-dev-cluster: ## Create a local kind cluster and load the Docker image.
+.PHONY: kind-cluster
+kind-cluster: ## Create a kind cluster for development (no CRDs or resources applied).
 	$(KIND) create cluster --name=$(PROJECT_FULL_NAME)-dev
-	$(KIND) load docker-image ${IMG} --name=$(PROJECT_FULL_NAME)-dev
 
+.PHONY: dev-clean
+dev-clean: ## Delete the local kind cluster used for development.
+	$(KIND) delete cluster --name=$(PROJECT_FULL_NAME)-dev
+
+.PHONY: dev-run
+dev-run: ## Run the operator locally (for debugging/development).
+	## todo: add flag --debug
+	go run ./cmd/main.go start
+
+#----------------------------------------------------------------------------------------------
+##@ Testing
+.PHONY: test
+test: manifests generate fmt vet envtest ## Run tests.
+	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out
+
+#----------------------------------------------------------------------------------------------
+##@ Testing: Run Operator outside of the cluster
 .PHONY: dev-local
 dev-local: ## Create a local kind cluster and install CRDs for development.
 	$(KIND) create cluster --name=$(PROJECT_FULL_NAME)-dev
 	$(MAKE) install
 
 .PHONY: dev-local-all
-dev-local-all: ## Full local dev setup: clean, create cluster, install CRDs, Crossplane, namespaces, secrets, and sample metrics.
+dev-local-all: ## Full local dev setup: clean-up, create cluster, install CRDs, Crossplane, namespaces, secrets, and sample metrics.
 	$(MAKE) dev-clean
-	$(KIND) create cluster --name=$(PROJECT_FULL_NAME)-dev
+	$(MAKE) kind-cluster
 	$(MAKE) install
 	$(MAKE) crossplane-install
 	$(MAKE) crossplane-provider-install
@@ -240,7 +233,14 @@ dev-local-all: ## Full local dev setup: clean, create cluster, install CRDs, Cro
 	$(MAKE) dev-basic-metric
 	$(MAKE) dev-managed-metric
 
-##@ Examples for local development
+#----------------------------------------------------------------------------------------------
+##@ Testing: Run Operator inside the cluster (production scenario)
+
+.PHONY: dev-deploy
+dev-deploy: manifests kustomize dev-build dev-clean kind-cluster kind-load-image helm-install-local ## Build the Docker image, create a local kind cluster, and deploy the Operator.
+
+#----------------------------------------------------------------------------------------------
+##@ Example Resources
 .PHONY: dev-secret
 dev-secret: ## Apply the example secret to the cluster.
 	kubectl apply -f examples/secret.yaml
@@ -273,84 +273,51 @@ dev-apply-metric-dynatrace-prod: ## Apply metric using Dynatrace production exam
 dev-v1beta1-compmetric: ## Apply v1beta1 compmetric example to the cluster.
 	kubectl apply -f examples/v1beta1/compmetric.yaml
 
-.PHONY: dev-kind
-dev-kind: ## Create a kind cluster for development (no CRDs or resources applied).
-	$(KIND) create cluster --name=$(PROJECT_FULL_NAME)-dev
-
-.PHONY: dev-clean
-dev-clean: ## Delete the local kind cluster used for development.
-	$(KIND) delete cluster --name=$(PROJECT_FULL_NAME)-dev
-
-.PHONY: dev-run
-dev-run: ## Run the operator locally (for debugging/development).
-	## todo: add flag --debug
-	go run ./cmd/main.go
-
-$(GOLANGCILINT): $(LOCALBIN)
-	@if test -x $(LOCALBIN)/golangci-lint && ! $(LOCALBIN)/golangci-lint version | grep -q $(GOLANGCILINT_VERSION); then \
-		echo "$(LOCALBIN)/golangci-lint version is not expected $(GOLANGCILINT_VERSION). Removing it before installing."; \
-		rm -rf $(LOCALBIN)/golangci-lint; \
-	fi
-	test -s $(LOCALBIN)/golangci-lint || GOBIN=$(LOCALBIN) GO111MODULE=on go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCILINT_VERSION)
-
-
-.PHONY: lint
-lint: ## Run golangci-lint against code.
-	$(GOLANGCILINT) config verify
-	$(GOLANGCILINT) run ./...
-
-.PHONY: lint-fix
-lint-fix: ## Run golangci-lint with --fix option to automatically fix issues.
-	$(GOLANGCILINT) run --fix
-
-### ------------------------------------ HELM ------------------------------------ ###
-##@ Local Testing
-
+#----------------------------------------------------------------------------------------------
+##@ Helm
 .PHONY: helm-chart
 helm-chart: ## Generate Helm chart files from templates.
 	OPERATOR_VERSION=$(shell cat VERSION) envsubst < charts/$(PROJECT_FULL_NAME)/Chart.yaml.tpl > charts/$(PROJECT_FULL_NAME)/Chart.yaml
 	OPERATOR_VERSION=$(shell cat VERSION) envsubst < charts/$(PROJECT_FULL_NAME)/values.yaml.tpl > charts/$(PROJECT_FULL_NAME)/values.yaml
 
 .PHONY: helm-install-local
-helm-install-local: docker-build # Build the Docker image and install the Helm chart locally
+helm-install-local: ## Install the Helm chart locally using the Docker image
 	helm upgrade --install $(PROJECT_FULL_NAME) charts/$(PROJECT_FULL_NAME)/ --set image.repository=$(IMG_BASE) --set image.tag=$(IMG_VERSION) --set image.pullPolicy=Never
 	$(KIND) load docker-image ${IMG} --name=$(PROJECT_FULL_NAME)-dev
 
-.PHONY: helm-work
-helm-work: dev-kind crossplane-install helm-install-local # Install Crossplane and Helm provider, then deploy the Helm chart
-	echo "Helm work done"
+#----------------------------------------------------------------------------------------------
+##@ Crossplane
 
-.PHONY: lefthook
-lefthook: # Initializes pre-commit hooks using lefthook https://github.com/evilmartians/lefthook
-	lefthook install
-
-.PHONY: check-diff
-check-diff: generate manifests # Ensures that go generate doesn't create a diff
-	@echo checking clean branch
-	@if git status --porcelain | grep . ; then echo Uncommitted changes found after running make generate manifests. Please ensure you commit all generated files in this branch after running make generate. && false; else echo branch is clean; fi
-
-.PHONY: reviewable
-reviewable: # Ensures that the code is reviewable by running generate, lint, and test
-	@$(MAKE) generate
-	@$(MAKE) lint
-	@$(MAKE) test
-
-### ------------------------------------ CROSSPLANE ------------------------------------ ###
-
-# Namespace where Crossplane is installed
+# CROSSPLANE_NAMESPACE defines the namespace where Crossplane will be installed.
 CROSSPLANE_NAMESPACE ?= crossplane-system
 
 .PHONY: crossplane-install
-crossplane-install: # Install Crossplane into the cluster.
-	helm install crossplane crossplane-stable/crossplane --namespace crossplane-system --create-namespace --wait
+crossplane-install: ## Install Crossplane into the cluster.
+	helm install crossplane crossplane-stable/crossplane --namespace $(CROSSPLANE_NAMESPACE) --create-namespace --wait
 
 .PHONY: crossplane-provider-install
-crossplane-provider-install: # Install the Helm provider using kubectl
+crossplane-provider-install: ## Install the Helm provider using kubectl
 	kubectl apply -f examples/crossplane/provider.yaml -n $(CROSSPLANE_NAMESPACE)
 	kubectl wait --for=condition=Healthy provider/provider-helm --timeout=1m
 	kubectl apply -f examples/crossplane/provider-config.yaml -n $(CROSSPLANE_NAMESPACE)
 
-
 .PHONY: helm-provider-sample
-helm-provider-sample: # Apply the Helm provider sample to the cluster.
+helm-provider-sample: ## Apply the Helm provider sample to the cluster.
 	kubectl apply -f examples/crossplane/release.yaml -n $(CROSSPLANE_NAMESPACE)
+
+#----------------------------------------------------------------------------------------------
+##@ Utility
+.PHONY: lefthook
+lefthook: ## Initializes pre-commit hooks using lefthook https://github.com/evilmartians/lefthook
+	lefthook install
+
+.PHONY: check-diff
+check-diff: generate manifests ## Ensures that go generate doesn't create a diff
+	@echo checking clean branch
+	@if git status --porcelain | grep . ; then echo Uncommitted changes found after running make generate manifests. Please ensure you commit all generated files in this branch after running make generate. && false; else echo branch is clean; fi
+
+.PHONY: reviewable
+reviewable: ## Ensures that the code is reviewable by running generate, lint, and test
+	@$(MAKE) generate
+	@$(MAKE) lint
+	@$(MAKE) test
