bin: add scripts for ci & git hooks

Author: markus-wa

.travis.yml

@@ -33,30 +33,22 @@ before_script:
   - pushd test/cs-demos && git lfs pull -I '*' && popd
 
 script:
-  - go build ./...
+  # Compile
+  - bin/build.sh
 
   # Make sure generated code is up-to-date
-  - go generate && go generate ./sendtables
-  - diff_output=$(git diff)
-  - if [[ "$diff_output" != "" ]]; then echo "Generated code is not up-to-date" && echo "$diff_output" && exit 1; fi
+  - bin/check-interfaces-generated.sh
 
   # Lint changed code
-  - if [[ "$TRAVIS_COMMIT_RANGE" != "" ]]; then commit_range=${TRAVIS_COMMIT_RANGE/.../..} && git diff $commit_range > /dev/null && base_rev=$commit_range || true; fi
-  - if [[ "$base_rev" = "" ]]; then base_rev='origin/master'; fi && echo "Linting changes between/since $base_rev"
-  - golangci-lint run --new-from-rev $base_rev
+  - bin/lint-changes.sh
 
-  # Get list of tests to run with race detection.
-  # We don't want to run the entire demo set with it because it's large and race tests take a lot longer.
-  - race_tests=$(go test -list . | grep -v "TestDemoSet\|Benchmark" | head -n -1 | awk -vORS=\| '{ print $1 }' | sed 's/|$/\n/')
   # Run race tests
-  - go test -v -race -run "$race_tests" -timeout 15m
+  - bin/race-tests.sh
 
