Makefile

.PHONY: e2e

# Image URL to use all building/pushing image targets
IMG ?= storageos/kubectl-storageos:test

# 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

KUBECTL_STOS_VERSION ?= v1.4.0

# Generate kuttl e2e tests for the following storageos/kind-node versions
# TEST_KIND_NODES is not intended to be updated manually.
# Please edit LATEST_KIND_NODE instead and run 'make update-kind-nodes'.
TEST_KIND_NODES ?= 1.22.3,1.23.0,1.24.2,1.25.0,1.26.0

LATEST_KIND_NODE ?= 1.22.3
REPO ?= kubectl-storageos

# 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

LDF_FLAGS = -X github.com/storageos/kubectl-storageos/pkg/version.PluginVersion=

BUILDFLAGS = -tags "exclude_graphdriver_btrfs exclude_graphdriver_devicemapper"

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

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

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

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

vet: ## Run go vet against code.
	go vet ${BUILDFLAGS} ./...

test: fmt vet generate ## Run tests.
	go test -v ${BUILDFLAGS} github.com/storageos/kubectl-storageos/...

e2e: ## Run e2e tests against latest supported k8s cluster.  
	kubectl-kuttl test --config e2e/kuttl/kubectl-storageos-installer-1.22.yaml
	kubectl-kuttl test --config e2e/kuttl/kubectl-storageos-upgrade-1.22.yaml

##@ Build

airbuild: air ## runs live build for development.
	air -c .air.toml

tidy: ## Regenerates Go dependencies.
	go mod tidy

build: test ## Test and build manager binary.
	make _build

_build: ## Build
	go build ${BUILDFLAGS} -ldflags "$(LDF_FLAGS)$(KUBECTL_STOS_VERSION)" -o bin/kubectl-storageos github.com/storageos/kubectl-storageos

_build-pre: ## Build configured to grab pre-release version of the operator
	go build ${BUILDFLAGS} -ldflags "$(LDF_FLAGS)$(KUBECTL_STOS_VERSION) -X github.com/storageos/kubectl-storageos/pkg/version.EnablePreReleases=true" -o bin/kubectl-storageos github.com/storageos/kubectl-storageos

run: fmt vet generate ## Run a controller from your host.
	go run ${BUILDFLAGS} ./main.go

update-kind-nodes: 
	LATEST_KIND_NODE=$(LATEST_KIND_NODE) ./hack/update-kind-nodes.sh

generate-tests: ## Generate kuttl e2e tests
	TEST_KIND_NODES=$(TEST_KIND_NODES) REPO=$(REPO) ./hack/generate-tests.sh

##@ Deployment
manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects.
		$(CONTROLLER_GEN) crd paths=./api/... rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases

deps: controller-gen ## Download all dependencies if necessary.

CONTROLLER_GEN = $(shell pwd)/bin/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.9.0)

HUSKY = $(shell pwd)/bin/husky
.PHONY: husky
husky: ## Download husky locally if necessary.
	$(call go-get-tool,$(HUSKY),github.com/automation-co/husky@v0.2.14)

AIR = $(shell pwd)/bin/air
air: ## Download air locally if necessary.
	$(call go-get-tool,$(AIR),github.com/cosmtrek/air@v1.40.1)

# 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 install $(2) ;\
rm -rf $$TMP_DIR ;\
}
endef