blob: 1b1376d42533e20a475796849cb0029d8bcb4fc6 [file] [log] [blame]
David K. Bainbridge06631892021-08-19 13:07:00 +00001# Directory to place `go install`ed binaries into.
2export GOBIN ?= $(shell pwd)/bin
Matteo Scandoloa4285862020-12-01 18:10:10 -08003
David K. Bainbridge06631892021-08-19 13:07:00 +00004GOLINT = $(GOBIN)/golint
5GEN_ATOMICINT = $(GOBIN)/gen-atomicint
6GEN_ATOMICWRAPPER = $(GOBIN)/gen-atomicwrapper
7STATICCHECK = $(GOBIN)/staticcheck
Matteo Scandoloa4285862020-12-01 18:10:10 -08008
David K. Bainbridge06631892021-08-19 13:07:00 +00009GO_FILES ?= $(shell find . '(' -path .git -o -path vendor ')' -prune -o -name '*.go' -print)
10
11# Also update ignore section in .codecov.yml.
12COVER_IGNORE_PKGS = \
13 go.uber.org/atomic/internal/gen-atomicint \
14 go.uber.org/atomic/internal/gen-atomicwrapper
Matteo Scandoloa4285862020-12-01 18:10:10 -080015
16.PHONY: build
17build:
David K. Bainbridge06631892021-08-19 13:07:00 +000018 go build ./...
Matteo Scandoloa4285862020-12-01 18:10:10 -080019
20.PHONY: test
21test:
David K. Bainbridge06631892021-08-19 13:07:00 +000022 go test -race ./...
Matteo Scandoloa4285862020-12-01 18:10:10 -080023
David K. Bainbridge06631892021-08-19 13:07:00 +000024.PHONY: gofmt
25gofmt:
26 $(eval FMT_LOG := $(shell mktemp -t gofmt.XXXXX))
27 gofmt -e -s -l $(GO_FILES) > $(FMT_LOG) || true
28 @[ ! -s "$(FMT_LOG)" ] || (echo "gofmt failed:" && cat $(FMT_LOG) && false)
Matteo Scandoloa4285862020-12-01 18:10:10 -080029
David K. Bainbridge06631892021-08-19 13:07:00 +000030$(GOLINT):
31 cd tools && go install golang.org/x/lint/golint
Matteo Scandoloa4285862020-12-01 18:10:10 -080032
David K. Bainbridge06631892021-08-19 13:07:00 +000033$(STATICCHECK):
34 cd tools && go install honnef.co/go/tools/cmd/staticcheck
Matteo Scandoloa4285862020-12-01 18:10:10 -080035
David K. Bainbridge06631892021-08-19 13:07:00 +000036$(GEN_ATOMICWRAPPER): $(wildcard ./internal/gen-atomicwrapper/*)
37 go build -o $@ ./internal/gen-atomicwrapper
38
39$(GEN_ATOMICINT): $(wildcard ./internal/gen-atomicint/*)
40 go build -o $@ ./internal/gen-atomicint
41
42.PHONY: golint
43golint: $(GOLINT)
44 $(GOLINT) ./...
45
46.PHONY: staticcheck
47staticcheck: $(STATICCHECK)
48 $(STATICCHECK) ./...
Matteo Scandoloa4285862020-12-01 18:10:10 -080049
50.PHONY: lint
David K. Bainbridge06631892021-08-19 13:07:00 +000051lint: gofmt golint staticcheck generatenodirty
Matteo Scandoloa4285862020-12-01 18:10:10 -080052
David K. Bainbridge06631892021-08-19 13:07:00 +000053# comma separated list of packages to consider for code coverage.
54COVER_PKG = $(shell \
55 go list -find ./... | \
56 grep -v $(foreach pkg,$(COVER_IGNORE_PKGS),-e "^$(pkg)$$") | \
57 paste -sd, -)
Matteo Scandoloa4285862020-12-01 18:10:10 -080058
David K. Bainbridge06631892021-08-19 13:07:00 +000059.PHONY: cover
60cover:
61 go test -coverprofile=cover.out -coverpkg $(COVER_PKG) -v ./...
62 go tool cover -html=cover.out -o cover.html
63
64.PHONY: generate
65generate: $(GEN_ATOMICINT) $(GEN_ATOMICWRAPPER)
66 go generate ./...
67
68.PHONY: generatenodirty
69generatenodirty:
70 @[ -z "$$(git status --porcelain)" ] || ( \
71 echo "Working tree is dirty. Commit your changes first."; \
72 exit 1 )
73 @make generate
74 @status=$$(git status --porcelain); \
75 [ -z "$$status" ] || ( \
76 echo "Working tree is dirty after `make generate`:"; \
77 echo "$$status"; \
78 echo "Please ensure that the generated code is up-to-date." )