Overview

roachtest is a tool for performing large-scale (multi-machine) automated tests. It relies on the concurrently-developed (but separate) tool roachprod.

Prerequisites

• Ensure that $GOPATH/bin is on your PATH.
• Install roachprod: go get -u github.com/cockroachdb/roachprod
• Build a linux release binary of cockroach: build/builder.sh mkrelease amd64-linux-gnu
• Build a linux binary of the workload tool: build/builder.sh make bin/workload
• Build a local binary of roachtest: make bin/roachtest
• Set up gcloud and google_compute_engine ssh key (TODO: more details)

Usage

You'll usually use roachtest run and specify a single test.

For Cockroach Labs employees, if your local username does not match your gcloud/@cockroachlabs.com username, you'll need to add --user=$CRL_USERNAME to the roachtest command. For non-Cockroach Labs employees, set --gce-project (and maybe --user too).

bin/roachtest run jepsen/1/bank/split

While iterating, don't forget to rebuild whichever of the above binaries you've touched. For example, the command line that I use while iterating on jepsen tests is make bin/roachtest && PATH=~/go/bin:$PATH bin/roachtest run --user=ben jepsen/1/bank/split

TODO: document process for creating and reusing a cluster.