chore(ci): Add makefile to simplify commands. (#181)

Author: Michael Ng

.travis.yml

@@ -13,15 +13,15 @@ jobs:
   include:
     - stage: 'Lint'
       env: GIMME_GO_VERSION=1.12.x GIMME_OS=linux GIMME_ARCH=amd64
-      before_script:
-        - curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(go env GOPATH)/bin v1.19.0
       script:
-        - $GOPATH/bin/golangci-lint run --out-format=tab --tests=false pkg/...
+        - make install lint
+
     - &test
       stage: 'Unit test'
       env: GIMME_GO_VERSION=master GIMME_OS=linux GIMME_ARCH=amd64
       script:
-        - go test -v -race ./... -coverprofile=profile.cov
+        - make cover
+
     - <<: *test
       stage: 'Unit test'
       env: GIMME_GO_VERSION=1.8.x
@@ -34,14 +34,16 @@ jobs:
         # This pkg not in go 1.8
         - go get github.com/stretchr/testify
         # -coverprofile was not introduced in 1.8
-        - go test -v -race ./...
+        - make test
+
     - <<: *test
       stage: 'Unit test'
       env: GIMME_GO_VERSION=1.12.x
       before_script:
         - go get github.com/mattn/goveralls
       after_success:
         - $GOPATH/bin/goveralls -coverprofile=profile.cov -service=travis-ci
+
     - stage: 'Integration tests'
       env: GIMME_GO_VERSION=1.12.x FSC_PATH="/tmp/fsc-repo"
       before_script:
@@ -51,6 +53,7 @@ jobs:
         - eval "$(gimme)"
       script:
         - ./scripts/run-fsc-tests.sh -f "$FSC_PATH/features/" -d "$FSC_PATH/features/support/datafiles/" -t "$TAGS"
+
     - stage: 'Source clear'
       env: GIMME_GO_VERSION=master GIMME_OS=linux GIMME_ARCH=amd64
       language: go

Makefile

@@ -0,0 +1,35 @@
+# The name of the executable (default is current directory name)
+TARGET := $(shell basename "$(PWD)")
+.DEFAULT_GOAL := help
+
+# Go parameters
+GO111MODULE:=on
+GOCMD=go
+GOPATH=$(shell $(GOCMD) env GOPATH)
+GOBUILD=$(GOCMD) build
+GOCLEAN=$(GOCMD) clean
+GOTEST=$(GOCMD) test
+GOGET=$(GOCMD) get
+GOLINT=golangci-lint
+
+# Make is verbose in Linux. Make it silent.
+MAKEFLAGS += --silent
+
+clean: ## runs `go clean` and removes the bin/ dir
+	GO111MODULE=$(GO111MODULE) $(GOCLEAN) --modcache
+	rm -rf $(GOBIN)
+
+cover: ## run unit tests with coverage
+	GO111MODULE=$(GO111MODULE) $(GOTEST) -race ./pkg/... -coverprofile=profile.cov
+
+install: ## installs dev and ci dependencies
+	curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b $(GOPATH)/bin v1.19.0
+
+lint: ## runs `golangci-lint` linters defined in `.golangci.yml` file
+	$(GOLINT) run --out-format=tab --tests=false pkg/...
+
+test: ## recursively test source code in pkg without coverage
+	GO111MODULE=$(GO111MODULE) $(GOTEST) ./pkg/...
+
+help: ## help
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST)