From a0346000249541406dc9b84458af567ef8a58f2d Mon Sep 17 00:00:00 2001 From: Jae Kwon Date: Fri, 5 Jan 2018 22:35:57 -0800 Subject: [PATCH] Revert "Changes to achieve a standardized build process and deterministic builds" --- Makefile | 79 +++++++------------------------------------ docs/install.rst | 13 ------- scripts/dist_build.sh | 28 +++++++++++++-- 3 files changed, 38 insertions(+), 82 deletions(-) diff --git a/Makefile b/Makefile index 2a4b14e3f..2aed1acf4 100644 --- a/Makefile +++ b/Makefile @@ -1,34 +1,13 @@ -GOTOOLS := \ +GOTOOLS = \ github.com/mitchellh/gox \ github.com/Masterminds/glide \ github.com/tcnksm/ghr \ gopkg.in/alecthomas/gometalinter.v2 -GO_MIN_VERSION := 1.9.2 -PACKAGES := $(shell go list ./... | grep -v '/vendor/') -BUILD_TAGS ?= tendermint -TMHOME ?= $(HOME)/.tendermint -GOPATH ?= $(shell go env GOPATH) -GOROOT ?= $(shell go env GOROOT) -GOGCCFLAGS ?= $(shell go env GOGCCFLAGS) -#LDFLAGS_EXTRA ?= -w -s -XC_ARCH ?= 386 amd64 arm -XC_OS ?= solaris darwin freebsd linux windows -XC_OSARCH ?= !darwin/arm !solaris/amd64 !freebsd/amd64 -BUILD_OUTPUT ?= ./build/{{.OS}}_{{.Arch}}/tendermint - -GOX_FLAGS = -os="$(XC_OS)" -arch="$(XC_ARCH)" -osarch="$(XC_OSARCH)" -output="$(BUILD_OUTPUT)" -ifeq ($(BUILD_FLAGS_RACE),YES) -RACEFLAG=-race -else -RACEFLAG= -endif -BUILD_FLAGS = -asmflags "-trimpath $(GOPATH)" -gcflags "-trimpath $(GOPATH)" -tags "$(BUILD_TAGS)" -ldflags "-X github.com/tendermint/tendermint/version.GitCommit=$(shell git rev-parse --short=8 HEAD) $(LDFLAGS_EXTRA)" $(RACEFLAG) -GO_VERSION:=$(shell go version | grep -o '[[:digit:]]\+.[[:digit:]]\+.[[:digit:]]\+') -#Check that that minor version of GO meets the minimum required -GO_MINOR_VERSION := $(shell grep -o \.[[:digit:]][[:digit:]]*\. <<< $(GO_VERSION) | grep -o [[:digit:]]* ) -GO_MIN_MINOR_VERSION := $(shell grep -o \.[[:digit:]][[:digit:]]*\. <<< $(GO_MIN_VERSION) | grep -o [[:digit:]]* ) -GO_MINOR_VERSION_CHECK := $(shell test $(GO_MINOR_VERSION) -ge $(GO_MIN_MINOR_VERSION) && echo YES) - +GOTOOLS_CHECK = gox glide ghr gometalinter.v2 +PACKAGES=$(shell go list ./... | grep -v '/vendor/') +BUILD_TAGS?=tendermint +TMHOME = $${TMHOME:-$$HOME/.tendermint} +BUILD_FLAGS = -ldflags "-X github.com/tendermint/tendermint/version.GitCommit=`git rev-parse --short HEAD`" all: check build test install metalinter @@ -38,61 +17,27 @@ check: check_tools get_vendor_deps ######################################## ### Build -build_xc: check_tools - $(shell which gox) $(BUILD_FLAGS) $(GOX_FLAGS) ./cmd/tendermint/ - build: -ifeq ($(OS),Windows_NT) - make build_xc XC_ARCH=amd64 XC_OS=windows BUILD_OUTPUT=$(GOPATH)/bin/tendermint -else - make build_xc XC_ARCH=amd64 XC_OS="$(shell uname -s)" BUILD_OUTPUT=$(GOPATH)/bin/tendermint -endif + go build $(BUILD_FLAGS) -o build/tendermint ./cmd/tendermint/ build_race: -#TODO: Wait for this to be merged: https://github.com/mitchellh/gox/pull/105 Then switch over to make build and remove the go build line. -# make build BUILD_FLAGS_RACE=YES - $(shell which go) build $(BUILD_FLAGS) -race -o "$(BUILD_OUTPUT)" ./cmd/tendermint/ + go build -race $(BUILD_FLAGS) -o build/tendermint ./cmd/tendermint # dist builds binaries for all platforms and packages them for distribution dist: @BUILD_TAGS='$(BUILD_TAGS)' sh -c "'$(CURDIR)/scripts/dist.sh'" install: - make build + go install $(BUILD_FLAGS) ./cmd/tendermint ######################################## ### Tools & dependencies check_tools: -ifeq ($(GO_VERSION),) - $(error go not found) -endif -#Check minimum required go version -ifneq ($(GO_VERSION),$(GO_MIN_VERSION)) - $(warning WARNING: build will not be deterministic. go version should be $(GO_MIN_VERSION)) -ifneq ($(GO_MINOR_VERSION_CHECK),YES) - $(error ERROR: The minor version of Go ($(GO_VERSION)) is lower than the minimum required ($(GO_MIN_VERSION))) -endif -endif -#-fdebug-prefix-map switches the temporary, randomized workdir name in the binary to a static text -ifneq ($(findstring -fdebug-prefix-map,$(GOGCCFLAGS)),-fdebug-prefix-map) - $(warning WARNING: build will not be deterministic. The compiler does not support the '-fdebug-prefix-map' flag.) -endif -#GOROOT string is copied into the binary. For deterministic builds, we agree to keep it at /usr/local/go. (Default for golang:1.9.2 docker image, linux and osx.) -ifneq ($(GOROOT),/usr/local/go) - $(warning WARNING: build will not be deterministic. GOROOT should be set to /usr/local/go) -endif -#GOPATH string is copied into the binary. Although the -trimpath flag tries to eliminate it, it doesn't do it everywhere in Go 1.9.2. For deterministic builds we agree to keep it at /go. (Default for golang:1.9.2 docker image.) -ifneq ($(GOPATH),/go) - $(warning WARNING: build will not be deterministic. GOPATH should be set to /go) -endif -#External dependencies defined in GOTOOLS are built with get_tools. If they are already available on the system (for exmaple using a package manager), then get_tools might not be necessary. -ifneq ($(findstring $(GOPATH)/bin,$(PATH)),$(GOPATH)/bin) - $(warning WARNING: PATH does not contain GOPATH/bin. Some external dependencies might be unavailable.) -endif -# https://stackoverflow.com/a/25668869 - @echo "Found tools: $(foreach tool,$(notdir $(GOTOOLS)),$(if $(shell which $(tool)),$(tool),$(error "No $(tool) in PATH. Add GOPATH/bin to PATH and run 'make get_tools'")))" + @# https://stackoverflow.com/a/25668869 + @echo "Found tools: $(foreach tool,$(GOTOOLS_CHECK),\ + $(if $(shell which $(tool)),$(tool),$(error "No $(tool) in PATH")))" get_tools: @echo "--> Installing tools" diff --git a/docs/install.rst b/docs/install.rst index 9edc051a6..64fae4cdc 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -6,19 +6,6 @@ From Binary To download pre-built binaries, see the `Download page `__. -From Source using Docker ------------------------- - -If you have docker running, all you need is the ``golang`` image to build tendermint. -If you don't, you can get help setting it up `here `__. - -:: - mkdir $HOME/tendermintbin - docker run --rm -it -v $HOME/tendermintbin:/go/bin:Z golang:1.9.2 /bin/bash -c "go-wrapper download github.com/tendermint/tendermint/cmd/tendermint ; make -C /go/src/github.com/tendermint/tendermint get_tools get_vendor_deps build_cc" - -You will find the ``tendermint`` binaries for different architectures and operating systems in your ``$HOME/tendermintbin`` folder. - - From Source ----------- diff --git a/scripts/dist_build.sh b/scripts/dist_build.sh index f1d8779f6..587199e02 100755 --- a/scripts/dist_build.sh +++ b/scripts/dist_build.sh @@ -9,8 +9,32 @@ DIR="$( cd -P "$( dirname "$SOURCE" )/.." && pwd )" # Change into that dir because we expect that. cd "$DIR" -# Make sure build tools are available, get VENDORED dependencies and build -make get_tools get_vendor_deps build_xc +# Get the git commit +GIT_COMMIT="$(git rev-parse --short HEAD)" +GIT_IMPORT="github.com/tendermint/tendermint/version" + +# Determine the arch/os combos we're building for +XC_ARCH=${XC_ARCH:-"386 amd64 arm"} +XC_OS=${XC_OS:-"solaris darwin freebsd linux windows"} + +# Make sure build tools are available. +make tools + +# Get VENDORED dependencies +make get_vendor_deps + +# Build! +# ldflags: -s Omit the symbol table and debug information. +# -w Omit the DWARF symbol table. +echo "==> Building..." +"$(which gox)" \ + -os="${XC_OS}" \ + -arch="${XC_ARCH}" \ + -osarch="!darwin/arm !solaris/amd64 !freebsd/amd64" \ + -ldflags "-s -w -X ${GIT_IMPORT}.GitCommit=${GIT_COMMIT}" \ + -output "build/pkg/{{.OS}}_{{.Arch}}/tendermint" \ + -tags="${BUILD_TAGS}" \ + github.com/tendermint/tendermint/cmd/tendermint # Zip all the files. echo "==> Packaging..."