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
KIND_CLUSTER ?= kind

# 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

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

.PHONY: proto
proto: ## Generate protobuf/gRPC code.
	PATH="$(shell go env GOPATH)/bin:$$PATH" protoc --proto_path=api/proto \
		--go_out=api/proto --go_opt=paths=source_relative \
		--go-grpc_out=api/proto --go-grpc_opt=paths=source_relative \
		writer/v1/writer.proto

.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 ./... -coverprofile cover.out

.PHONY: test-controller
test-controller: setup-envtest ## Run controller envtest suite only.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./internal/controller/...


.PHONY: ensure-kind-cli
ensure-kind-cli: ## Verify that the Kind CLI is installed.
	@command -v kind >/dev/null 2>&1 || { \
		echo "Kind is not installed. Please install Kind manually."; \
		exit 1; \
	}

.PHONY: ensure-kind-runtime
ensure-kind-runtime: ensure-kind-cli ## Verify that Kind can reach a Docker-compatible runtime.
	@command -v docker >/dev/null 2>&1 || { \
		echo "Docker CLI is not installed. Install Docker Desktop or start a Docker-compatible runtime such as Colima."; \
		exit 1; \
	}
	@docker info >/dev/null 2>&1 || { \
		echo "Docker daemon is not reachable. Start Docker Desktop or run: colima start --cpu 4 --memory 8"; \
		exit 1; \
	}

.PHONY: ensure-kind-cluster
ensure-kind-cluster: ensure-kind-runtime ## Ensure that the expected Kind cluster exists and is the active kubectl context.
	@kind get clusters | grep -Fxq '$(KIND_CLUSTER)' || { \
		echo "Creating Kind cluster '$(KIND_CLUSTER)' for nightly e2e tests..."; \
		kind create cluster --name '$(KIND_CLUSTER)'; \
	}
	@kubectl config use-context 'kind-$(KIND_CLUSTER)' >/dev/null

.PHONY: recreate-kind-cluster
recreate-kind-cluster: ensure-kind-runtime ## Recreate the expected Kind cluster to ensure a clean nightly e2e environment.
	@kind get clusters | grep -Fxq '$(KIND_CLUSTER)' && { \
		echo "Deleting existing Kind cluster '$(KIND_CLUSTER)' before nightly e2e tests..."; \
		kind delete cluster --name '$(KIND_CLUSTER)'; \
	} || true
	@echo "Creating fresh Kind cluster '$(KIND_CLUSTER)' for nightly e2e tests..."
	@kind create cluster --name '$(KIND_CLUSTER)'
	@kubectl config use-context 'kind-$(KIND_CLUSTER)' >/dev/null

# TODO(user): To use a different vendor for e2e tests, modify the setup under 'tests/e2e'.
# The default setup assumes Kind is pre-installed and builds/loads the Manager Docker image locally.
.PHONY: test-e2e
test-e2e: test-e2e-fast ## Run the fast e2e lane (static TLS secrets).

.PHONY: test-e2e-fast
test-e2e-fast: manifests generate fmt vet ensure-kind-cli ## Run e2e tests in fast lane (hermetic Kind cluster, static TLS secrets).
	KIND_CLUSTER=$(KIND_CLUSTER) E2E_TLS_MODE=static go test -count=1 -timeout=30m -tags=e2e ./test/e2e/ -v

.PHONY: test-e2e-nightly
test-e2e-nightly: manifests generate fmt vet ensure-kind-cli recreate-kind-cluster ## Run e2e tests in nightly lane (fresh Kind cluster managed by the Make target, cert-manager).
	KIND_CLUSTER=$(KIND_CLUSTER) E2E_TLS_MODE=cert-manager go test -count=1 -timeout=30m -tags=e2e ./test/e2e/ -v

.PHONY: test-e2e-hostpath-incremental
test-e2e-hostpath-incremental: manifests generate fmt vet ensure-kind-cli recreate-kind-cluster ## Run the hostpath SnapshotMetadata incremental generation e2e locally.
	KIND_CLUSTER=$(KIND_CLUSTER) E2E_TLS_MODE=cert-manager go test -count=1 -timeout=20m -tags=e2e ./test/e2e/ -run 'TestIncrementalBackupGenerations' -v

.PHONY: test-e2e-real-cluster
test-e2e-real-cluster: manifests generate fmt vet ## Run real-cluster e2e gate against the current kubeconfig and a pullable IMG.
	E2E_REAL_CLUSTER=true E2E_TLS_MODE=cert-manager E2E_STORAGE_CLASS="$(E2E_STORAGE_CLASS)" E2E_VOLUME_SNAPSHOT_CLASS="$(E2E_VOLUME_SNAPSHOT_CLASS)" IMG=$(IMG) go test -count=1 -timeout=45m -tags=e2e ./test/e2e/ -run 'TestBackupRetryScenarios|TestRealClusterRestoreWorkflow' -v

.PHONY: test-e2e-ceph-nightly
test-e2e-ceph-nightly: manifests generate fmt vet ## Run Ceph-backed nightly CBT gate against current kubeconfig and preinstalled Ceph CSI/SnapshotMetadataService.
	E2E_REAL_CLUSTER=true E2E_TLS_MODE=cert-manager E2E_USE_REAL_CBT_PROVIDER=true E2E_STORAGE_CLASS="$(E2E_STORAGE_CLASS)" E2E_VOLUME_SNAPSHOT_CLASS="$(E2E_VOLUME_SNAPSHOT_CLASS)" IMG=$(IMG) go test -count=1 -timeout=75m -tags=e2e ./test/e2e/ -run 'TestBackupRetryScenarios|TestIncrementalBackupGenerations' -v

.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 snaplane-builder
	$(CONTAINER_TOOL) buildx use snaplane-builder
	- $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
	- $(CONTAINER_TOOL) buildx rm snaplane-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: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config.
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	cd config/writer-sidecar && $(KUSTOMIZE) edit set image controller=${IMG}
	cd config/restore-populator && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/default | $(KUBECTL) apply -f -

.PHONY: deploy-e2e-fast
deploy-e2e-fast: manifests kustomize ## Deploy controller to the K8s cluster without cert-manager resources (e2e fast lane).
	cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG}
	cd config/writer-sidecar && $(KUSTOMIZE) edit set image controller=${IMG}
	cd config/restore-populator && $(KUSTOMIZE) edit set image controller=${IMG}
	$(KUSTOMIZE) build config/e2e/fast | $(KUBECTL) apply -f -

.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: undeploy-e2e-fast
undeploy-e2e-fast: kustomize ## Undeploy e2e fast-lane resources from the K8s cluster specified in ~/.kube/config.
	$(KUSTOMIZE) build config/e2e/fast | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f -

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