Makefile

# Copyright 2019 The KubeCarrier Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

SHELL=/bin/bash
.SHELLFLAGS=-euo pipefail -c

export CGO_ENABLED:=0

BRANCH=$(shell git rev-parse --abbrev-ref HEAD)
SHORT_SHA=$(shell git rev-parse --short HEAD)
VERSION?=${BRANCH}-${SHORT_SHA}
BUILD_DATE=$(shell date +%s)
IMAGE_ORG?=quay.io/kubecarrier
MODULE=k8c.io/kubecarrier
LD_FLAGS=-X $(MODULE)/pkg/internal/version.Version=$(VERSION) -X $(MODULE)/pkg/internal/version.Branch=$(BRANCH) -X $(MODULE)/pkg/internal/version.Commit=$(SHORT_SHA) -X $(MODULE)/pkg/internal/version.BuildDate=$(BUILD_DATE)
KIND_CLUSTER?=kubecarrier
COMPONENTS = operator manager ferry catapult elevator apiserver
E2E_COMPONENTS = fake-operator

ifdef CI
	# prow sets up GOPATH and we want to make sure it's in the PATH
	# https://github.com/kubernetes/test-infra/issues/9469
	# https://github.com/kubernetes/test-infra/blob/895df89b7e4238125063157842c191dac6f7e58f/prow/pod-utils/decorate/podspec.go#L474
	export PATH:=${PATH}:${GOPATH}/bin
endif

# Dev Image to use
# Always bump this version, when changing ANY component version below.
DEV_IMAGE_TAG=v6

# Versions used to build DEV image:
export GOLANGCI_LINT_VERSION=1.26.0
export STATIK_VERSION=0.1.8
export CONTROLLER_GEN_VERSION=0.2.9
export PROTOC_VERSION=3.11.4
export PROTOC_GEN_GO_VERSION=1.3.5
export PROTOC_GRPC_GATEWAY_VERSION=1.14.5
export TESTIFY_VERSION=1.4.0

# every makefile operation should have explicit kubeconfig
undefine KUBECONFIG

# https://github.com/kubernetes-sigs/kind/releases/tag/v0.7.0
# There are different node image types for newer kind v0.7.0+ version
# KIND_NODE_IMAGE?=kindest/node:v1.17.0@sha256:9512edae126da271b66b990b6fff768fbb7cd786c7d39e86bdf55906352fdf62
# KIND_NODE_IMAGE=kindest/node:v1.16.4@sha256:b91a2c2317a000f3a783489dfb755064177dbc3a0b2f4147d50f04825d016f55
# KIND_NODE_IMAGE=kindest/node:v1.15.7@sha256:e2df133f80ef633c53c0200114fce2ed5e1f6947477dbc83261a6a921169488d
# KIND_NODE_IMAGE=kindest/node:v1.14.10@sha256:81ae5a3237c779efc4dda43cc81c696f88a194abcc4f8fa34f86cf674aa14977

# -----------------
# Compile & Release
# -----------------
all: \
	bin/linux_amd64/operator \
	bin/linux_amd64/manager

bin/linux_amd64/%: GOARGS = GOOS=linux GOARCH=amd64
bin/darwin_amd64/%: GOARGS = GOOS=darwin GOARCH=amd64
bin/windows_amd64/%: GOARGS = GOOS=windows GOARCH=amd64

bin/%: FORCE
	$(eval COMPONENT=$(shell basename $*))
	$(GOARGS) go build -ldflags "-w $(LD_FLAGS)" -o bin/$* cmd/$(COMPONENT)/main.go

FORCE:

# Release!
release:
	goreleaser release --rm-dist
	go run ./hack/krew-manifest -version=$(shell git describe --tags --abbrev=0) > dist/krew.yaml
.PHONY: release

