The Apollo Runtime Testing Framework

This repository contains the rtf command line tool and orchestrator service along with supporting crates and example Test Plans.

The user facing documentation can be viewed in GitHub Pages here.

Project status

While this tool may be of interest to users outside of Apollo, it should be noted that RTF is an Apollo internal tool and not a supported Apollo product.

Please refer to the LICENSE file in the root of the repo for further information.

Contributing to RTF as an Apollo Engineer

If you are contributing to this repo, the developer documentation can be found here.

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.

$ mise trust

If you are using Rust Rover you can change your rust toolchain in Settings > Rust to point to /Users/<USER>/.local/share/mise/shims

Once you have Rust set up you can install rtf by using cargo:

$ cargo install --path crates/rtf-cli

Once that completes you should be able to run rtf in your terminal and see the help output. For more details on getting started with rtf please refer to the docs, the source of which are written using mdbook in the docs directory.

Adding the rtf-bot (Apollo Marvin) to your repository

This link takes you to the page that allows you to configure Apollo Marvin's repository access. You can also navigate to this page by going to the settings of the runtime-testing-framework repo -> Integrations (GitHub Apps) and then clicking "Configure" next to the Apollo Marvin app.