-
Notifications
You must be signed in to change notification settings - Fork 20
/
Makefile
200 lines (164 loc) · 8.79 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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
# See https://tech.davis-hansson.com/p/make/
SHELL := bash
.DELETE_ON_ERROR:
.SHELLFLAGS := -eu -o pipefail -c
.DEFAULT_GOAL := all
MAKEFLAGS += --warn-undefined-variables
MAKEFLAGS += --no-builtin-rules
MAKEFLAGS += --no-print-directory
BIN ?= $(abspath .tmp/bin)
CACHE := $(abspath .tmp/cache)
COPYRIGHT_YEARS := 2020-2024
LICENSE_IGNORE := -e /testdata/
# Set to use a different compiler. For example, `GO=go1.18rc1 make test`.
GO ?= go
TOOLS_MOD_DIR := ./internal/tools
UNAME_OS := $(shell uname -s)
UNAME_ARCH := $(shell uname -m)
PATH_SEP ?= ":"
PROTOC_VERSION := $(shell cat ./.protoc_version)
# For release candidates, the download artifact has a dash between "rc" and the number even
# though the version tag does not :(
PROTOC_ARTIFACT_VERSION := $(shell echo $(PROTOC_VERSION) | sed -E 's/-rc([0-9]+)$$/-rc-\1/g')
PROTOC_DIR := $(abspath $(CACHE)/protoc/$(PROTOC_VERSION))
PROTOC := $(PROTOC_DIR)/bin/protoc
LOWER_UNAME_OS := $(shell echo $(UNAME_OS) | tr A-Z a-z)
ifeq ($(LOWER_UNAME_OS),darwin)
PROTOC_OS := osx
ifeq ($(UNAME_ARCH),arm64)
PROTOC_ARCH := aarch_64
else
PROTOC_ARCH := x86_64
endif
else
PROTOC_OS := $(LOWER_UNAME_OS)
PROTOC_ARCH := $(UNAME_ARCH)
endif
PROTOC_ARTIFACT_SUFFIX ?= $(PROTOC_OS)-$(PROTOC_ARCH)
.PHONY: help
help: ## Describe useful make targets
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "%-30s %s\n", $$1, $$2}'
.PHONY: all
all: ## Build, test, and lint (default)
$(MAKE) test
$(MAKE) lint
.PHONY: clean
clean: ## Delete intermediate build artifacts
@# -X only removes untracked files, -d recurses into directories, -f actually removes files/dirs
git clean -Xdf
.PHONY: test
test: build ## Run unit tests
$(GO) test -race -cover ./...
$(GO) test -tags protolegacy ./...
cd internal/benchmarks && SKIP_DOWNLOAD_GOOGLEAPIS=true $(GO) test -race -cover ./...
.PHONY: benchmarks
benchmarks: build ## Run benchmarks
cd internal/benchmarks && $(GO) test -bench=. -benchmem -v ./...
.PHONY: build
build: generate ## Build all packages
$(GO) build ./...
.PHONY: install
install: ## Install all binaries
$(GO) install ./...
.PHONY: lint
lint: $(BIN)/golangci-lint ## Lint Go
$(GO) vet ./... ./internal/benchmarks/...
$(BIN)/golangci-lint run
cd internal/benchmarks && $(BIN)/golangci-lint run
.PHONY: lintfix
lintfix: $(BIN)/golangci-lint ## Automatically fix some lint errors
$(BIN)/golangci-lint run --fix
cd internal/benchmarks && $(BIN)/golangci-lint run --fix
.PHONY: generate
generate: $(BIN)/license-header $(BIN)/goyacc test-descriptors ext-features-descriptors ## Regenerate code and licenses
PATH="$(BIN)$(PATH_SEP)$(PATH)" $(GO) generate ./...
@# We want to operate on a list of modified and new files, excluding
@# deleted and ignored files. git-ls-files can't do this alone. comm -23 takes
@# two files and prints the union, dropping lines common to both (-3) and
@# those only in the second file (-2). We make one git-ls-files call for
@# the modified, cached, and new (--others) files, and a second for the
@# deleted files.
comm -23 \
<(git ls-files --cached --modified --others --no-empty-directory --exclude-standard | sort -u | grep -v $(LICENSE_IGNORE) ) \
<(git ls-files --deleted | sort -u) | \
xargs $(BIN)/license-header \
--license-type apache \
--copyright-holder "Buf Technologies, Inc." \
--year-range "$(COPYRIGHT_YEARS)"
.PHONY: upgrade
upgrade: ## Upgrade dependencies
go get -u -t ./... && go mod tidy -v
.PHONY: checkgenerate
checkgenerate:
@# Used in CI to verify that `make generate` doesn't produce a diff.
test -z "$$(git status --porcelain | tee /dev/stderr)"
$(BIN)/license-header: internal/tools/go.mod internal/tools/go.sum
@mkdir -p $(@D)
cd $(TOOLS_MOD_DIR) && \
GOWORK=off $(GO) build -o $@ github.com/bufbuild/buf/private/pkg/licenseheader/cmd/license-header
$(BIN)/golangci-lint: internal/tools/go.mod internal/tools/go.sum
@mkdir -p $(@D)
cd $(TOOLS_MOD_DIR) && \
GOWORK=off $(GO) build -o $@ github.com/golangci/golangci-lint/cmd/golangci-lint
$(BIN)/goyacc: internal/tools/go.mod internal/tools/go.sum
@mkdir -p $(@D)
cd $(TOOLS_MOD_DIR) && \
GOWORK=off $(GO) build -o $@ golang.org/x/tools/cmd/goyacc
$(CACHE)/protoc-$(PROTOC_VERSION).zip:
@mkdir -p $(@D)
curl -o $@ -fsSL https://github.com/protocolbuffers/protobuf/releases/download/v$(PROTOC_VERSION)/protoc-$(PROTOC_ARTIFACT_VERSION)-$(PROTOC_ARTIFACT_SUFFIX).zip
.PHONY: protoc
protoc: $(PROTOC)
$(PROTOC): $(CACHE)/protoc-$(PROTOC_VERSION).zip
@mkdir -p $(@D)
unzip -o -q $< -d $(PROTOC_DIR) && \
touch $@
.PHONY: wellknownimports
wellknownimports: $(PROTOC) $(sort $(wildcard $(PROTOC_DIR)/include/google/protobuf/*.proto)) $(sort $(wildcard $(PROTOC_DIR)/include/google/protobuf/*/*.proto))
@rm -rf wellknownimports/google 2>/dev/null && true
@mkdir -p wellknownimports/google/protobuf/compiler
cp -R $(PROTOC_DIR)/include/google/protobuf/*.proto wellknownimports/google/protobuf
cp -R $(PROTOC_DIR)/include/google/protobuf/compiler/*.proto wellknownimports/google/protobuf/compiler
internal/testdata/all.protoset: $(PROTOC) $(sort $(wildcard internal/testdata/*.proto))
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/desc_test_complex.protoset: $(PROTOC) internal/testdata/desc_test_complex.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/desc_test_defaults.protoset: $(PROTOC) internal/testdata/desc_test_defaults.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/desc_test_proto3_optional.protoset: $(PROTOC) internal/testdata/desc_test_proto3_optional.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/descriptor_impl_tests.protoset: $(PROTOC) internal/testdata/desc_test2.proto internal/testdata/desc_test_complex.proto internal/testdata/desc_test_defaults.proto internal/testdata/desc_test_proto3.proto internal/testdata/desc_test_proto3_optional.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/descriptor_editions_impl_tests.protoset: $(PROTOC) internal/testdata/editions/all_default_features.proto internal/testdata/editions/features_with_overrides.proto internal/testdata/editions/file_default_delimited.proto
cd $(@D)/editions && $(PROTOC) --descriptor_set_out=../$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/editions/all.protoset: $(PROTOC) $(sort $(wildcard internal/testdata/editions/*.proto))
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_imports -I. $(filter-out protoc,$(^F))
internal/testdata/source_info.protoset: $(PROTOC) internal/testdata/desc_test_options.proto internal/testdata/desc_test_comments.proto internal/testdata/desc_test_complex.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) --include_source_info -I. $(filter-out protoc,$(^F))
internal/testdata/options/options.protoset: $(PROTOC) internal/testdata/options/options.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) -I. $(filter-out protoc,$(^F))
internal/testdata/options/test.protoset: $(PROTOC) internal/testdata/options/test.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) -I. $(filter-out protoc,$(^F))
internal/testdata/options/test_proto3.protoset: $(PROTOC) internal/testdata/options/test_proto3.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) -I. $(filter-out protoc,$(^F))
internal/testdata/options/test_editions.protoset: $(PROTOC) internal/testdata/options/test_editions.proto
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) -I. $(filter-out protoc,$(^F))
.PHONY: test-descriptors
test-descriptors: internal/testdata/all.protoset
test-descriptors: internal/testdata/desc_test_complex.protoset
test-descriptors: internal/testdata/desc_test_defaults.protoset
test-descriptors: internal/testdata/desc_test_proto3_optional.protoset
test-descriptors: internal/testdata/descriptor_impl_tests.protoset
test-descriptors: internal/testdata/descriptor_editions_impl_tests.protoset
test-descriptors: internal/testdata/editions/all.protoset
test-descriptors: internal/testdata/source_info.protoset
test-descriptors: internal/testdata/options/options.protoset
test-descriptors: internal/testdata/options/test.protoset
test-descriptors: internal/testdata/options/test_proto3.protoset
test-descriptors: internal/testdata/options/test_editions.protoset
internal/featuresext/cpp_features.protoset: $(PROTOC)
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) google/protobuf/cpp_features.proto
internal/featuresext/java_features.protoset: $(PROTOC)
cd $(@D) && $(PROTOC) --descriptor_set_out=$(@F) google/protobuf/java_features.proto
.PHONY: ext-features-descriptors
ext-features-descriptors: internal/featuresext/cpp_features.protoset internal/featuresext/java_features.protoset