blob: 9b1bc3b0e1d891f34507d5454a00642942c66561 [file] [log] [blame]
Elia Battistonc8d0d462022-02-22 16:30:51 +01001export GOBIN ?= $(shell pwd)/bin
2
3GOLINT = $(GOBIN)/golint
4STATICCHECK = $(GOBIN)/staticcheck
5BENCH_FLAGS ?= -cpuprofile=cpu.pprof -memprofile=mem.pprof -benchmem
6
7# Directories containing independent Go modules.
8#
9# We track coverage only for the main module.
10MODULE_DIRS = . ./benchmarks ./zapgrpc/internal/test
11
12# Many Go tools take file globs or directories as arguments instead of packages.
13GO_FILES := $(shell \
14 find . '(' -path '*/.*' -o -path './vendor' ')' -prune \
15 -o -name '*.go' -print | cut -b3-)
16
17.PHONY: all
18all: lint test
19
20.PHONY: lint
21lint: $(GOLINT) $(STATICCHECK)
22 @rm -rf lint.log
23 @echo "Checking formatting..."
24 @gofmt -d -s $(GO_FILES) 2>&1 | tee lint.log
25 @echo "Checking vet..."
26 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && go vet ./... 2>&1) &&) true | tee -a lint.log
27 @echo "Checking lint..."
28 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && $(GOLINT) ./... 2>&1) &&) true | tee -a lint.log
29 @echo "Checking staticcheck..."
30 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && $(STATICCHECK) ./... 2>&1) &&) true | tee -a lint.log
31 @echo "Checking for unresolved FIXMEs..."
32 @git grep -i fixme | grep -v -e Makefile | tee -a lint.log
33 @echo "Checking for license headers..."
34 @./checklicense.sh | tee -a lint.log
35 @[ ! -s lint.log ]
36 @echo "Checking 'go mod tidy'..."
37 @make tidy
38 @if ! git diff --quiet; then \
39 echo "'go mod tidy' resulted in changes or working tree is dirty:"; \
40 git --no-pager diff; \
41 fi
42
43$(GOLINT):
44 cd tools && go install golang.org/x/lint/golint
45
46$(STATICCHECK):
47 cd tools && go install honnef.co/go/tools/cmd/staticcheck
48
49.PHONY: test
50test:
51 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && go test -race ./...) &&) true
52
53.PHONY: cover
54cover:
55 go test -race -coverprofile=cover.out -coverpkg=./... ./...
56 go tool cover -html=cover.out -o cover.html
57
58.PHONY: bench
59BENCH ?= .
60bench:
61 @$(foreach dir,$(MODULE_DIRS), ( \
62 cd $(dir) && \
63 go list ./... | xargs -n1 go test -bench=$(BENCH) -run="^$$" $(BENCH_FLAGS) \
64 ) &&) true
65
66.PHONY: updatereadme
67updatereadme:
68 rm -f README.md
69 cat .readme.tmpl | go run internal/readme/readme.go > README.md
70
71.PHONY: tidy
72tidy:
73 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && go mod tidy) &&) true