Makefile

# The import path is where your repository can be found.
# To import subpackages, always prepend the full import path.
# If you change this, run `make clean`. Read more: https://git.io/vM7zV
IMPORT_PATH := github.com/GoogleCloudPlatform/ubbagent

# V := 1 # When V is set, print commands and build progress.

# Space separated patterns of packages to skip in list, test, format.
IGNORED_PACKAGES := /vendor/ /sdk/python2 /sdk/python3

.PHONY: all
all: help

.PHONY: help
help:
	@echo "Usage: make <target>"
	@echo
	@echo "To get started:"
	@echo "  make setup"
	@echo "  make deps"
	@echo "  make build"
	@echo
	@echo "A successful build will generate a bin/ubbagent executable."
	@echo
	@echo "Targets:"
	@echo "  build             - Build the ubbagent binary."
	@echo "  build-sdk-python2 - Build the python2 agent module."
	@echo "  build-sdk-python3 - Build the python3 agent module."
	@echo "  clean             - Clean build artifacts."
	@echo "  cover             - Display code coverage."
	@echo "  deps              - Fetch or update dependencies."
	@echo "  help              - Display this help message."
	@echo "  setup             - Install required build tools."
	@echo "  test              - Run unit tests."
	@echo "  test-sdk-python2  - Run the python2 module tests."
	@echo "  test-sdk-python3  - Run the python3 module tests."

.PHONY: build
build: .GOPATH/.ok
	$Q go install $(if $V,-v) $(VERSION_FLAGS) $(IMPORT_PATH)

.PHONY: build-sdk-python2
build-sdk-python2: .GOPATH/.ok
	$Q go build $(if $V,-v) $(VERSION_FLAGS) -buildmode=c-shared -o bin/python2/ubbagent.so $(IMPORT_PATH)/sdk/python2
	@rm bin/python2/ubbagent.h

.PHONY: build-sdk-python3
build-sdk-python3: .GOPATH/.ok
	$Q go build $(if $V,-v) $(VERSION_FLAGS) -buildmode=c-shared -o bin/python3/ubbagent.so $(IMPORT_PATH)/sdk/python3
	@rm bin/python3/ubbagent.h

.PHONY: test-sdk-python2
test-sdk-python2: build-sdk-python2
	$Q PYTHONPATH=bin/python2 python2 sdk/python2/test.py

.PHONY: test-sdk-python3
test-sdk-python3: build-sdk-python3
	$Q PYTHONPATH=bin/python3 python3 sdk/python3/test.py

.PHONY: deps
deps: .GOPATH/.ok
	@test -x ./bin/dep || \
	    { echo "dep not found, try running 'make setup'..."; exit 1; }
# Make .GOPATH unreadable so that dep does not traverse into it.
	@chmod -r $(GOPATH)
	-$Q ( cd $(GOPATH)/src/$(IMPORT_PATH) \
	    && bin/dep ensure -vendor-only )
	@chmod +r $(GOPATH)

### Code not in the repository root? Another binary? Add to the path like this.
# .PHONY: otherbin
# otherbin: .GOPATH/.ok
# 	$Q go install $(if $V,-v) $(VERSION_FLAGS) $(IMPORT_PATH)/cmd/otherbin

##### ^^^^^^ EDIT ABOVE ^^^^^^ #####

##### =====> Utility targets <===== #####

.PHONY: clean test list cover format

clean:
	$Q rm -rf bin .GOPATH

test: .GOPATH/.ok
#	$Q go test $(if $V,-v) -i -race $(allpackages) # install -race libs to speed up next run
ifndef CI
	$Q go vet $(allpackages)
	$Q GODEBUG=cgocheck=2 go test -race $(allpackages)
else
	$Q ( go vet $(allpackages); echo $$? ) | \
	    tee .GOPATH/test/vet.txt | sed '$$ d'; exit $$(tail -1 .GOPATH/test/vet.txt)
	$Q ( GODEBUG=cgocheck=2 go test -v -race $(allpackages); echo $$? ) | \
	    tee .GOPATH/test/output.txt | sed '$$ d'; exit $$(tail -1 .GOPATH/test/output.txt)
endif

