Add version flags and build target (#11)

Author: vearutop

README.md

@@ -1,15 +1,17 @@
 # Go development helpers
 
-## Usage
+## Installation
 
 Add a test file (e.g. `dev_test.go`) to your module with unused import.
+
 ```go
 package mymodule_test
 
 import _ "github.com/bool64/dev" // Include development helpers to project. 
 ```
 
 Add `Makefile` to your module with includes standard targets.
+
 ```Makefile
 GOLANGCI_LINT_VERSION := "v1.35.2" # Optional.
 
@@ -54,6 +56,7 @@ test: test-unit
 ```
 
 Then `make` will have these targets:
+
 ```
 Usage
   test:                 Run tests
@@ -64,4 +67,10 @@ Usage
   bench:                Run benchmark, iterations count controlled by BENCH_COUNT, default 5.
   github-actions:       Replace GitHub Actions from template
 
-```
+```
+
+## Build Versioning
+
+You can include `$(DEVGO_PATH)/makefiles/build.mk` to add automated versioning of build artifacts. Make will
+configure `ldflags` to set up [version info](./version/info.go), then you can access it in runtime with `version.Info()`
+or expose with [HTTP handler](./version/handler.go). Version information also includes versions of dependencies.

go.mod

@@ -1,3 +1,5 @@
 module github.com/bool64/dev
 
 go 1.11
+
+require github.com/stretchr/testify v1.7.0

go.sum

@@ -0,0 +1,11 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

makefiles/build.mk

@@ -0,0 +1,27 @@
+GO ?= go
+
+# Override in app Makefile to add custom ldflags, example BUILD_LDFLAGS="-s -w"
+BUILD_LDFLAGS ?= ""
+
+# Override in app Makefile to control build target, example BUILD_PKG=./cmd/my-app
+BUILD_PKG ?= .
+
+# Override in app Makefile to control build artifact destination.
+BUILD_DIR ?= ./bin
+
+## Build Linux binary
+build-linux:
+	@echo "Building Linux AMD64 binary, GOFLAGS: $(GOFLAGS)"
+	@GOOS=linux GOARCH=amd64 $(GO) build -ldflags "$(shell bash $(DEVGO_SCRIPTS)/version-ldflags.sh && echo $(BUILD_LDFLAGS))" -o $(BUILD_DIR)/ $(BUILD_PKG)
+
+## Build binary
+build:
+	@echo "Building binary, GOFLAGS: $(GOFLAGS)"
+	@$(GO) build -ldflags "$(shell bash $(DEVGO_SCRIPTS)/version-ldflags.sh && echo $(BUILD_LDFLAGS))" -o $(BUILD_DIR)/ $(BUILD_PKG)
+
+## Build and run binary
+run:
+	@echo "Running binary"
+	@$(GO) run -ldflags "$(shell bash $(DEVGO_SCRIPTS)/version-ldflags.sh && echo $(BUILD_LDFLAGS))" $(BUILD_PKG)
+
+.PHONY: build-linux build run

scripts/version-ldflags.sh

@@ -10,6 +10,6 @@ fi
 build_user="$USER"
 build_date=$(date +%FT%T%Z)
 
-version_pkg=github.com/bool64/dev-go/version
+version_pkg=github.com/bool64/dev/version
 
 echo -X "$version_pkg".version="$VERSION" -X "$version_pkg".branch="$branch" -X "$version_pkg".revision="$revision" -X "$version_pkg".buildUser="$build_user" -X "$version_pkg".buildDate="$build_date"

version/handler.go

@@ -0,0 +1,17 @@
+package version
+
+import (
+	"encoding/json"
+	"net/http"
+)
+
+// Handler serves version information with HTTP.
+func Handler(w http.ResponseWriter, _ *http.Request) {
+	b, err := json.Marshal(Info())
+	if err != nil {
+		http.Error(w, err.Error(), http.StatusInternalServerError)
+	}
+
+	w.Header().Set("Content-Type", "application/json")
+	_, _ = w.Write(b)
+}

version/info.go

@@ -0,0 +1,80 @@
+// Package version contains build information.
+package version
+
+import "runtime"
+
+// Build information. Populated at build-time.
+// nolint:gochecknoglobals
+var (
+	version      = "dev"
+	revision     string
+	branch       string
+	buildUser    string
+	buildDate    string
+	dependencies map[string]string
+)
+
+// Information holds app version info.
+type Information struct {
+	Version      string            `json:"version,omitempty"`
+	Revision     string            `json:"revision,omitempty"`
+	Branch       string            `json:"branch,omitempty"`
+	BuildUser    string            `json:"build_user,omitempty"`
+	BuildDate    string            `json:"build_date,omitempty"`
+	GoVersion    string            `json:"go_version,omitempty"`
+	Dependencies map[string]string `json:"dependencies,omitempty"`
+}
+
+// Info returns app version info.
+func Info() Information {
+	return Information{
+		Version:      version,
+		Revision:     revision,
+		Branch:       branch,
+		BuildUser:    buildUser,
+		BuildDate:    buildDate,
+		GoVersion:    runtime.Version(),
+		Dependencies: dependencies,
+	}
+}
+
+// String return version information as string.
+func (i Information) String() string {
+	res := ""
+
+	if i.Version != "" {
+		res += ", Version: " + i.Version
+	}
+
+	if i.Revision != "" {
+		res += ", Revision: " + i.Revision
+	}
+
+	if i.Branch != "" {
+		res += ", Branch: " + i.Branch
+	}
+
+	if i.BuildUser != "" {
+		res += ", BuildUser: " + i.BuildUser
+	}
+
+	if i.BuildDate != "" {
+		res += ", BuildDate: " + i.BuildDate
+	}
+
+	res += ", GoVersion: " + runtime.Version()
+
+	return res[2:]
+}
+
+// Values return version information as string map.
+func (i Information) Values() map[string]string {
+	return map[string]string{
+		"version":    i.Version,
+		"revision":   i.Revision,
+		"branch":     i.Branch,
+		"build_user": i.BuildUser,
+		"build_date": i.BuildDate,
+		"go_version": i.GoVersion,
+	}
+}

version/info_test.go

@@ -0,0 +1,52 @@
+package version
+
+import (
+	"fmt"
+	"runtime"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestInformation_String(t *testing.T) {
+	version = "v3.2.1"
+	branch = ""
+	revision = ""
+	buildDate = ""
+	buildUser = ""
+
+	assert.Equal(t, "Version: v3.2.1, GoVersion: "+runtime.Version(), Info().String())
+
+	version = "v1.2.3"
+	branch = "refs/heads/master"
+	revision = "111765232072440cc598b189e284c9a4450a6018"
+	buildUser = "user"
+	buildDate = "2021-01-13 22:13:41"
+
+	assert.Equal(t, fmt.Sprintf("Version: %s, Revision: %s, Branch: %s, BuildUser: %s, BuildDate: %s, GoVersion: %s",
+		version, revision, branch, buildUser, buildDate, runtime.Version()), Info().String())
+}
+
+func TestInformation_Values(t *testing.T) {
+	version = "v3.2.1"
+	branch = ""
+	revision = ""
+	buildDate = ""
+	buildUser = ""
+
+	assert.Equal(t, map[string]string{
+		"branch": "", "build_date": "", "build_user": "", "go_version": runtime.Version(),
+		"revision": "", "version": "v3.2.1",
+	}, Info().Values())
+
+	version = "v1.2.3"
+	branch = "refs/heads/master"
+	revision = "111765232072440cc598b189e284c9a4450a6018"
+	buildDate = "2021-01-13 22:13:41"
+	buildUser = "user"
+
+	assert.Equal(t, map[string]string{
+		"branch": branch, "build_date": buildDate, "build_user": buildUser,
+		"go_version": runtime.Version(), "revision": revision, "version": version,
+	}, Info().Values())
+}

version/mod.go

@@ -0,0 +1,25 @@
+// +build go1.12
+
+package version
+
+import (
+	"fmt"
+	"runtime/debug"
+)
+
+//nolint:gochecknoinits
+func init() {
+	if info, available := debug.ReadBuildInfo(); available {
+		if version == "dev" && info.Main.Version != "(devel)" {
+			version = info.Main.Version
+			revision = fmt.Sprintf("(unknown, mod sum: %q)", info.Main.Sum)
+			buildUser = "(unknown)"
+			buildDate = "(unknown)"
+		}
+
+		dependencies = make(map[string]string, len(info.Deps))
+		for _, dep := range info.Deps {
+			dependencies[dep.Path] = dep.Version
+		}
+	}
+}