TARGET := $(shell basename `pwd`) SRC = $(shell find . -type f -name '*.go' -not -path "./vendor/*") GO := go BIN := ./bin PRE_COMMIT = $(shell command -v bin/venv/bin/pre-commit ~/.local/bin/pre-commit pre-commit | head -n1) PKG_MANAGER ?= $(shell command -v dnf yum|head -n1) GINKO_CLI_VERSION = $(shell grep 'ginkgo/v2' go.mod | grep -o ' v.*' | sed 's/ //g' | sed 's|//indirect||g') COVERAGE_PATH ?= .coverage #================================================= # Required tools installation tartgets #================================================= .PHONY: install.tools install.tools: .install.pre-commit .install.codespell .install.golangci-lint .install.ginkgo ## Install needed tools .PHONY: .install.codespell .install.codespell: sudo ${PKG_MANAGER} -y install codespell .PHONY: .install.ginkgo .install.ginkgo: if [ ! -x "$(GOBIN)/ginkgo" ]; then \ $(GO) install -mod=mod github.com/onsi/ginkgo/v2/ginkgo@$(GINKO_CLI_VERSION) ; \ fi .PHONY: .install.pre-commit .install.pre-commit: if [ -z "$(PRE_COMMIT)" ]; then \ python3 -m pip install --user pre-commit; \ fi .PHONY: .install.golangci-lint .install.golangci-lint: VERSION=1.56.2 ./hack/install_golangci.sh #================================================= # Testing (units, functionality, ...) targets #================================================= .PHONY: test test: test-unit .PHONY: test-unit test-unit: ## Run unit tests rm -rf ${COVERAGE_PATH} && mkdir -p ${COVERAGE_PATH} $(GOBIN)/ginkgo \ -r \ --skip-package test/ \ --cover \ --covermode atomic \ --coverprofile coverprofile \ --output-dir ${COVERAGE_PATH} \ --succinct $(GO) tool cover -html=${COVERAGE_PATH}/coverprofile -o ${COVERAGE_PATH}/coverage.html $(GO) tool cover -func=${COVERAGE_PATH}/coverprofile > ${COVERAGE_PATH}/functions cat ${COVERAGE_PATH}/functions | sed -n 's/\(total:\).*\([0-9][0-9].[0-9]\)/\1 \2/p' #================================================= # Linting/Formatting/Code Validation targets #================================================= .PHONY: validate validate: gofmt lint govet pre-commit codespell ## Validate prometheus-podman-exporter code (fmt, lint, ...) .PHONY: lint lint: ## Run golangci-lint @echo "running golangci-lint" $(BIN)/golangci-lint run .PHONY: pre-commit pre-commit: ## Run pre-commit ifeq ($(PRE_COMMIT),) @echo "FATAL: pre-commit was not found, make .install.pre-commit to installing it." >&2 @exit 2 endif $(PRE_COMMIT) run -a .PHONY: gofmt gofmt: ## Run gofmt @echo -e "gofmt check and fix" @gofmt -w $(SRC) .PHONY: govet govet: ## Run govet @echo "running go vet" @go vet ../$(TARGET) .PHONY: codespell codespell: ## Run codespell @echo "running codespell" @codespell -S ./vendor,go.mod,go.sum,./.git,*_test.go #================================================= # Help menu #================================================= _HLP_TGTS_RX = '^[[:print:]]+:.*?\#\# .*$$' _HLP_TGTS_CMD = grep -E $(_HLP_TGTS_RX) $(MAKEFILE_LIST) _HLP_TGTS_LEN = $(shell $(_HLP_TGTS_CMD) | cut -d : -f 1 | wc -L) _HLPFMT = "%-$(_HLP_TGTS_LEN)s %s\n" .PHONY: help help: ## Print listing of key targets with their descriptions @printf $(_HLPFMT) "Target:" "Description:" @printf $(_HLPFMT) "--------------" "--------------------" @$(_HLP_TGTS_CMD) | sort | \ awk 'BEGIN {FS = ":(.*)?## "}; \ {printf $(_HLPFMT), $$1, $$2}'