Makefile

GOVERSION := $(shell go version | cut -d ' ' -f 3 | cut -d '.' -f 2)

.PHONY: build check fmt lint test test-race vet test-cover-html help install proto
.DEFAULT_GOAL := build
PROTON_COMMIT := "e0c6ae65649c06de6e3dd9af5028ea583a9ed999"

install:
	@echo "Clean up imports..."
	@go mod download
	@go get -d github.com/vektra/mockery/v2@v2.38.0

build: ## build all
	CGO_ENABLED=0 go build -o shield .

generate: ## run all go generate in the code base (including generating mock files)
	@go generate ./...
	@echo " > generating mock files"
	@mockery

lint: ## Run linters
	@golangci-lint run

format:
	@echo "Running gofumpt..."
	@gofumpt -l -w .

# TODO: create separate command for integration tests
test: ## Run tests
	go test -race $(shell go list ./... | grep -v /mocks | grep -v /test/ | grep -v /proto/) -covermode=atomic -coverprofile=coverage.out

e2e-test: ## Run all e2e tests
	go test -v -race ./test/e2e_test/... -covermode=atomic -coverprofile=coverage.out

e2e-smoke-test: ## Run smoke tests
	go test -v -race ./test/e2e_test/smoke -covermode=atomic  -coverprofile=coverage.out

e2e-regression-test: ## Run regression tests
	go test -v -race ./test/e2e_test/regression -covermode=atomic -coverprofile=coverage.out

benchmark: ## Run benchmarks
	go test -run=XX -bench=Benchmark. -count 3 -benchtime=1s github.com/goto/shield/integration

coverage: ## print code coverage
	go test -race -coverprofile coverage.out -covermode=atomic ./... -tags=unit_test && go tool cover -html=coverage.txt

clean :
	rm -rf dist

proto: ## Generate the protobuf files
	@echo " > generating protobuf from goto/proton"
	@echo " > [info] make sure correct version of dependencies are installed using 'make install'"
	@buf generate https://github.com/goto/proton/archive/${PROTON_COMMIT}.zip#strip_components=1 --template buf.gen.yaml --path gotocompany/shield
	@cp -R proto/gotocompany/shield/* proto/ && rm -Rf proto/gotocompany
	@echo " > protobuf compilation finished"

help:
	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

doc: clean-doc ## Generate api and cli documentation
	@echo "> generate cli docs"
	@go run . reference --plain | sed '1 s,.*,# CLI,' > ./docs/docs/reference/cli.md
	@echo ">generate api docs"
	@cd $(CURDIR)/docs/docs; yarn docusaurus clean-api-docs all;  yarn docusaurus gen-api-docs all
	@echo "> format api docs"
	@npx prettier --write $(CURDIR)/docs/docs/apis/*.mdx

doc-build: ## Run documentation locally
	@echo "> building docs"
	@cd $(CURDIR)/docs/docs; yarn start