blob: 9b1bc3b0e1d891f34507d5454a00642942c66561 [file] [log] [blame]
khenaidoo7d3c5582021-08-11 18:09:44 -04001export GOBIN ?= $(shell pwd)/bin
Holger Hildebrandtfa074992020-03-27 15:42:06 +00002
khenaidoo7d3c5582021-08-11 18:09:44 -04003GOLINT = $(GOBIN)/golint
4STATICCHECK = $(GOBIN)/staticcheck
Holger Hildebrandtfa074992020-03-27 15:42:06 +00005BENCH_FLAGS ?= -cpuprofile=cpu.pprof -memprofile=mem.pprof -benchmem
khenaidoo7d3c5582021-08-11 18:09:44 -04006
7# Directories containing independent Go modules.
8#
9# We track coverage only for the main module.
10MODULE_DIRS = . ./benchmarks ./zapgrpc/internal/test
11
Holger Hildebrandtfa074992020-03-27 15:42:06 +000012# Many Go tools take file globs or directories as arguments instead of packages.
khenaidoo7d3c5582021-08-11 18:09:44 -040013GO_FILES := $(shell \
14 find . '(' -path '*/.*' -o -path './vendor' ')' -prune \
15 -o -name '*.go' -print | cut -b3-)
Holger Hildebrandtfa074992020-03-27 15:42:06 +000016
17.PHONY: all
18all: lint test
19
Holger Hildebrandtfa074992020-03-27 15:42:06 +000020.PHONY: lint
khenaidoo7d3c5582021-08-11 18:09:44 -040021lint: $(GOLINT) $(STATICCHECK)
Holger Hildebrandtfa074992020-03-27 15:42:06 +000022 @rm -rf lint.log
23 @echo "Checking formatting..."
khenaidoo7d3c5582021-08-11 18:09:44 -040024 @gofmt -d -s $(GO_FILES) 2>&1 | tee lint.log
Holger Hildebrandtfa074992020-03-27 15:42:06 +000025 @echo "Checking vet..."
khenaidoo7d3c5582021-08-11 18:09:44 -040026 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && go vet ./... 2>&1) &&) true | tee -a lint.log
Holger Hildebrandtfa074992020-03-27 15:42:06 +000027 @echo "Checking lint..."
khenaidoo7d3c5582021-08-11 18:09:44 -040028 @$(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
Holger Hildebrandtfa074992020-03-27 15:42:06 +000031 @echo "Checking for unresolved FIXMEs..."
khenaidoo7d3c5582021-08-11 18:09:44 -040032 @git grep -i fixme | grep -v -e Makefile | tee -a lint.log
Holger Hildebrandtfa074992020-03-27 15:42:06 +000033 @echo "Checking for license headers..."
khenaidoo7d3c5582021-08-11 18:09:44 -040034 @./checklicense.sh | tee -a lint.log
Holger Hildebrandtfa074992020-03-27 15:42:06 +000035 @[ ! -s lint.log ]
khenaidoo7d3c5582021-08-11 18:09:44 -040036 @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
Holger Hildebrandtfa074992020-03-27 15:42:06 +000048
49.PHONY: test
50test:
khenaidoo7d3c5582021-08-11 18:09:44 -040051 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && go test -race ./...) &&) true
Holger Hildebrandtfa074992020-03-27 15:42:06 +000052
53.PHONY: cover
54cover:
khenaidoo7d3c5582021-08-11 18:09:44 -040055 go test -race -coverprofile=cover.out -coverpkg=./... ./...
56 go tool cover -html=cover.out -o cover.html
Holger Hildebrandtfa074992020-03-27 15:42:06 +000057
58.PHONY: bench
59BENCH ?= .
60bench:
khenaidoo7d3c5582021-08-11 18:09:44 -040061 @$(foreach dir,$(MODULE_DIRS), ( \
62 cd $(dir) && \
63 go list ./... | xargs -n1 go test -bench=$(BENCH) -run="^$$" $(BENCH_FLAGS) \
64 ) &&) true
Holger Hildebrandtfa074992020-03-27 15:42:06 +000065
66.PHONY: updatereadme
67updatereadme:
68 rm -f README.md
69 cat .readme.tmpl | go run internal/readme/readme.go > README.md
khenaidoo7d3c5582021-08-11 18:09:44 -040070
71.PHONY: tidy
72tidy:
73 @$(foreach dir,$(MODULE_DIRS),(cd $(dir) && go mod tidy) &&) true