Makefile

# @echo off
.SILENT:

# Make sure that globstar is active, this allows bash to use ./**/*.go
SHELL=/usr/bin/env bash -O globstar

# Default repository
REPO=github.com/bitmaelum/bitmaelum-suite

# Our defined apps and tools
APPS := bm-server bm-client bm-config bm-mail bm-send bm-json bm-bridge
TOOLS := hash-address jwt proof-of-work update-resolver vault-edit resolve-auth update-pow jwt-validate toaster

# These files are checked for license headers
LICENSE_CHECK_DIRS=internal/**/*.go pkg/**/*.go tools/**/*.go cmd/**/*.go

CROSS_APPS := $(foreach app,$(APPS),cross-$(app))
CROSS_TOOLS := $(foreach tool,$(TOOLS),cross-$(tool))

# Platforms we can build on for cross platform. Should be in <os>-<arch> notation
PLATFORMS := windows-amd64 linux-amd64 darwin-amd64
BUILD_ALL_PLATFORMS := $(foreach platform,$(PLATFORMS),build-all-$(platform))


# Generate LD flags
PKG=$(shell go list ./internal)
BUILD_DATE=$(shell date)
COMMIT=$(shell git rev-parse HEAD)
VERSIONTAG="v0.0.0"
LD_FLAGS = -ldflags "-X '${PKG}.BuildDate=${BUILD_DATE}' -X '${PKG}.GitCommit=${COMMIT}' -X '${PKG}.VersionTag=${VERSIONTAG}'"

# Set environment variables from GO env if not set explicitly already
GOPATH ?= $(shell go env GOPATH)
GOOS ?= $(shell go env GOOS)
GOARCH ?= $(shell go env GOARCH)


# paths to binaries
GO_STATCHECK_BIN = $(GOPATH)/bin/staticcheck
GO_INEFF_BIN = $(GOPATH)/bin/ineffassign
GO_GOCYCLO_BIN = $(GOPATH)/bin/gocyclo
GO_GOIMPORTS_BIN = $(GOPATH)/bin/goimports
GO_LINT_BIN = $(GOPATH)/bin/golint
GO_LICENSE_BIN = $(GOPATH)/bin/addlicense

# ---------------------------------------------------------------------------

# Downloads external tools as they are not available by default
get_test_tools: ## go get all build tools needed to testing
	GO111MODULE=off go get -u honnef.co/go/tools/cmd/staticcheck
	GO111MODULE=off go get -u github.com/google/addlicense
	GO111MODULE=off go get -u github.com/gordonklaus/ineffassign
	GO111MODULE=off go get -u github.com/fzipp/gocyclo/cmd/gocyclo
	GO111MODULE=off go get -u golang.org/x/tools/cmd/goimports
	GO111MODULE=off go get -u golang.org/x/lint/golint

lint: ## Formats your go code to specified standards
	$(GO_GOIMPORTS_BIN) -w  --format-only .

## Runs all tests for the whole repository
test: test_goimports test_license test_vet test_golint test_staticcheck test_ineffassign test_gocyclo test_unit

test_goimports:	
	source .github/workflows/github.sh  ; \
	section "Test imports and code style" ; \
	out=`$(GO_GOIMPORTS_BIN) -l .` ; \
	echo "$${out}" ; \
	test -z `echo $${out}`

test_license:
	source .github/workflows/github.sh ;\
	section "Test for licenses" ;\
	shopt -s globstar ;\
	$(GO_LICENSE_BIN) -c "BitMaelum Authors" -l mit -y 2021 -check $(LICENSE_CHECK_DIRS) 

test_vet:
	source .github/workflows/github.sh ;\
	section "Test go vet" ;\
	go vet ./...

test_staticcheck:
	source .github/workflows/github.sh ;\
	section "Test static checks" ;\
	$(GO_STATCHECK_BIN) ./...

test_golint:
	source .github/workflows/github.sh ;\
	section "Checking linting" ;\
	$(GO_LINT_BIN) -set_exit_status ./...

test_ineffassign:
	source .github/workflows/github.sh ;\
	section "Test ineffassign" ;\
	$(GO_INEFF_BIN) ./...

test_gocyclo:
	source .github/workflows/github.sh ;\
	section "Testing cyclomatic complexity" ;\
	$(GO_GOCYCLO_BIN) -over 15 .

test_unit:
	source .github/workflows/github.sh ;\
	section "Test unittests" ;\
	go test ./...

clean: ## Clean releases
	go clean

# Build default OS/ARCH apps in root release directory
$(APPS):
	$(info -   Building app $@)
	go build $(LD_FLAGS) -o release/$@ $(REPO)/cmd/$@

# Build default OS/ARCH tools in root release directory
$(TOOLS):
	$(info -   Building tool $@)
	go build $(LD_FLAGS) -o release/$@ $(REPO)/tools/$@

# Build GOOS/GOARCH apps in separate release directory
$(CROSS_APPS):
	$(info -   Building app $(subst cross-,,$@) (${GOOS}-${GOARCH}))
	if [[ "${GOOS}" == "windows" ]]; then SUFFIX=".exe"; else SUFFIX="" ; fi; \
	CGO_ENABLED=0 go build $(LD_FLAGS) -o release/${GOOS}-${GOARCH}/$(subst cross-,,$@)$${SUFFIX} $(REPO)/cmd/$(subst cross-,,$@)

# Build GOOS/GOARCH tools in separate release directory
$(CROSS_TOOLS):
	$(info -   Building tool $(subst cross-,,$@) (${GOOS}-${GOARCH}))
	go build $(LD_FLAGS) -o release/${GOOS}-${GOARCH}/$(subst cross-,,$@) $(REPO)/tools/$(subst cross-,,$@)

$(BUILD_ALL_PLATFORMS):
	make -j $(CROSS_APPS) GOOS=${GOOS} GOARCH=${GOARCH}
	#make -j $(CROSS_TOOLS) GOOS=${GOOS} GOARCH=${GOARCH}

$(PLATFORMS):
	$(eval GOOS=$(firstword $(subst -, ,$@)))
	$(eval GOARCH=$(lastword $(subst -, ,$@)))
	$(info - Cross platform build $(GOOS) / $(GOARCH))
	make -j build-all-$(GOOS)-$(GOARCH) GOOS=$(GOOS) GOARCH=$(GOARCH)

info:
	$(info Building BitMaelum apps and tools)

cross-info:
	$(info Cross building BitMaelum apps and tools)

fix-licenses: ## Adds / updates license information in source files
	$(GO_LICENSE_BIN) -c "BitMaelum Authors" -l mit -y 2021 -v $(LICENSE_CHECK_DIRS)

build-all: cross-info $(PLATFORMS) ## Build all cross-platform binaries

build: info $(APPS) $(TOOLS) ## Build default platform binaries

all: test build ## Run tests and build default platform binaries

help: ## Display available commands
	echo "BitMaelum make commands"
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'