# Install the KubeCarrier CLI via Krew
krew-install:
	@goreleaser release --snapshot  --rm-dist
	@go run ./hack/krew-manifest -version=$(shell git describe --tags --abbrev=0)-SNAPSHOT-$(shell git rev-parse --short HEAD) > dist/krew.yaml
	@kubectl krew uninstall kubecarrier || true
	@kubectl krew install --manifest=dist/krew.yaml --archive=dist/kubecarrier_$(shell go env GOOS)_$(shell go env GOARCH).tar.gz
.PHONY: krew-install

# Install KubeCarrier CLI
install:
	@go install -ldflags "-w $(LD_FLAGS)" ./cmd/kubectl-kubecarrier
.PHONY: install

# -------
# Cleanup
# -------
e2e-test-clean:
	@kind delete cluster --name=${MANAGEMENT_KIND_CLUSTER} "--kubeconfig=${HOME}/.kube/kind-config-${MANAGEMENT_KIND_CLUSTER}" || true
	@kind delete cluster --name=${SVC_KIND_CLUSTER} "--kubeconfig=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER}" || true
.PHONY: e2e-test-clean

clean: e2e-test-clean
	rm -rf bin/$*
.PHONY: clean

# ---------------
# Code Generators
# ---------------

bin/docgen: hack/docgen/main.go
	$(GOARGS) go build -ldflags "-w $(LD_FLAGS)" -o bin/docgen ./hack/docgen

# Generates GRPC Files from API definitions
generate-grpc:
ifdef CI
	@hack/proto-codegen.sh
else
	@docker run --rm -e CI=true -w /src -v $(PWD):/src:delegated \
		--user "$(id -u):$(id -g)" \
		quay.io/kubecarrier/dev:${DEV_IMAGE_TAG} \
		make generate-grpc
endif
.PHONY: generate-grpc

# Generates KubeCarrier Deployment files and CRDs
generate-config:
ifdef CI
	@hack/codegen.sh
	@FIX_GOLDEN=1 go test ./pkg/internal/resources/...
else
	@docker run --rm -e CI=true -w /src -v $(PWD):/src:delegated \
		--user "$(id -u):$(id -g)" \
		quay.io/kubecarrier/dev:${DEV_IMAGE_TAG} \
		make generate-config
endif
.PHONY: generate-config

# Runs all code generators
generate: generate-grpc generate-config docs
.PHONY: generate

# Create API Reference docs
docs: bin/docgen
	@hack/docgen.sh
.PHONY: docs

# ------------
# Test Runners
# ------------

# run unittests
test:
	CGO_ENABLED=1 go test -race -v ./...
.PHONY: test

# check generated files for changes and lint project
lint: generate
	@hack/validate-directory-clean.sh
	pre-commit run -a
	golangci-lint run ./... --deadline=15m

# End to end testing
TEST_ID?=1
MANAGEMENT_KIND_CLUSTER?=kubecarrier-${TEST_ID}
SVC_KIND_CLUSTER?=kubecarrier-svc-${TEST_ID}

