cmd, internal/build, docker: advertise commit date in unstable build versions (ethereum#19522)

* add-date-to unstable

* fields-insteadof-split

* internal/build: support building with missing git

* docker: add git history back to support commit date in version

* internal/build: use PR commits hashes for PR builds

Author: C. Brown

.dockerignore

@@ -1,7 +1,3 @@
-**/.git
-.git
-!.git/HEAD
-!.git/refs/heads
 **/*_test.go
 
 build/_workspace

Dockerfile

@@ -1,7 +1,7 @@
 # Build Geth in a stock Go builder container
 FROM golang:1.12-alpine as builder
 
-RUN apk add --no-cache make gcc musl-dev linux-headers
+RUN apk add --no-cache make gcc musl-dev linux-headers git
 
 ADD . /go-ethereum
 RUN cd /go-ethereum && make geth

Dockerfile.alltools

@@ -1,7 +1,7 @@
 # Build Geth in a stock Go builder container
 FROM golang:1.12-alpine as builder
 
-RUN apk add --no-cache make gcc musl-dev linux-headers
+RUN apk add --no-cache make gcc musl-dev linux-headers git
 
 ADD . /go-ethereum
 RUN cd /go-ethereum && make all

build/ci.go

@@ -284,6 +284,7 @@ func buildFlags(env build.Environment) (flags []string) {
 	var ld []string
 	if env.Commit != "" {
 		ld = append(ld, "-X", "main.gitCommit="+env.Commit)
+		ld = append(ld, "-X", "main.gitDate="+env.Date)
 	}
 	if runtime.GOOS == "darwin" {
 		ld = append(ld, "-s")

cmd/ethkey/main.go

@@ -30,11 +30,12 @@ const (
 
 // Git SHA1 commit hash of the release (set via linker flags)
 var gitCommit = ""
+var gitDate = ""
 
 var app *cli.App
 
 func init() {
-	app = utils.NewApp(gitCommit, "an Ethereum key manager")
+	app = utils.NewApp(gitCommit, gitDate, "an Ethereum key manager")
 	app.Commands = []cli.Command{
 		commandGenerate,
 		commandInspect,

cmd/evm/main.go

@@ -27,9 +27,10 @@ import (
 )
 
 var gitCommit = "" // Git SHA1 commit hash of the release (set via linker flags)
+var gitDate = ""
 
 var (
-	app = utils.NewApp(gitCommit, "the evm command line interface")
+	app = utils.NewApp(gitCommit, gitDate, "the evm command line interface")
 
 	DebugFlag = cli.BoolFlag{
 		Name:  "debug",

cmd/geth/config.go

@@ -101,7 +101,7 @@ func loadConfig(file string, cfg *gethConfig) error {
 func defaultNodeConfig() node.Config {
 	cfg := node.DefaultConfig
 	cfg.Name = clientIdentifier
-	cfg.Version = params.VersionWithCommit(gitCommit)
+	cfg.Version = params.VersionWithCommit(gitCommit, gitDate)
 	cfg.HTTPModules = append(cfg.HTTPModules, "eth", "shh")
 	cfg.WSModules = append(cfg.WSModules, "eth", "shh")
 	cfg.IPCPath = "geth.ipc"

cmd/geth/consolecmd_test.go

@@ -50,7 +50,7 @@ func TestConsoleWelcome(t *testing.T) {
 	geth.SetTemplateFunc("goos", func() string { return runtime.GOOS })
 	geth.SetTemplateFunc("goarch", func() string { return runtime.GOARCH })
 	geth.SetTemplateFunc("gover", runtime.Version)
-	geth.SetTemplateFunc("gethver", func() string { return params.VersionWithMeta })
+	geth.SetTemplateFunc("gethver", func() string { return params.VersionWithCommit("", "") })
 	geth.SetTemplateFunc("niltime", func() string { return time.Unix(0, 0).Format(time.RFC1123) })
 	geth.SetTemplateFunc("apis", func() string { return ipcAPIs })
 
@@ -133,7 +133,7 @@ func testAttachWelcome(t *testing.T, geth *testgeth, endpoint, apis string) {
 	attach.SetTemplateFunc("goos", func() string { return runtime.GOOS })
 	attach.SetTemplateFunc("goarch", func() string { return runtime.GOARCH })
 	attach.SetTemplateFunc("gover", runtime.Version)
-	attach.SetTemplateFunc("gethver", func() string { return params.VersionWithMeta })
+	attach.SetTemplateFunc("gethver", func() string { return params.VersionWithCommit("", "") })
 	attach.SetTemplateFunc("etherbase", func() string { return geth.Etherbase })
 	attach.SetTemplateFunc("niltime", func() string { return time.Unix(0, 0).Format(time.RFC1123) })
 	attach.SetTemplateFunc("ipc", func() bool { return strings.HasPrefix(endpoint, "ipc") })

cmd/geth/main.go

@@ -50,8 +50,9 @@ const (
 var (
 	// Git SHA1 commit hash of the release (set via linker flags)
 	gitCommit = ""
+	gitDate   = ""
 	// The app that holds all commands and flags.
-	app = utils.NewApp(gitCommit, "the go-ethereum command line interface")
+	app = utils.NewApp(gitCommit, gitDate, "the go-ethereum command line interface")
 	// flags that configure the node
 	nodeFlags = []cli.Flag{
 		utils.IdentityFlag,

cmd/geth/misccmd.go

@@ -112,6 +112,9 @@ func version(ctx *cli.Context) error {
 	if gitCommit != "" {
 		fmt.Println("Git Commit:", gitCommit)
 	}
+	if gitDate != "" {
+		fmt.Println("Git Commit Date:", gitDate)
+	}
 	fmt.Println("Architecture:", runtime.GOARCH)
 	fmt.Println("Protocol Versions:", eth.ProtocolVersions)
 	fmt.Println("Network Id:", eth.DefaultConfig.NetworkId)

cmd/swarm/global-store/main.go

@@ -26,6 +26,7 @@ import (
 var (
 	version   = "0.1"
 	gitCommit string // Git SHA1 commit hash of the release (set via linker flags)
+	gitDate   string
 )
 
 func main() {
@@ -45,6 +46,9 @@ func newApp() (app *cli.App) {
 	if len(gitCommit) >= 8 {
 		app.Version += "-" + gitCommit[:8]
 	}
+	if gitDate != "" {
+		app.Version += "-" + gitDate
+	}
 	app.Usage = "Swarm Global Store"
 
 	// app flags (for all commands)

cmd/swarm/main.go

@@ -102,7 +102,7 @@ func init() {
 	utils.ListenPortFlag.Value = 30399
 }
 
-var app = utils.NewApp("", "Ethereum Swarm")
+var app = utils.NewApp("", "", "Ethereum Swarm")
 
 // This init function creates the cli.App.
 func init() {

cmd/swarm/swarm-snapshot/main.go

@@ -25,6 +25,7 @@ import (
 )
 
 var gitCommit string // Git SHA1 commit hash of the release (set via linker flags)
+var gitDate string
 
 // default value for "create" command --nodes flag
 const defaultNodes = 8
@@ -40,7 +41,7 @@ func main() {
 // newApp construct a new instance of Swarm Snapshot Utility.
 // Method Run is called on it in the main function and in tests.
 func newApp() (app *cli.App) {
-	app = utils.NewApp(gitCommit, "Swarm Snapshot Utility")
+	app = utils.NewApp(gitCommit, gitDate, "Swarm Snapshot Utility")
 
 	app.Name = "swarm-snapshot"
 	app.Usage = ""

cmd/utils/flags.go

@@ -92,16 +92,13 @@ GLOBAL OPTIONS:
 }
 
 // NewApp creates an app with sane defaults.
-func NewApp(gitCommit, usage string) *cli.App {
+func NewApp(gitCommit, gitDate, usage string) *cli.App {
 	app := cli.NewApp()
 	app.Name = filepath.Base(os.Args[0])
 	app.Author = ""
 	//app.Authors = nil
 	app.Email = ""
-	app.Version = params.VersionWithMeta
-	if len(gitCommit) >= 8 {
-		app.Version += "-" + gitCommit[:8]
-	}
+	app.Version = params.VersionWithCommit(gitCommit, gitDate)
 	app.Usage = usage
 	return app
 }

internal/build/env.go

@@ -20,7 +20,9 @@ import (
 	"flag"
 	"fmt"
 	"os"
+	"strconv"
 	"strings"
+	"time"
 )
 
 var (
@@ -35,39 +37,49 @@ var (
 
 // Environment contains metadata provided by the build environment.
 type Environment struct {
-	Name                string // name of the environment
-	Repo                string // name of GitHub repo
-	Commit, Branch, Tag string // Git info
-	Buildnum            string
-	IsPullRequest       bool
-	IsCronJob           bool
+	Name                      string // name of the environment
+	Repo                      string // name of GitHub repo
+	Commit, Date, Branch, Tag string // Git info
+	Buildnum                  string
+	IsPullRequest             bool
+	IsCronJob                 bool
 }
 
 func (env Environment) String() string {
-	return fmt.Sprintf("%s env (commit:%s branch:%s tag:%s buildnum:%s pr:%t)",
-		env.Name, env.Commit, env.Branch, env.Tag, env.Buildnum, env.IsPullRequest)
+	return fmt.Sprintf("%s env (commit:%s date:%s branch:%s tag:%s buildnum:%s pr:%t)",
+		env.Name, env.Commit, env.Date, env.Branch, env.Tag, env.Buildnum, env.IsPullRequest)
 }
 
 // Env returns metadata about the current CI environment, falling back to LocalEnv
 // if not running on CI.
 func Env() Environment {
 	switch {
 	case os.Getenv("CI") == "true" && os.Getenv("TRAVIS") == "true":
+		commit := os.Getenv("TRAVIS_PULL_REQUEST_SHA")
+		if commit == "" {
+			os.Getenv("TRAVIS_COMMIT")
+		}
 		return Environment{
 			Name:          "travis",
 			Repo:          os.Getenv("TRAVIS_REPO_SLUG"),
-			Commit:        os.Getenv("TRAVIS_COMMIT"),
+			Commit:        commit,
+			Date:          getDate(commit),
 			Branch:        os.Getenv("TRAVIS_BRANCH"),
 			Tag:           os.Getenv("TRAVIS_TAG"),
 			Buildnum:      os.Getenv("TRAVIS_BUILD_NUMBER"),
 			IsPullRequest: os.Getenv("TRAVIS_PULL_REQUEST") != "false",
 			IsCronJob:     os.Getenv("TRAVIS_EVENT_TYPE") == "cron",
 		}
 	case os.Getenv("CI") == "True" && os.Getenv("APPVEYOR") == "True":
+		commit := os.Getenv("APPVEYOR_PULL_REQUEST_HEAD_COMMIT")
+		if commit == "" {
+			os.Getenv("APPVEYOR_REPO_COMMIT")
+		}
 		return Environment{
 			Name:          "appveyor",
 			Repo:          os.Getenv("APPVEYOR_REPO_NAME"),
-			Commit:        os.Getenv("APPVEYOR_REPO_COMMIT"),
+			Commit:        commit,
+			Date:          getDate(commit),
 			Branch:        os.Getenv("APPVEYOR_REPO_BRANCH"),
 			Tag:           os.Getenv("APPVEYOR_REPO_TAG_NAME"),
 			Buildnum:      os.Getenv("APPVEYOR_BUILD_NUMBER"),
@@ -84,14 +96,15 @@ func LocalEnv() Environment {
 	env := applyEnvFlags(Environment{Name: "local", Repo: "ethereum/go-ethereum"})
 
 	head := readGitFile("HEAD")
-	if splits := strings.Split(head, " "); len(splits) == 2 {
-		head = splits[1]
+	if fields := strings.Fields(head); len(fields) == 2 {
+		head = fields[1]
 	} else {
 		return env
 	}
 	if env.Commit == "" {
 		env.Commit = readGitFile(head)
 	}
+	env.Date = getDate(env.Commit)
 	if env.Branch == "" {
 		if head != "HEAD" {
 			env.Branch = strings.TrimPrefix(head, "refs/heads/")
@@ -107,6 +120,21 @@ func firstLine(s string) string {
 	return strings.Split(s, "\n")[0]
 }
 
+func getDate(commit string) string {
+	if commit == "" {
+		return ""
+	}
+	out := RunGit("show", "-s", "--format=%ct", commit)
+	if out == "" {
+		return ""
+	}
+	date, err := strconv.ParseInt(strings.TrimSpace(out), 10, 64)
+	if err != nil {
+		panic(fmt.Sprintf("failed to parse git commit date: %v", err))
+	}
+	return time.Unix(date, 0).Format("20060102")
+}
+
 func applyEnvFlags(env Environment) Environment {
 	if !flag.Parsed() {
 		panic("you need to call flag.Parse before Env or LocalEnv")

internal/build/util.go

@@ -68,13 +68,14 @@ func RunGit(args ...string) string {
 	cmd := exec.Command("git", args...)
 	var stdout, stderr bytes.Buffer
 	cmd.Stdout, cmd.Stderr = &stdout, &stderr
-	if err := cmd.Run(); err == exec.ErrNotFound {
-		if !warnedAboutGit {
-			log.Println("Warning: can't find 'git' in PATH")
-			warnedAboutGit = true
+	if err := cmd.Run(); err != nil {
+		if e, ok := err.(*exec.Error); ok && e.Err == exec.ErrNotFound {
+			if !warnedAboutGit {
+				log.Println("Warning: can't find 'git' in PATH")
+				warnedAboutGit = true
+			}
+			return ""
 		}
-		return ""
-	} else if err != nil {
 		log.Fatal(strings.Join(cmd.Args, " "), ": ", err, "\n", stderr.String())
 	}
 	return strings.TrimSpace(stdout.String())

params/version.go

@@ -55,10 +55,13 @@ func ArchiveVersion(gitCommit string) string {
 	return vsn
 }
 
-func VersionWithCommit(gitCommit string) string {
+func VersionWithCommit(gitCommit, gitDate string) string {
 	vsn := VersionWithMeta
 	if len(gitCommit) >= 8 {
 		vsn += "-" + gitCommit[:8]
 	}
+	if (VersionMeta != "stable") && (gitDate != "") {
+		vsn += "-" + gitDate
+	}
 	return vsn
 }