Link Search Menu Expand Document

Rollout recommendation

To safely accelerate tests on production, we recommend that you first run YourBase Test Acceleration in its Observation Mode, and manually verify the output logged.

We propose the rollout to be done in the following 3 phases:

  1. Phase 1: Test locally
  2. Phase 2: Test in CI
  3. Phase 3: Enable local test acceleration across your development team

Phase 1: Test locally

This phase will synchronize your code’s dependency graph on your local machine storage. Hence, after completing this phase, you’ll see the tests on your branch running faster only on your local machine.

In your development branch:

  1. Install YourBase Test Acceleration locally.
  2. Run YourBase Test Acceleration in Observation Mode.
  3. Ensure that YourBase Test Acceleration accelerates your tests correctly, or resolve any issues that arise.
  4. Disable Observation Mode.
  5. Run your tests.

Phase 2: Test in CI

This phase will synchronize your code’s dependency graph on remote storage for use by CI. Hence, after completing this phase, you’ll see the tests on your branch running faster on your CI as well.

Step 1. Configure Remote Cache

In your CI environment:

  1. Set up a Shared Dependency Graph for use in CI.

    • Tip: It may be easier to set up and debug the remote cache from your local environment before configuring it in the CI.
  2. Set up the following configuration variables for your CI environment:

Step 2. Install in test branch

In your test branch, do the following:

  1. Install YourBase Test Acceleration to your project via requirements.txt or whatever other mechanism you use to install your dependencies in your CI environment.
  2. Enable Observation Mode.
  3. Run your tests as usual.
  4. Ensure that YourBase Test Acceleration accelerates these tests correctly, or resolve any issues that arise.
  5. Disable Observation Mode.
  6. Run your tests as usual.

Step 3: Install in main branch

In your main branch, before enabling Yourbase Test Acceleration for full production, we recommend executing the following steps for a subset of builds, for example in a canary environment or as a percentage experiment:

  1. Install YourBase Test Acceleration to your project via requirements.txt or whatever other mechanism you use to install your dependencies in your CI environment.
  2. Set YOURBASE_DISABLE=true and ensure CI continues to run as expected.
  3. Enable Observation Mode.
  4. Set YOURBASE_DISABLE=false.
  5. Run your tests as usual.
  6. Ensure that YourBase Test Acceleration accelerates these tests correctly, or resolve any issues that arise.
  7. Disable Observation Mode.
  8. Run your tests as usual.

Note: Once YourBase Test Acceleration is launched to production, we recommend continuing to run the full test suite occasionally, for example, in advance of major releases.


Phase 3: Enable local test acceleration across your development team

After this phase, you’ll see tests run faster for developers across the team because of them sharing their dependency graph.

Do the following starting with a group of beta users, slowly rolling out to the entire team:

  1. Set up the shared Dependency Graph for use by your local machine.
  2. Install YourBase Test Acceleration to your project via requirements.txt or whatever other mechanism you use to install your dependencies in your local environment
  3. Set up the following configuration variables for your local environment: