Makefile.common

# 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])\.')

PYTHON       := python3
PROMU        := $(FIRST_GOPATH)/bin/promu
SWAG         := $(FIRST_GOPATH)/bin/swag
pkgs          = ./...

# clang format
FORMAT_FIND_FLAGS ?= -name '*.c' -o -name '*.h' -not -path 'pkg/collector/bpf/include/vmlinux.h' -not -path 'pkg/collector/bpf/libbpf/*'

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 command -v gotestsum > /dev/null),)
	GOTEST_DIR := test-results
	GOTEST := gotestsum --junitfile $(GOTEST_DIR)/unit-tests.xml --
endif
endif

HELM_VERSION	 ?= 3.17.3
HELM_URL		 := https://get.helm.sh/helm-v${HELM_VERSION}-${GO_BUILD_PLATFORM}.tar.gz
HELM			 := $(FIRST_GOPATH)/bin/helm

CT_VERSION 		 ?= 3.12.0
CT_URL			 := https://github.com/helm/chart-testing/releases/download/v${CT_VERSION}/chart-testing_${CT_VERSION}_$(GOHOSTOS)_$(GOHOSTARCH).tar.gz
CT				 := $(FIRST_GOPATH)/bin/ct

PROMU_VERSION ?= 0.17.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.60.3
# 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             ?= ceems

DOCKER_ARCHS            ?= amd64

BUILD_DOCKER_ARCHS = $(addprefix common-docker-,$(DOCKER_ARCHS))
PUBLISH_DOCKER_ARCHS = $(addprefix common-docker-publish-,$(DOCKER_ARCHS))
SIGN_DOCKER_ARCHS = $(addprefix common-docker-sign-,$(DOCKER_ARCHS))
TAG_DOCKER_ARCHS = $(addprefix common-docker-tag-latest-,$(DOCKER_ARCHS))
PULL_DOCKER_ARCHS = $(addprefix common-docker-pull-,$(DOCKER_ARCHS))

SANITIZED_DOCKER_IMAGE_TAG := $(subst +,-,$(DOCKER_IMAGE_TAG))

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 lint yamllint unused build test

# Chart-testing targets
.PHONY: common-ct
common-ct: ctlint cttest

.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 command -v yamllint > /dev/null))
	@echo "yamllint not installed so skipping"
else
	yamllint .
endif

.PHONY: common-ctlint
common-ctlint: $(CT)
	@echo ">> running ctlint on helm charts"
	$(CT) lint --config deployment/ct/config.yaml --chart-dirs deployment/charts

.PHONY: common-cttest
common-cttest: $(CT)
	@echo ">> testing helm charts"
	$(CT) install --config deployment/ct/config.yaml --chart-dirs deployment/charts

.PHONY: common-clang-format
clang-format: ## Run code formatter on BPF code.
	find pkg/collector/bpf $(FORMAT_FIND_FLAGS) | xargs -n 1000 clang-format -i -style=file

# 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

# Dont bother updating swagger docs for release builds
.PHONY: common-build
common-build: promu swag bpf
ifeq ($(RELEASE_BUILD), 0)
ifeq ($(CGO_APPS), 1)
	@echo ">> updating swagger docs"
	$(SWAG) init -d $(SWAGGER_DIR) -g $(SWAGGER_MAIN) -o $(SWAGGER_DIR)/docs --pd --v3.1 --quiet
	$(SWAG) fmt -d $(SWAGGER_DIR) -g $(SWAGGER_MAIN)
endif
	@echo ">> building test binaries"
	mkdir -p scripts/mock_servers/assets
	cp -r pkg/collector/testdata/redfish scripts/mock_servers/assets
	cp -r pkg/collector/testdata/k8s scripts/mock_servers/assets
	cp -r pkg/lb/testdata/pyroscope scripts/mock_servers/assets
	cp -r pkg/api/testdata/openstack scripts/mock_servers/assets
	$(PROMU_GO_TEST) build --prefix $(PREFIX) $(PROMU_BINARIES)
ifeq ($(CGO_APPS), 0)
	$(PROMU_CGO_TEST) build --prefix $(PREFIX) $(PROMU_BINARIES)
endif
endif
	@echo ">> building binaries"
	$(PROMU) build --prefix $(PREFIX) $(PROMU_BINARIES)

.PHONY: common-crossbuild
common-crossbuild: promu updatevars
	@echo ">> building release binaries"
	$(PROMU) crossbuild -v --parallelism=3

.PHONY: common-crossbuild-test
common-crossbuild-test: promu updatevars
	@echo ">> building release binaries"
	$(PROMU) crossbuild -v --parallelism=2 -p linux/amd64 -p linux/arm64

