Makefile

# Image URL to use all building/pushing image targets
IMG ?= mercari/spanner-autoscaler:latest

# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.32.0

# Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
ifeq (,$(shell go env GOBIN))
GOBIN=$(shell go env GOPATH)/bin
else
GOBIN=$(shell go env GOBIN)
endif

# Setting SHELL to bash allows bash commands to be executed by recipes.
# Options are set to exit when a recipe line exits non-zero or a piped command fails.
SHELL = /usr/bin/env bash -o pipefail
.SHELLFLAGS = -ec

# base64 decode flag differs between macOS (base64 -D) and Linux (base64 -d).
BASE64_DECODE := $(shell if base64 --decode /dev/null 2>/dev/null; then echo "base64 --decode"; elif base64 -d /dev/null 2>/dev/null; then echo "base64 -d"; else echo "base64 -D"; fi)

# Webhook TLS cert dir used by run-dev.
WEBHOOK_CERT_DIR ?= $(LOCALBIN)/webhook-certs

# Webhook server namespace (must match config/default).
WEBHOOK_NAMESPACE ?= spanner-autoscaler

.PHONY: all
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
# entire set of makefiles included in this invocation, looking for lines of the
# file as xyz: ## something, and then pretty-format the target and help. Then,
# if there's a line with ##@ something, that gets pretty-printed as a category.
# More info on the usage of ANSI control characters for terminal formatting:
# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
# More info on the awk command:
# http://linuxcommand.org/lc3_adv_awk.php

.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)

.PHONY: clean
clean: ## Remove any locally built or downloaded files
	rm -rf $(shell pwd)/bin

.PHONY: docs
docs: crd-ref-docs ## Generate CRD reference docs
	$(CRD_REF_DOCS) --config docs/config/config.yaml --renderer markdown --output-path docs/crd-reference.md --source-path api/v1beta1

##@ Development

.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

.PHONY: generate
generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations.
	$(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..."

.PHONY: fmt
fmt: ## Run go fmt against code.
	go fmt ./...

.PHONY: vet
vet: ## Run go vet against code.
	go vet ./...

.PHONY: lint
lint: golangci-lint ## Run golangci-lint against code.
	$(GOLANGCI_LINT) cache clean
	$(GOLANGCI_LINT) run

.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

.PHONY: dev-certs
dev-certs: ## Extract webhook TLS certs from cluster into $(WEBHOOK_CERT_DIR) for local webhook development.
	mkdir -p $(WEBHOOK_CERT_DIR)
	kubectl get secret -n $(WEBHOOK_NAMESPACE) webhook-server-cert -o jsonpath='{.data.tls\.crt}' | $(BASE64_DECODE) > $(WEBHOOK_CERT_DIR)/tls.crt
	kubectl get secret -n $(WEBHOOK_NAMESPACE) webhook-server-cert -o jsonpath='{.data.tls\.key}' | $(BASE64_DECODE) > $(WEBHOOK_CERT_DIR)/tls.key

.PHONY: run-dev
run-dev: manifests generate fmt vet dev-certs ## Run controller locally with webhook forwarding (requires kind cluster with deploy-dev or tilt-up).
	go run ./cmd/main.go -zap-devel --cert-dir=$(WEBHOOK_CERT_DIR)

.PHONY: test-integration
test-integration: manifests generate envtest ## Run integration tests (starts emulators automatically if not running).
	@if ! nc -z localhost 9091 2>/dev/null; then \
		echo "Emulators not running, starting..."; \
		$(MAKE) emulator-up; \
		echo "Waiting for monitoring emulator to be ready..."; \
		for i in $$(seq 1 60); do nc -z localhost 9091 2>/dev/null && break || sleep 1; done; \
	fi
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" \
	go test -tags integration ./test/integration/... -v -count=1

.PHONY: emulator-up
emulator-up: ## Start Spanner and Monitoring emulators via docker-compose.
	docker compose up -d --build

.PHONY: emulator-down
emulator-down: ## Stop and remove emulator containers.
	docker compose down

KIND_CLUSTER_NAME = spanner-autoscaler

.PHONY: kind-cluster-create
kind-cluster-create: kind ## Create a kind cluster for development
	@if [ -z $(shell $(KIND) get clusters | grep $(KIND_CLUSTER_NAME)) ]; then \
	  $(KIND) create cluster --name $(KIND_CLUSTER_NAME); \
	fi
	kubectl config use-context kind-$(KIND_CLUSTER_NAME)

.PHONY: tilt-up
tilt-up: kind-cluster-create tilt ## Create kind cluster (if needed) and start Tilt.
	$(TILT) up

.PHONY: tilt-down
tilt-down: tilt kind ## Tear down Tilt, stop emulators, delete the kind cluster, and remove webhook certs.
	$(TILT) down
	$(MAKE) emulator-down
	$(KIND) delete cluster --name $(KIND_CLUSTER_NAME)
	rm -rf $(WEBHOOK_CERT_DIR)

.PHONY: logs-controller
logs-controller: tilt ## Stream controller logs (requires Tilt to be running).
	$(TILT) logs -f controller

.PHONY: kind-cluster-delete
kind-cluster-delete: kind ## Delete the kind cluster created for development
	@$(KIND) delete cluster --name $(KIND_CLUSTER_NAME)

.PHONY: kind-cluster-reset
kind-cluster-reset: kind-cluster-delete kind-cluster-create ## Recreate the kind cluster for development

.PHONY: kind-load-docker-image
kind-load-docker-image: kind ## Load a local Docker image to the kind cluster for development
	@$(KIND) load docker-image --name $(KIND_CLUSTER_NAME) ${IMG}

##@ 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 (webhooks disabled).
	ENABLE_WEBHOOKS=false go run ./cmd/main.go -zap-devel

# If you wish to build 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: test ## Build docker image with the manager.
	docker build -t ${IMG} .

.PHONY: docker-push
docker-push: ## Push docker image with the manager.
	docker push ${IMG}

# PLATFORMS defines the target platforms for  the manager image be build to provide support to multiple
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
# - able to use docker buildx . More info: https://docs.docker.com/build/buildx/
# - have enable BuildKit, More info: https://docs.docker.com/develop/develop-images/build_enhancements/
# - be able to push the image for your registry (i.e. if you do not inform a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
# To properly provided solutions that supports more than one platform you should use this option.
PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le
.PHONY: docker-buildx
docker-buildx: test ## 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
	docker buildx use project-v3-builder
	- docker buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
	- docker 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 -

.PHONY: uninstall
uninstall: manifests kustomize ## Uninstall CRDs 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/crd | kubectl delete --ignore-not-found=$(ignore-not-found) -f -

.PHONY: deploy
deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/default | kubectl apply -f -

.PHONY: deploy-dev
deploy-dev: manifests kustomize ## Deploy controller (for development, see `docs/webhook_development.md` for details) to the K8s cluster specified in ~/.kube/config.
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/deploy-dev | kubectl apply -f -

.PHONY: undeploy
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
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest
KIND = $(LOCALBIN)/kind
KPT = $(LOCALBIN)/kpt
GOLANGCI_LINT = $(LOCALBIN)/golangci-lint
CRD_REF_DOCS = $(LOCALBIN)/crd-ref-docs
TILT = $(LOCALBIN)/tilt

## Tool Versions
# Versions for Go-installed tools are pinned in go.mod via tools/tools.go (managed by dependabot).
# Versions for curl-installed tools (kustomize, kpt, tilt) remain hardcoded here.
KUSTOMIZE_VERSION ?= v5.8.1
KPT_VERSION ?= v1.0.0-beta.34
TILT_VERSION ?= v0.33.21

KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"

.PHONY: deps
deps: kustomize controller-gen envtest kind kpt golangci-lint crd-ref-docs tilt ## Download the following dependencies locally (in './bin') if necessary

.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 || { curl -Ss $(KUSTOMIZE_INSTALL_SCRIPT) --output install_kustomize.sh && bash install_kustomize.sh $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); rm install_kustomize.sh; }

