Makefile

# List special make targets that are not associated with files
.PHONY: help all test format fmtcheck vet lint coverage cyclo ineffassign misspell astscan qa deps clean nuke install loc

VERSION=0.3.3

SHELL=/bin/bash
CURRENTDIR=$(shell pwd)
REPOPATH=github.com/funkygao
OWNER=funkygao
VENDOR=funkygao
PROJECT=dbus
PKGNAME=${VENDOR}-${PROJECT}
GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD 2> /dev/null || echo 'unknown')
GIT_ID=$(shell git rev-parse HEAD | cut -c1-7)
GIT_DIRTY=$(shell test -n "`git status --porcelain`" && echo "+CHANGES" || true)
GO_VERSION=$(shell go version | sed -e 's/^[^0-9.]*\([0-9.]*\).*/\1/' )
BUILD_TIME=$(shell date '+%Y%m%d-%H:%M:%S')
BUILD_USER=$(shell echo `whoami`@`hostname`)
GO_FLAGS=${GO_FLAGS:-} # Extra go flags to use in the build.

ldflags="\
-X github.com/funkygao/golib/version.Version=$(VERSION) \
-X github.com/funkygao/golib/version.Branch=${GIT_BRANCH} \
-X github.com/funkygao/golib/version.Revision=${GIT_ID}${GIT_DIRTY} \
-X github.com/funkygao/golib/version.BuildDate=${BUILD_TIME} \
-X github.com/funkygao/golib/version.BuildUser=${BUILD_USER} \
-w"

help:
	@echo "The following commands are available:"
	@echo ""
	@echo "    make qa          : Run all Quality-Assurance checks"
	@echo "    make test        : Run unit tests"
	@echo ""
	@echo "    make format      : Format the source code"
	@echo "    make fmtcheck    : Check if the source code has been formatted"
	@echo "    make vet         : Check for suspicious constructs"
	@echo "    make simple      : Simplify code"
	@echo "    make checkall    : Check all"
	@echo "    make lint        : Check for style errors"
	@echo "    make coverage    : Generate the coverage report"
	@echo "    make cyclo       : Generate the cyclomatic complexity report"
	@echo "    make ineffassign : Detect ineffectual assignments"
	@echo "    make misspell    : Detect commonly misspelled words in source files"
	@echo "    make astscan     : GO AST scanner"
	@echo "    make loc         : Line of code"
	@echo "    make vis         : Visualize package dependencies"
	@echo "    make generate    : Recursively invoke go generate"
	@echo "    make escape      : Escape analysis"
	@echo ""
	@echo "    make dbusd       : Build and install dbusd to $(GOPATH)/bin"
	@echo "    make dbc         : Build and install dbc to $(GOPATH)/bin"
	@echo "    make all         : Build and install dbc+dbusd to $(GOPATH)/bin"
	@echo ""
	@echo "    make docs        : Generate source code documentation"
	@echo ""
	@echo "    make deps        : Get the dependencies"
	@echo "    make clean       : Remove any build artifact"
	@echo "    make nuke        : Deletes any intermediate file"
	@echo ""

# Run the unit tests
test:
	@mkdir -p .target/test
	GOPATH=$(GOPATH) \
	go test -covermode=atomic -bench=. -race -v ./... | \
	tee >(PATH=$(GOPATH)/bin:$(PATH) go-junit-report > .target/test/report.xml); \
	test $${PIPESTATUS[0]} -eq 0

# Format the source code inplace
format:
	@find . -type f -name "*.go" -exec gofmt -s -w {} \;

escape:
	go build -gcflags '-m=1' ./cmd/dbusd
	@rm -f dbusd

# Check if the source code has been formatted
fmtcheck:
	@mkdir -p .target
	@find . -type f -name "*.go" -exec gofmt -s -d {} \; | tee .target/format.diff
	@test ! -s .target/format.diff || { echo "ERROR: the source code has not been formatted - please use 'make format' or 'gofmt'"; exit 1; }

# Check for syntax errors
vet:
	-GOPATH=$(GOPATH) go vet ./...

# Check for style errors
lint:
	-GOPATH=$(GOPATH) PATH=$(GOPATH)/bin:$(PATH) golint ./... | grep -v self | grep -v 'have comment'

