Makefile

# Image URL to use all building/pushing image targets
IMG ?= controller:latest
IMAGE_TAG ?=

# 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

# CONTAINER_TOOL defines the container tool to be used for building images.
# Be aware that the target commands are only tested with Docker which is
# scaffolded by default. However, you might want to replace it to use other
# tools. (i.e. podman)
CONTAINER_TOOL ?= docker

# 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

.PHONY: all
all: help

##@ 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 command 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)

##@ Development

.PHONY: check
check: manifests generate fmt vet lint ## Run all code generation, formatting, vetting, and linting checks.

.PHONY: manifests
manifests: controller-gen ## Generate CRDs into the Helm chart.
	$(CONTROLLER_GEN) crd paths="./..." output:crd:artifacts:config=helm/supabase-operator/crds

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

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

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

.PHONY: test
test: manifests generate fmt vet setup-envtest ## Run tests.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test $$(go list ./... | grep -v /e2e) -coverprofile cover.out

# TODO(user): To use a different vendor for e2e tests, modify the setup under 'tests/e2e'.
# The default setup assumes Minikube is pre-installed and builds/loads the Manager Docker image locally.
# CertManager is installed by default; skip with:
# - CERT_MANAGER_INSTALL_SKIP=true
MINIKUBE ?= minikube
MINIKUBE_PROFILE ?= supabase-operator-test-e2e
MINIKUBE_START_ARGS ?= --driver=docker
E2E_IMG_REPO ?= ghcr.io/strrl/supabase-operator
E2E_IMG_TAG ?= $(shell ./hack/commit-hash.sh)
E2E_IMG ?= $(E2E_IMG_REPO):$(E2E_IMG_TAG)

.PHONY: setup-test-e2e
setup-test-e2e: ## Set up a Minikube profile for e2e tests if it does not exist
	@command -v $(MINIKUBE) >/dev/null 2>&1 || { \
		echo "Minikube is not installed. Please install Minikube manually."; \
		exit 1; \
	}
	@mkdir -p $(LOCALBIN)
	@if ! $(MINIKUBE) status -p $(MINIKUBE_PROFILE) >/dev/null 2>&1; then \
		echo "Starting Minikube profile '$(MINIKUBE_PROFILE)'..."; \
		$(MINIKUBE) start -p $(MINIKUBE_PROFILE) $(MINIKUBE_START_ARGS); \
	else \
		echo "Minikube profile '$(MINIKUBE_PROFILE)' already running. Skipping start."; \
	fi
	@$(MINIKUBE) update-context -p $(MINIKUBE_PROFILE)
	@$(MINIKUBE) -p $(MINIKUBE_PROFILE) kubectl -- config view --raw > $(LOCALBIN)/$(MINIKUBE_PROFILE)-kubeconfig
	@echo "Kubeconfig written to $(LOCALBIN)/$(MINIKUBE_PROFILE)-kubeconfig"

.PHONY: test-e2e
test-e2e: setup-test-e2e manifests generate fmt vet ## Run the e2e tests against a Minikube profile.
	./hack/build-image.sh
	$(MINIKUBE) image load $(E2E_IMG) -p $(MINIKUBE_PROFILE)
	MINIKUBE=$(MINIKUBE) MINIKUBE_PROFILE=$(MINIKUBE_PROFILE) KUBECONFIG=$(LOCALBIN)/$(MINIKUBE_PROFILE)-kubeconfig E2E_IMG_REPO=$(E2E_IMG_REPO) E2E_IMG_TAG=$(E2E_IMG_TAG) go test -tags=e2e ./test/e2e/ -v -ginkgo.v
	$(MAKE) cleanup-test-e2e

.PHONY: cleanup-test-e2e
cleanup-test-e2e: ## Tear down the Minikube profile used for e2e tests
	@echo "Deleting Minikube profile '$(MINIKUBE_PROFILE)'..."
	@$(MINIKUBE) delete -p $(MINIKUBE_PROFILE) >/dev/null 2>&1 || true
	@rm -f $(LOCALBIN)/$(MINIKUBE_PROFILE)-kubeconfig

