Improve build process and restructure project

The build process now allows for reproducable builds resulting
in the same checksums every time the build pipeline is executed.
This is achieved by overwriting the timestamps of build targets
in zip-files with the timestamp of the latest git commit.

The latest commit hash of the git repository is used to provide
a reproducable build identifier.

To allow the standard go install routine to install goad the goad.go
file is moved into a separate package. Allowing for a main.go
calling the cli in the project root.

These changes facilitate the creation of a recipe for the homebrew
package manager.

Also we update the base image within the docker file since
we are using a newer version of git to format the date
in this new build process. The old base image contained
an older version of git.

Author: cwaltken-edrans

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.8
+FROM golang:1.8.1-stretch
 
 RUN apt-get update
 RUN apt-get install -y zip

Makefile

@@ -1,38 +1,94 @@
+SHELL := /bin/bash
+
+# name of the binary created
+TARGET := goad
+
+# Prepend our vendor directory to the system GOPATH
+# so that import path resolution will prioritize
+# our third party snapshots.
+GOPATH := ${PWD}/vendor:${GOPATH}
+export GOPATH
+
+# These will be provided to the target
+VERSION := 1.3.0
+BUILD := `git rev-parse HEAD`
+
+# Timestamp of last commit to allow for reproducable builds
+TIMESTAMP := `git log -1 --date=format:%Y%m%d%H%M --pretty=format:%cd`
+
+# Use linker flags to provide version/build settings to the target
+LDFLAGS = -ldflags "-X=github.com/goadapp/goad/version.version=$(VERSION) -X=github.com/goadapp/goad/version.build=$(BUILD)"
+
+# go source files, ignore vendor directory
+SRC = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
+
+# go source folders to test
+TEST = $(shell go list ./... | grep -v /vendor/)
+
+# $(GO-BUILD) command
+GO-BUILD = go build $(LDFLAGS)
+
+# $(ZIP) command ignoring timestamps and using UTC timezone
+ZIP = TZ=UTC zip -jrX
+
+.PHONY: lambda bindata clean all-zip all linux osx windows check fmt test install uninstall
+
 all: osx linux windows
 
-test:
-	go test ./...
+test: bindata
+	@go test $(TEST)
 
 lambda:
-	GOOS=linux GOARCH=amd64 go build -o data/lambda/goad-lambda ./lambda
-	zip -jr data/lambda data/lambda
+	@GOOS=linux GOARCH=amd64 $(GO-BUILD) -o data/lambda/goad-lambda ./lambda
+	@find data/lambda -exec touch -t $(TIMESTAMP) {} \; # strip timestamp
+	@$(ZIP) data/lambda data/lambda
 
 bindata: lambda
-	go get github.com/jteeuwen/go-bindata/...
-	go-bindata -nocompress -pkg infrastructure -o infrastructure/bindata.go data/lambda.zip
+	@go get -u github.com/jteeuwen/go-bindata/...
+	@go-bindata -modtime $(TIMESTAMP) -nocompress -pkg infrastructure -o infrastructure/bindata.go data/lambda.zip
 
 linux: bindata
-	GOOS=linux GOARCH=amd64 go build -o ./build/linux/x86-64/goad ./cli
-	GOOS=linux GOARCH=386 go build -o ./build/linux/x86/goad ./cli
+	@GOOS=linux GOARCH=amd64 $(GO-BUILD) -o build/linux/x86-64/$(TARGET)
+	@GOOS=linux GOARCH=386 $(GO-BUILD) -o build/linux/x86/$(TARGET)
 
 osx: bindata
-	GOOS=darwin GOARCH=amd64 go build -o ./build/osx/x86-64/goad ./cli
+	@GOOS=darwin GOARCH=amd64 $(GO-BUILD) -o build/osx/x86-64/$(TARGET)
 
 windows: bindata
-	GOOS=windows GOARCH=amd64 go build -o ./build/windows/x86-64/goad ./cli
-	GOOS=windows GOARCH=386 go build -o ./build/windows/x86/goad ./cli
+	@GOOS=windows GOARCH=amd64 $(GO-BUILD) -o build/windows/x86-64/$(TARGET)
+	@GOOS=windows GOARCH=386 $(GO-BUILD) -o build/windows/x86/$(TARGET)
 
 clean:
