build.mk

OS = $(shell uname | tr A-Z a-z)
GOARCH = $(shell go env GOARCH)

## The expected golang version; crashes if the local env is different
GOLANG_VERSION ?= 1.20

## Build variables
BUILD_DIR ?= bin
BINARY_NAME_client ?= p1
BINARY_NAME_pocket ?= pocket
POST_BUILD_TARGETS = rename-binaries
## When issuing make build against a branch/state that doesn't have a tag referencing the supplied commit hash, the version will be set to the branch name.
VERSION ?= $(shell git describe --tags --exact-match 2>/dev/null || git symbolic-ref -q --short HEAD)
COMMIT_HASH ?= $(shell git rev-parse --short HEAD 2>/dev/null)
DATE_FMT = +%FT%T%z

## Check if the distribution has configured a SOURCE_DATE_EPOCH env var in order to generate a reproducible output.
## This is not currently used but a best practice according to https://reproducible-builds.org/docs/source-date-epoch/
ifdef SOURCE_DATE_EPOCH
    BUILD_DATE ?= $(shell date -u -d "@$(SOURCE_DATE_EPOCH)" "$(DATE_FMT)" 2>/dev/null || date -u -r "$(SOURCE_DATE_EPOCH)" "$(DATE_FMT)" 2>/dev/null || date -u "$(DATE_FMT)")
else
    BUILD_DATE ?= $(shell date "$(DATE_FMT)")
endif
## LDFLAGS are going to be used by the linker to set the version, commit hash and build date.
## debug.ReadBuildInfo() is not going to be used because currently a customised version string is needed.
LDFLAGS += -X github.com/pokt-network/pocket/app.AppVersion=${VERSION} -X github.com/pokt-network/pocket/app.CommitHash=${COMMIT_HASH} -X github.com/pokt-network/pocket/app.BuildDate=${BUILD_DATE}
export CGO_ENABLED ?= 0
ifeq (${VERBOSE}, 1)
ifeq ($(filter -v,${GOARGS}),)
	GOARGS += -v
endif
endif

.PHONY: clean
clean: ${CLEAN_TARGETS} ## Clean the build directory
	rm -rf ${BUILD_DIR}/

.PHONY: goversion
goversion: ## Check if the installed Go version is the required one
ifneq (${IGNORE_GOLANG_VERSION}, 1)
	@printf "${GOLANG_VERSION}\n$$(go version | awk '{sub(/^go/, "", $$3);print $$3}')" | sort -t '.' -k 1,1 -k 2,2 -k 3,3 -g | head -1 | grep -q -E "^${GOLANG_VERSION}$$" || (printf "Required Go version is ${GOLANG_VERSION}\nInstalled: `go version`" && exit 1)
endif

.PHONY: build-%
build-%: pre-build
build-%: goversion ## Build a single application in the app directory
ifeq (${VERBOSE}, 1)
## Informs developer of go environment
	go env
endif

	@mkdir -p ${BUILD_DIR}
	go build ${GOARGS} -trimpath -tags "${GOTAGS}" -ldflags "${LDFLAGS}" -o ${BUILD_DIR}/$* ./app/$*

	@${MAKE} post-build

.PHONY: build
build: pre-build
build: goversion ## Build all applications in the app directory
ifeq (${VERBOSE}, 1)
## Informs developer of go environment
	go env
endif

	@mkdir -p ${BUILD_DIR}
	go build ${GOARGS} -trimpath -tags "${GOTAGS}" -ldflags "${LDFLAGS}" -o ${BUILD_DIR}/ ./app/...

	@${MAKE} post-build

## Pre build hook
.PHONY: pre-build
pre-build: ${PRE_BUILD_TARGETS}
	@:

## Post build hook
.PHONY: post-build
post-build: ${POST_BUILD_TARGETS}
	@:

.PHONY: run-%
run-%: build-% ## Run a single application in after building it
	${BUILD_DIR}/$*

.PHONY: run ## Run all applications in the app directory after building them
run: $(patsubst app/%,run-%,$(wildcard app/*)) ## Build and execute all applications

.PHONY: rename-%
rename-%: ## Rename a binary to the name specified in BINARY_NAME_$* if it exists.
## Redirecting stderr to /dev/null to avoid returning an error if the file already exists
	@mv -f ${BUILD_DIR}/$* ${BUILD_DIR}/${BINARY_NAME_$*} 2>/dev/null; true

.PHONY: rename-binaries
rename-binaries: $(patsubst bin/%,rename-%,$(wildcard bin/*)) ## Rename all binaries in the bin directory to the name specified in BINARY_NAME_$* if it exists