2021-01-31 23:10:16 +00:00
# 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
u n export 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 = ./...
i f e q ( a r m , $( GOHOSTARCH ) )
GOHOSTARM ?= $( shell GOARM = $( GO) env GOARM)
GO_BUILD_PLATFORM ?= $( GOHOSTOS) -$( GOHOSTARCH) v$( GOHOSTARM)
e l s e
GO_BUILD_PLATFORM ?= $( GOHOSTOS) -$( GOHOSTARCH)
e n d i f
GOTEST := $( GO) test
GOTEST_DIR :=
i f n e q ( $( CIRCLE_JOB ) , )
2023-07-26 22:05:15 +00:00
i f n e q ( $( shell command -v gotestsum > /dev /null ) , )
2021-01-31 23:10:16 +00:00
GOTEST_DIR := test-results
GOTEST := gotestsum --junitfile $( GOTEST_DIR) /unit-tests.xml --
e n d i f
e n d i f
2023-07-26 22:05:15 +00:00
PROMU_VERSION ?= 0.15.0
2021-01-31 23:10:16 +00:00
PROMU_URL := https://github.com/prometheus/promu/releases/download/v$( PROMU_VERSION) /promu-$( PROMU_VERSION) .$( GO_BUILD_PLATFORM) .tar.gz
2022-12-28 23:00:02 +00:00
SKIP_GOLANGCI_LINT :=
2021-01-31 23:10:16 +00:00
GOLANGCI_LINT :=
GOLANGCI_LINT_OPTS ?=
2024-03-17 22:51:41 +00:00
GOLANGCI_LINT_VERSION ?= v1.55.2
# golangci-lint only supports linux, darwin and windows platforms on i386/amd64/arm64.
2021-01-31 23:10:16 +00:00
# windows isn't included here because of the path separator being different.
i f e q ( $( GOHOSTOS ) , $( filter $ ( GOHOSTOS ) ,linux darwin ) )
2024-03-17 22:51:41 +00:00
ifeq ( $( GOHOSTARCH) ,$( filter $( GOHOSTARCH) ,amd64 i386 arm64) )
2022-08-02 06:19:38 +00:00
# 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.
2022-12-28 23:00:02 +00:00
ifneq ( ,$( SKIP_GOLANGCI_LINT) )
GOLANGCI_LINT :=
else ifeq ( ,$( CIRCLE_JOB) )
2022-08-02 06:19:38 +00:00
GOLANGCI_LINT := $( FIRST_GOPATH) /bin/golangci-lint
else ifeq ( ,$( wildcard .github/workflows/golangci-lint.yml) )
GOLANGCI_LINT := $( FIRST_GOPATH) /bin/golangci-lint
endif
2021-01-31 23:10:16 +00:00
endif
e n d i f
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) )
2023-07-07 07:05:50 +00:00
SANITIZED_DOCKER_IMAGE_TAG := $( subst +,-,$( DOCKER_IMAGE_TAG) )
2021-01-31 23:10:16 +00:00
i f e q ( $( GOHOSTARCH ) , a m d 6 4 )
ifeq ( $( GOHOSTOS) ,$( filter $( GOHOSTOS) ,linux freebsd darwin windows) )
# Only supported on amd64
test-flags := -race
endif
e n d i f
# 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
2021-07-07 13:10:33 +00:00
common-all : precheck style check_license lint yamllint unused build test
2021-01-31 23:10:16 +00:00
.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"
2022-08-02 06:19:38 +00:00
$( GO) mod download
2021-01-31 23:10:16 +00:00
.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 \
2022-08-02 06:19:38 +00:00
$( GO) get -d $$ m; \
2021-01-31 23:10:16 +00:00
done
2022-08-02 06:19:38 +00:00
$( GO) mod tidy
2021-01-31 23:10:16 +00:00
.PHONY : common -test -short
common-test-short : $( GOTEST_DIR )
@echo ">> running short tests"
2022-08-02 06:19:38 +00:00
$( GOTEST) -short $( GOOPTS) $( pkgs)
2021-01-31 23:10:16 +00:00
.PHONY : common -test
common-test : $( GOTEST_DIR )
@echo ">> running all tests"
2022-08-02 06:19:38 +00:00
$( GOTEST) $( test-flags) $( GOOPTS) $( pkgs)
2021-01-31 23:10:16 +00:00
$(GOTEST_DIR) :
@mkdir -p $@
.PHONY : common -format
common-format :
@echo ">> formatting code"
2022-08-02 06:19:38 +00:00
$( GO) fmt $( pkgs)
2021-01-31 23:10:16 +00:00
.PHONY : common -vet
common-vet :
@echo ">> vetting code"
2022-08-02 06:19:38 +00:00
$( GO) vet $( GOOPTS) $( pkgs)
2021-01-31 23:10:16 +00:00
.PHONY : common -lint
common-lint : $( GOLANGCI_LINT )
i f d e f G O L A N G C I _ L I N T
@echo ">> running golangci-lint"
2022-08-02 06:19:38 +00:00
$( GOLANGCI_LINT) run $( GOLANGCI_LINT_OPTS) $( pkgs)
2021-01-31 23:10:16 +00:00
e n d i f
2024-03-17 22:51:41 +00:00
.PHONY : common -lint -fix
common-lint-fix : $( GOLANGCI_LINT )
i f d e f G O L A N G C I _ L I N T
@echo ">> running golangci-lint fix"
$( GOLANGCI_LINT) run --fix $( GOLANGCI_LINT_OPTS) $( pkgs)
e n d i f
2021-07-07 13:10:33 +00:00
.PHONY : common -yamllint
common-yamllint :
@echo ">> running yamllint on all YAML files in the repository"
2023-07-26 22:05:15 +00:00
i f e q ( , $( shell command -v yamllint > /dev /null ) )
2021-07-07 13:10:33 +00:00
@echo "yamllint not installed so skipping"
e l s e
yamllint .
e n d i f
2021-01-31 23:10:16 +00:00
# For backward-compatibility.
.PHONY : common -staticcheck
common-staticcheck : lint
.PHONY : common -unused
2022-08-02 06:19:38 +00:00
common-unused :
2021-01-31 23:10:16 +00:00
@echo ">> running check for unused/missing packages in go.mod"
2022-08-02 06:19:38 +00:00
$( GO) mod tidy
2021-01-31 23:10:16 +00:00
@git diff --exit-code -- go.sum go.mod
.PHONY : common -build
common-build : promu
@echo ">> building binaries"
2022-08-02 06:19:38 +00:00
$( PROMU) build --prefix $( PREFIX) $( PROMU_BINARIES)
2021-01-31 23:10:16 +00:00
.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 -%:
2023-07-07 07:05:50 +00:00
docker build -t " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) -linux- $* : $( SANITIZED_DOCKER_IMAGE_TAG) " \
2021-01-31 23:10:16 +00:00
-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 -%:
2023-07-07 07:05:50 +00:00
docker push " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) -linux- $* : $( SANITIZED_DOCKER_IMAGE_TAG) "
2021-01-31 23:10:16 +00:00
2021-02-08 23:12:07 +00:00
DOCKER_MAJOR_VERSION_TAG = $( firstword $( subst ., ,$( shell cat VERSION) ) )
2021-01-31 23:10:16 +00:00
.PHONY : common -docker -tag -latest $( TAG_DOCKER_ARCHS )
common-docker-tag-latest : $( TAG_DOCKER_ARCHS )
$(TAG_DOCKER_ARCHS) : common -docker -tag -latest -%:
2023-07-07 07:05:50 +00:00
docker tag " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) -linux- $* : $( SANITIZED_DOCKER_IMAGE_TAG) " " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) -linux- $* :latest "
docker tag " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) -linux- $* : $( SANITIZED_DOCKER_IMAGE_TAG) " " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) -linux- $* :v $( DOCKER_MAJOR_VERSION_TAG) "
2021-01-31 23:10:16 +00:00
.PHONY : common -docker -manifest
common-docker-manifest :
2023-07-07 07:05:50 +00:00
DOCKER_CLI_EXPERIMENTAL = enabled docker manifest create -a " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) : $( SANITIZED_DOCKER_IMAGE_TAG) " $( foreach ARCH,$( DOCKER_ARCHS) ,$( DOCKER_REPO) /$( DOCKER_IMAGE_NAME) -linux-$( ARCH) :$( SANITIZED_DOCKER_IMAGE_TAG) )
DOCKER_CLI_EXPERIMENTAL = enabled docker manifest push " $( DOCKER_REPO) / $( DOCKER_IMAGE_NAME) : $( SANITIZED_DOCKER_IMAGE_TAG) "
2021-01-31 23:10:16 +00:00
.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
i f d e f G O L A N G C I _ L I N T
$(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)
e n d i f
.PHONY : precheck
precheck ::
d e f i n e 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
e n d e f