Testing

Run visual tests on your React Native builds in the cloud with the testing method that fits your workflow: Standard, EAS Update, or EAS Cloud Build.

Run a visual test with one command​

To run tests, use this guided testing command:

Terminal

npx sherlo test

For non-interactive commands, you can run directly:

• npx sherlo test:standard - test app builds with bundled JavaScript
• npx sherlo test:eas-update - test builds with OTA JavaScript updates - skip rebuilds
• npx sherlo test:eas-cloud-build - automatically test builds created on Expo servers

Ready-to-run examples

Each testing method has a complete example project.

Browse examples on GitHub

Pick a testing method for your workflow​

Select a testing method based on your needs:

Standard

Description

Run visual tests on app builds with bundled JavaScript.

Workflow

Requirements

• Define paths to preview simulator builds

Options

Option	Value	Description
--android	<path>	Path to Android build (.apk)
--ios	<path>	Path to iOS build (.app, .tar.gz or .tar)

note

Options --android and --ios override the android and ios config properties if they are set in both places.

Usage

Run Sherlo to test builds with bundled JavaScript:

Terminal

npx sherlo test:standard

Try a complete example project with a GitHub Actions workflow included

EAS Update

Description

Run visual tests using over-the-air JavaScript updates - without full app rebuilds.

Workflow

Requirements

• Use EAS Update for over-the-air updates
• Install expo version 51 or higher and expo-dev-client
• Define paths to development simulator builds

Options

Option	Value	Description
--branch	<branch>	Name of the EAS Update branch to fetch the latest update from
--android	<path>	Path to Android build (.apk)
--ios	<path>	Path to iOS build (.app, .tar.gz or .tar)

note

Options --android and --ios override the android and ios config properties if they are set in both places.

Usage

Run Sherlo to test the latest update from an EAS Update branch:

Terminal

npx sherlo test:eas-update --branch <branch>

note

Make sure you've published your latest changes to EAS Update before testing. You can use:

Terminal

npx eas-cli update --auto --branch <branch>

Try a complete example project with a GitHub Actions workflow included

EAS Cloud Build

Description

Automatically run visual tests after builds complete on Expo servers.

Workflow

Requirements

• Use EAS Build to create preview simulator builds on Expo servers

• Add eas-build-on-complete script to your package.json:

  package.json

  {
    "scripts": {
      "eas-build-on-complete": "npx sherlo eas-build-on-complete --profile <profile>",
      // ...
    },
    // ...
  }

  EAS build profile

  The --profile option must:

  • Point to the EAS build profile that creates preview simulator builds
  • Match the --profile option used in your EAS build command

Options

Option	Value	Description
--easBuildScriptName	<name>	Name of the package.json script that triggers EAS build
--waitForEasBuild		Start waiting for EAS build to be triggered manually

Usage

Run Sherlo to test builds after completion on Expo servers:

Automatic

Start Sherlo and automatically trigger the EAS build using a script from your package.json:

Terminal

npx sherlo test:eas-cloud-build --easBuildScriptName <name>

Manual

Start Sherlo and then manually trigger the EAS build command:

Terminal

npx sherlo test:eas-cloud-build --waitForEasBuild

EAS build profile

The --profile option in the EAS build command must match the one in eas-build-on-complete script.

Try a complete example project with a GitHub Actions workflow included

Common options​

These options work with any testing command:

Option	Value	Default	Description
--token	<token>		Authentication token for the project
--message	<message>		Custom message to label the test
--config	<path>	sherlo.config.json	Path to the config file
--projectRoot	<path>	.	Path to the root directory of your project

note

Option --token overrides config property if it is set in both places.