Makefile

# renovate: datasource=docker depName=golangci/golangci-lint
GOLANGCI_LINT_VERSION = v2.5.0
.DEFAULT_GOAL := help

.PHONY: help
help: Makefile ## Display this help
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "; printf "Usage:\n\n    make \033[36m<target>\033[0m [VARIABLE=value...]\n\nTargets:\n\n"}; {printf "    \033[36m%-30s\033[0m %s\n", $$1, $$2}'
	@grep -E '^(override )?[a-zA-Z_-]+ \??\+?= .*?## .*$$' $< | sort | awk 'BEGIN {FS = " \\??\\+?= .*?## "; printf "\nVariables:\n\n"}; {gsub(/override /, "", $$1); printf "    \033[36m%-30s\033[0m %s\n", $$1, $$2}'

.PHONY: unit-test
unit-test:
	go test ./pkg/... -race -shuffle=on -coverprofile=cover.out -covermode=atomic
	go tool cover -html=cover.out -o cover.html
	go test -tags generator ./cmd/generator/... -race -shuffle=on -coverprofile=generator-cover.out
	go tool cover -html=generator-cover.out -o generator-cover.html

.PHONY: clean-go-cache
clean-go-cache: ## Clean go cache
	@go clean -modcache

.PHONY: deps
deps: ## Add missing and remove unused modules, verify deps and download them to local cache
	@go mod tidy && go mod verify && go mod download

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

.PHONY: vet
vet: ## Run go vet against code
	go vet ./...

.PHONY: lint
lint: ## Run golangci-lint against code
	docker run --pull always --rm -v $(shell pwd):/telemetry-exporter -w /telemetry-exporter -v $(shell go env GOCACHE):/cache/go -e GOCACHE=/cache/go -e GOLANGCI_LINT_CACHE=/cache/go -v $(shell go env GOPATH)/pkg:/go/pkg golangci/golangci-lint:$(GOLANGCI_LINT_VERSION) golangci-lint --color always run

.PHONY: dev-all
dev-all: deps fmt vet lint unit-test ## Run all the development checks

.PHONY: generate
generate: ## Run go generate
	go generate ./...
	go generate -tags generator ./cmd/generator/...

.PHONY: generator-tests
generator-tests: ## Regenerate the generator generated files and run generator unit tests
	go generate -tags generator ./cmd/generator/... # ensure the generated files generated by the generator are up to date
	go test -tags generator ./cmd/generator/... -race -shuffle=on -coverprofile=generator-cover.out

.PHONY: functional-test
functional-test: ## Run functional tests
	go run github.com/onsi/ginkgo/v2/ginkgo --randomize-all --randomize-suites --race --keep-going --fail-on-pending --trace --covermode=atomic --coverprofile=functional-cover.out --force-newlines -p -v -r tests