Makefile

SHELL=/bin/sh
GOPATH ?= $(shell go env GOPATH)
PKGS = $(shell go list ./... | grep -v examples | grep -v ruletest)
LINTER = $(GOPATH)/bin/golangci-lint
ACT_BIN = $(GOPATH)/bin/act
TPARSE_BIN = $(GOPATH)/bin/tparse

help:
	@cat $(MAKEFILE_LIST) | docker run --rm --platform linux/amd64 -i xanders/make-help

# Execute all meaningful jobs from Makefile to release the project's binary
all: test lint

# Run tests
test: $(TPARSE_BIN)
	@go test $(PKGS) -v -json -race -buildvcs -cover -coverprofile=coverage.out | $(TPARSE_BIN) -pass

# Run benchmarks of source code
bench:
	@go test $(PKGS) -v -race -buildvcs -bench=. -benchmem -cpu=1,2,4,12

# Run lint
lint: $(LINTER)
	@$(LINTER) run ./... --timeout 10m

$(LINTER):
	@echo "==> Installing linter..."
	@curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/d302a302c93198df24e842a29f6ddebb5f4cb3dd/install.sh | sh -s -- -b ${GOPATH}/bin v1.60.3

# This jobs is to simulate github ci environment for tests github action workflows
act: $(ACT_BIN)
	$(ACT_BIN) --container-architecture linux/amd64 --platform ubuntu-latest=node:buster --rm

$(ACT_BIN):
	@echo "==> Installing act..."
	@curl -sSfL https://raw.githubusercontent.com/nektos/act/38e43bd51f66493057857f6d743153c874a7178f/install.sh | sh -s -- -b ${GOPATH}/bin

# It's a great job to take a look to source code coverage using a friendly view
cover-html: test
	@go tool cover -html=coverage.out

$(TPARSE_BIN):
	@echo "==> Installing tparse..."
	@go install github.com/mfridman/tparse@latest

.PHONY: all build test bench lint act cover-html help