.PHONY: lint
lint: golangci-lint ## Run golangci-lint linter
	$(GOLANGCI_LINT) run

.PHONY: lint-fix
lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes
	$(GOLANGCI_LINT) run --fix

.PHONY: lint-config
lint-config: golangci-lint ## Verify golangci-lint linter configuration
	$(GOLANGCI_LINT) config verify

##@ Build

.PHONY: build
build: manifests generate fmt vet ## Build supabase-operator binary.
	go build -o bin/supabase-operator cmd/main.go

.PHONY: run
run: manifests generate fmt vet ## Run a controller from your host.
	go run ./cmd/main.go

# 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: image
image: ## Build the controller image using hack/build-image.sh.
	@if [ -n "$(IMAGE_TAG)" ]; then \
		IMAGE_TAG=$(IMAGE_TAG) bash ./hack/build-image.sh; \
	else \
		bash ./hack/build-image.sh; \
	fi

##@ Dependencies

## Location to install dependencies to
LOCALBIN ?= $(shell pwd)/bin
$(LOCALBIN):
	mkdir -p $(LOCALBIN)

## Tool Binaries
KUBECTL ?= kubectl
HELM ?= helm
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest
GOLANGCI_LINT = $(LOCALBIN)/golangci-lint

## Tool Versions
CONTROLLER_TOOLS_VERSION ?= v0.19.0
#ENVTEST_VERSION is the version of controller-runtime release branch to fetch the envtest setup script (i.e. release-0.20)
ENVTEST_VERSION ?= $(shell go list -m -f "{{ .Version }}" sigs.k8s.io/controller-runtime | awk -F'[v.]' '{printf "release-%d.%d", $$2, $$3}')
#ENVTEST_K8S_VERSION is the version of Kubernetes to use for setting up ENVTEST binaries (i.e. 1.31)
ENVTEST_K8S_VERSION ?= $(shell go list -m -f "{{ .Version }}" k8s.io/api | awk -F'[v.]' '{printf "1.%d", $$3}')
GOLANGCI_LINT_VERSION ?= v2.4.0

.PHONY: clean-tools
clean-tools: ## Remove all downloaded tools from bin/ directory.
	@echo "Removing all tools from $(LOCALBIN)..."
	@rm -rf $(LOCALBIN)/*
	@echo "Tools removed. Run 'make <tool-name>' to reinstall."

.PHONY: controller-gen
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary.
$(CONTROLLER_GEN): $(LOCALBIN)
	$(call go-install-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen,$(CONTROLLER_TOOLS_VERSION))

.PHONY: setup-envtest
setup-envtest: envtest ## Download the binaries required for ENVTEST in the local bin directory.
	@echo "Setting up envtest binaries for Kubernetes version $(ENVTEST_K8S_VERSION)..."
	@$(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path || { \
		echo "Error: Failed to set up envtest binaries for version $(ENVTEST_K8S_VERSION)."; \
		exit 1; \
	}

.PHONY: envtest
envtest: $(ENVTEST) ## Download setup-envtest locally if necessary.
$(ENVTEST): $(LOCALBIN)
	$(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest,$(ENVTEST_VERSION))

.PHONY: golangci-lint
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
$(GOLANGCI_LINT): $(LOCALBIN)
	$(call go-install-tool,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint,$(GOLANGCI_LINT_VERSION))

# go-install-tool will 'go install' any package with custom target and name of binary, if it doesn't exist
# $1 - target path with name of binary
# $2 - package url which can be installed
# $3 - specific version of package
define go-install-tool
@[ -f "$(1)-$(3)" ] && [ "$$(readlink -- "$(1)" 2>/dev/null)" = "$(1)-$(3)" ] || { \
set -e; \
package=$(2)@$(3) ;\
echo "Downloading $${package}" ;\
rm -f $(1) ;\
GOBIN=$(LOCALBIN) go install $${package} ;\
mv $(1) $(1)-$(3) ;\
} ;\
ln -sf $$(realpath $(1)-$(3)) $(1)
endef