forked from gardener/gardener
-
Notifications
You must be signed in to change notification settings - Fork 0
/
tools.mk
206 lines (168 loc) · 10.2 KB
/
tools.mk
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
201
202
203
204
205
206
# Copyright 2021 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# This make file is supposed to be included in the top-level make file.
# It can be reused by repos vendoring g/g to have some common make recipes for building and installing development
# tools as needed.
# Recipes in the top-level make file should declare dependencies on the respective tool recipes (e.g. $(CONTROLLER_GEN))
# as needed. If the required tool (version) is not built/installed yet, make will make sure to build/install it.
# The *_VERSION variables in this file contain the "default" values, but can be overwritten in the top level make file.
ifeq ($(strip $(shell go list -m 2>/dev/null)),github.com/gardener/gardener)
TOOLS_PKG_PATH := ./hack/tools
else
# dependency on github.com/gardener/gardener/hack/tools is optional and only needed if other projects want to reuse
# install-promtool.sh, logcheck, or gomegacheck. If they don't use it and the project doesn't depend on the package,
# silence the error to minimize confusion.
TOOLS_PKG_PATH := $(shell go list -tags tools -f '{{ .Dir }}' github.com/gardener/gardener/hack/tools 2>/dev/null)
endif
TOOLS_BIN_DIR := $(TOOLS_DIR)/bin
CONTROLLER_GEN := $(TOOLS_BIN_DIR)/controller-gen
DOCFORGE := $(TOOLS_BIN_DIR)/docforge
GEN_CRD_API_REFERENCE_DOCS := $(TOOLS_BIN_DIR)/gen-crd-api-reference-docs
GINKGO := $(TOOLS_BIN_DIR)/ginkgo
GOIMPORTS := $(TOOLS_BIN_DIR)/goimports
GOIMPORTSREVISER := $(TOOLS_BIN_DIR)/goimports-reviser
GOLANGCI_LINT := $(TOOLS_BIN_DIR)/golangci-lint
GOMEGACHECK := $(TOOLS_BIN_DIR)/gomegacheck.so # plugin binary
GO_ADD_LICENSE := $(TOOLS_BIN_DIR)/addlicense
GO_APIDIFF := $(TOOLS_BIN_DIR)/go-apidiff
GO_VULN_CHECK := $(TOOLS_BIN_DIR)/govulncheck
GO_TO_PROTOBUF := $(TOOLS_BIN_DIR)/go-to-protobuf
HELM := $(TOOLS_BIN_DIR)/helm
IMPORT_BOSS := $(TOOLS_BIN_DIR)/import-boss
KIND := $(TOOLS_BIN_DIR)/kind
KUBECTL := $(TOOLS_BIN_DIR)/kubectl
LOGCHECK := $(TOOLS_BIN_DIR)/logcheck.so # plugin binary
MOCKGEN := $(TOOLS_BIN_DIR)/mockgen
OPENAPI_GEN := $(TOOLS_BIN_DIR)/openapi-gen
PROMTOOL := $(TOOLS_BIN_DIR)/promtool
PROTOC := $(TOOLS_BIN_DIR)/protoc
PROTOC_GEN_GOGO := $(TOOLS_BIN_DIR)/protoc-gen-gogo
REPORT_COLLECTOR := $(TOOLS_BIN_DIR)/report-collector
SETUP_ENVTEST := $(TOOLS_BIN_DIR)/setup-envtest
SKAFFOLD := $(TOOLS_BIN_DIR)/skaffold
YAML2JSON := $(TOOLS_BIN_DIR)/yaml2json
YQ := $(TOOLS_BIN_DIR)/yq
# default tool versions
DOCFORGE_VERSION ?= v0.33.0
GOLANGCI_LINT_VERSION ?= v1.54.1
GO_APIDIFF_VERSION ?= v0.5.0
GO_ADD_LICENSE_VERSION ?= v1.1.1
GOIMPORTSREVISER_VERSION ?= v3.4.0
GO_VULN_CHECK_VERSION ?= latest
HELM_VERSION ?= v3.11.2
KIND_VERSION ?= v0.18.0
KUBECTL_VERSION ?= v1.24.11
PROTOC_VERSION ?= 23.4
SKAFFOLD_VERSION ?= v2.2.0
YQ_VERSION ?= v4.31.2
export TOOLS_BIN_DIR := $(TOOLS_BIN_DIR)
export PATH := $(abspath $(TOOLS_BIN_DIR)):$(PATH)
#########################################
# Common #
#########################################
# Tool targets should declare go.mod as a prerequisite, if the tool's version is managed via go modules. This causes
# make to rebuild the tool in the desired version, when go.mod is changed.
# For tools where the version is not managed via go.mod, we use a file per tool and version as an indicator for make
# whether we need to install the tool or a different version of the tool (make doesn't rerun the rule if the rule is
# changed).
# Use this "function" to add the version file as a prerequisite for the tool target: e.g.
# $(HELM): $(call tool_version_file,$(HELM),$(HELM_VERSION))
tool_version_file = $(TOOLS_BIN_DIR)/.version_$(subst $(TOOLS_BIN_DIR)/,,$(1))_$(2)
# This target cleans up any previous version files for the given tool and creates the given version file.
# This way, we can generically determine, which version was installed without calling each and every binary explicitly.
$(TOOLS_BIN_DIR)/.version_%:
@version_file=$@; rm -f $${version_file%_*}*
@touch $@
.PHONY: clean-tools-bin
clean-tools-bin:
rm -rf $(TOOLS_BIN_DIR)/*
#########################################
# Tools #
#########################################
$(CONTROLLER_GEN): go.mod
go build -o $(CONTROLLER_GEN) sigs.k8s.io/controller-tools/cmd/controller-gen
$(DOCFORGE): $(call tool_version_file,$(DOCFORGE),$(DOCFORGE_VERSION))
curl -L -o $(DOCFORGE) https://github.com/gardener/docforge/releases/download/$(DOCFORGE_VERSION)/docforge-$(shell uname -s | tr '[:upper:]' '[:lower:]')-$(shell uname -m | sed 's/x86_64/amd64/')
chmod +x $(DOCFORGE)
$(GEN_CRD_API_REFERENCE_DOCS): go.mod
go build -o $(GEN_CRD_API_REFERENCE_DOCS) github.com/ahmetb/gen-crd-api-reference-docs
$(GINKGO): go.mod
go build -o $(GINKGO) github.com/onsi/ginkgo/v2/ginkgo
$(GOIMPORTS): go.mod
go build -o $(GOIMPORTS) golang.org/x/tools/cmd/goimports
$(GOIMPORTSREVISER): $(call tool_version_file,$(GOIMPORTSREVISER),$(GOIMPORTSREVISER_VERSION))
GOBIN=$(abspath $(TOOLS_BIN_DIR)) go install github.com/incu6us/goimports-reviser/v3@$(GOIMPORTSREVISER_VERSION)
$(GOLANGCI_LINT): $(call tool_version_file,$(GOLANGCI_LINT),$(GOLANGCI_LINT_VERSION))
@# CGO_ENABLED has to be set to 1 in order for golangci-lint to be able to load plugins
@# see https://github.com/golangci/golangci-lint/issues/1276
GOBIN=$(abspath $(TOOLS_BIN_DIR)) CGO_ENABLED=1 go install github.com/golangci/golangci-lint/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)
ifeq ($(strip $(shell go list -m 2>/dev/null)),github.com/gardener/gardener)
$(GOMEGACHECK): $(TOOLS_PKG_PATH)/gomegacheck/go.* $(shell find $(TOOLS_PKG_PATH)/gomegacheck -type f -name '*.go')
cd $(TOOLS_PKG_PATH)/gomegacheck; CGO_ENABLED=1 go build -o $(abspath $(GOMEGACHECK)) -buildmode=plugin ./plugin
else
$(GOMEGACHECK): go.mod
CGO_ENABLED=1 go build -o $(GOMEGACHECK) -buildmode=plugin github.com/gardener/gardener/hack/tools/gomegacheck/plugin
endif
$(GO_ADD_LICENSE):
GOBIN=$(abspath $(TOOLS_BIN_DIR)) go install github.com/google/addlicense@$(GO_ADD_LICENSE_VERSION)
$(GO_APIDIFF): $(call tool_version_file,$(GO_APIDIFF),$(GO_APIDIFF_VERSION))
GOBIN=$(abspath $(TOOLS_BIN_DIR)) go install github.com/joelanford/go-apidiff@$(GO_APIDIFF_VERSION)
$(GO_VULN_CHECK): $(call tool_version_file,$(GO_VULN_CHECK),$(GO_VULN_CHECK_VERSION))
GOBIN=$(abspath $(TOOLS_BIN_DIR)) go install golang.org/x/vuln/cmd/govulncheck@$(GO_VULN_CHECK_VERSION)
$(GO_TO_PROTOBUF): go.mod
go build -o $(GO_TO_PROTOBUF) k8s.io/code-generator/cmd/go-to-protobuf
$(HELM): $(call tool_version_file,$(HELM),$(HELM_VERSION))
curl -sSfL https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | HELM_INSTALL_DIR=$(TOOLS_BIN_DIR) USE_SUDO=false bash -s -- --version $(HELM_VERSION)
$(IMPORT_BOSS): go.mod
go build -o $(IMPORT_BOSS) k8s.io/code-generator/cmd/import-boss
$(KIND): $(call tool_version_file,$(KIND),$(KIND_VERSION))
curl -L -o $(KIND) https://kind.sigs.k8s.io/dl/$(KIND_VERSION)/kind-$(shell uname -s | tr '[:upper:]' '[:lower:]')-$(shell uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')
chmod +x $(KIND)
$(KUBECTL): $(call tool_version_file,$(KUBECTL),$(KUBECTL_VERSION))
curl -Lo $(KUBECTL) https://dl.k8s.io/release/$(KUBECTL_VERSION)/bin/$(shell uname -s | tr '[:upper:]' '[:lower:]')/$(shell uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')/kubectl
chmod +x $(KUBECTL)
ifeq ($(strip $(shell go list -m 2>/dev/null)),github.com/gardener/gardener)
$(LOGCHECK): $(TOOLS_PKG_PATH)/logcheck/go.* $(shell find $(TOOLS_PKG_PATH)/logcheck -type f -name '*.go')
cd $(TOOLS_PKG_PATH)/logcheck; CGO_ENABLED=1 go build -o $(abspath $(LOGCHECK)) -buildmode=plugin ./plugin
else
$(LOGCHECK): go.mod
CGO_ENABLED=1 go build -o $(LOGCHECK) -buildmode=plugin github.com/gardener/gardener/hack/tools/logcheck/plugin
endif
$(MOCKGEN): go.mod
go build -o $(MOCKGEN) go.uber.org/mock/mockgen
$(OPENAPI_GEN): go.mod
go build -o $(OPENAPI_GEN) k8s.io/kube-openapi/cmd/openapi-gen
$(PROMTOOL): $(TOOLS_PKG_PATH)/install-promtool.sh
@$(TOOLS_PKG_PATH)/install-promtool.sh
$(PROTOC): $(call tool_version_file,$(PROTOC),$(PROTOC_VERSION))
@PROTOC_VERSION=$(PROTOC_VERSION) $(TOOLS_PKG_PATH)/install-protoc.sh
$(PROTOC_GEN_GOGO): go.mod
go build -o $(PROTOC_GEN_GOGO) k8s.io/code-generator/cmd/go-to-protobuf/protoc-gen-gogo
ifeq ($(strip $(shell go list -m 2>/dev/null)),github.com/gardener/gardener)
$(REPORT_COLLECTOR): $(TOOLS_PKG_PATH)/report-collector/*.go
go build -o $(REPORT_COLLECTOR) $(TOOLS_PKG_PATH)/report-collector
else
$(REPORT_COLLECTOR): go.mod
go build -o $(REPORT_COLLECTOR) github.com/gardener/gardener/hack/tools/report-collector
endif
$(SETUP_ENVTEST): go.mod
go build -o $(SETUP_ENVTEST) sigs.k8s.io/controller-runtime/tools/setup-envtest
$(SKAFFOLD): $(call tool_version_file,$(SKAFFOLD),$(SKAFFOLD_VERSION))
curl -Lo $(SKAFFOLD) https://storage.googleapis.com/skaffold/releases/$(SKAFFOLD_VERSION)/skaffold-$(shell uname -s | tr '[:upper:]' '[:lower:]')-$(shell uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')
chmod +x $(SKAFFOLD)
$(YAML2JSON): go.mod
go build -o $(YAML2JSON) github.com/bronze1man/yaml2json
$(YQ): $(call tool_version_file,$(YQ),$(YQ_VERSION))
curl -L -o $(YQ) https://github.com/mikefarah/yq/releases/download/$(YQ_VERSION)/yq_$(shell uname -s | tr '[:upper:]' '[:lower:]')_$(shell uname -m | sed 's/x86_64/amd64/;s/aarch64/arm64/')
chmod +x $(YQ)