Rainforest Tests: Writing a Test

This article provides a step by step guide to writing Rainforest Tests


Rainforest vs. Rainforest Classic

Rainforest Automation and RFA are now Rainforest tests.

  • Rainforest Tests - Quickly capture UI element with screenshots
  • Rainforest Tests provide easy and efficient test writing for desktop applications. Test execution may be done via Automation Service, Tester Community or On-Premise Testers.

Plain English tests are now Rainforest Classic tests.

  • Rainforest Classic tests - Detail your test case line by line
  • Rainforest Classic tests allow you to write instructions via a free-form English testing writing interface. Tests may be run on desktop applications, mobile browsers, and mobile applications. Test execution is done via the Tester Community or On-Premise Testers.


This article provides details on creating and editing Rainforest Tests.

Create a New Test

  1. Navigate to the All Tests page (paper) and then select Tests
  2. Click the blue Create Test button in the top right of the All Tests page to start a new test.
  3. Select one of the Sites to test or add a new one by entering the URL in the Add a New Site tab.
  4. Select Quickly capture UI elements with screenshots from How do you want to compose this test?
  5. Click on Create Test

Create Test Dialog box


Writing a test

The following are the general steps for writing a Rainforest Test. Each step is covered in more detail below. Step and Action are used interchangeably.



  1. The Virtual Machine (VM) will load and Navigate to the starting URL
    This uses the default platform and the URL selected on the Create Test Dialog.
    The URL can be updated by clicking the URL on the first step.
    Additionally, a Navigate step may be added and a new URL is needed
  2. Name the test
    by clicking Untitled Test in the top left of the screen.
    Click Save Changes to save the test at any point
  3. Add additional test steps/actions
    Click Select action or embed a test.
    For a list of actions and how to embed tests see Rainforest Tests: Actions, Assertions and Embedded Tests.
  4. Capture and name the element
    Click on `Element' in the test step and then screenshot the desired area from within the VM.
    Recapture the element if needed by selecting Recapture element and try again.
    See Rainforest Tests: Content Matching for information on how to increase the stability of elements.
    Don't forget to provide a name for the element.
  5. Continue adding steps
    Continue through the test adding additional steps as needed.
    Steps can be updated, moved, and deleted as desired
    Additionally, variables may be used for dynamic information such as login or email. For more information on variables see Step Variables Overview



Makes sure to save changes often. Saving is not done automatically.


Preview Actions

Preview Actions steps through the result of the test actions in real-time on the VM to the right.

  • If the action(s) behave as expected, proceed with adding more actions and previewing them to validate. If not, update the test step as needed.
  • If no actions are selected, Preview Actions will play ALL actions of the test.
  • To play a few actions, click the number to the left of the action(s), then select Preview Actions.


Adding, deleting, and moving actions

Add actions

To add a step between two current steps:

  1. Select the + between the actions.
  2. Select from Select action or embed a test that appears.
    To add an action at the end of the test:
  3. Select from Select action or embed a test that appears after the last action.
  4. Provide information on the new action.


Delete actions

  1. Select the action(s) to delete by clicking the action number.
  2. Select Delete button at top of the Actions list.


Move actions

  1. Select the "=" to the right of the action
  2. Move the action up and down to the desired location
    Note: Action cannot be moved above Start at action.


Use Draft to validate the test

As the test is being written, it should be validated. This can be done without adding unnecessary noise to your results screen. Set the test to draft; the results are stored separately from the production runs. Additionally, the test will not inadvertently be run, and the entire team will know it is in progress.

  1. Select Settings (little gear) to open the test's settings.
  2. Set this test to draft so that the toggle is colored.
  3. After closing Settings, click Run Draft in the top right of the screen.
  4. Set How this run will be executed to Automation Service or select Change to run it using the Tester Community.
  5. Select the same platform you used to create the test.
  6. Click Start Draft Run.
  7. Review the results on the Draft Runs tab in Results.

For more information on how the Test Writing Interface works, and how to run and review test results, see the following articles

If you have any questions, please feel free to reach out to us at [email protected] or through Intercom!

Updated 2 months ago

Rainforest Tests: Writing a Test

This article provides a step by step guide to writing Rainforest Tests

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.