docker/swarmkit

# Base path used to install.
DESTDIR=/usr/local

# Used to populate version variable in main package.
VERSION=$(shell git describe --match 'v[0-9]*' --dirty='.m' --always)

# Race detector is only supported on amd64.
RACE := $(shell test $$(go env GOARCH) != "amd64" || (echo "-race"))

# Project packages.
PACKAGES = $(shell go list ./...)
INTEGRATION_PACKAGE = $(shell go list ./integration)

# Project binaries.
COMMANDS=swarm-bench protoc-gen-gogoswarm
BINARIES=$(addprefix bin/,$(COMMANDS))
SWARMD_COMMANDS=swarmd swarmctl swarm-rafttool
SWARMD_BINARIES=$(addprefix swarmd/bin/,$(SWARMD_COMMANDS))

VERSIONPKG := $(shell go list ./version)
GO_LDFLAGS=-ldflags "-X $(VERSIONPKG).Version=$(VERSION)"
GO_TESTFLAGS=--timeout=20m $(RACE)

GOBIN=$(shell go env GOPATH)/bin

.DEFAULT_GOAL = all
.PHONY: all
all: check binaries test integration-tests swarmd-tests ## run check, build the binaries and run the tests

.PHONY: ci
ci: check binaries checkprotos coverage coverage-integration ## to be used by the CI

.PHONY: AUTHORS
AUTHORS: .mailmap .git/HEAD
    git log --format='%aN <%aE>' | sort -fu > $@

# This only needs to be generated by hand when cutting full releases.
version/version.go:
    ./version/version.sh > $@

.PHONY: setup
setup: ## install dependencies
    @echo "🐳 $@"
    # install golangci-lint version v1.50.1 to ./bin/golangci-lint
    @curl -fsSL https://raw.githubusercontent.com/golangci/golangci-lint/v1.50.1/install.sh | sh -s v1.50.1
    @(cd tools ; GO111MODULE=on go install github.com/containerd/protobuild)

.PHONY: generate
generate: protos
    @echo "🐳 $@"
    @PATH=${ROOTDIR}/bin:${GOBIN}:${PATH} go generate -x ${PACKAGES}

.PHONY: protos
protos: bin/protoc-gen-gogoswarm ## generate protobuf
    @echo "🐳 $@"
    @PATH=${ROOTDIR}/bin:${GOBIN}:${PATH} protobuild ${PACKAGES}

.PHONY: checkprotos
checkprotos: generate ## check if protobufs needs to be generated again
    @echo "🐳 $@"
    @test -z "$$(git status --short | grep ".pb.go" | tee /dev/stderr)" || \
        ((git diff | cat) && \
        (echo "👹 please run 'make generate' when making changes to proto files" && false))

.PHONY: check
check: fmt-proto
check: ## Run various source code validation tools
    @echo "🐳 $@"
    @./bin/golangci-lint run

.PHONY: fmt-proto
fmt-proto:
    @test -z "$$(find . -path ./vendor -prune -o ! -name timestamp.proto ! -name duration.proto -name '*.proto' -type f -exec grep -Hn -e "^ " {} \; | tee /dev/stderr)" || \
        (echo "👹 please indent proto files with tabs only" && false)
    @test -z "$$(find . -path ./vendor -prune -o -name '*.proto' -type f -exec grep -Hn "Meta meta = " {} \; | grep -v '(gogoproto.nullable) = false' | tee /dev/stderr)" || \
        (echo "👹 meta fields in proto files must have option (gogoproto.nullable) = false" && false)

.PHONY: build
build: ## build the go packages
    @echo "🐳 $@"
    @go build -tags "${DOCKER_BUILDTAGS}" -v ${GO_LDFLAGS} ${GO_GCFLAGS} ${PACKAGES}

.PHONY: test
test: ## run tests, except integration tests
    @echo "🐳 $@"
    @go test -parallel 8 ${GO_TESTFLAGS} -tags "${DOCKER_BUILDTAGS}" $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES})

.PHONY: integration-tests
integration-tests: ## run integration tests
    @echo "🐳 $@"
    @go test -parallel 8 ${GO_TESTFLAGS} -tags "${DOCKER_BUILDTAGS}" ${INTEGRATION_PACKAGE}

.PHONY: swarmd-tests
swarmd-tests: ## run swarmd tests
    @echo "🐳 $@"
    @cd swarmd && go test -parallel 8 ${GO_TESTFLAGS} -tags "${DOCKER_BUILDTAGS}" ./...

# Build a binary from a cmd.
bin/%: cmd/% .FORCE
    @echo "🐳 $@"
    @go build -tags "${DOCKER_BUILDTAGS}" -o $@ ${GO_LDFLAGS}  ${GO_GCFLAGS} ./$<

swarmd/bin/%: swarmd/cmd/% .FORCE
    @echo "🐳 $@"
    @cd swarmd && go build -tags "${DOCKER_BUILDTAGS}" -o ../$@ ${GO_LDFLAGS}  ${GO_GCFLAGS} ../$<

.PHONY: .FORCE
.FORCE:

.PHONY: binaries
binaries: $(BINARIES) $(SWARMD_BINARIES) ## build binaries
    @echo "🐳 $@"

.PHONY: clean
clean: ## clean up binaries
    @echo "🐳 $@"
    @rm -f $(BINARIES) $(SWARMD_BINARIES)

.PHONY: install
install: $(BINARIES) $(SWARMD_BINARIES) ## install binaries
    @echo "🐳 $@"
    @mkdir -p $(DESTDIR)/bin
    @install $(BINARIES) $(SWARMD_BINARIES) $(DESTDIR)/bin

.PHONY: uninstall
uninstall:
    @echo "🐳 $@"
    @rm -f $(addprefix $(DESTDIR)/bin/,$(notdir $(BINARIES)))

.PHONY: coverage
coverage: ## generate coverprofiles from the unit tests
    @echo "🐳 $@"
    @( for pkg in $(filter-out ${INTEGRATION_PACKAGE},${PACKAGES}); do \
        go test ${GO_TESTFLAGS} -tags "${DOCKER_BUILDTAGS}" -test.short -coverprofile="$$(go list -f "{{.Dir}}" $$pkg)/coverage.txt" -covermode=atomic $$pkg || exit; \
    done )

.PHONY: coverage-integration
coverage-integration: ## generate coverprofiles from the integration tests
    @echo "🐳 $@"
    go test ${GO_TESTFLAGS} -tags "${DOCKER_BUILDTAGS}" -test.short -coverprofile="$$(go list -f "{{.Dir}}" ${INTEGRATION_PACKAGE})/coverage.txt" -covermode=atomic ${INTEGRATION_PACKAGE}

.PHONY: help
help: ## this help
    @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort

.PHONY: dep-validate
dep-validate: go-mod-vendor
    @echo "+ $@"
    @go mod tidy
    @git diff --exit-code go.mod go.sum vendor || \
        (echo >&2 "+ inconsistent dependencies! what you have in go.mod does not match with what you have in vendor" && false)

.PHONY: go-mod-vendor
go-mod-vendor:
    @go mod tidy
    @go mod vendor
    @# ensure that key protobuf spec files are in vendor dir
    @module=github.com/gogo/protobuf ; \
        prefix=$$(go env GOMODCACHE)/$${module} ; \
        version=$$(go list -m -f '{{.Version}}' $${module}) ; \
        cp -a $${prefix}@$${version}/protobuf vendor/$${module}/ && chmod -R u+w vendor/$${module}