Contributing to Shotover
This guide contains tips and tricks for working on Shotover itself.
Configuring the Environment
Shotover is written in Rust, so make sure you have a rust toolchain installed. See the rustup site for a quick way to setup your Rust development environment.
Once you've installed Rust via Rustup (you should just be fine with the latest stable). You will need to install a few other tools needed to compile some of Shotover's dependencies.
Shotover requires the following in order to build:
- pkg-config (Linux)
On Ubuntu you can install them via
sudo apt-get install cmake gcc g++ libssl-dev pkg-config.
Installing Optional Tools and Libraries
While not required for building Shotover, installing
docker-compose will allow you to run Shotover's integration tests and also build the static libc version of Shotover. This setup script might work for you:
curl -sSL https://get.docker.com/ | sudo sh Do not use the rootless install as many of our tests rely on the user created bridge networks having their interface exposed to the host, which rootless install does not support. Instead add your user to the docker group:
usermod -aG docker $USER
Now you can build Shotover by running
cargo build. The executable will then be found in
Building Shotover (release)
The way you build Shotover will dramatically impact performance. To build Shotover for deployment in production environments, for maximum performance or for any benchmarking use
cargo build --release. The resulting executable will be found in
Running the Tests
The Cassandra tests require the Cassandra CPP driver.
Installing Cassandra CPP Driver
Upstream installation information and dependencies for the Cassandra CPP driver can be found here.
However that is likely unusable because datastax do not ship packages for modern ubuntu so we have our own script which will compile, package and install the driver on a modern ubuntu. So to install the driver on ubuntu just run the script at
Run Shotover tests
Shotover's tests suite must be run via nextest as we rely on its configuration to avoid running incompatible integration tests concurrently. To use nextest:
- Install nextest:
cargo install nextest
- Then run the tests:
cargo nextest run
The tests rely on configuration in
tests/test-configs/, so if for example, you wanted to manually setup the services for the redis-passthrough test, you could run these commands in the
docker-compose -f shotover-proxy/tests/test-configs/redis-passthrough/docker-compose.yaml up
cargo run -- --topology-file tests/test-configs/redis-passthrough/topology.yaml
Submitting a PR
Before submitting a PR you can run the following to ensure it will pass CI:
cargo clippy- Ensure you haven't introduced any warnings.
cargo build --all-targets- Ensure everything still builds and you haven't introduced any warnings.
cargo nextest run --all-features- All tests pass.