Step-by-step instructions for getting started with Rainforest
Welcome to Rainforest QA
This guide will provide you with a high-level overview how our platform works, and how to begin your journey with Rainforest testing. We know testing is not always fun or easy, but don’t worry, you are not in the QA jungle alone.
We encourage you to start by watching this short video introduction to the Rainforest QA Dashboard which addresses many basic functionality-related questions.
Setup and Configuration
1. Configure your Sites and Environments
Sites are distinct web properties which you’d like to run Rainforest tests against. All new tests created in Rainforest will be set to run against the default Site as configured in your Sites and Environment settings.
Your web app might be deployed to multiple locations—such as a staging, develop or production environment. If access to your environments are restricted by IP address, please see our list of IPs to whitelist so that our testers will can gain access for testing.
2. Select your default Platforms
Let us know the testing platforms you’re going to be testing against the most often by selecting them in your Platforms settings. You can customize or override your default Platforms for any individual test, but it’s easiest for your test writers if default browsers are preselected.
3. Spin up test accounts
Create enough login credentials for testers to execute tests requiring logins to your web application. After these accounts have been created, upload them to Rainforest as tabular variables as a Comma Separated Value (.CSV) file. When a test is run, each tester will be assigned one unique row of variable values, which will be repeated any time the tabular variable placeholder appears within a specific test.
How many test accounts do I need?
Be sure to create sufficient accounts so that all testers assigned to your test will receive a unique account. Use the following equation to ensure that you will have sufficient unique accounts:
Minimum number of test accounts:
Tests * Browsers * (3 Testers * 2 Safety)
- tests = number of tests using this variable
- browsers = number of browsers you're running these tests against
- testers = default number of testers we send to each job
- safety = safety margin we use in case we need to add more testers to a job
Using this equation, to successfully run 1 profile update test against 5 browsers, the we would need a minimum of 30 logins.
4. Prepare users with seeded test states
Seeded states allow testers to land into an account that has certain actions complete. With a seeded state, you can have a tester login and go directly to the part of your application you need to test. Having users with various seeded test states is crucial to reducing run time and tester error.
Reach out to us if you have questions on best practices for managing seeded states.
5. Invite your Team
In your Team Settings, scroll down until your see "Invite User". In the fields, enter the Name and Email of your teammates that will have access to Rainforest and click 'Invite User'.
The invited teammate will receive an email notification from Rainforest with a link instructing them to complete the account set up process by setting a password. Note that the email link is good for 10 hours.
To remove a user, simply hit the 'x' beside their name and confirm.
If you need to modify details of the team member, or need to resend the invite, delete the user and re-invite.
Writing your first Tests
1. Define Your Smoke Tests
2. Build Your Initial Test Suite
3. Run your tests
There are several ways to run your Rainforest tests:
- Test level runs: select individual or multiple tests to start a run.
- Filtered runs: apply a filter from the Tests view to run tests by test Result type, Sites, or Tags.
- Smart Folder: run tests manually by folders from Folder view.
- Scheduled runs: set the day and time of when you want Rainforest to automatically trigger runs of your tests based on tags or folders.
- Trigger tests using the API or CLI.
4. View your Results
See this article for a comprehensive breakdown of the results sections.
Also, it is important to understand how and when Rainforest rejects or accepts tester results. Review this short explanation that will explain how it works.
5. Build your Regression Suite
To start building out your regression test suite, we recommend checking out:
- Our list of 50 Essential Integration Tests that may be applicable to your application
- How to leverage our Developer Experience which allows your developer team write and upload tests via our CLI without disrupting their everyday workflow
- Our CTO's guide to Continuous Deployment
6. Create a process to update and optimize your test suite
Read how we at Rainforest have optimized our usage of Rainforest.
Our Help Center is always readily available and will likely have the answer to the question that you have. If you can't locate the answer there, feel free to reach out to us on Intercom by clicking the below icon wherever it appears in your Rainforest portal or by emailing firstname.lastname@example.org.
Our primary team is based in Pacific Standard Timezone (PST), which means we may not always be available to provide an immediate response. However, we will do our best to get back to you as soon as we can.