Plan stages can be used to control how tests are run within a plan. By grouping your tests into stages, you can:
- Configure tests to run in parallel or sequentially
- Manage behavior on failure
- Override default settings for browsers, the run multiplier, and DataTables
Example of a plan with multiple stages
This guide explains the different settings that can be applied to plan stages: concurrency, behavior on failure, and override settings.
If you're seeking advice for how to organize tests into plans, check out the guide Organizing tests into plans.
To get started, take the following steps to open the stage options modal:
- Open the plan details page
- Click on the pencil icon to open the plan edit page.
- Scroll down to the Tests section to find the plan stages.
- Click on the pencil icon next to a stage to open the stage options modal.
Accessing the stage options modal
Tests in a stage can run in parallel or sequentially.
In a parallel stage, all tests start running at the same time. Running tests in parallel helps minimize run time and dependencies between tests.
When a stage is configured to run tests in parallel, up to 50 tests run at the same time by default. Use the "Max" input to configure a different concurrency limit.
Setting a concurrency limit is recommended for all plan stages, as it provides a number of benefits:
- Most applications, particularly in pre-production environments, have limited underlying resources. A reasonable concurrency limit allows you to take advantage of speeding up your tests by running in parallel without risking overloading the underlying servers
- Leveraging concurrency limits allows you to avoid adding excess plan stages just to limit test tests in parallel or enable stopping once you get a failure
- When tests fail or are flaky in a parallel plan but pass individually, you can reduce the concurrency limit before resorting to running fully in sequence
Click the play button next to the title of a stage to run an individual plan stage for troubleshooting.
Tests in a sequential stage run one at a time in the order in which they are defined in the plan.
If a plan runs tests on multiple browsers, environments, and/or DataTable scenarios, only one test (on one of the configured browsers/environments/scenarios) runs at a given time.
Behavior on failure
Depending on the plan stage settings, a failing test can cause different outcomes. The stage options modal has two settings to manage behavior on failure: always run all tests in stage and always run stage.
Settings to manage behavior on failure
Always run all tests in stage
If this setting is enabled, all tests in a stage run until they either pass or fail.
If this setting is turned off, a failed test stops subsequent tests in the stage from running. The tests that were scheduled to run after the failed test have a skipped status.
Always run stage
If this setting is enabled, the stage always runs even if tests in a previous stage failed. This setting can be useful for defining clean-up stages that remove test data generated in a previous stage.
If this setting is turned off, tests in this stage only run if all tests in previous stages passed. If a test in a previous stage fails, the tests in this stage have a skipped status.
Stage override settings
Override device settings for this stage
Use a different set of browsers for this stage.
Override run multiplier for this stage
Use a different run multiplier for this stage.
Ignore data tables for this stage
If the "Ignore data tables for this stage" setting is enabled, tests that are associated with DataTables only run the first scenario of the first DataTable associated with the test.