-	rm -rf data/lambda/goad-lambda
-	rm -rf data/lambda.zip
-	rm -rf build
+	@rm -rf data/lambda/goad-lambda
+	@rm -rf data/lambda.zip
+	@rm -rf build
+	@rm -rf infrastructure/bindata.go
+
+build: bindata
+	@$(GO-BUILD) $(LDFLAGS) -o build/$(TARGET)
+
+install: bindata
+	@go install $(LDFLAGS)
+
+uninstall: clean
+	@go clean -i
+
+fmt:
+	@gofmt -l -w $(SRC)
+
+simplify:
+	@gofmt -s -l -w $(SRC)
+
+check:
+	@test -z $(shell gofmt -l main.go | tee /dev/stderr) || echo "[WARN] Fix formatting issues with 'make fmt'"
+	@for d in $$(go list ./... | grep -v /vendor/); do golint $${d}; done
+	@go tool vet ${SRC}
 
 all-zip: all
-	mkdir ./build/zip
-	zip -jr ./build/zip/goad-osx-x86-64 ./build/osx/x86-64/goad
-	zip -jr ./build/zip/goad-linux-x86-64 ./build/linux/x86-64/goad
-	zip -jr ./build/zip/goad-linux-x86 ./build/linux/x86/goad
-	zip -jr ./build/zip/goad-windows-x86-64 ./build/windows/x86-64/goad
-	zip -jr ./build/zip/goad-windows-x86 ./build/windows/x86/goad
-
-.PHONY: lambda bindata
+	@mkdir -p ./build/zip
+	@find build -exec touch -t $(TIMESTAMP) {} \; # strip timestamp
+	@$(ZIP) ./build/zip/goad-osx-x86-64 ./build/osx/x86-64/goad
+	@$(ZIP) ./build/zip/goad-linux-x86-64 ./build/linux/x86-64/goad
+	@$(ZIP) ./build/zip/goad-linux-x86 ./build/linux/x86/goad
+	@$(ZIP) ./build/zip/goad-windows-x86-64 ./build/windows/x86-64/goad
+	@$(ZIP) ./build/zip/goad-windows-x86 ./build/windows/x86/goad

cli/cli.go

@@ -1,4 +1,4 @@
-package main
+package cli
 
 import (
 	"encoding/json"
@@ -18,7 +18,7 @@ import (
 	ini "gopkg.in/ini.v1"
 
 	"github.com/dustin/go-humanize"
-	"github.com/goadapp/goad"
+	"github.com/goadapp/goad/goad"
 	"github.com/goadapp/goad/queue"
 	"github.com/goadapp/goad/version"
 	"github.com/nsf/termbox-go"
@@ -51,9 +51,9 @@ var (
 const coldef = termbox.ColorDefault
 const nano = 1000000000
 
-func main() {
+func Run() {
 	app.HelpFlag.Short('h')
-	app.Version(version.Version)
+	app.Version(version.String())
 	app.VersionFlag.Short('V')
 
 	config := aggregateConfiguration()

cli/ini_parser_test.go

@@ -1,4 +1,4 @@
-package main
+package cli
 
 import (
 	"os"

goad.go renamed to goad/goad.go

@@ -57,7 +57,7 @@ func main() {
 
 func parseLambdaSettings() LambdaSettings {
 	app.HelpFlag.Short('h')
-	app.Version(version.Version)
+	app.Version(version.String())
 	kingpin.MustParse(app.Parse(os.Args[1:]))
 
 	requestParameters := requestParameters{

lambda/lambda.go

@@ -0,0 +1,7 @@
+package main
+
+import "github.com/goadapp/goad/cli"
+
+func main() {
+	cli.Run()
+}

main.go

@@ -3,10 +3,31 @@ package version
 import "strings"
 
 // Version describes the Goad version.
-const Version = "1.3.0"
+var (
+	version string
+	build   string
+)
+
+// Version returns the version
+func Version() string {
+	return version
+}
+
+// Build returns the build number
+func Build() string {
+	if len(build) >= 8 {
+		return build[0:8]
+	}
+	return build
+}
+
+// String returns a composed string of version and build number
+func String() string {
+	return Version() + "-" + Build()
+}
 
 // LambdaVersion returns a version string that can be used as a Lambda function
 // alias.
 func LambdaVersion() string {
-	return "v" + strings.Replace(Version, ".", "-", -1)
+	return "v" + strings.Replace(String(), ".", "-", -1)
 }

version/version.go

@@ -7,7 +7,7 @@ import (
 	"log"
 	"net/http"
 
-	"github.com/goadapp/goad"
+	"github.com/goadapp/goad/goad"
 	"github.com/goadapp/goad/queue"
 	"github.com/gorilla/websocket"
 )