blob: c7f9ea64ff5911218d7efdbfe0f43e4a20928a02 [file] [log] [blame]
khenaidoo59ce9dd2019-11-11 13:05:32 -05001# Copyright 2018 The Prometheus Authors
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11# See the License for the specific language governing permissions and
12# limitations under the License.
13
14
15# A common Makefile that includes rules to be reused in different prometheus projects.
16# !!! Open PRs only against the prometheus/prometheus/Makefile.common repository!
17
18# Example usage :
19# Create the main Makefile in the root project directory.
20# include Makefile.common
21# customTarget:
22# @echo ">> Running customTarget"
23#
24
25# Ensure GOBIN is not set during build so that promu is installed to the correct path
26unexport GOBIN
27
28GO ?= go
29GOFMT ?= $(GO)fmt
30FIRST_GOPATH := $(firstword $(subst :, ,$(shell $(GO) env GOPATH)))
31GOOPTS ?=
32GOHOSTOS ?= $(shell $(GO) env GOHOSTOS)
33GOHOSTARCH ?= $(shell $(GO) env GOHOSTARCH)
34
35GO_VERSION ?= $(shell $(GO) version)
36GO_VERSION_NUMBER ?= $(word 3, $(GO_VERSION))
37PRE_GO_111 ?= $(shell echo $(GO_VERSION_NUMBER) | grep -E 'go1\.(10|[0-9])\.')
38
39GOVENDOR :=
40GO111MODULE :=
41ifeq (, $(PRE_GO_111))
42 ifneq (,$(wildcard go.mod))
43 # Enforce Go modules support just in case the directory is inside GOPATH (and for Travis CI).
44 GO111MODULE := on
45
46 ifneq (,$(wildcard vendor))
47 # Always use the local vendor/ directory to satisfy the dependencies.
48 GOOPTS := $(GOOPTS) -mod=vendor
49 endif
50 endif
51else
52 ifneq (,$(wildcard go.mod))
53 ifneq (,$(wildcard vendor))
54$(warning This repository requires Go >= 1.11 because of Go modules)
55$(warning Some recipes may not work as expected as the current Go runtime is '$(GO_VERSION_NUMBER)')
56 endif
57 else
58 # This repository isn't using Go modules (yet).
59 GOVENDOR := $(FIRST_GOPATH)/bin/govendor
60 endif
61endif
62PROMU := $(FIRST_GOPATH)/bin/promu
63pkgs = ./...
64
65ifeq (arm, $(GOHOSTARCH))
66 GOHOSTARM ?= $(shell GOARM= $(GO) env GOARM)
67 GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)v$(GOHOSTARM)
68else
69 GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)
70endif
71
72PROMU_VERSION ?= 0.4.0
73PROMU_URL := https://github.com/prometheus/promu/releases/download/v$(PROMU_VERSION)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM).tar.gz
74
75GOLANGCI_LINT :=
76GOLANGCI_LINT_OPTS ?=
77GOLANGCI_LINT_VERSION ?= v1.16.0
78# golangci-lint only supports linux, darwin and windows platforms on i386/amd64.
79# windows isn't included here because of the path separator being different.
80ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin))
81 ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386))
82 GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint
83 endif
84endif
85
86PREFIX ?= $(shell pwd)
87BIN_DIR ?= $(shell pwd)
88DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD))
89DOCKER_REPO ?= prom
90
91DOCKER_ARCHS ?= amd64
92
93BUILD_DOCKER_ARCHS = $(addprefix common-docker-,$(DOCKER_ARCHS))
94PUBLISH_DOCKER_ARCHS = $(addprefix common-docker-publish-,$(DOCKER_ARCHS))
95TAG_DOCKER_ARCHS = $(addprefix common-docker-tag-latest-,$(DOCKER_ARCHS))
96
97ifeq ($(GOHOSTARCH),amd64)
98 ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux freebsd darwin windows))
99 # Only supported on amd64
100 test-flags := -race
101 endif
102endif
103
104# This rule is used to forward a target like "build" to "common-build". This
105# allows a new "build" target to be defined in a Makefile which includes this
106# one and override "common-build" without override warnings.
107%: common-% ;
108
109.PHONY: common-all
110common-all: precheck style check_license lint unused build test
111
112.PHONY: common-style
113common-style:
114 @echo ">> checking code style"
115 @fmtRes=$$($(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print)); \
116 if [ -n "$${fmtRes}" ]; then \
117 echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \
118 echo "Please ensure you are using $$($(GO) version) for formatting code."; \
119 exit 1; \
120 fi
121
122.PHONY: common-check_license
123common-check_license:
124 @echo ">> checking license header"
125 @licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \
126 awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \
127 done); \
128 if [ -n "$${licRes}" ]; then \
129 echo "license header checking failed:"; echo "$${licRes}"; \
130 exit 1; \
131 fi
132
133.PHONY: common-deps
134common-deps:
135 @echo ">> getting dependencies"
136ifdef GO111MODULE
137 GO111MODULE=$(GO111MODULE) $(GO) mod download
138else
139 $(GO) get $(GOOPTS) -t ./...
140endif
141
142.PHONY: common-test-short
143common-test-short:
144 @echo ">> running short tests"
145 GO111MODULE=$(GO111MODULE) $(GO) test -short $(GOOPTS) $(pkgs)
146
147.PHONY: common-test
148common-test:
149 @echo ">> running all tests"
150 GO111MODULE=$(GO111MODULE) $(GO) test $(test-flags) $(GOOPTS) $(pkgs)
151
152.PHONY: common-format
153common-format:
154 @echo ">> formatting code"
155 GO111MODULE=$(GO111MODULE) $(GO) fmt $(pkgs)
156
157.PHONY: common-vet
158common-vet:
159 @echo ">> vetting code"
160 GO111MODULE=$(GO111MODULE) $(GO) vet $(GOOPTS) $(pkgs)
161
162.PHONY: common-lint
163common-lint: $(GOLANGCI_LINT)
164ifdef GOLANGCI_LINT
165 @echo ">> running golangci-lint"
166ifdef GO111MODULE
167# 'go list' needs to be executed before staticcheck to prepopulate the modules cache.
168# Otherwise staticcheck might fail randomly for some reason not yet explained.
169 GO111MODULE=$(GO111MODULE) $(GO) list -e -compiled -test=true -export=false -deps=true -find=false -tags= -- ./... > /dev/null
170 GO111MODULE=$(GO111MODULE) $(GOLANGCI_LINT) run $(GOLANGCI_LINT_OPTS) $(pkgs)
171else
172 $(GOLANGCI_LINT) run $(pkgs)
173endif
174endif
175
176# For backward-compatibility.
177.PHONY: common-staticcheck
178common-staticcheck: lint
179
180.PHONY: common-unused
181common-unused: $(GOVENDOR)
182ifdef GOVENDOR
183 @echo ">> running check for unused packages"
184 @$(GOVENDOR) list +unused | grep . && exit 1 || echo 'No unused packages'
185else
186ifdef GO111MODULE
187 @echo ">> running check for unused/missing packages in go.mod"
188 GO111MODULE=$(GO111MODULE) $(GO) mod tidy
189ifeq (,$(wildcard vendor))
190 @git diff --exit-code -- go.sum go.mod
191else
192 @echo ">> running check for unused packages in vendor/"
193 GO111MODULE=$(GO111MODULE) $(GO) mod vendor
194 @git diff --exit-code -- go.sum go.mod vendor/
195endif
196endif
197endif
198
199.PHONY: common-build
200common-build: promu
201 @echo ">> building binaries"
202 GO111MODULE=$(GO111MODULE) $(PROMU) build --prefix $(PREFIX)
203
204.PHONY: common-tarball
205common-tarball: promu
206 @echo ">> building release tarball"
207 $(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR)
208
209.PHONY: common-docker $(BUILD_DOCKER_ARCHS)
210common-docker: $(BUILD_DOCKER_ARCHS)
211$(BUILD_DOCKER_ARCHS): common-docker-%:
212 docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" \
213 --build-arg ARCH="$*" \
214 --build-arg OS="linux" \
215 .
216
217.PHONY: common-docker-publish $(PUBLISH_DOCKER_ARCHS)
218common-docker-publish: $(PUBLISH_DOCKER_ARCHS)
219$(PUBLISH_DOCKER_ARCHS): common-docker-publish-%:
220 docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)"
221
222.PHONY: common-docker-tag-latest $(TAG_DOCKER_ARCHS)
223common-docker-tag-latest: $(TAG_DOCKER_ARCHS)
224$(TAG_DOCKER_ARCHS): common-docker-tag-latest-%:
225 docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:latest"
226
227.PHONY: common-docker-manifest
228common-docker-manifest:
229 DOCKER_CLI_EXPERIMENTAL=enabled docker manifest create -a "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" $(foreach ARCH,$(DOCKER_ARCHS),$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$(ARCH):$(DOCKER_IMAGE_TAG))
230 DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)"
231
232.PHONY: promu
233promu: $(PROMU)
234
235$(PROMU):
236 $(eval PROMU_TMP := $(shell mktemp -d))
237 curl -s -L $(PROMU_URL) | tar -xvzf - -C $(PROMU_TMP)
238 mkdir -p $(FIRST_GOPATH)/bin
239 cp $(PROMU_TMP)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM)/promu $(FIRST_GOPATH)/bin/promu
240 rm -r $(PROMU_TMP)
241
242.PHONY: proto
243proto:
244 @echo ">> generating code from proto files"
245 @./scripts/genproto.sh
246
247ifdef GOLANGCI_LINT
248$(GOLANGCI_LINT):
249 mkdir -p $(FIRST_GOPATH)/bin
250 curl -sfL https://install.goreleaser.com/github.com/golangci/golangci-lint.sh | sh -s -- -b $(FIRST_GOPATH)/bin $(GOLANGCI_LINT_VERSION)
251endif
252
253ifdef GOVENDOR
254.PHONY: $(GOVENDOR)
255$(GOVENDOR):
256 GOOS= GOARCH= $(GO) get -u github.com/kardianos/govendor
257endif
258
259.PHONY: precheck
260precheck::
261
262define PRECHECK_COMMAND_template =
263precheck:: $(1)_precheck
264
265PRECHECK_COMMAND_$(1) ?= $(1) $$(strip $$(PRECHECK_OPTIONS_$(1)))
266.PHONY: $(1)_precheck
267$(1)_precheck:
268 @if ! $$(PRECHECK_COMMAND_$(1)) 1>/dev/null 2>&1; then \
269 echo "Execution of '$$(PRECHECK_COMMAND_$(1))' command failed. Is $(1) installed?"; \
270 exit 1; \
271 fi
272endef