mirror of https://github.com/prometheus/prometheus
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
267 lines
8.8 KiB
267 lines
8.8 KiB
# Copyright 2018 The Prometheus Authors |
|
# 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. |
|
|
|
|
|
# A common Makefile that includes rules to be reused in different prometheus projects. |
|
# !!! Open PRs only against the prometheus/prometheus/Makefile.common repository! |
|
|
|
# Example usage : |
|
# Create the main Makefile in the root project directory. |
|
# include Makefile.common |
|
# customTarget: |
|
# @echo ">> Running customTarget" |
|
# |
|
|
|
# Ensure GOBIN is not set during build so that promu is installed to the correct path |
|
unexport GOBIN |
|
|
|
GO ?= go |
|
GOFMT ?= $(GO)fmt |
|
FIRST_GOPATH := $(firstword $(subst :, ,$(shell $(GO) env GOPATH))) |
|
GOOPTS ?= |
|
GOHOSTOS ?= $(shell $(GO) env GOHOSTOS) |
|
GOHOSTARCH ?= $(shell $(GO) env GOHOSTARCH) |
|
|
|
GO_VERSION ?= $(shell $(GO) version) |
|
GO_VERSION_NUMBER ?= $(word 3, $(GO_VERSION)) |
|
PRE_GO_111 ?= $(shell echo $(GO_VERSION_NUMBER) | grep -E 'go1\.(10|[0-9])\.') |
|
|
|
PROMU := $(FIRST_GOPATH)/bin/promu |
|
pkgs = ./... |
|
|
|
ifeq (arm, $(GOHOSTARCH)) |
|
GOHOSTARM ?= $(shell GOARM= $(GO) env GOARM) |
|
GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH)v$(GOHOSTARM) |
|
else |
|
GO_BUILD_PLATFORM ?= $(GOHOSTOS)-$(GOHOSTARCH) |
|
endif |
|
|
|
GOTEST := $(GO) test |
|
GOTEST_DIR := |
|
ifneq ($(CIRCLE_JOB),) |
|
ifneq ($(shell which gotestsum),) |
|
GOTEST_DIR := test-results |
|
GOTEST := gotestsum --junitfile $(GOTEST_DIR)/unit-tests.xml -- |
|
endif |
|
endif |
|
|
|
PROMU_VERSION ?= 0.14.0 |
|
PROMU_URL := https://github.com/prometheus/promu/releases/download/v$(PROMU_VERSION)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM).tar.gz |
|
|
|
SKIP_GOLANGCI_LINT := |
|
GOLANGCI_LINT := |
|
GOLANGCI_LINT_OPTS ?= |
|
GOLANGCI_LINT_VERSION ?= v1.51.2 |
|
# golangci-lint only supports linux, darwin and windows platforms on i386/amd64. |
|
# windows isn't included here because of the path separator being different. |
|
ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin)) |
|
ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386)) |
|
# If we're in CI and there is an Actions file, that means the linter |
|
# is being run in Actions, so we don't need to run it here. |
|
ifneq (,$(SKIP_GOLANGCI_LINT)) |
|
GOLANGCI_LINT := |
|
else ifeq (,$(CIRCLE_JOB)) |
|
GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint |
|
else ifeq (,$(wildcard .github/workflows/golangci-lint.yml)) |
|
GOLANGCI_LINT := $(FIRST_GOPATH)/bin/golangci-lint |
|
endif |
|
endif |
|
endif |
|
|
|
PREFIX ?= $(shell pwd) |
|
BIN_DIR ?= $(shell pwd) |
|
DOCKER_IMAGE_TAG ?= $(subst /,-,$(shell git rev-parse --abbrev-ref HEAD)) |
|
DOCKERFILE_PATH ?= ./Dockerfile |
|
DOCKERBUILD_CONTEXT ?= ./ |
|
DOCKER_REPO ?= prom |
|
|
|
DOCKER_ARCHS ?= amd64 |
|
|
|
BUILD_DOCKER_ARCHS = $(addprefix common-docker-,$(DOCKER_ARCHS)) |
|
PUBLISH_DOCKER_ARCHS = $(addprefix common-docker-publish-,$(DOCKER_ARCHS)) |
|
TAG_DOCKER_ARCHS = $(addprefix common-docker-tag-latest-,$(DOCKER_ARCHS)) |
|
|
|
ifeq ($(GOHOSTARCH),amd64) |
|
ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux freebsd darwin windows)) |
|
# Only supported on amd64 |
|
test-flags := -race |
|
endif |
|
endif |
|
|
|
# This rule is used to forward a target like "build" to "common-build". This |
|
# allows a new "build" target to be defined in a Makefile which includes this |
|
# one and override "common-build" without override warnings. |
|
%: common-% ; |
|
|
|
.PHONY: common-all |
|
common-all: precheck style check_license lint yamllint unused build test |
|
|
|
.PHONY: common-style |
|
common-style: |
|
@echo ">> checking code style" |
|
@fmtRes=$$($(GOFMT) -d $$(find . -path ./vendor -prune -o -name '*.go' -print)); \ |
|
if [ -n "$${fmtRes}" ]; then \ |
|
echo "gofmt checking failed!"; echo "$${fmtRes}"; echo; \ |
|
echo "Please ensure you are using $$($(GO) version) for formatting code."; \ |
|
exit 1; \ |
|
fi |
|
|
|
.PHONY: common-check_license |
|
common-check_license: |
|
@echo ">> checking license header" |
|
@licRes=$$(for file in $$(find . -type f -iname '*.go' ! -path './vendor/*') ; do \ |
|
awk 'NR<=3' $$file | grep -Eq "(Copyright|generated|GENERATED)" || echo $$file; \ |
|
done); \ |
|
if [ -n "$${licRes}" ]; then \ |
|
echo "license header checking failed:"; echo "$${licRes}"; \ |
|
exit 1; \ |
|
fi |
|
|
|
.PHONY: common-deps |
|
common-deps: |
|
@echo ">> getting dependencies" |
|
$(GO) mod download |
|
|
|
.PHONY: update-go-deps |
|
update-go-deps: |
|
@echo ">> updating Go dependencies" |
|
@for m in $$($(GO) list -mod=readonly -m -f '{{ if and (not .Indirect) (not .Main)}}{{.Path}}{{end}}' all); do \ |
|
$(GO) get -d $$m; \ |
|
done |
|
$(GO) mod tidy |
|
|
|
.PHONY: common-test-short |
|
common-test-short: $(GOTEST_DIR) |
|
@echo ">> running short tests" |
|
$(GOTEST) -short $(GOOPTS) $(pkgs) |
|
|
|
.PHONY: common-test |
|
common-test: $(GOTEST_DIR) |
|
@echo ">> running all tests" |
|
$(GOTEST) $(test-flags) $(GOOPTS) $(pkgs) |
|
|
|
$(GOTEST_DIR): |
|
@mkdir -p $@ |
|
|
|
.PHONY: common-format |
|
common-format: |
|
@echo ">> formatting code" |
|
$(GO) fmt $(pkgs) |
|
|
|
.PHONY: common-vet |
|
common-vet: |
|
@echo ">> vetting code" |
|
$(GO) vet $(GOOPTS) $(pkgs) |
|
|
|
.PHONY: common-lint |
|
common-lint: $(GOLANGCI_LINT) |
|
ifdef GOLANGCI_LINT |
|
@echo ">> running golangci-lint" |
|
# 'go list' needs to be executed before staticcheck to prepopulate the modules cache. |
|
# Otherwise staticcheck might fail randomly for some reason not yet explained. |
|
$(GO) list -e -compiled -test=true -export=false -deps=true -find=false -tags= -- ./... > /dev/null |
|
$(GOLANGCI_LINT) run $(GOLANGCI_LINT_OPTS) $(pkgs) |
|
endif |
|
|
|
.PHONY: common-yamllint |
|
common-yamllint: |
|
@echo ">> running yamllint on all YAML files in the repository" |
|
ifeq (, $(shell which yamllint)) |
|
@echo "yamllint not installed so skipping" |
|
else |
|
yamllint . |
|
endif |
|
|
|
# For backward-compatibility. |
|
.PHONY: common-staticcheck |
|
common-staticcheck: lint |
|
|
|
.PHONY: common-unused |
|
common-unused: |
|
@echo ">> running check for unused/missing packages in go.mod" |
|
$(GO) mod tidy |
|
@git diff --exit-code -- go.sum go.mod |
|
|
|
.PHONY: common-build |
|
common-build: promu |
|
@echo ">> building binaries" |
|
$(PROMU) build --prefix $(PREFIX) $(PROMU_BINARIES) |
|
|
|
.PHONY: common-tarball |
|
common-tarball: promu |
|
@echo ">> building release tarball" |
|
$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR) |
|
|
|
.PHONY: common-docker $(BUILD_DOCKER_ARCHS) |
|
common-docker: $(BUILD_DOCKER_ARCHS) |
|
$(BUILD_DOCKER_ARCHS): common-docker-%: |
|
docker build -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" \ |
|
-f $(DOCKERFILE_PATH) \ |
|
--build-arg ARCH="$*" \ |
|
--build-arg OS="linux" \ |
|
$(DOCKERBUILD_CONTEXT) |
|
|
|
.PHONY: common-docker-publish $(PUBLISH_DOCKER_ARCHS) |
|
common-docker-publish: $(PUBLISH_DOCKER_ARCHS) |
|
$(PUBLISH_DOCKER_ARCHS): common-docker-publish-%: |
|
docker push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" |
|
|
|
DOCKER_MAJOR_VERSION_TAG = $(firstword $(subst ., ,$(shell cat VERSION))) |
|
.PHONY: common-docker-tag-latest $(TAG_DOCKER_ARCHS) |
|
common-docker-tag-latest: $(TAG_DOCKER_ARCHS) |
|
$(TAG_DOCKER_ARCHS): common-docker-tag-latest-%: |
|
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:latest" |
|
docker tag "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(DOCKER_IMAGE_TAG)" "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:v$(DOCKER_MAJOR_VERSION_TAG)" |
|
|
|
.PHONY: common-docker-manifest |
|
common-docker-manifest: |
|
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)) |
|
DOCKER_CLI_EXPERIMENTAL=enabled docker manifest push "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(DOCKER_IMAGE_TAG)" |
|
|
|
.PHONY: promu |
|
promu: $(PROMU) |
|
|
|
$(PROMU): |
|
$(eval PROMU_TMP := $(shell mktemp -d)) |
|
curl -s -L $(PROMU_URL) | tar -xvzf - -C $(PROMU_TMP) |
|
mkdir -p $(FIRST_GOPATH)/bin |
|
cp $(PROMU_TMP)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM)/promu $(FIRST_GOPATH)/bin/promu |
|
rm -r $(PROMU_TMP) |
|
|
|
.PHONY: proto |
|
proto: |
|
@echo ">> generating code from proto files" |
|
@./scripts/genproto.sh |
|
|
|
ifdef GOLANGCI_LINT |
|
$(GOLANGCI_LINT): |
|
mkdir -p $(FIRST_GOPATH)/bin |
|
curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/$(GOLANGCI_LINT_VERSION)/install.sh \ |
|
| sed -e '/install -d/d' \ |
|
| sh -s -- -b $(FIRST_GOPATH)/bin $(GOLANGCI_LINT_VERSION) |
|
endif |
|
|
|
.PHONY: precheck |
|
precheck:: |
|
|
|
define PRECHECK_COMMAND_template = |
|
precheck:: $(1)_precheck |
|
|
|
PRECHECK_COMMAND_$(1) ?= $(1) $$(strip $$(PRECHECK_OPTIONS_$(1))) |
|
.PHONY: $(1)_precheck |
|
$(1)_precheck: |
|
@if ! $$(PRECHECK_COMMAND_$(1)) 1>/dev/null 2>&1; then \ |
|
echo "Execution of '$$(PRECHECK_COMMAND_$(1))' command failed. Is $(1) installed?"; \ |
|
exit 1; \ |
|
fi |
|
endef
|
|
|