-  # We run all tests again to get full coverage, technically unnecessary tho
-  - coverpkg_ignore='/(msg|fake)'
-  # coverpkg for multiple mains is broken in 1.12, so we need to exclude the examples from coverage
-  # https://github.com/golang/go/issues/30374
-  - if ! [[ "$TRAVIS_GO_VERSION" =~ ^1\.11 ]]; then coverpkg_ignore="${coverpkg_ignore}|/examples"; fi
-  - go test -v -timeout 30m -coverprofile=coverage.txt -coverpkg=$(go list ./... | grep -v -E ${coverpkg_ignore} | awk -vORS=, '{ print $1 }' | sed 's/,$/\n/') ./...
+  # Coverage
+  # Note: We run ALL tests again to get full coverage
+  #       Race tests are too slow and skip the regression set
+  - bin/coverage.sh
 
 after_success:
   - bash <(curl -s https://codecov.io/bash)

README.md

@@ -159,18 +159,41 @@ If your project is using this library feel free to submit a PR or send a message
 
 ## Development
 
-### Running tests
+### Git hooks
 
-To run tests [Git LFS](https://git-lfs.github.com) is required.
+To install some (optional, but quite handy) `pre-commit` and `pre-push` hooks, you can run the following script.
 
-```sh
-git submodule init
-git submodule update
-pushd test/cs-demos && git lfs pull -I '*' && popd
-go test
-```
+    bin/git-hooks/link-git-hooks.sh
+
+#### `pre-commit`:
+- check if [interfaces have been updated](#generating-interfaces)
+- build the code
+- run unit tests
+
+#### `pre-push`:
+- run regression tests
+
+### Testing
+
+#### Unit tests
+
+For any new features, [Test Driven Development](https://medium.com/@pierreprinetti/test-driven-development-in-go-baeab5adb468) should be practiced where possible.
+However, due to some design flaws in some parts of the code it's currently not always practical to do so.
+
+Running unit tests:
+
+    bin/unit-tests.sh
+    # or (identical)
+    go test -short ./...
+
+#### Regression tests
+
+For the full regression suite you will need to download the test demo-set.
+For this, [Git LFS](https://git-lfs.github.com) is required.
+
+Downloading demos + running regression tests:
 
-Here's a cool [gist of a pre-commit hook](https://gist.github.com/micvbang/4c8cb1f24cfe04d1a0dfab010eb851d8) to run tests before each commit. You can put this inside the `.git/hooks` directory to avoid committing/pushing code with build errors or failing tests.
+    bin/regression-tests.sh
 
 ### Debugging
 
@@ -187,7 +210,7 @@ We generate interfaces such as `IGameState` from structs to make it easier to ke
 For this we use [@vburenin](https://github.com/vburenin)'s [`ifacemaker`](https://github.com/vburenin/ifacemaker) tool.
 You can install it via `GO111MODULE=off go get github.com/vburenin/ifacemaker`.
 
-After adding it to your `PATH` you can use `go generate` to update interfaces.
+After adding it to your `PATH` you can use `bin/generate-interfaces.sh` to update interfaces.
 
 ### Generating protobuf code
 

bin/.gitignore

@@ -0,0 +1 @@
+!coverage.sh

bin/build.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+set -e
+
+# compile all packages + tests
+go build ./...
+go test -run ^$ ./...

bin/check-interfaces-generated.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+
+set -e
+
+bin_dir=$(dirname "$0")
+
+$bin_dir/generate-interfaces.sh
+diff_output=$(git diff --ignore-submodules)
+if [[ "$diff_output" != "" ]]; then
+	# don't keep the changes used for the check
+	git stash save --keep-index --quiet
+	git stash drop --quiet
+
+	echo "ERROR: generated code is not up-to-date"
+	echo "$diff_output"
+	exit 1
+fi

bin/ci.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+# This script simulates a CI run.
+# Might not work on windows since race tests are broken.
+# Prerequisites must be installed manually:
+# - ifacemaker -> GO111MODULE=off go get github.com/vburenin/ifacemaker
+# - golangci-lint -> https://github.com/golangci/golangci-lint/releases
+# - test-data -> pushd test/cs-demos && git lfs pull -I '*' && popd
+
+set -e
+
+# get the commands straight form the travis config
+ci_commands=$(sed -n '/^script:/,/^\S/p' .travis.yml | grep -E '^  - ' | cut -c 5-)
+
+while read -r cmd; do
+	echo "running $cmd:"
+	$cmd
+	echo -e '\n'
+done <<<"$ci_commands"

bin/coverage.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -e
+
+bin/download-test-data.sh
+
+# don't cover mocks and generated protobuf code
+coverpkg_ignore='/(fake|msg)'
+coverpkg=$(go list ./... | grep -v -E ${coverpkg_ignore} | awk -vORS=, '{ print $1 }' | sed 's/,$/\n/')
+
+# -timeout 30m because the CI is slow
+# output file must be called 'coverage.txt' for Codecov
+go test -v -timeout 30m -coverprofile=coverage.txt -coverpkg=$coverpkg ./...

bin/download-test-data.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+set -e
+
+echo 'downloading/updating test data (~ 1 GB), this may take a while ...'
+
+git submodule init
+git submodule update
+
+pushd test/cs-demos >/dev/null
+git lfs pull -I '*'
+popd >/dev/null
+
+echo 'download complete'

bin/generate-interfaces.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+set -e
+
+go generate
+go generate ./sendtables

bin/git-hooks/link-git-hooks.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# Windows needs special treatment
+windows() { [[ -n "$WINDIR" ]]; }
+
+# Cross-platform symlink function
+link() {
+	if windows; then
+		# We need elevated privileges and some windows stuff
+		powershell "Start-Process cmd -ArgumentList '/c','cd',(Get-Location).path,'&& mklink','${1//\//\\}','${2//\//\\}','|| cd && pause' -v RunAs"
+	else
+		# You know what? I think ln's parameters are backwards.
+		ln -s "$2" "$1"
+	fi
+}
+
+cd "$(dirname "$0")/../.."
+
+if [ -f .git/hooks/pre-commit ]; then
+	echo 'removing existing pre-commit hook'
+	rm .git/hooks/pre-commit
+fi
+if [ -f .git/hooks/pre-push ]; then
+	echo 'removing existing pre-push hook'
+	rm .git/hooks/pre-push
+fi
+
+link .git/hooks/pre-commit ../../bin/git-hooks/pre-commit.sh
+echo 'added pre-commit hook'
+
+echo 'do you want to set up the pre-push hook for the regression suite?'
+echo -n 'this will download ~ 1 GB of test-data (if not already done) [y/N] '
+
+read prePushYesNo
+if [[ "$prePushYesNo" == "y" || "$prePushYesNo" == "Y" ]]; then
+	bin/download-test-data.sh
+	link .git/hooks/pre-push ../../bin/git-hooks/pre-push.sh
+	echo 'added pre-push hook'
+fi