Makefile: add 'e2e-test' target

Add a target to the Makefile that installs the end-to-end test NPM
dependencies then runs the tests. By default, this will only run tests
matching the "default" profile of the tests (excluding performance tests).
The 'E2E_FLAGS' variable can be used to specify the profile(s) used by the
tests (e.g., '--all' to include the tests excluded by default).

Add documentation on how to run the end-to-end tests to 'README.md'.

Signed-off-by: Victoria Dye <vdye@github.com>

Author: vdye

Makefile

@@ -13,6 +13,7 @@ INSTALL_ROOT := /
 BINDIR := $(CURDIR)/bin
 DISTDIR := $(CURDIR)/_dist
 DOCDIR := $(CURDIR)/_docs
+TESTDIR := $(CURDIR)/_test
 
 # Platform information
 GOOS := $(shell go env GOOS)
@@ -26,6 +27,7 @@ PACKAGE_ARCH := $(GOARCH)
 APPLE_APP_IDENTITY =
 APPLE_INST_IDENTITY =
 APPLE_KEYCHAIN_PROFILE =
+E2E_FLAGS=
 
 # Build targets
 .PHONY: build
@@ -39,6 +41,14 @@ doc:
 	@scripts/make-docs.sh --docs="$(CURDIR)/docs/man" \
 			      --output="$(DOCDIR)"
 
+# Testing targets
+.PHONY: e2e-test
+e2e-test: build
+	@echo
+	@echo "======== Running end-to-end tests ========"
+	$(RM) -r $(TESTDIR)
+	@scripts/run-e2e-tests.sh $(E2E_FLAGS)
+
 # Installation targets
 .PHONY: install
 install: build doc
@@ -170,3 +180,4 @@ clean:
 	$(RM) -r $(BINDIR)
 	$(RM) -r $(DISTDIR)
 	$(RM) -r $(DOCDIR)
+	$(RM) -r $(TESTDIR)

README.md

@@ -170,11 +170,45 @@ $ go build -o bin/ ./...
 
 ### Testing and Linting
 
-To run the project's unit tests, navigate to the repository root directory and
-run `go test -v ./...`.
+Unless otherwise specified, run commands from the repository root.
 
-To run the project's linter, navigate to the repository root directory and run
-`go vet ./...`.
+#### Unit tests
+
+```
+go test -v ./...
+```
+
+#### Linter
+
+```
+go vet ./...
+```
+
+#### End-to-end tests
+
+In order to run these tests, you need to have a recent version of
+[Node.js](https://nodejs.org) (current LTS version is a pretty safe bet) and NPM
+installed.
+
+For the standard set of tests (i.e., excluding exceptionally slow tests), run:
+
+```
+make e2e-test
+```
+
+To configure the test execution and filtering, set the `E2E_FLAGS` build
+variable. The available options are:
+
+* `--offline`: run all tests except those that require internet access.
+* `--all`: run all tests, including slow performance tests.
+
+The above modes are mutually exclusive; if multiple are specified, only the last
+will be used. For example, `E2E_FLAGS="--offline --all"` is equivalent to
+`E2E_FLAGS="--all"`.
+
+:warning: The performance tests that are excluded by default clone very large
+repos from the internet and can take anywhere from ~30 minutes to multiple hours
+to run, depending on internet connectivity and other system resources.
 
 ## License
 

scripts/run-e2e-tests.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+THISDIR="$( cd "$(dirname "$0")" ; pwd -P )"
+TESTDIR="$THISDIR/../test/e2e"
+
+# Defaults
+ARGS=()
+
+# Parse script arguments
+for i in "$@"
+do
+case "$i" in
+	--offline)
+	ARGS+=("-p" "offline")
+	shift # past argument
+	;;
+	--all)
+	ARGS+=("-p" "all")
+	shift # past argument
+	;;
+	*)
+	die "unknown option '$i'"
+	;;
+esac
+done
+
+# Exit as soon as any line fails
+set -e
+
+cd "$TESTDIR"
+
+npm install
+npm run test -- ${ARGS:+${ARGS[*]}}