GNUmakefile

SHELL = bash
default: lint check test dev

GIT_COMMIT := $(shell git rev-parse --short HEAD)
GIT_DIRTY := $(if $(shell git status --porcelain),+CHANGES)

GO_LDFLAGS := "$(GO_LDFLAGS) -X github.com/hashicorp/nomad-autoscaler/version.GitCommit=$(GIT_COMMIT)$(GIT_DIRTY)"
GO_TAGS := ""

# Attempt to use gotestsum for running tests, otherwise fallback to go test.
GO_TEST_CMD = $(if $(shell command -v gotestsum 2>/dev/null),gotestsum --,go test)

# Respect $GOBIN if set in environment or via $GOENV file.
BIN := $(shell go env GOBIN)
ifndef BIN
BIN := $(GOPATH)/bin
endif

HELP_FORMAT="    \033[36m%-25s\033[0m %s\n"
.PHONY: help
help: ## Display this usage information
	@echo "Valid targets:"
	@grep -E '^[^ ]+:.*?## .*$$' $(MAKEFILE_LIST) | \
		sort | \
		awk 'BEGIN {FS = ":.*?## "}; \
			{printf $(HELP_FORMAT), $$1, $$2}'
	@echo ""

.PHONY: tools
tools: lint-tools test-tools generate-tools

.PHONY: generate-tools
generate-tools: ## Install the tools used to generate code
	@echo "==> Installing code generate tools..."
	go install github.com/bufbuild/buf/cmd/buf@v1.45.0
	go install github.com/golang/protobuf/protoc-gen-go@v1.5.3
	@echo "==> Done"

.PHONY: test-tools
test-tools: ## Install the tools used to run tests
	@echo "==> Installing test tools..."
	go install gotest.tools/gotestsum@v1.8.2
	@echo "==> Done"

.PHONY: lint-tools
lint-tools: ## Install the tools used to lint
	@echo "==> Installing lint tools..."
	go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.61.0
	go install honnef.co/go/tools/cmd/staticcheck@2024.1.1
	go install github.com/hashicorp/go-hclog/hclogvet@v0.2.0
	go install github.com/hashicorp/hcl/v2/cmd/hclfmt@d0c4fa8b0bbc2e4eeccd1ed2a32c2089ed8c5cf1
	@echo "==> Done"

pkg/%/nomad-autoscaler: GO_OUT ?= $@
pkg/windows_%/nomad-autoscaler: GO_OUT = $@.exe
pkg/%/nomad-autoscaler: ## Build Nomad Autoscaler for GOOS_GOARCH, e.g. pkg/linux_amd64/nomad-autoscaler
	@echo "==> Building $@ with tags $(GO_TAGS)..."
	@CGO_ENABLED=0 \
		GOOS=$(firstword $(subst _, ,$*)) \
		GOARCH=$(lastword $(subst _, ,$*)) \
		go build -trimpath -ldflags $(GO_LDFLAGS) -tags "$(GO_TAGS)" -o $(GO_OUT)

.PRECIOUS: pkg/%/nomad-autoscaler
pkg/%.zip: pkg/%/nomad-autoscaler ## Build and zip Nomad Autoscaler for GOOS_GOARCH, e.g. pkg/linux_amd64.zip
	@echo "==> Packaging for $@..."
	@cp LICENSE $(dir $<)LICENSE.txt
	zip -j $@ $(dir $<)*

.PHONY: dev
dev: lint ## Build for the current development version
	@echo "==> Building autoscaler..."
	@CGO_ENABLED=0 GOPROXY=direct go build \
		-ldflags $(GO_LDFLAGS) \
		-tags "$(GO_TAGS)" \
		-o ./bin/nomad-autoscaler
	@rm -f $(BIN)/nomad-autoscaler && cp ./bin/nomad-autoscaler $(BIN)/
	@echo "==> Done"

.PHONY: proto
proto: ## Generate the protocol buffers
	@echo "==> Generating proto bindings..."
	@buf --config tools/buf/buf.yaml --template tools/buf/buf.gen.yaml generate
	@echo "==> Done"

.PHONY: lint
lint: lint-tools generate-tools hclfmt ## Lint the source code
	@echo "==> Linting source code..."
	@GOPROXY=direct \
	golangci-lint run -j 1 --build-tags "$(GO_TAGS)" --timeout=8m
	@staticcheck ./...
	@hclogvet .
	@buf lint --config=./tools/buf/buf.yaml
	@echo "==> Done"

