Getting started

To build rtf from source, start by cloning the repo locally:

git clone git@github.com:apollographql/runtime-testing-framework.git
cd runtime-testing-framework

You will need a local Rust toolchain. We recommend using mise to install the Rust toolchain and other dependencies. After installing mise, trust the mise config file:

mise trust

Install rtf with cargo:

cargo install --path crates/rtf-cli

Verify installation:

rtf

This should print the rtf help output to your terminal. With that done, you’re ready to run some test plans!

Example test plans

This repo contains a “Hello, world!” test plan to introduce you to rtf concepts. Start by following the “Hello, world!” guide.

The rtf-morgue contains the most up-to-date examples of how to write test plans for a variety of different test cases. It also contains guides for running those test plans.