.PHONY: controller-gen
controller-gen: $(LOCALBIN) ## Download controller-gen locally if necessary.
	cd tools && GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen

.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: kind
kind: $(LOCALBIN) ## Download 'kind' locally if necessary
	cd tools && GOBIN=$(LOCALBIN) go install sigs.k8s.io/kind

.PHONY: kpt
kpt: ## Downlaod 'kpt' locally if necessary
	test -s $(LOCALBIN)/kpt || \
	GOBIN=$(LOCALBIN) go install github.com/GoogleContainerTools/kpt@$(KPT_VERSION)

.PHONY: golangci-lint
golangci-lint: $(LOCALBIN) ## Download 'golangci-lint' locally if necessary
	cd tools && GOBIN=$(LOCALBIN) go install github.com/golangci/golangci-lint/v2/cmd/golangci-lint

.PHONY: crd-ref-docs
crd-ref-docs: $(LOCALBIN) ## Download 'crd-ref-docs' locally if necessary
	cd tools && GOBIN=$(LOCALBIN) go install github.com/elastic/crd-ref-docs

.PHONY: tilt
tilt: $(LOCALBIN) ## Download 'tilt' locally if necessary
	@if ! test -s $(LOCALBIN)/tilt || ! $(LOCALBIN)/tilt version | grep -q $(subst v,,$(TILT_VERSION)); then \
		OS=$$(uname -s | tr '[:upper:]' '[:lower:]' | sed 's/darwin/mac/'); \
		ARCH=$$(uname -m | sed 's/aarch64/arm64/'); \
		echo "Downloading tilt $(TILT_VERSION)..."; \
		curl -fsSL "https://github.com/tilt-dev/tilt/releases/download/$(TILT_VERSION)/tilt.$(subst v,,$(TILT_VERSION)).$${OS}.$${ARCH}.tar.gz" \
			| tar -xz -C $(LOCALBIN) tilt; \
	fi