.PHONY: hclfmt
hclfmt: ## Format HCL files with hclfmt
	@echo "--> Formatting HCL"
	@find . -name '.git' -prune \
	        -o \( -name '*.nomad' -o -name '*.hcl' -o -name '*.tf' \) \
	      -print0 | xargs -0 hclfmt -w
	@if (git status -s | grep -q -e '\.hcl$$' -e '\.nomad$$' -e '\.tf$$'); then echo the following HCL files are out of sync; git status -s | grep -e '\.hcl$$' -e '\.nomad$$' -e '\.tf$$'; exit 1; fi

.PHONY: check
check: tools check-sdk check-root-mod check-protobuf ## Lint the source code and check other properties

.PHONY: check-sdk
check-sdk: ## Checks the SDK pkg is isolated
	@echo "==> Checking SDK package is isolated..."
	@if go list --test -f '{{ join .Deps "\n" }}' ./sdk | grep github.com/hashicorp/nomad-autoscaler/ | grep -v -e /nomad-autoscaler/sdk/ -e nomad-autoscaler/sdk.test; \
		then echo " /sdk package depends the ^^ above internal packages. Remove such dependency"; \
		exit 1; fi
	@echo "==> Done"

.PHONY: check-root-mod
check-root-mod: ## Checks the root Go mod is tidy
	@echo "==> Checking Go mod and Go sum..."
	@go mod tidy
	@if (git status --porcelain | grep -Eq "go\.(mod|sum)"); then \
		echo go.mod or go.sum needs updating; \
		git --no-pager diff go.mod; \
		git --no-pager diff go.sum; \
		exit 1; fi
	@echo "==> Done"

.PHONY: check-protobuf
check-protobuf: ## Checks the protobuf files are in-sync
	@$(MAKE) proto
	@echo "==> Checking proto files are in-sync..."
	@if (git status -s | grep -q .pb.go); then echo the following proto files are out of sync; git status -s | grep .pb.go; exit 1; fi
	@echo "==> Done"

.PHONY: test
test: ## Test the source code
	@$(MAKE) -C plugins/test
	@echo "==> Testing source code..."
	@GOPROXY=direct \
    	$(GO_TEST_CMD) -v -race -cover ./... -tags "$(GO_TAGS)"
	@echo "==> Done"

.PHONY: clean-plugins
clean-plugins:
	@echo "==> Cleaning plugins..."
	@rm -rf ./bin/plugins/
	@echo "==> Done"

.PHONY: clean
clean: clean-plugins
	@echo "==> Cleaning build artifacts..."
	@rm -f ./bin/nomad-autoscaler
	@echo "==> Done"

bin/plugins/nomad-apm:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/apm/nomad && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/nomad-target:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/target/nomad && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/prometheus:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/apm/prometheus && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/target-value:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/strategy/target-value && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/fixed-value:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/strategy/fixed-value && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/pass-through:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/strategy/pass-through && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/threshold:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/strategy/threshold && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/aws-asg:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/target/aws-asg && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/datadog:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/apm/datadog && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/azure-vmss:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/target/azure-vmss && go build -o ../../../../$@
	@echo "==> Done"

bin/plugins/gce-mig:
	@echo "==> Building $@..."
	@mkdir -p $$(dirname $@)
	@cd ./plugins/builtin/target/gce-mig && go build -o ../../../../$@
	@echo "==> Done"

.PHONY: plugins
plugins: \
	bin/plugins/nomad-apm \
	bin/plugins/nomad-target \
	bin/plugins/prometheus \
	bin/plugins/target-value \
	bin/plugins/fixed-value \
	bin/plugins/pass-through \
	bin/plugins/threshold \
	bin/plugins/aws-asg \
	bin/plugins/datadog \
	bin/plugins/azure-vmss \
	bin/plugins/gce-mig

.PHONY: tidy-test-plugin-mods
tidy-test-plugin-mods:
	@echo "==> Tidying test plugin Go modules..."
	@cd plugins/test/noop-apm && go mod tidy
	@cd plugins/test/noop-strategy && go mod tidy
	@cd plugins/test/noop-target && go mod tidy
	@echo "==> Done"

.PHONY: version
version:
ifneq (,$(wildcard version/version_ent.go))
	@$(CURDIR)/scripts/version.sh version/version.go version/version_ent.go
else
	@$(CURDIR)/scripts/version.sh version/version.go version/version.go
endif