.PHONY: common-tarball
common-tarball: promu
	@echo ">> building release tarball"
	$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR)

.PHONY: common-helm-package
common-helm-package: helm
	@echo ">> building helm packages"
	$(HELM) package deployment/charts/* -d .tarballs

.PHONY: common-docker-repo-name
common-docker-repo-name:
	@echo "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)"

.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-$*:$(SANITIZED_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-$*:$(SANITIZED_DOCKER_IMAGE_TAG)"

.PHONY: common-docker-sign $(SIGN_DOCKER_ARCHS)
common-docker-sign: $(SIGN_DOCKER_ARCHS)
$(SIGN_DOCKER_ARCHS): common-docker-sign-%:
	cosign sign --recursive --yes $(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)@$(shell docker buildx imagetools inspect $(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG) --format='{{json .Manifest}}' | jq -r .digest)

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-$*:$(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)"

.PHONY: common-docker-pull $(PULL_DOCKER_ARCHS)
common-docker-pull: $(PULL_DOCKER_ARCHS)
$(PULL_DOCKER_ARCHS): common-docker-pull-%:
	docker pull "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$*:$(SANITIZED_DOCKER_IMAGE_TAG)"

# Starting from Docker CLI v29, seems like provenance is defaulted to true and hence,
# create manifest does not work anymore as there is no one provenance layer even in
# single layered image.
# Ref: https://github.com/docker/build-push-action/issues/1459
# Ref: https://github.com/docker/buildx/issues/1509
.PHONY: common-docker-manifest
common-docker-manifest:
	DOCKER_CLI_EXPERIMENTAL=enabled docker buildx imagetools create -t "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME):$(SANITIZED_DOCKER_IMAGE_TAG)" $(foreach ARCH,$(DOCKER_ARCHS),$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)-linux-$(ARCH):$(SANITIZED_DOCKER_IMAGE_TAG))

.PHONY: updatevars
updatevars:
	@echo ">> updating makefile vars in-place"
	sed -i -e 's/RELEASE_BUILD           ?= 0/RELEASE_BUILD           ?= 1/g' Makefile
	sed -i -e 's/osusergo, netgo, static_build, test/osusergo, netgo, static_build/g' .promu/.promu-go.yml
	sed -i -e 's/CGO_APPS                ?= 0/CGO_APPS                ?= $(CGO_APPS)/g' Makefile

.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: helm
helm: $(HELM)
$(HELM):
	$(eval HELM_TMP := $(shell mktemp -d))
	curl -s -L $(HELM_URL) | tar -xvzf - -C $(HELM_TMP)
	mkdir -p $(FIRST_GOPATH)/bin
	cp $(HELM_TMP)/$(GO_BUILD_PLATFORM)/helm $(FIRST_GOPATH)/bin/helm
	rm -r $(HELM_TMP)

.PHONY: ct
ct: $(CT)
$(CT):
	$(eval CT_TMP := $(shell mktemp -d))
	curl -s -L $(CT_URL) | tar -xvzf - -C $(CT_TMP)
	mkdir -p $(FIRST_GOPATH)/bin
	cp $(CT_TMP)/ct $(FIRST_GOPATH)/bin/ct
	cp -r $(CT_TMP)/etc $(HOME)/.ct
	rm -r $(CT_TMP)

# Build bpf assets
.PHONY: bpf
# Build bpf assets only when CGO_APPS=0
ifeq ($(CGO_APPS), 0)
bpf: clang bpfclean
	@echo ">> building bpf assets using clang"
	$(MAKE) -C ./pkg/collector/bpf

# Clean existing bpf assets. When GOARCH is set we ALWAYS clean the
# assets as we need to build them for each architecture
.PHONY: bpfclean
ifdef GOARCH
bpfclean: 
	@echo ">> cleaning existing bpf assets"
	$(MAKE) -C ./pkg/collector/bpf clean
endif

# Install clang using script. Do it only when GOARCH is set as we need
# clang to build go binaries inside golang-builder container.
.PHONY: clang
ifdef GOARCH
clang:
	@echo ">> installing clang"
	@./scripts/install_clang.sh
endif
endif

# Dont run swagger for release builds. This is due to cross compiling with GOARCH set 
# to different archs and swag will be built in arch specific bin folder.
.PHONY: swag
swag: $(SWAG)
$(SWAG):
ifeq ($(RELEASE_BUILD), 0)
ifeq ($(CGO_APPS), 1)
	$(GO) install github.com/swaggo/swag/v2/cmd/swag@v2.0.0-rc5
endif
endif

.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