e2e-setup: install require-docker
	@mkdir -p /tmp/kubecarrier-hack
	@cp ./hack/audit.yaml /tmp/kubecarrier-hack
	@kind create cluster --retain --config=./hack/kind-config.yaml --name=${MANAGEMENT_KIND_CLUSTER} --image=${KIND_NODE_IMAGE} || true
	@kind create cluster --config=./hack/kind-config.yaml --name=${SVC_KIND_CLUSTER} --image=${KIND_NODE_IMAGE} || true
	@kind get kubeconfig --internal --name=${MANAGEMENT_KIND_CLUSTER} | sed "s/kubecarrier-${TEST_ID}-control-plane/$$(docker  network inspect kind  | jq '.[0].Containers | to_entries | map(.value) | map(select(.Name == "kubecarrier-${TEST_ID}-control-plane"))[0].IPv4Address[:-3]' -r)/g" > "${HOME}/.kube/internal-kind-config-${MANAGEMENT_KIND_CLUSTER}"
	@kind get kubeconfig --name=${MANAGEMENT_KIND_CLUSTER} > "${HOME}/.kube/kind-config-${MANAGEMENT_KIND_CLUSTER}"
	@echo "Deploy cert-manger in management cluster"
	# Deploy cert-manager right after the creation of the management cluster, since the deployments of cert-manger take some time to get ready.
	@$(MAKE) KUBECONFIG=${HOME}/.kube/kind-config-${MANAGEMENT_KIND_CLUSTER} cert-manager
	@$(MAKE) KUBECONFIG=${HOME}/.kube/kind-config-${MANAGEMENT_KIND_CLUSTER} dex
	@kind get kubeconfig --internal --name=${SVC_KIND_CLUSTER} | sed "s/kubecarrier-svc-${TEST_ID}-control-plane/$$(docker  network inspect kind  | jq '.[0].Containers | to_entries | map(.value) | map(select(.Name == "kubecarrier-svc-${TEST_ID}-control-plane"))[0].IPv4Address[:-3]' -r)/g"  > "${HOME}/.kube/internal-kind-config-${SVC_KIND_CLUSTER}"
	@kind get kubeconfig --name=${SVC_KIND_CLUSTER} > "${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER}"
	@$(MAKE) KUBECONFIG=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER} cert-manager
	@echo "kind clusters created"
	@kubectl --kubeconfig=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER} apply -n default -f ./config/serviceCluster
	@kubectl --kubeconfig=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER} create serviceaccount kubecarrier -n default --dry-run -o yaml | kubectl apply --kubeconfig=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER} -f -
	@kubectl --kubeconfig=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER} create clusterrolebinding kubecarrier --serviceaccount=default:kubecarrier --clusterrole kubecarrier:service-cluster-admin --dry-run -o yaml |  kubectl apply --kubeconfig=${HOME}/.kube/kind-config-${SVC_KIND_CLUSTER} -f -
	@go run ./hack/impersonate --kubeconfig "${HOME}/.kube/internal-kind-config-${SVC_KIND_CLUSTER}" --as "system:serviceaccount:default:kubecarrier"
	@echo "service cluster service account created"
	@echo "Loading the images"
	@$(MAKE) KIND_CLUSTER=${MANAGEMENT_KIND_CLUSTER} kind-load -j 5
	@$(MAKE) KIND_CLUSTER=${SVC_KIND_CLUSTER} kind-load-fake-operator

# soft-reinstall reinstall kubecarrier in the e2e cluster. It's intended for usage during development
soft-reinstall: e2e-setup install
	@kubectl kubecarrier setup --kubeconfig "${HOME}/.kube/kind-config-${MANAGEMENT_KIND_CLUSTER}"
	@kubectl --kubeconfig "${HOME}/.kube/kind-config-${MANAGEMENT_KIND_CLUSTER}" delete pod --all -n kubecarrier-system

# Run E2E test
e2e-test: e2e-setup
	@LD_FLAGS="$(LD_FLAGS)" TEST_ID=${TEST_ID} MANAGEMENT_KIND_CLUSTER=${MANAGEMENT_KIND_CLUSTER} SVC_KIND_CLUSTER=${SVC_KIND_CLUSTER} $(SHELL) ./hack/.e2e-test.sh

.PHONY: e2e-test


# -------------
# Util Commands
# -------------
fmt:
	go fmt ./...

vet:
	go vet ./...

tidy:
	go mod tidy

require-docker:
	@docker ps > /dev/null 2>&1 || start-docker.sh || (echo "cannot find running docker daemon nor can start new one" && false)
	@[[ -z "${QUAY_IO_USERNAME}" ]] || ( echo "logging in to ${QUAY_IO_USERNAME}" && docker login -u ${QUAY_IO_USERNAME} -p ${QUAY_IO_PASSWORD} quay.io )
.PHONY: require-docker

generate-ide-tasks:
	@go run ./hack/gen-tasks.go -ldflags "${LD_FLAGS}"

