Makefile

# Image URL to use all building/pushing image targets

# VERSION is the version of the binary.
REVISION ?= $(shell git describe --tags --dirty 2>/dev/null)

OPERATOR_IMG ?= ghcr.io/cloudtty/cloudshell-operator:$(REVISION)
TTY_IMG ?= ghcr.io/cloudtty/cloudshell:$(REVISION)
#NOTE: job.yaml.tmpl image should align with above

# ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary.
ENVTEST_K8S_VERSION = 1.23

# 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 paths=./pkg/apis/... output:crd:dir=./charts/cloudtty/_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: fmt vet envtest ## Run tests.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) -p path)" go test $$(go list ./... | grep -v /test/e2e) -coverprofile cover.out

##@ Build

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

.PHONY: release
release: build-chart docker-build docker-push

.PHONY: docker-build
docker-build: test ## Build docker image with the manager.
	docker build -t ${OPERATOR_IMG} . -f docker/operator/Dockerfile
	docker build -t ${TTY_IMG} . -f docker/cloudshell/Dockerfile

.PHONY: docker-push
docker-push: ## Push docker image with the manager.
	docker push ${OPERATOR_IMG}
	docker push ${TTY_IMG}
##@ E2E Testing

.PHONY: test-e2e
test-e2e: ## Run e2e tests against an existing kind cluster.
	@command -v kind >/dev/null 2>&1 || { echo "kind is not installed. Please install kind first: https://kind.sigs.k8s.io/"; exit 1; }
	@command -v helm >/dev/null 2>&1 || { echo "helm is not installed. Please install helm first: https://helm.sh/"; exit 1; }
	go test ./test/e2e/ -v -ginkgo.v -timeout 30m

.PHONY: kind-create
kind-create: ## Create a kind cluster for e2e testing.
	kind create cluster --name kind --config test/e2e/kind-config.yaml || true

.PHONY: kind-delete
kind-delete: ## Delete the kind cluster.
	kind delete cluster --name kind

.PHONY: kind-load
kind-load: docker-build ## Build and load images into kind.
	kind load docker-image ${OPERATOR_IMG} --name kind
	kind load docker-image ${TTY_IMG} --name kind

# Local one-shot e2e: create cluster -> build & load images -> run tests
.PHONY: local-e2e-test
local-e2e-test: kind-create kind-load test-e2e ## Run full e2e flow locally.

##@ Deployment

ifndef ignore-not-found
  ignore-not-found = false
endif

.PHONY: generate-yaml
generate-yaml: kustomize
	$(KUSTOMIZE) build config/crd  > cloud_shell_crd.yaml

.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=${OPERATOR_IMG}
	$(KUSTOMIZE) build config/default | kubectl apply -f -

.PHONY: undeploy
undeploy: ## 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: codegen
codegen:
	./hack/update-codegen.sh

.PHONY: build-chart
build-chart:
	helm package ./charts/cloudtty --dependency-update --destination .  --app-version $(REVISION)

CONTROLLER_GEN = $(shell go env GOPATH)/bin/controller-gen
.PHONY: controller-gen
controller-gen: ## Download controller-gen locally if necessary.
	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.8.0)

KUSTOMIZE = $(shell pwd)/bin/kustomize
.PHONY: kustomize
kustomize: ## Download kustomize locally if necessary.
	$(call go-get-tool,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v3@v3.8.7)

ENVTEST = $(shell pwd)/bin/setup-envtest
.PHONY: envtest
envtest: ## Download envtest-setup locally if necessary.
	$(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@latest)

# go-get-tool will 'go get' any package $2 and install it to $1.
PROJECT_DIR := $(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
define go-get-tool
@[ -f $(1) ] || { \
set -e ;\
TMP_DIR=$$(mktemp -d) ;\
cd $$TMP_DIR ;\
go mod init tmp ;\
echo "Downloading $(2)" ;\
GOBIN=$(PROJECT_DIR)/bin go get $(2) ;\
rm -rf $$TMP_DIR ;\
}
endef

.PHONY: helmdoc
helmdoc:
ifeq (, $(shell which readme-generator))
	@{ \
	set -e ;\
	echo 'installing readme-generator-for-helm' ;\
	npm install -g @bitnami/readme-generator-for-helm ;\
	}
endif

helm-doc-gen: helmdoc
	readme-generator -v charts/cloudtty/values.yaml -r charts/cloudtty/README.md