Makefile

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

# 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: 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 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: 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
	$(MAKE) sync-crds

.PHONY: sync-crds
sync-crds: ## Sync generated CRDs into the Helm chart.
	@mkdir -p charts/uptime-robot-operator/crds
	cp config/crd/bases/*.yaml charts/uptime-robot-operator/crds/

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

# Kind cluster name for e2e tests. Override when using a named cluster, e.g. kind create cluster --name e2e-test
KIND_CLUSTER ?= kind
# Pinned cert-manager version for local/dev testing and webhook TLS.
CERT_MANAGER_VERSION ?= v1.16.2
CERT_MANAGER_MANIFEST ?= https://github.com/cert-manager/cert-manager/releases/download/$(CERT_MANAGER_VERSION)/cert-manager.yaml

# Run basic e2e tests (without real UptimeRobot API).
# The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
.PHONY: test-e2e
test-e2e: manifests generate fmt vet ## Run the e2e tests. Expected an isolated environment using Kind.
	@command -v kind >/dev/null 2>&1 || { \
		echo "Kind is not installed. Please install Kind manually."; \
		exit 1; \
	}
	@kind get clusters | grep -q '$(KIND_CLUSTER)' || { \
		echo "No Kind cluster \"$(KIND_CLUSTER)\" is running. Start one with: kind create cluster"; \
		echo "  or use a named cluster: KIND_CLUSTER=e2e-test make test-e2e"; \
		exit 1; \
	}
	@echo "Ensuring cert-manager $(CERT_MANAGER_VERSION) is installed"
	@$(MAKE) cert-manager-install
	@echo "Using Kind cluster: $(KIND_CLUSTER). Ensure kubectl context is set: kubectl config use-context kind-$(KIND_CLUSTER)"
	@echo "NOTE: Skipping real API tests (monitor, maintenancewindow, account, contact, monitorgroup, slackintegration, integration). Use 'make test-e2e-real' to run with real UptimeRobot API."
	KIND_CLUSTER=$(KIND_CLUSTER) go test ./test/e2e/ -v -ginkgo.v -ginkgo.label-filter="!monitor && !maintenancewindow && !account && !contact && !monitorgroup && !slackintegration && !integration"

# Run e2e tests with real UptimeRobot API (requires UPTIME_ROBOT_API_KEY env var)
.PHONY: test-e2e-real
test-e2e-real: manifests generate fmt vet ## Run e2e tests against real UptimeRobot API. Requires UPTIME_ROBOT_API_KEY.
	@command -v kind >/dev/null 2>&1 || { \
		echo "Kind is not installed. Please install Kind manually."; \
		exit 1; \
	}
	@kind get clusters | grep -q '$(KIND_CLUSTER)' || { \
		echo "No Kind cluster \"$(KIND_CLUSTER)\" is running. Start one with: kind create cluster"; \
		echo "  or use a named cluster: KIND_CLUSTER=e2e-test make test-e2e-real"; \
		exit 1; \
	}
	@echo "Ensuring cert-manager $(CERT_MANAGER_VERSION) is installed"
	@$(MAKE) cert-manager-install
	@echo "Using Kind cluster: $(KIND_CLUSTER). Ensure kubectl context is set: kubectl config use-context kind-$(KIND_CLUSTER)"
	@[ -n "$$UPTIME_ROBOT_API_KEY" ] || { \
		echo "UPTIME_ROBOT_API_KEY is not set. Please set it to run real API tests."; \
		exit 1; \
	}
	KIND_CLUSTER=$(KIND_CLUSTER) go test ./test/e2e/ -v -ginkgo.v -ginkgo.label-filter="monitor || maintenancewindow || account || contact || monitorgroup || slackintegration || integration" -timeout 60m

# Run all e2e tests (basic + real API)
.PHONY: test-e2e-all
test-e2e-all: manifests generate fmt vet ## Run all e2e tests including real API tests.
	@command -v kind >/dev/null 2>&1 || { \
		echo "Kind is not installed. Please install Kind manually."; \
		exit 1; \
	}
	@kind get clusters | grep -q '$(KIND_CLUSTER)' || { \
		echo "No Kind cluster \"$(KIND_CLUSTER)\" is running. Start one with: kind create cluster"; \
		echo "  or use a named cluster: KIND_CLUSTER=e2e-test make test-e2e-all"; \
		exit 1; \
	}
	@echo "Ensuring cert-manager $(CERT_MANAGER_VERSION) is installed"
	@$(MAKE) cert-manager-install
	@echo "Using Kind cluster: $(KIND_CLUSTER). Ensure kubectl context is set: kubectl config use-context kind-$(KIND_CLUSTER)"
	KIND_CLUSTER=$(KIND_CLUSTER) go test ./test/e2e/ -v -ginkgo.v -timeout 60m

.PHONY: test-e2e-verbose
test-e2e-verbose: manifests generate fmt vet ## Run full e2e suite with verbose Ginkgo node-event tracing.
	@command -v kind >/dev/null 2>&1 || { \
		echo "Kind is not installed. Please install Kind manually."; \
		exit 1; \
	}
	@kind get clusters | grep -q '$(KIND_CLUSTER)' || { \
		echo "No Kind cluster \"$(KIND_CLUSTER)\" is running. Start one with: kind create cluster"; \
		echo "  or use a named cluster: KIND_CLUSTER=e2e-test make test-e2e-verbose"; \
		exit 1; \
	}
	@echo "Ensuring cert-manager $(CERT_MANAGER_VERSION) is installed"
	@$(MAKE) cert-manager-install
	@echo "Using Kind cluster: $(KIND_CLUSTER). Ensure kubectl context is set: kubectl config use-context kind-$(KIND_CLUSTER)"
	@[ -n "$$UPTIME_ROBOT_API_KEY" ] || { \
		echo "UPTIME_ROBOT_API_KEY is not set. Please set it to run verbose full e2e tests."; \
		exit 1; \
	}
	KIND_CLUSTER=$(KIND_CLUSTER) go test ./test/e2e -run TestE2E -count=1 -v -timeout=60m -args \
		-ginkgo.v -ginkgo.show-node-events -ginkgo.trace

.PHONY: dev-cluster
dev-cluster: ## Create a local Kind cluster for development.
	./hack/setup-dev-cluster.sh

.PHONY: dev-cluster-delete
dev-cluster-delete: ## Delete the local development cluster.
	./hack/setup-dev-cluster.sh --delete

.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 manager binary.
	go build -o bin/manager 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: docker-build
docker-build: ## Build docker image with the manager.
	$(CONTAINER_TOOL) build -t ${IMG} .

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

# PLATFORMS defines the target platforms for the manager image be built to provide support to multiple
# architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to:
# - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/
# - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/
# - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail)
# To adequately provide solutions that are compatible with multiple platforms, you should consider using this option.
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
	# 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
	- $(CONTAINER_TOOL) buildx create --name uptime-robot-operator-builder
	$(CONTAINER_TOOL) buildx use uptime-robot-operator-builder
	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm uptime-robot-operator-builder
	rm Dockerfile.cross

.PHONY: build-installer
build-installer: manifests generate kustomize ## Generate a consolidated YAML with CRDs and deployment.
	mkdir -p dist
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/default > dist/install.yaml

##@ 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: cert-manager-check 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 -
	$(MAKE) webhook-cert-wait
	$(KUBECTL) rollout status deployment/uptime-robot-controller-manager -n uptime-robot-system --timeout=180s
	@for i in $$(seq 1 36); do \
		endpoint_ip="$$( $(KUBECTL) get endpoints uptime-robot-webhook-service -n uptime-robot-system -o jsonpath="{.subsets[0].addresses[0].ip}" 2>/dev/null )"; \
		if [ -n "$$endpoint_ip" ]; then \
			echo "uptime-robot-webhook-service endpoint ready: $$endpoint_ip"; \
			exit 0; \
		fi; \
		sleep 5; \
	done; \
	echo "Timed out waiting for endpoints/uptime-robot-webhook-service to be ready"; \
	exit 1

.PHONY: deploy-with-cert-manager
deploy-with-cert-manager: cert-manager-install deploy ## Deploy controller and install pinned cert-manager first.

.PHONY: undeploy
undeploy: kustomize ## 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 -

.PHONY: cert-manager-install
cert-manager-install: ## Install pinned cert-manager version and wait until ready.
	$(KUBECTL) apply -f $(CERT_MANAGER_MANIFEST)
	$(MAKE) cert-manager-wait

.PHONY: cert-manager-check
cert-manager-check: ## Verify cert-manager is already installed (no install side effects).
	@$(KUBECTL) get deployment cert-manager -n cert-manager >/dev/null 2>&1 || { \
		echo "cert-manager is not installed in this cluster."; \
		echo "Install it with: make cert-manager-install"; \
		echo "Or use: make deploy-with-cert-manager IMG=$(IMG)"; \
		exit 1; \
	}

.PHONY: cert-manager-wait
cert-manager-wait: ## Wait for cert-manager deployments to become Available.
	$(KUBECTL) wait --for=condition=Available deployment/cert-manager -n cert-manager --timeout=180s
	$(KUBECTL) wait --for=condition=Available deployment/cert-manager-webhook -n cert-manager --timeout=180s
	$(KUBECTL) wait --for=condition=Available deployment/cert-manager-cainjector -n cert-manager --timeout=180s

.PHONY: cert-manager-uninstall
cert-manager-uninstall: ## Uninstall pinned cert-manager resources.
	$(KUBECTL) delete -f $(CERT_MANAGER_MANIFEST) --ignore-not-found=true

.PHONY: webhook-cert-wait
webhook-cert-wait: ## Wait for webhook serving certificate/secret to be ready after deploy.
	$(KUBECTL) wait --for=condition=Ready certificate/uptime-robot-serving-cert -n uptime-robot-system --timeout=180s
	@for i in $$(seq 1 36); do \
		if $(KUBECTL) get secret webhook-server-cert -n uptime-robot-system >/dev/null 2>&1; then \
			echo "webhook-server-cert is present"; \
			exit 0; \
		fi; \
		sleep 5; \
	done; \
	echo "Timed out waiting for secret/webhook-server-cert in uptime-robot-system"; \
	exit 1

##@ Dependencies

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

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

## Tool Versions
KUSTOMIZE_VERSION ?= v5.5.0
CONTROLLER_TOOLS_VERSION ?= v0.17.2
#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 ?= v1.63.4

.PHONY: kustomize
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary.
$(KUSTOMIZE): $(LOCALBIN)
	$(call go-install-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5,$(KUSTOMIZE_VERSION))

.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/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)" ] || { \
set -e; \
package=$(2)@$(3) ;\
echo "Downloading $${package}" ;\
rm -f $(1) || true ;\
GOBIN=$(LOCALBIN) go install $${package} ;\
mv $(1) $(1)-$(3) ;\
} ;\
ln -sf $(1)-$(3) $(1)
endef