install-git-hooks:
	pre-commit install
	printf "#!/bin/bash\\nmake generate-ide-tasks" > .git/hooks/post-commit && chmod +x .git/hooks/post-commit
	cp .git/hooks/post-commit .git/hooks/post-checkout
	cp .git/hooks/post-commit .git/hooks/post-merge

# Install cert-manager in the configured Kubernetes cluster
cert-manager:
	kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v0.14.0/cert-manager.yaml
	kubectl wait --for=condition=available deployment/cert-manager -n cert-manager --timeout=240s
	kubectl wait --for=condition=available deployment/cert-manager-cainjector -n cert-manager --timeout=240s
	kubectl wait --for=condition=available deployment/cert-manager-webhook -n cert-manager --timeout=240s

dex:
	kubectl apply -f ./test/testdata/00_prereq.yaml
	helm upgrade --install --namespace kubecarrier-system dex stable/dex --values ./test/testdata/dex_values.yaml

# ----------------
# Container Images
# ----------------

push-images: $(addprefix push-image-, $(COMPONENTS))

# build all container images except the test image
build-images: $(addprefix build-image-, $(COMPONENTS))

kind-load: $(addprefix kind-load-, $(COMPONENTS))

kind-load-fake-operator: $(addprefix kind-load-, $(E2E_COMPONENTS))

build-image-dev: require-docker
	@mkdir -p bin/image/dev
	@cp -a config/dockerfiles/dev.Dockerfile bin/image/dev/Dockerfile
	@docker build -t ${IMAGE_ORG}/dev:${DEV_IMAGE_TAG} bin/image/dev \
		--build-arg GOLANGCI_LINT_VERSION=${GOLANGCI_LINT_VERSION} \
		--build-arg STATIK_VERSION=${STATIK_VERSION} \
		--build-arg CONTROLLER_GEN_VERSION=${CONTROLLER_GEN_VERSION} \
		--build-arg PROTOC_VERSION=${PROTOC_VERSION} \
		--build-arg PROTOC_GEN_GO_VERSION=${PROTOC_GEN_GO_VERSION} \
		--build-arg TESTIFY_VERSION=${TESTIFY_VERSION} \
		--build-arg PROTOC_GRPC_GATEWAY_VERSION=${PROTOC_GRPC_GATEWAY_VERSION}

push-image-dev: build-image-dev
	@docker push ${IMAGE_ORG}/dev:${DEV_IMAGE_TAG}
	@echo pushed ${IMAGE_ORG}/dev:${DEV_IMAGE_TAG}

build-image-test: require-docker
	@mkdir -p bin/image/test
	@cp -a config/dockerfiles/test.Dockerfile bin/image/test/Dockerfile
	@cp -a .pre-commit-config.yaml bin/image/test
	@cp -a hack/install-deps.sh bin/image/test
	@cp -a hack/lib.sh bin/image/test
	@cp -a go.mod go.sum hack/start-docker.sh bin/image/test
	@docker build -t ${IMAGE_ORG}/test bin/image/test

push-image-test: build-image-test require-docker
	@docker push ${IMAGE_ORG}/test
	@echo pushed ${IMAGE_ORG}/test

.SECONDEXPANSION:
# copy binary in new folder, so docker build is only sending the binary to the docker deamon
build-image-%: bin/linux_amd64/$$* require-docker
	@mkdir -p bin/image/$*
	@mv bin/linux_amd64/$* bin/image/$*
	@cp -a config/dockerfiles/$*.Dockerfile bin/image/$*/Dockerfile
	@docker build -t ${IMAGE_ORG}/$*:${VERSION} bin/image/$*

push-image-%: build-image-$$* require-docker
	@docker push ${IMAGE_ORG}/$*:${VERSION}
	@echo pushed ${IMAGE_ORG}/$*:${VERSION}

kind-load-%: build-image-$$*
	kind load docker-image ${IMAGE_ORG}/$*:${VERSION} --name=${KIND_CLUSTER}