Tooling for Remote Execution API

This project contains miscellaneous tooling useful for dealing with Remote Execution API servers. Such servers include BuildBarn, Buildfarm, and BuildGrid.

Tools

REAPI Smoke Test

The REAPAI "smoke test" is a simple operational check of an REAPI instance. It checks whether an REAPI server can handle basic CAS, Action Cache, and Execution service requests. The test creates a unique Command proto, requests its execution, and then checks the outputs and the Action Cache to ensure they are in the expected state.

To build the smoketest binary:

$ cd cmd/smoketest
$ go build

If you are running an REAPI instance at 127.0.0.1:8980, then you can run the smoketest against that instance with the OSFamily platform property set to Linux by running:

$ ./smoketest -r 127.0.0.1:8980 -p OSFamily=Linux

There are other options to enable TLS, send an authorization token, add additional platform properties, etc. Run smoketest -h to see the available options.

Load Testing

The casload tool generates CAS traffic according to one or more specifications of the form: NUM_REQUESTS:MIN_BLOB_SIZE:MAX_BLOB_SIZE[:CONCURRENCY].

To build the casload binary:

$ cd cmd/smoketest
$ go build

If you are running a CAS instance at 127.0.0.1:8980, then you can generate 15,000 requests with blob sizes ranging from 5000 bytes to 10,000 bytes with 100 concurrent requests by running:

$ ./casload -r 127.0.0.1:8980 generate:15000:5000:10000:100

There are other options to enable TLS, send an authorization token, etc. Run casload -h to see the available options.

casload takes "load actions" as parameters which drive the load test. Each load action has access to a set of "known digests".

The load actions are:

generate:NUM_BLOBS:MIN_BLOB_SIZE:MAX_BLOB_SIZE[:CONCURRENCY] - This load action generates random blobs and writes them to the CAS. Each digest is added to the set of known digests. The blobs will be between MIN_BLOB_SIZE and MAX_BLOB_SIZE in size. The action will use CONCURRENCY workers to send requests.
load-digests:FILENAME - Load digests from a CSV file into the set of known digests. The CSV file consists of lines in the following format: HASH,SIZE,true|false where the third field is whether the digest is known to be present in the CAS or not.
save-digests:FILENAME - Save the set of known digests to a CSV file in the same format expected by the load-digests load action.
read:NUM_DIGESTS_TO_READ:NUM_READS_PER_DIGEST[:CONCURRENCY] - This load action randomly chooses NUM_DIGESTS_TO_READ from the set of known digests and issues NUM_READS_PER_DIGEST RPCs to read the blob from the CAS and verify its content matches the digest hash. The action will use CONCURRENCY workers to send requests.

Development

To rebuild the generated Go files, run:

$ ./scripts/gen-proto.sh

Contributions

Contributions are welcome. Please open a pull request or file an issue.

Please run go fmt ./... to format the code before submitting.

Useful Links

remote-apis-testing project