forked from grafana/dskit
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
98 lines (78 loc) · 4.14 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# put tools at the root of the folder
PATH := $(CURDIR)/.tools/bin:$(PATH)
# We don't want find to scan inside a bunch of directories
DONT_FIND := -name vendor -prune -o -name .git -prune -o -name .cache -prune -o -name .tools -prune -o
# Generating proto code is automated.
PROTO_DEFS := $(shell find . $(DONT_FIND) -type f -name '*.proto' -print)
PROTO_GOS := $(patsubst %.proto,%.pb.go,$(PROTO_DEFS))
# Download the proper protoc version for Darwin (osx) and Linux.
# If you need windows for some reason it's at https://github.com/protocolbuffers/protobuf/releases/download/v3.6.1/protoc-3.6.1-win32.zip
UNAME_S := $(shell uname -s)
PROTO_PATH := https://github.com/protocolbuffers/protobuf/releases/download/v3.6.1/
ifeq ($(UNAME_S), Linux)
PROTO_ZIP=protoc-3.6.1-linux-x86_64.zip
endif
ifeq ($(UNAME_S), Darwin)
PROTO_ZIP=protoc-3.6.1-osx-x86_64.zip
endif
GO_MODS=$(shell find . $(DONT_FIND) -type f -name 'go.mod' -print)
.DEFAULT_GOAL := help
.PHONY: help
help: ## Display this help and any documented user-facing targets. Other undocumented targets may be present in the Makefile.
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make <target>\n\nTargets:\n"} /^[a-zA-Z_-]+:.*?##/ { printf " %-50s %s\n", $$1, $$2 } /^##@/ { printf "\n%s\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
.PHONY: test
test: ## Runs Go tests
go test -tags netgo -timeout 30m -race -count 1 ./...
.PHONY: test-benchmarks
test-benchmarks: ## Runs Go benchmarks with 1 iteration to make sure they still make sense
go test -tags netgo -run=NONE -bench=. -benchtime=1x -timeout 30m ./...
.PHONY: lint
lint: .tools/bin/misspell .tools/bin/faillint .tools/bin/golangci-lint ## Runs misspell, golangci-lint, and faillint
misspell -error README.md CONTRIBUTING.md LICENSE
# Configured via .golangci.yml.
golangci-lint run
# Ensure no blocklisted package is imported.
faillint -paths "github.com/bmizerany/assert=github.com/stretchr/testify/assert,\
golang.org/x/net/context=context,\
sync/atomic=go.uber.org/atomic,\
github.com/go-kit/kit/log, \
github.com/prometheus/client_golang/prometheus.{MustRegister}=github.com/prometheus/client_golang/prometheus/promauto,\
github.com/prometheus/client_golang/prometheus.{NewCounter,NewCounterVec,NewGauge,NewGaugeVec,NewGaugeFunc,NewHistogram,NewHistogramVec,NewSummary,NewSummaryVec}\
=github.com/prometheus/client_golang/prometheus/promauto.With.{NewCounter,NewCounterVec,NewGauge,NewGaugeVec,NewGaugeFunc,NewHistogram,NewHistogramVec,NewSummary,NewSummaryVec}"\
./...
.PHONY: clean
clean: ## Removes the .tools/ directory
@# go mod makes the modules read-only, so before deletion we need to make them deleteable
@chmod -R u+rwX .tools 2> /dev/null || true
rm -rf .tools/
.PHONY: mod-check
mod-check: ## Git diffs the go mod files
@./.scripts/mod-check.sh $(GO_MODS)
.PHONY: clean-protos
clean-protos: ## Removes the proto files
rm -rf $(PROTO_GOS)
.PHONY: protos
protos: .tools/bin/protoc .tools/bin/protoc-gen-gogoslick .tools/bin/protoc-gen-go $(PROTO_GOS) ## Creates proto files
%.pb.go:
.tools/protoc/bin/protoc -I $(GOPATH):./vendor/github.com/gogo/protobuf:./vendor:./$(@D) --gogoslick_out=plugins=grpc,Mgoogle/protobuf/any.proto=github.com/gogo/protobuf/types,:./$(@D) ./$(patsubst %.pb.go,%.proto,$@)
.PHONY: check-protos
check-protos: clean-protos protos ## Re-generates protos and git diffs them
@git diff --exit-code -- $(PROTO_GOS)
.tools:
mkdir -p .tools/
.tools/bin/misspell: .tools
GOPATH=$(CURDIR)/.tools go install github.com/client9/misspell/cmd/[email protected]
.tools/bin/faillint: .tools
GOPATH=$(CURDIR)/.tools go install github.com/fatih/[email protected]
.tools/bin/golangci-lint: .tools
GOPATH=$(CURDIR)/.tools go install github.com/golangci/golangci-lint/cmd/[email protected]
.tools/bin/protoc: .tools
ifeq ("$(wildcard .tools/protoc/bin/protoc)","")
mkdir -p .tools/protoc
cd .tools/protoc && curl -LO $(PROTO_PATH)$(PROTO_ZIP)
unzip -n .tools/protoc/$(PROTO_ZIP) -d .tools/protoc/
endif
.tools/bin/protoc-gen-gogoslick: .tools
GOPATH=$(CURDIR)/.tools go install github.com/gogo/protobuf/[email protected]
.tools/bin/protoc-gen-go: .tools
GOPATH=$(CURDIR)/.tools go install github.com/golang/protobuf/[email protected]