1# 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 72GOTEST := $(GO) test 73GOTEST_DIR := 74ifneq ($(CIRCLE_JOB),) 75ifneq ($(shell which gotestsum),) 76 GOTEST_DIR := test-results 77 GOTEST := gotestsum --junitfile $(GOTEST_DIR)/unit-tests.xml -- 78endif 79endif 80 81PROMU_VERSION ?= 0.12.0 82PROMU_URL := https://github.com/prometheus/promu/releases/download/v$(PROMU_VERSION)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM).tar.gz 83 84GOLANGCI_LINT := 85GOLANGCI_LINT_OPTS ?= 86GOLANGCI_LINT_VERSION ?= v1.39.0 87# golangci-lint only supports linux, darwin and windows platforms on i386/amd64. 88# windows isn't included here because of the path separator being different. 89ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin)) 90 ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386)) 91 GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint 92 endif 93endif 94 95PREFIX ?= $(shell pwd) 96BIN_DIR ?= $(shell pwd) 97DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD)) 98DOCKERFILE_PATH ?= ./Dockerfile 99DOCKERBUILD_CONTEXT ?= ./ 100DOCKER_REPO ?= prom 101 102DOCKER_ARCHS ?= amd64 103 104BUILD_DOCKER_ARCHS = $(addprefix common-docker-,$(DOCKER_ARCHS)) 105PUBLISH_DOCKER_ARCHS = $(addprefix common-docker-publish-,$(DOCKER_ARCHS)) 106TAG_DOCKER_ARCHS = $(addprefix common-docker-tag-latest-,$(DOCKER_ARCHS)) 107 108ifeq ($(GOHOSTARCH),amd64) 109 ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux freebsd darwin windows)) 110 # Only supported on amd64 111 test-flags := -race 112 endif 113endif 114 115# This rule is used to forward a target like "build" to "common-build". This 116# allows a new "build" target to be defined in a Makefile which includes this 117# one and override "common-build" without override warnings. 118%: common-% ; 119 120.PHONY: common-all 121common-all: precheck style check_license lint yamllint unused build test 122 123.PHONY: common-style 124common-style: 125 @echo ">> checking code style" 126 @fmtRes=$$($(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print)); \ 127 if [ -n "$${fmtRes}" ]; then \ 128 echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \ 129 echo "Please ensure you are using $$($(GO) version) for formatting code."; \ 130 exit 1; \ 131 fi 132 133.PHONY: common-check_license 134common-check_license: 135 @echo ">> checking license header" 136 @licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \ 137 awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \ 138 done); \ 139 if [ -n "$${licRes}" ]; then \ 140 echo "license header checking failed:"; echo "$${licRes}"; \ 141 exit 1; \ 142 fi 143 144.PHONY: common-deps 145common-deps: 146 @echo ">> getting dependencies" 147ifdef GO111MODULE 148 GO111MODULE=$(GO111MODULE) $(GO) mod download 149else 150 $(GO) get $(GOOPTS) -t ./... 151endif 152 153.PHONY: update-go-deps 154update-go-deps: 155 @echo ">> updating Go dependencies" 156 @for m in $$($(GO) list -mod=readonly -m -f '{{ if and (not .Indirect) (not .Main)}}{{.Path}}{{end}}' all); do \ 157 $(GO) get $$m; \ 158 done 159 GO111MODULE=$(GO111MODULE) $(GO) mod tidy 160ifneq (,$(wildcard vendor)) 161 GO111MODULE=$(GO111MODULE) $(GO) mod vendor 162endif 163 164.PHONY: common-test-short 165common-test-short: $(GOTEST_DIR) 166 @echo ">> running short tests" 167 GO111MODULE=$(GO111MODULE) $(GOTEST) -short $(GOOPTS) $(pkgs) 168 169.PHONY: common-test 170common-test: $(GOTEST_DIR) 171 @echo ">> running all tests" 172 GO111MODULE=$(GO111MODULE) $(GOTEST) $(test-flags) $(GOOPTS) $(pkgs) 173 174$(GOTEST_DIR): 175 @mkdir -p $@ 176 177.PHONY: common-format 178common-format: 179 @echo ">> formatting code" 180 GO111MODULE=$(GO111MODULE) $(GO) fmt $(pkgs) 181 182.PHONY: common-vet 183common-vet: 184 @echo ">> vetting code" 185 GO111MODULE=$(GO111MODULE) $(GO) vet $(GOOPTS) $(pkgs) 186 187.PHONY: common-lint 188common-lint: $(GOLANGCI_LINT) 189ifdef GOLANGCI_LINT 190 @echo ">> running golangci-lint" 191ifdef GO111MODULE 192# 'go list' needs to be executed before staticcheck to prepopulate the modules cache. 193# Otherwise staticcheck might fail randomly for some reason not yet explained. 194 GO111MODULE=$(GO111MODULE) $(GO) list -e -compiled -test=true -export=false -deps=true -find=false -tags= -- ./... > /dev/null 195 GO111MODULE=$(GO111MODULE) $(GOLANGCI_LINT) run $(GOLANGCI_LINT_OPTS) $(pkgs) 196else 197 $(GOLANGCI_LINT) run $(pkgs) 198endif 199endif 200 201.PHONY: common-yamllint 202common-yamllint: 203 @echo ">> running yamllint on all YAML files in the repository" 204ifeq (, $(shell which yamllint)) 205 @echo "yamllint not installed so skipping" 206else 207 yamllint . 208endif 209 210# For backward-compatibility. 211.PHONY: common-staticcheck 212common-staticcheck: lint 213 214.PHONY: common-unused 215common-unused: $(GOVENDOR) 216ifdef GOVENDOR 217 @echo ">> running check for unused packages" 218 @$(GOVENDOR) list +unused | grep . && exit 1 || echo 'No unused packages' 219else 220ifdef GO111MODULE 221 @echo ">> running check for unused/missing packages in go.mod" 222 GO111MODULE=$(GO111MODULE) $(GO) mod tidy 223ifeq (,$(wildcard vendor)) 224 @git diff --exit-code -- go.sum go.mod 225else 226 @echo ">> running check for unused packages in vendor/" 227 GO111MODULE=$(GO111MODULE) $(GO) mod vendor 228 @git diff --exit-code -- go.sum go.mod vendor/ 229endif 230endif 231endif 232 233.PHONY: common-build 234common-build: promu 235 @echo ">> building binaries" 236 GO111MODULE=$(GO111MODULE) $(PROMU) build --prefix $(PREFIX) $(PROMU_BINARIES) 237 238.PHONY: common-tarball 239common-tarball: promu 240 @echo ">> building release tarball" 241 $(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR) 242 243.PHONY: common-docker $(BUILD_DOCKER_ARCHS) 244common-docker: $(BUILD_DOCKER_ARCHS) 245$(BUILD_DOCKER_ARCHS): common-docker-%: 246 docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" \ 247 -f $(DOCKERFILE_PATH) \ 248 --build-arg ARCH="$*" \ 249 --build-arg OS="linux" \ 250 $(DOCKERBUILD_CONTEXT) 251 252.PHONY: common-docker-publish $(PUBLISH_DOCKER_ARCHS) 253common-docker-publish: $(PUBLISH_DOCKER_ARCHS) 254$(PUBLISH_DOCKER_ARCHS): common-docker-publish-%: 255 docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" 256 257DOCKER_MAJOR_VERSION_TAG = $(firstword $(subst ., ,$(shell cat VERSION))) 258.PHONY: common-docker-tag-latest $(TAG_DOCKER_ARCHS) 259common-docker-tag-latest: $(TAG_DOCKER_ARCHS) 260$(TAG_DOCKER_ARCHS): common-docker-tag-latest-%: 261 docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:latest" 262 docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)" 263 264.PHONY: common-docker-manifest 265common-docker-manifest: 266 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)) 267 DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" 268 269.PHONY: promu 270promu: $(PROMU) 271 272$(PROMU): 273 $(eval PROMU_TMP := $(shell mktemp -d)) 274 curl -s -L $(PROMU_URL) | tar -xvzf - -C $(PROMU_TMP) 275 mkdir -p $(FIRST_GOPATH)/bin 276 cp $(PROMU_TMP)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM)/promu $(FIRST_GOPATH)/bin/promu 277 rm -r $(PROMU_TMP) 278 279.PHONY: proto 280proto: 281 @echo ">> generating code from proto files" 282 @./scripts/genproto.sh 283 284ifdef GOLANGCI_LINT 285$(GOLANGCI_LINT): 286 mkdir -p $(FIRST_GOPATH)/bin 287 curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/$(GOLANGCI_LINT_VERSION)/install.sh \ 288 | sed -e '/install -d/d' \ 289 | sh -s -- -b $(FIRST_GOPATH)/bin $(GOLANGCI_LINT_VERSION) 290endif 291 292ifdef GOVENDOR 293.PHONY: $(GOVENDOR) 294$(GOVENDOR): 295 GOOS= GOARCH= $(GO) get -u github.com/kardianos/govendor 296endif 297 298.PHONY: precheck 299precheck:: 300 301define PRECHECK_COMMAND_template = 302precheck:: $(1)_precheck 303 304PRECHECK_COMMAND_$(1) ?= $(1) $$(strip $$(PRECHECK_OPTIONS_$(1))) 305.PHONY: $(1)_precheck 306$(1)_precheck: 307 @if ! $$(PRECHECK_COMMAND_$(1)) 1>/dev/null 2>&1; then \ 308 echo "Execution of '$$(PRECHECK_COMMAND_$(1))' command failed. Is $(1) installed?"; \ 309 exit 1; \ 310 fi 311endef 312