list: .GOPATH/.ok
	@echo $(allpackages)

cover: bin/gocovmerge .GOPATH/.ok
	@echo "NOTE: make cover does not exit 1 on failure, don't use it to check for tests success!"
	$Q rm -f .GOPATH/cover/*.out .GOPATH/cover/all.merged
	$(if $V,@echo "-- go test -coverpkg=./... -coverprofile=.GOPATH/cover/... ./...")
	@for MOD in $(allpackages); do \
		go test -coverpkg=`echo $(allpackages)|tr " " ","` \
			-coverprofile=.GOPATH/cover/unit-`echo $$MOD|tr "/" "_"`.out \
			$$MOD 2>&1 | grep -v "no packages being tested depend on"; \
	done
	$Q ./bin/gocovmerge .GOPATH/cover/*.out > .GOPATH/cover/all.merged
ifndef CI
	$Q go tool cover -html .GOPATH/cover/all.merged
else
	$Q go tool cover -html .GOPATH/cover/all.merged -o .GOPATH/cover/all.html
endif
	@echo ""
	@echo "=====> Total test coverage: <====="
	@echo ""
	$Q go tool cover -func .GOPATH/cover/all.merged

format: bin/goimports .GOPATH/.ok
	$Q find .GOPATH/src/$(IMPORT_PATH)/ -iname \*.go | grep -v \
	    -e "^$$" $(addprefix -e ,$(IGNORED_PACKAGES)) | xargs ./bin/goimports -w

##### =====> Internals <===== #####

.PHONY: setup
setup: clean .GOPATH/.ok
	@if ! grep "/.GOPATH" .gitignore > /dev/null 2>&1; then \
	    echo "/.GOPATH" >> .gitignore; \
	    echo "/bin" >> .gitignore; \
	fi
	go get -u github.com/golang/dep/cmd/dep
	- go get -u golang.org/x/tools/cmd/goimports
	- go get -u github.com/wadey/gocovmerge
	@test -f Gopkg.toml || \
		(cd $(CURDIR)/.GOPATH/src/$(IMPORT_PATH) && ./bin/dep init)

DATE             := $(shell date -u '+%Y-%m-%d-%H%M UTC')
VERSION_FLAGS    := -ldflags='-X "main.BuildTime=$(DATE)"'

# cd into the GOPATH to workaround ./... not following symlinks
_allpackages = $(shell ( cd $(CURDIR)/.GOPATH/src/$(IMPORT_PATH) && \
    GOPATH=$(CURDIR)/.GOPATH go list ./... 2>&1 1>&3 | \
    grep -v -e "^$$" $(addprefix -e ,$(IGNORED_PACKAGES)) 1>&2 ) 3>&1 | \
    grep -v -e "^$$" $(addprefix -e ,$(IGNORED_PACKAGES)))

# memoize allpackages, so that it's executed only once and only if used
allpackages = $(if $(__allpackages),,$(eval __allpackages := $$(_allpackages)))$(__allpackages)

export GOPATH := $(CURDIR)/.GOPATH
unexport GOBIN

Q := $(if $V,,@)

.GOPATH/.ok:
	$Q mkdir -p "$(dir .GOPATH/src/$(IMPORT_PATH))"
	$Q ln -s `echo $(IMPORT_PATH)|awk -F / '{printf"..";for(i=1;i<=NF;i++)printf"/.."}'` ".GOPATH/src/$(IMPORT_PATH)"
	$Q mkdir -p .GOPATH/test .GOPATH/cover
	$Q mkdir -p bin
	$Q ln -s ../bin .GOPATH/bin
	$Q touch $@

.PHONY: bin/gocovmerge bin/goimports
bin/gocovmerge: .GOPATH/.ok
	@test -x ./bin/gocovmerge || \
	    { echo "gocovmerge not found, try running 'make setup'..."; exit 1; }
bin/goimports: .GOPATH/.ok
	@test -x ./bin/goimports || \
	    { echo "goimports not found, try running 'make setup'..."; exit 1; }

# Based on https://github.com/cloudflare/hellogopher - v1.1 - MIT License
#
# Copyright (c) 2017 Cloudflare
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.