Makefile

# Image URL to use all building/pushing image targets
IMG ?= tensorfusion/tensor-fusion-operator:latest
# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION ?= 1.35.0
# Keep envtest-based suites from overloading the local control plane startup.
GINKGO_PARALLEL_PROCS ?= 4

# 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 ?= $(shell command -v docker >/dev/null 2>&1 && echo docker || echo nerdctl)

# 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 && \
	cp -r config/crd/bases/* ./charts/tensor-fusion/crds/ && \
	bash hack/sync-helm-rbac.sh

.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: vendor
vendor: ## Vendor dependencies and apply scheduler patches.
	go mod vendor
	bash ./scripts/patch-scheduler.sh

.PHONY: one-crd
one-crd:
	bash scripts/generate-crd.sh

.PHONY: test
test: build-provider vendor manifests generate fmt vet envtest ## Run tests and generate coverage.
	KUBEBUILDER_ASSETS="$(ENVTEST_ASSETS_DIR)" GO_TESTING=true go run github.com/onsi/ginkgo/v2/ginkgo -timeout 12m -cover -coverprofile cover.out -r --skip-file ./test/e2e

.PHONY: check-coverage
check-coverage: ## Check if test coverage meets minimum threshold (default: 45%)
	@if [ ! -f cover.out ]; then \
		echo "Error: cover.out not found. Run 'make test' first."; \
		exit 1; \
	fi
	@COVERAGE=$$(go tool cover -func=cover.out | grep "^total:" | awk '{print $$3}' | sed 's/%//'); \
	echo "$${COVERAGE}%";

.PHONY: test-with-coverage-check
test-with-coverage-check: test check-coverage ## Run tests and verify coverage meets threshold

.PHONY: test-serial
test-serial: build-provider vendor manifests generate fmt vet envtest ## Run tests.
	KUBEBUILDER_ASSETS="$(ENVTEST_ASSETS_DIR)" GO_TESTING=true go run github.com/onsi/ginkgo/v2/ginkgo -timeout 12m -r --skip-file ./test/e2e

.PHONY: ut
ut: vendor manifests generate ## Run unit tests by make ut F=<focus-file>
	cd internal/controller && KUBEBUILDER_ASSETS="$(ENVTEST_ASSETS_DIR)" GO_TESTING=true go run github.com/onsi/ginkgo/v2/ginkgo -p --procs $(GINKGO_PARALLEL_PROCS) -timeout 12m --focus-file $F && cd ../../

.PHONY: ut-sched
ut-sched: vendor manifests generate ## Run unit tests by make ut F=<focus-file>
	cd test/sched && KUBEBUILDER_ASSETS="$(ENVTEST_ASSETS_DIR)" GO_TESTING=true go run github.com/onsi/ginkgo/v2/ginkgo -p --procs $(GINKGO_PARALLEL_PROCS) -timeout 12m --focus-file $F && cd ../../

.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' || { \
		echo "No Kind cluster is running. Please start a Kind cluster before running the e2e tests."; \
		exit 1; \
	}
	go test ./test/e2e/ -v -ginkgo.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

##@ Build

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

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

.PHONY: build-provider
build-provider: ## Build accelerator example library.
	$(MAKE) -C provider example

.PHONY: build-hypervisor
build-hypervisor: ## Build hypervisor binary with CGO disabled using purego.
	CGO_ENABLED=0 \
	go build -o bin/hypervisor ./cmd/hypervisor

# Target arch for docker image binaries (matches dockerfile/*.Dockerfile COPY paths).
TARGETARCH ?= $(shell go env GOARCH)

.PHONY: build-manager-linux
build-manager-linux: vendor manifests generate fmt vet ## Cross-compile manager for linux/${TARGETARCH}.
	GOOS=linux GOARCH=$(TARGETARCH) CGO_ENABLED=0 \
	go build -o bin/manager-linux-$(TARGETARCH) cmd/main.go

.PHONY: build-hypervisor-linux
build-hypervisor-linux: ## Cross-compile hypervisor for linux/${TARGETARCH}.
	GOOS=linux GOARCH=$(TARGETARCH) CGO_ENABLED=0 \
	go build -o bin/hypervisor-linux-$(TARGETARCH) ./cmd/hypervisor

.PHONY: build-hypervisor-tui
build-hypervisor-tui: 
	go build -o bin/hypervisor-tui ./cmd/hypervisor-tui


.PHONY: clean-cache
clean-cache: ## Clean Go build cache.
	go clean -cache -testcache

# Hypervisor image override (separate from operator IMG).
HYPERVISOR_IMG ?= tensorfusion/tensor-fusion-hypervisor:latest

# Build operator image. The Dockerfile lives at dockerfile/operator.Dockerfile and
# expects a pre-built bin/manager-linux-${TARGETARCH}, so we build the binary first.
.PHONY: docker-build
docker-build: build-manager-linux ## Build operator docker image (override IMG=... TARGETARCH=...).
	$(CONTAINER_TOOL) build -t ${IMG} \
		-f dockerfile/operator.Dockerfile \
		--build-arg TARGETARCH=$(TARGETARCH) \
		.

.PHONY: docker-build-hypervisor
docker-build-hypervisor: build-hypervisor-linux ## Build hypervisor docker image (override HYPERVISOR_IMG=... TARGETARCH=...).
	$(CONTAINER_TOOL) build -t ${HYPERVISOR_IMG} \
		-f dockerfile/hypervisor.Dockerfile \
		--build-arg TARGETARCH=$(TARGETARCH) \
		.

.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
.PHONY: docker-buildx
docker-buildx: ## Build and push operator docker image for multiple architectures.
	# Build binaries for each target arch before invoking buildx.
	for arch in amd64 arm64; do \
		$(MAKE) build-manager-linux TARGETARCH=$$arch ; \
	done
	# copy operator Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross.
	sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' dockerfile/operator.Dockerfile > Dockerfile.cross
	# `buildx create` is allowed to fail (idempotent: builder may already exist).
	# Everything else MUST fail the target — leading `-` here would silently
	# swallow real build/push errors and let CI report a green release on a
	# broken image.
	- $(CONTAINER_TOOL) buildx create --name tensor-fusion-operator-builder
	$(CONTAINER_TOOL) buildx use tensor-fusion-operator-builder
	$(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross .
	$(CONTAINER_TOOL) buildx rm tensor-fusion-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: 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: 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 -

##@ 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
ENVTEST_ASSETS_DIR = $(abspath $(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path))

## Tool Versions
KUSTOMIZE_VERSION ?= v5.8.0
CONTROLLER_TOOLS_VERSION ?= v0.20.0
ENVTEST_VERSION ?= $(shell go list -m -f "{{ .Version }}" sigs.k8s.io/controller-runtime | awk -F'[v.]' '{printf "release-%d.%d", $$2, $$3}')
GOLANGCI_LINT_VERSION ?= v2.8.0

.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: 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)" ] || { \
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