test.bash: rewrite the integration test in Go
This CL switches the integration test to be written in Go instead of bash.
The benefits are:
* The logic for setting up the dependencies is more robust and
handles better a situation where the dependency failed to initialize
(due to network trouble, FS permission problems, etc).
* The logic does a better job at cleaning up stale dependencies.
For example, my .cache folder has go1.9.4, go1.9.5, go1.10.5, and go1.10.6
folders even though we don't use them anymore.
* Being able to run only a subset of the integration test since you can
pass "-run" to the script.
* A signifcant amount of complexity in the test.bash script was running
the tests in parallel. This is trivial to do in Go.
The major detriment is that Go is more verbose as a "scripting" language.
Change-Id: Id7e5b303fb305fdbc0368bdf809dbf29fca1d983
Reviewed-on: https://go-review.googlesource.com/c/164861
Reviewed-by: Herbie Ong <herbie@google.com>
diff --git a/test.bash b/test.bash
index ad06c41..3a28e59 100755
--- a/test.bash
+++ b/test.bash
@@ -3,208 +3,6 @@
# Use of this source code is governed by a BSD-style
# license that can be found in the LICENSE file.
-REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-
-function print() { echo -e "\x1b[1m> $@\x1b[0m"; }
-
-# The test directory contains the Go and protobuf toolchains used for testing.
-# The bin directory contains symlinks to each tool by version.
-# It is safe to delete this directory and run the test script from scratch.
-TEST_DIR=$REPO_ROOT/.cache
-mkdir -p $TEST_DIR/bin
-function register_binary() {
- rm -f $TEST_DIR/bin/$1 # best-effort delete
- ln -s $TEST_DIR/$2 $TEST_DIR/bin/$1
-}
-export PATH=$TEST_DIR/bin:$PATH
-cd $TEST_DIR # install toolchains relative to test directory
-
-# Download and build the protobuf toolchain.
-# We avoid downloading the pre-compiled binaries since they do not contain
-# the conformance test runner.
-PROTOBUF_VERSION=3.6.1
-PROTOBUF_DIR="protobuf-$PROTOBUF_VERSION"
-if [ ! -d $PROTOBUF_DIR ]; then
- print "download and build $PROTOBUF_DIR"
- (curl -s -L https://github.com/google/protobuf/releases/download/v$PROTOBUF_VERSION/protobuf-all-$PROTOBUF_VERSION.tar.gz | tar -zxf -) || exit 1
- (cd $PROTOBUF_DIR && ./configure && make && cd conformance && make) || exit 1
-fi
-register_binary conformance-test-runner $PROTOBUF_DIR/conformance/conformance-test-runner
-register_binary protoc $PROTOBUF_DIR/src/protoc
-export PROTOBUF_ROOT=$TEST_DIR/$PROTOBUF_DIR
-
-# Patch proto files in the toolchain with new locations of Go packages.
-# TODO: these changes should be committed upstream.
-if ! grep -q "option go_package =" $PROTOBUF_ROOT/conformance/conformance.proto; then
-(cat << EOF
---- a/conformance/conformance.proto 2018-07-30 15:16:10.000000000 -0700
-+++ b/conformance/conformance.proto 2019-01-20 03:03:47.000000000 -0800
-@@ -32,0 +33 @@
-+option go_package = "github.com/golang/protobuf/v2/internal/testprotos/conformance;conformance_proto";
---- a/src/google/protobuf/any.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/any.proto 2019-01-20 02:58:13.000000000 -0800
-@@ -36 +36 @@
--option go_package = "github.com/golang/protobuf/ptypes/any";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/api.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/api.proto 2019-01-20 03:00:58.000000000 -0800
-@@ -43 +43 @@
--option go_package = "google.golang.org/genproto/protobuf/api;api";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/compiler/plugin.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/compiler/plugin.proto 2019-01-20 03:03:49.000000000 -0800
-@@ -52 +52 @@
--option go_package = "github.com/golang/protobuf/protoc-gen-go/plugin;plugin_go";
-+option go_package = "github.com/golang/protobuf/v2/types/plugin;plugin_proto";
---- a/src/google/protobuf/descriptor.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/descriptor.proto 2019-01-20 03:03:52.000000000 -0800
-@@ -43 +43 @@
--option go_package = "github.com/golang/protobuf/protoc-gen-go/descriptor;descriptor";
-+option go_package = "github.com/golang/protobuf/v2/types/descriptor;descriptor_proto";
---- a/src/google/protobuf/duration.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/duration.proto 2019-01-20 03:00:55.000000000 -0800
-@@ -37 +37 @@
--option go_package = "github.com/golang/protobuf/ptypes/duration";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/empty.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/empty.proto 2019-01-20 03:00:52.000000000 -0800
-@@ -36 +36 @@
--option go_package = "github.com/golang/protobuf/ptypes/empty";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/field_mask.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/field_mask.proto 2019-01-20 03:00:50.000000000 -0800
-@@ -40 +40 @@
--option go_package = "google.golang.org/genproto/protobuf/field_mask;field_mask";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/source_context.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/source_context.proto 2019-01-20 03:00:47.000000000 -0800
-@@ -40 +40 @@
--option go_package = "google.golang.org/genproto/protobuf/source_context;source_context";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/struct.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/struct.proto 2019-01-20 03:00:42.000000000 -0800
-@@ -37 +37 @@
--option go_package = "github.com/golang/protobuf/ptypes/struct;structpb";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/timestamp.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/timestamp.proto 2019-01-20 03:00:40.000000000 -0800
-@@ -37 +37 @@
--option go_package = "github.com/golang/protobuf/ptypes/timestamp";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/type.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/type.proto 2019-01-20 03:03:44.000000000 -0800
-@@ -44 +44 @@
--option go_package = "google.golang.org/genproto/protobuf/ptype;ptype";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
---- a/src/google/protobuf/wrappers.proto 2018-07-23 13:56:42.000000000 -0700
-+++ b/src/google/protobuf/wrappers.proto 2019-01-20 03:03:45.000000000 -0800
-@@ -42 +42 @@
--option go_package = "github.com/golang/protobuf/ptypes/wrappers";
-+option go_package = "github.com/golang/protobuf/v2/types/known;known_proto";
-EOF
-) | patch -d $PROTOBUF_ROOT -p1
-fi
-
-# Download each Go toolchain version.
-GO_LATEST=go1.11.4
-GO_VERSIONS=(go1.9.7 go1.10.7 $GO_LATEST)
-for GO_VERSION in ${GO_VERSIONS[@]}; do
- if [ ! -d $GO_VERSION ]; then
- print "download $GO_VERSION"
- GOOS=$(uname | tr '[:upper:]' '[:lower:]')
- (mkdir $GO_VERSION && curl -s -L https://dl.google.com/go/$GO_VERSION.$GOOS-amd64.tar.gz | tar -zxf - -C $GO_VERSION --strip-components 1) || exit 1
- fi
- register_binary $GO_VERSION $GO_VERSION/bin/go
-done
-register_binary go $GO_LATEST/bin/go
-register_binary gofmt $GO_LATEST/bin/gofmt
-
-# Travis-CI sets GOROOT, which confuses later invocations of the Go toolchains.
-# Explicitly clear GOROOT, so each toolchain uses their default GOROOT.
-unset GOROOT
-
-# Setup GOPATH for pre-module support.
-export GOPATH=$TEST_DIR/gopath
-MODULE_PATH=$(cd $REPO_ROOT && go list -m -f "{{.Path}}")
-rm -rf gopath/src # best-effort delete
-mkdir -p gopath/src/$(dirname $MODULE_PATH)
-(cd gopath/src/$(dirname $MODULE_PATH) && ln -s $REPO_ROOT $(basename $MODULE_PATH))
-
-# Download dependencies using modules.
-# For pre-module support, dump the dependencies in a vendor directory.
-(cd $REPO_ROOT && go mod tidy && go mod vendor) || exit 1
-
-# Regenerate Go source files.
-if [ "$1" == "-regenerate" ]; then
- cd $REPO_ROOT
- go run ./internal/cmd/generate-types -execute || exit 1
- go run ./internal/cmd/generate-protos -execute || exit 1
- gofmt -w $(git ls-files '*.go') || exit 1
- exit 0
-fi
-
-# Run tests across every supported version of Go.
-LABELS=()
-PIDS=()
-OUTS=()
-function cleanup() { for OUT in ${OUTS[@]}; do rm $OUT; done; }
-trap cleanup EXIT
-for GO_VERSION in ${GO_VERSIONS[@]}; do
- # Run the go command in a background process.
- function go() {
- # Use a per-version Go cache to work around bugs in Go build caching.
- # See https://golang.org/issue/26883
- GO_CACHE="$TEST_DIR/cache.$GO_VERSION"
- LABELS+=("$(echo "$GO_VERSION $@")")
- OUT=$(mktemp)
- (cd $GOPATH/src/$MODULE_PATH && GOCACHE=$GO_CACHE $GO_VERSION "$@" &> $OUT) &
- PIDS+=($!)
- OUTS+=($OUT)
- }
-
- # TODO: "go build" does not descend into testdata, which means that
- # generated .pb.go files are not being built.
- go build ./...
- go test -race ./...
- go test -race -tags purego ./...
- go test -race -tags proto1_legacy ./...
-
- unset go # to avoid confusing later invocations of "go"
-done
-
-# Wait for all processes to finish.
-RET=0
-for I in ${!PIDS[@]}; do
- print "${LABELS[$I]}"
- if ! wait ${PIDS[$I]}; then
- cat ${OUTS[$I]} # only output upon error
- RET=1
- fi
-done
-
-# Run commands that produce output when there is a failure.
-function check() {
- OUT=$(cd $REPO_ROOT && "$@" 2>&1)
- if [ ! -z "$OUT" ]; then
- print "$@"
- echo "$OUT"
- RET=1
- fi
-}
-
-# Check for stale or unformatted source files.
-check go run ./internal/cmd/generate-types
-check go run ./internal/cmd/generate-protos
-check gofmt -d $(cd $REPO_ROOT && git ls-files '*.go')
-
-# Check for changed or untracked files.
-check git diff --no-prefix HEAD
-check git ls-files --others --exclude-standard
-
-# Print termination status.
-if [ $RET -eq 0 ]; then
- echo -e "\x1b[32;1mPASS\x1b[0m"
-else
- echo -e "\x1b[31;1mFAIL\x1b[0m"
-fi
-exit $RET
+cd "$(git rev-parse --show-toplevel)"
+go test -v -timeout 60m -tags integration "$@"
+exit $?