simple:
	-gosimple ./...

checkall:
	-aligncheck ./...
	-structcheck ./...
	-varcheck ./...
	-aligncheck ./...
	-errcheck ./...
	-staticcheck ./...

# Generate the coverage report
coverage:
	@mkdir -p .target/report
	-@GOPATH=$(GOPATH) go test -covermode=count ./... | grep -v "no test files" | column -t

# Report cyclomatic complexity
cyclo:
	@mkdir -p .target/report
	-GOPATH=$(GOPATH) gocyclo -avg . | tee .target/report/cyclo.txt ; test $${PIPESTATUS[0]} -eq 0

# Detect ineffectual assignments
ineffassign:
	@mkdir -p .target/report
	-GOPATH=$(GOPATH) ineffassign . | tee .target/report/ineffassign.txt ; test $${PIPESTATUS[0]} -eq 0

# Detect commonly misspelled words in source files
misspell:
	-find . -type f -name "*.go" -exec misspell -error {} \; | tee .target/report/misspell.txt ; test $${PIPESTATUS[0]} -eq 0
	-misspell README.md

# AST scanner
astscan:
	@mkdir -p .target/report
	-GOPATH=$(GOPATH) gas ./... | tee .target/report/astscan.txt ; test $${PIPESTATUS[0]} -eq 0

# Generate source docs
docs:
	@mkdir -p .target/docs
	nohup sh -c 'GOPATH=$(GOPATH) godoc -http=127.0.0.1:6060' > .target/godoc_server.log 2>&1 &
	wget --directory-prefix=.target/docs/ --execute robots=off --retry-connrefused --recursive --no-parent --adjust-extension --page-requisites --convert-links http://127.0.0.1:6060/pkg/github.com/${VENDOR}/${PROJECT}/ ; kill -9 `lsof -ti :6060`
	@echo '<html><head><meta http-equiv="refresh" content="0;./127.0.0.1:6060/pkg/'${REPOPATH}'/'${PROJECT}'/index.html"/></head><a href="./127.0.0.1:6060/pkg/'${REPOPATH}'/'${PROJECT}'/index.html">'${PKGNAME}' Documentation ...</a></html>' > .target/docs/index.html
	open .target/docs/index.html

# Alias to run all quality-assurance checks
qa: fmtcheck vet lint coverage ineffassign misspell astscan
	-go test ./...

# Get the dependencies
deps:
	GOPATH=$(GOPATH) go get github.com/golang/lint/golint
	GOPATH=$(GOPATH) go get github.com/jstemmer/go-junit-report
	GOPATH=$(GOPATH) go get github.com/axw/gocov/gocov
	GOPATH=$(GOPATH) go get github.com/fzipp/gocyclo
	GOPATH=$(GOPATH) go get github.com/gordonklaus/ineffassign
	GOPATH=$(GOPATH) go get github.com/client9/misspell/cmd/misspell
	GOPATH=$(GOPATH) go get github.com/HewlettPackard/gas
	GOPATH=$(GOPATH) go get github.com/dominikh/go-tools
	GOPATH=$(GOPATH) go get github.com/pquerna/ffjson
	GOPATH=$(GOPATH) go get github.com/hirokidaichi/goviz
	GOPATH=$(GOPATH) go get github.com/wgliang/goreporter

# Remove any build artifact
clean:
	GOPATH=$(GOPATH) go clean ./...

# Deletes any intermediate file
nuke:
	rm -rf ./.target
	GOPATH=$(GOPATH) go clean -i ./...

generate:
	@go generate ./...

# Report the golang line of code
loc:
	@find . -name "*.go" | xargs wc -l | tail -1

vis:
	goviz -i github.com/funkygao/dbus/engine | dot -Tpng -o engine.png
	open engine.png

# Install dbsud to $GOPATH/bin
dbusd:generate
	go install ${GO_FLAGS} -ldflags ${ldflags} ./cmd/dbusd

# Install dbc to $GOPATH/bin
dbc:generate
	go install ${GO_FLAGS} -ldflags ${ldflags} ./cmd/dbc

all:dbusd dbc