Makefile

.PHONY: *
.DEFAULT_GOAL:=help

# Project setup
BINARY_NAME=algoid
OWNER=algorandfoundation
REPO=did-algo
PROJECT_REPO=github.com/$(OWNER)/$(REPO)
DOCKER_IMAGE=ghcr.io/$(OWNER)/$(BINARY_NAME)
MAINTAINERS='Joe Polny <joe@algorand.foundation>'

# State values
GIT_COMMIT_DATE=$(shell TZ=UTC git log -n1 --pretty=format:'%cd' --date='format-local:%Y-%m-%dT%H:%M:%SZ')
GIT_COMMIT_HASH=$(shell git log -n1 --pretty=format:'%H')
GIT_TAG=$(shell git describe --tags --always --abbrev=0 | cut -c 1-7)

# Linker tags
# https://golang.org/cmd/link/
LD_FLAGS += -s -w
LD_FLAGS += -X $(PROJECT_REPO)/info.CoreVersion=$(GIT_TAG:v%=%)
LD_FLAGS += -X $(PROJECT_REPO)/info.BuildCode=$(GIT_COMMIT_HASH)
LD_FLAGS += -X $(PROJECT_REPO)/info.BuildTimestamp=$(GIT_COMMIT_DATE)

# For commands that require a specific package path, default to all local
# subdirectories if no value is provided.
pkg?="..."

# "buf" is used to manage protocol buffer definitions, if not installed
# locally we fallback to use a builder image.
buf:=buf
ifeq (, $(shell which buf))
	buf=docker run --platform linux/amd64 --rm -it -v $(shell pwd):/workdir ghcr.io/bryk-io/buf-builder:1.29.0 buf
endif

help:
	@echo "Commands available"
	@sed -n 's/^##//p' ${MAKEFILE_LIST} | column -t -s ':' | sed -e 's/^/ /' | sort

## bench: Run benchmarks
bench:
	go test -run=XXX -bench=. -benchmem ./...

## build: Build for the current architecture in use, intended for development
build:
	# Build CLI application
	go build -v -ldflags '$(LD_FLAGS)' -o $(BINARY_NAME) ./client/cli

## build-for: Build the available binaries for the specified 'os' and 'arch'
# make build-for os=linux arch=amd64
build-for:
	CGO_ENABLED=0 GOOS=$(os) GOARCH=$(arch) \
	go build -v -ldflags '$(LD_FLAGS)' \
	-o $(BINARY_NAME)_$(os)_$(arch)$(suffix) \
	./client/cli

## ca-roots: Generate the list of valid CA certificates
ca-roots:
	@docker run -dit --rm --name ca-roots debian:stable-slim
	@docker exec --privileged ca-roots sh -c "apt update"
	@docker exec --privileged ca-roots sh -c "apt install -y ca-certificates"
	@docker exec --privileged ca-roots sh -c "cat /etc/ssl/certs/* > /ca-roots.crt"
	@docker cp ca-roots:/ca-roots.crt ca-roots.crt
	@docker stop ca-roots

## deps: Verify dependencies and remove intermediary products
deps:
	go mod tidy
	go clean

## docker: Build docker image
# https://github.com/opencontainers/image-spec/blob/master/annotations.md
docker:
	make build-for os=linux arch=amd64
	mv $(BINARY_NAME)_linux_amd64 $(BINARY_NAME)
	@-docker rmi $(DOCKER_IMAGE):$(GIT_TAG:v%=%)
	@docker build \
	"--label=org.opencontainers.image.title=$(BINARY_NAME)" \
	"--label=org.opencontainers.image.authors=$(MAINTAINERS)" \
	"--label=org.opencontainers.image.created=$(GIT_COMMIT_DATE)" \
	"--label=org.opencontainers.image.revision=$(GIT_COMMIT_HASH)" \
	"--label=org.opencontainers.image.version=$(GIT_TAG:v%=%)" \
	--rm -t $(DOCKER_IMAGE):$(GIT_TAG:v%=%) .
	@docker build \
	"--label=org.opencontainers.image.title=$(BINARY_NAME)-resolver" \
	"--label=org.opencontainers.image.authors=$(MAINTAINERS)" \
	"--label=org.opencontainers.image.created=$(GIT_COMMIT_DATE)" \
	"--label=org.opencontainers.image.revision=$(GIT_COMMIT_HASH)" \
	"--label=org.opencontainers.image.version=$(GIT_TAG:v%=%)" \
	--rm -f Dockerfile.resolver -t $(DOCKER_IMAGE)-resolver:$(GIT_TAG:v%=%) .
	@rm $(BINARY_NAME)

## install: Install the binary to GOPATH and keep cached all compiled artifacts
install:
	@go build -v -ldflags '$(LD_FLAGS)' -o ${GOPATH}/bin/$(BINARY_NAME) ./client/cli
	mv ${BINARY_NAME} ${GOBIN}/.

## lint: Static analysis
lint:
	# Code
	golangci-lint run -v ./$(pkg)

	# Helm charts
	helm lint helm/*

## protos: Compile all protobuf definitions and RPC services
protos:
	# Verify PB definitions
	make proto-test

	# Build package image
	$(buf) build --output proto/did/v1/image.bin --path proto/did/v1

	# Generate package code using buf.gen.yaml
	$(buf) generate --output proto --path proto/did/v1

	# Add compiler version to generated files
	@-sed -i.bak 's/(unknown)/buf-v$(shell buf --version)/g' proto/did/v1/*.pb.go

	# Remove package comment added by the gateway generator to avoid polluting
	# the package documentation.
	@-sed -i.bak '/\/\*/,/*\//d' proto/did/v1/*.pb.gw.go

	# Remove non-required dependencies. "protoc-gen-validate" don't have runtime
	# dependencies but the generated code includes the package by the default =/.
	@-sed -i.bak '/protoc-gen-validate/d' proto/did/v1/*.pb.go

	# Remove in-place edit backup files
	@-rm proto/did/v1/*.bak

	# Style adjustments (required for consistency)
	gofmt -s -w proto/did/v1
	goimports -w proto/did/v1

## proto-test: Verify protobuf definitions
proto-test:
	# Verify style and consistency
	$(buf) lint --path proto/did/v1

	# Verify breaking changes. This fails if no image is already present,
	# use `buf build --o proto/did/v1/image.bin --path proto/did/v1` to generate it.
	$(buf) breaking --against proto/did/v1/image.bin

## release: Prepare artifacts for a new tagged release
release:
	goreleaser release --skip-validate --skip-publish --clean

## scan-deps: Look for known vulnerabilities in the project dependencies
# https://github.com/sonatype-nexus-community/nancy
scan-deps:
	@go list -json -deps ./... | nancy sleuth --skip-update-check

## test: Run all tests excluding the vendor dependencies
test:
	# Unit tests
	# -count=1 -p=1 (disable cache and parallel execution)
	go test -race -v -failfast -coverprofile=coverage.report ./$(pkg)
	go tool cover -html coverage.report -o coverage.html

## updates: List available updates for direct dependencies
# https://github.com/golang/go/wiki/Modules#how-to-upgrade-and-downgrade-dependencies
updates:
	@GOWORK=off go list -u -f '{{if (and (not (or .Main .Indirect)) .Update)}}{{.Path}}: [{{.Version}} -> {{.Update.Version}}]{{end}}' -mod=mod -m all 2> /dev/null