Test plans

Test plan is a set of test cases that are meant to be executed together.

Test plans can be created by manually selecting test cases in the Test cases section or by using filters and AQL queries, which allows you to quickly select all test cases that have the same tag, testing layer, or other attribute.

Creating test plans

Creating test plan by selecting test cases

To create a test plan by manually selecting test cases:

1. Go to Test cases.
2. Select the test cases using Ctrl or by checking the boxes next to them.
3. Click ⋯ in the bottom panel and select Test plan.
4. Enter a name for the test plan.
5. Click Submit. A new test plan will be created in the Test plans section.

Creating test plan using filters

To create a test plan using filters:

1. Go to Test cases.
2. Click the search box above the test case list.
3. Enter the search terms to filter the test cases.
4. Select the test cases using Ctrl or by checking the boxes next to them.
5. Click ⋯ in the bottom panel and select Test plan.
6. Enter a name for the test plan.
7. Click Submit. A new test plan will be created in the Test plans section.

To learn more about using filters, see the Test cases article.

Creating test plan using AQL

To create a test plan using Allure Query Language:

1. Go to Test plans.
2. Click + Test plan.
3. Under Name, enter a name for the test plan.
4. Optionally, under Tree, select a tree that will be used to preview the test cases.
5. Under Test cases query, enter an AQL query to select the test cases for the test plan.
6. Review the list of test cases and click Submit. A new test plan will be created in the Test plans section.

Managing test plans

All created test plans can be found in the Test plans section of your project.

You can edit and delete test plans by clicking the ⋯ icon next to the test plan. When editing a test plan, you can change its name and the set of test cases of which it consists.

If a test plan was created using an AQL query, you can update its set of test cases (test cases that match the AQL query) by clicking ⋯ and selecting Sync test cases.

Editing test plans

Although it is technically possible, we do not recommend changing the type of a test plan (e.g., switching from manually selected test cases to AQL queries) after you have created it. This can lead to unexpected behavior and unpleasant surprises down the road. So, if you created a test plan based on tag = "smoke" rule, and you want to include one more test case, then you need to update your test case to meet the test plan criteria rather than manually adding the test case to the created test plan.

1. Go to Test plans.
2. Find the test plan you want to edit, then click the ⋯ icon next to it and select Edit. You can use the search bar at the top of the page to search for the test plan by its name.
3. Under Name, enter a new name for the test plan if you want to change it.
4. If the test plan was created using an AQL query, you can change it under Test cases query. Otherwise, you can ignore this field.
5. Revise the list of test cases if necessary and click Submit.

Assigning team members and jobs

Normally, when you run a single test case, you can assign a team member to the launch if the test case is manual, or specify a job if the test case is automated.

When using test plans, instead of assigning team members and specifying jobs for each test case every time you run a test plan, you can do that beforehand.

1. Go to Test plans.
2. Click a test plan to which you want to assign team members or specify jobs.
3. Go to the Executors tab.
4. Click a group of test cases under Manual to assign team members or a group under Automated to specify jobs.
5. On the right side of the page, select the test cases by checking the boxes to the left of their names.
6. In the upper right of the test case list, click the Bulk actions button and select Assign user (manual test cases) or Assign job (automated test cases).
7. Select a team member or a job and click Submit.

Launching test plans

1. Go to Test plans.
2. Find the test plan you want to run and click the Run text plan icon next to it. A new window will appear where you can change the attributes of the launch.
3. Under Name, enter a name for the launch, or keep the suggested name.
4. Under Tags, you can select tags to be added to the launch.
5. Under Issues, you can link the launch to one or several issues in external issue trackers.
6. Under Links, you can add free-form links to the launch.
7. Under Environment, you can specify one or more sets of environment variables for the launch.
8. When finished, click the Submit button to run the test plan, creating a new launch in the Launches section.

One important thing to note here is that if you are executing a test plan that includes automated test cases, your testing framework integration must support selective execution of test cases. Otherwise, when you run a test plan, all of your integrated tests will be executed.

You can learn more about selective test execution here.