Makefile

MAKEFLAGS+=-j
VERSION:=$$(git log -1 --format='%H')
ALL_SUPPORTED_OS_ARCH:=$(shell go tool dist list -json|jq -r '.[] | select((.FirstClass == true or .GOARCH == "ppc64le") and .GOARCH != "386") | "dist/ec_\(.GOOS)_\(.GOARCH)"')
SHELL=bash
ROOT_DIR:=$(shell dirname $(realpath $(firstword $(MAKEFILE_LIST))))
COPY:="Red Hat, Inc."

##@ Information targets

.PHONY: help
help: ## Display this help.
	@awk 'function ww(s) {\
		if (length(s) < 59) {\
			return s;\
		}\
		else {\
			r="";\
			l="";\
			split(s, arr, " ");\
			for (w in arr) {\
				if (length(l " " arr[w]) > 59) {\
					r=r l "\n                     ";\
					l="";\
				}\
				l=l " " arr[w];\
			}\
			r=r l;\
			return r;\
		}\
	} BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9%/_-]+:.*?##/ { printf "  \033[36m%-18s\033[0m %s\n", "make " $$1, ww($$2) } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

##@ Development targets

.PHONY: $(ALL_SUPPORTED_OS_ARCH)
$(ALL_SUPPORTED_OS_ARCH): ## Build binaries for specific platform/architecture, e.g. make dist/ec_linux_amd64
	@GOOS=$$(echo $(notdir $@) |cut -d'_' -f2); \
	GOARCH=$$(echo $(notdir $@) |cut -d'_' -f3); \
	GOOS=$${GOOS} GOARCH=$${GOARCH} go build -ldflags="-s -w -X github.com/hacbs-contract/ec-cli/cmd.Version=$(VERSION)" -o dist/ec_$${GOOS}_$${GOARCH}; \
	sha256sum -b dist/ec_$${GOOS}_$${GOARCH} > dist/ec_$${GOOS}_$${GOARCH}.sha256

.PHONY: dist
dist: $(ALL_SUPPORTED_OS_ARCH) ## Build binaries for all supported operating systems and architectures

.PHONY: build
build: dist/ec_$(shell go env GOOS)_$(shell go env GOARCH) ## Build the ec binary for the current platform
	@ln -sf ec_$(shell go env GOOS)_$(shell go env GOARCH) dist/ec

.PHONY: docs
docs: ## Generate documentation
	@rm docs/reference/*.yaml
	@go run internal/documentation/documentation.go -yaml docs/reference

.PHONY: website
website: docs ## Render the website
	@cd website
# On GitHub actions we authenticate from the workflow, locally folk must authenticate using:
# https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-with-a-personal-access-token
	@npm clean-install --no-progress
	@npm run render

.PHONY: test
test: ## Run unit tests
# Given the nature of generative tests the test timeout was increased from 500ms
# to 30s to accommodate many samples being generated and test cases being run.
# This is not something we should tolerate for long and we should revert to
# 500ms test deadline with exceptions for long tests.
	@go test -race -covermode=atomic -coverprofile=coverage-unit.out -short -timeout 30s ./...

.ONESHELL:
.SHELLFLAGS=-e -c
.PHONY: acceptance
acceptance: ## Run acceptance tests
	@ACCEPTANCE_WORKDIR="$$(mktemp -d)"
	@function cleanup() {
	  rm -rf "$${ACCEPTANCE_WORKDIR}"
	}
	@trap cleanup EXIT
	@cp -R . "$${ACCEPTANCE_WORKDIR}"
	@cd "$${ACCEPTANCE_WORKDIR}"
	@go run internal/acceptance/coverage/coverage.go .
	@$(MAKE) build
	@export COVERAGE_FILEPATH="$${ACCEPTANCE_WORKDIR}"
	@export COVERAGE_FILENAME="-acceptance"
	@go test ./internal/acceptance
	@go run github.com/wadey/gocovmerge "$${ACCEPTANCE_WORKDIR}"/coverage-acceptance*.out > "$(ROOT_DIR)/coverage-acceptance.out"

LICENSE_IGNORE=-ignore 'docs/reference/*.yaml' -ignore 'website/node_modules/**' -ignore 'website/public/**'
.PHONY: lint
lint: ## Run linter
# addlicense doesn't give us a nice explanation so we prefix it with one
	@go run github.com/google/addlicense -c $(COPY) -s -check $(LICENSE_IGNORE) . | sed 's/^/Missing license header in: /g'
# piping to sed above looses the exit code, luckily addlicense is fast so we invoke it for the second time to exit 1 in case of issues
	@go run github.com/google/addlicense -c $(COPY) -s -check $(LICENSE_IGNORE) . >/dev/null 2>&1
	@go run github.com/golangci/golangci-lint/cmd/golangci-lint run --sort-results $(if $(GITHUB_ACTIONS), --out-format=github-actions --timeout=5m0s)

.PHONY: lint-fix
lint-fix: ## Fix linting issues automagically
	@go run github.com/google/addlicense -c $(COPY) -s -ignore 'docs/reference/*.yaml' .
	@go run github.com/daixiang0/gci write -s standard -s default -s "prefix(github.com/hacbs-contract/ec-cli)" .
	@go run github.com/golangci/golangci-lint/cmd/golangci-lint run --fix

.PHONY: clean
clean: ## Delete build output
	@rm dist/*