Makefile

# -*- mode: makefile -*-
# dse-github-app Makefile.
# Don't forget to add a comment that starts with a ## after the name of each target
# to see it included in the help output. See the 'help' target comments for details.

.DEFAULT_GOAL := help

PROJECT := random-ingress-operator

GIT_COMMIT ?= $(shell git rev-parse HEAD)

DOCKER ?= docker

# Allow only alphanumeric characters, "-" or "_" in image name, the rest are replaced by "-"
CURRENT_DOCKER_IMAGE_TAG = $(GIT_COMMIT)

# Repo trusted by our prod cluster
PROD_IMAGE_REPOSITORY ?= ghcr.io/backmarket-oss/random-ingress-operator

OUTDIR ?= out
CHECKSTYLE_FILE ?=
COVERPROFILE_FILE ?= $(OUTDIR)/coverage.out
HTML_COVERAGE_FILE ?= $(OUTDIR)/coverage.html
TEST_JUNIT_FILE ?= $(OUTDIR)/junit.xml
TEST_REPORT_FILE ?= $(OUTDIR)/report.json

# 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.
# This is a requirement for 'setup-envtest.sh' in the test target.
# 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 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)

##@ Development

.PHONY: manifests
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
	$(CONTROLLER_GEN) crd rbac:roleName=manager-role 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: mocks
mocks: mockgen ## Generate mocks used for testing.
	$(MOCKGEN) -copyright_file hack/boilerplate.go.txt sigs.k8s.io/controller-runtime/pkg/client Client,StatusWriter > controllers/mocks/client.go

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

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

.PHONY: $(OUTDIR)
$(OUTDIR): ## Create output directory
	mkdir -p $(OUTDIR)

.PHONY: cover-html
cover-html: $(OUTDIR) ## Generate HTML coverage report from coverprofile file
	go tool cover -html=$(COVERPROFILE_FILE) -o $(HTML_COVERAGE_FILE)

.PHONY: test-all
ENVTEST_ASSETS_DIR=$(shell pwd)/testbin
test-all: $(OUTDIR) manifests generate fmt vet ## Run all tests (including integration tests).
	mkdir -p ${ENVTEST_ASSETS_DIR}
	test -f ${ENVTEST_ASSETS_DIR}/setup-envtest.sh || curl -sSLo ${ENVTEST_ASSETS_DIR}/setup-envtest.sh https://raw.githubusercontent.com/kubernetes-sigs/controller-runtime/v0.8.3/hack/setup-envtest.sh
	source ${ENVTEST_ASSETS_DIR}/setup-envtest.sh; \
		fetch_envtest_tools $(ENVTEST_ASSETS_DIR); \
		setup_envtest_env $(ENVTEST_ASSETS_DIR); \
		gotestsum --jsonfile $(TEST_REPORT_FILE) --junitfile $(TEST_JUNIT_FILE) -- -race -covermode=atomic -coverprofile=$(COVERPROFILE_FILE) ./...

.PHONY: test-unit
test-unit: $(OUTDIR) manifests generate fmt vet ## Run unit tests.
	gotestsum --jsonfile $(TEST_REPORT_FILE) --junitfile $(TEST_JUNIT_FILE) -- -short -race -covermode=atomic -coverprofile=$(COVERPROFILE_FILE) ./...

##@ Build

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

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

.PHONY: build-image
build-image: ## Build Docker image
	$(DOCKER) build -t $(PROJECT) .

.PHONY: push-image
push-image: build-image ## Push image on the image repositories
	$(DOCKER) tag $(PROJECT) $(PROD_IMAGE_REPOSITORY)/$(PROJECT):$(CURRENT_DOCKER_IMAGE_TAG)
	$(DOCKER) push $(PROD_IMAGE_REPOSITORY)/$(PROJECT):$(CURRENT_DOCKER_IMAGE_TAG)

##@ Deployment

.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.
	$(KUSTOMIZE) build config/crd | kubectl delete -f -

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

.PHONY: undeploy
undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config.
	$(KUSTOMIZE) build config/default | kubectl delete -f -

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

## Tool Binaries
KUSTOMIZE ?= $(LOCALBIN)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen
MOCKGEN ?= $(LOCALBIN)/mockgen

## Tool Versions
KUSTOMIZE_VERSION ?= v3.8.7

# TODO: v0.11.1 is available but fails to 'go install',
#       investigate it.
CONTROLLER_TOOLS_VERSION ?= v0.10.0

MOCKGEN_VERSION ?= v1.6.0

.PHONY: controller-gen
controller-gen: ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
	@ if test -x $(LOCALBIN)/controller-gen && ! $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION); then \
		echo "$(LOCALBIN)/controller-gen version is not expected $(CONTROLLER_TOOLS_VERSION). Removing it before installing."; \
		rm -rf $(LOCALBIN)/controller-gen; \
	fi
	test -s $(LOCALBIN)/controller-gen ||	GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION)

KUSTOMIZE_INSTALL_SCRIPT ?= "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh"
.PHONY: kustomize
kustomize: ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
	@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) | bash -s -- $(subst v,,$(KUSTOMIZE_VERSION)) $(LOCALBIN); }

.PHONY: mockgen
mockgen: ## Download mockgen locally if necessary. If wrong version is installed, it will be removed before downloading.
	@ if test -x $(LOCALBIN)/mockgen && ! $(LOCALBIN)/mockgen -version | grep -q $(MOCKGEN_VERSION); then \
		echo "$(LOCALBIN)/mockgen version is not expected $(MOCKGEN_VERSION). Removing it before installing."; \
		rm -rf $(LOCALBIN)/mockgen; \
	fi
	test -s $(LOCALBIN)/mockgen ||	GOBIN=$(LOCALBIN) go install github.com/golang/mock/mockgen@$(MOCKGEN_VERSION)