The purpose of a Test Plan is to give you better visibility and management over your Tests.
It provides a table of all the Tests included in the Test Plan and their respective Test Executions.
If tracking a particular version, the Test Plan will show the latest status for each Test, independent of the number of testing iterations (i.e.,Test Executions) you make with them.
You can group Test Executions and easily give feedback on the current/latest status of the Tests involved in those Test Executions.
From the Test Plan, it's possible to create one or more Test Executions for all or just a subset of the Tests contained within the Test Plan (e.g., only those Tests that are still failling).
You are also able to assign one or more Test Plans to a given release and track progress of those tests within each Test Plan.
The Coverage Analysis can also be done, taking into account just the tests from a given Test Plan and its related Test Executions.
Create Test Plan
To create a new Test Plan Issue,
Step 1: Click the "Create" on the top of the screen to open the Create Issue dialog box / page or press the "C" key on the keyboard.
In the old UI, click the "+" on the left:
Step 2: Select the Project. On the Issue Type, select Test Plan.
Step 3: Type a Summary for the test plan and fill out all appropriate fields (mandatory fields are marked with an asterisk). If you're working with versions, then you should also fill out the Fix Version to indicate that you're tracking the results of the Tests for that version. This will be used to automatically fill out the Fix Version of the planned Test Executions (i.e., the ones linked to/created from this Test Plan).
Optional: To create a series of similar Test Plans – within the same Project – check Create another at the bottom of the dialog.
Step 5: When you are satisfied with the content of your Test Plan, click Create.
Step 5a: If you checked Create another, a new Create Issue dialog appears. This issue is automatically pre-populated with your previous Test Plan details, with the Summary field blank.
Add Tests to a Test Plan
Aside from adding Tests to the Test Plan using the issue create screen, you can also do it in the Test issue page.
Step 1: Click Add.
Step 2: Choose to add either Tests or Test Sets. Note that if you choose Test Sets, you are not actually adding Test Set(s); instead, you are adding the Tests that belong to that Test Set(s).
Step 3: Choose the Tests you want, by using the Select or Search tabs and then selecting some or all of them.
Step 4: Click Add selected or Add all.
Reorder Tests
The following procedure details how you can change the order of the Tests, directly in the Test Plan issue screen.
There are two ways of changing the order of Tests within a Test Plan:
Drag-and-Drop
To reorder Tests,
Step 1: Open the Test Plan issue.
Step 2: Hover over the desired Test row (under the Tests section on the view page) and the drag handle column.
Step 3: Click the drag handle and move the Test up or down in the current page.
Change Rank Action
This action allows users to change the Rank of a Test between pages.
To change the rank of a Test,
Step 1: Open the Test Plan issue.
Step 2: Click the ... on the desired Test Set row and click the Change Rank option that appears in the drop down menu. The change rank dialog appears.
Step 3: Enter the desired index number (1-based) and click OK.
Associate Test Executions to the Test Plan
Since the table only shows Test Runs for tests that are in the Test Plan and for Test Executions that are associated with the Test Plan, it's necessary to associate Test Executions with the Test Plan.
You can also add existing Test Execution issues directly to a Test Plan.
Test Executions can also be associated with a Test Plan by editing the field Associated Test Plans in the Test Plans section in Test Execution issue view page. Note that with this method, only the Test Execution will be associated with the Test Plan; the Tests will not be associated. To inline edit the Associated Test Plans field, just hover over the field view area, click it and add or remove the Test Plans you want to associate with the Test Execution.
Test Plan table
The Test Plan Test view section in the issue page provides a table where you can see all the Tests that were added to the Test Plan and their Test Executions (if they are associated to the Test Plan).
- Create a planned Test Execution (see next Section), so its results will be reflected on the current Test Plan
- Add Tests and Test Sets
- Test Plan Progress Bar
- Table Filters (see Filter Section)
- Use a Test Environment to calculate the status for test issues for that environment.
- Opens a dialog with a table that displays information about the Test Runs of a particular Test.
This dialog's table is similar to the Test Run table because it allows for inline execution (1) and for operations like Assign and Delete (2). This table's columns are configurable. Similar to the Tests table in the Test Plans issue view page, it is possible to use a Test Environment to calculate the status for test runs for that environment (3).
Create Test Executions from the Test Plan
There are several ways to create Test Executions directly in the Test Plan issue page.
Create planned Test Execution
The most common and straightforward way to create a Test Execution for all the Tests, or for a subset of those that are currently in some consolidated status, is by using the option available at the top of the Test Plan issue screen.
The Create Test Execution button will open a dropdown with some options that will allow you to select the Tests that will be part of the Test Execution.
Please note
In order to create a related Test Execution from the Test Plan, you (as a user) must have permission to edit the current Test Plan because the results on the Test Execution will affect the consolidated information shown at the Test Plan. A user will only be able to create Test Executions in certain projects. If the user does not have permission to create Test Executions for a selected project, an error message will be displayed.
All tests...
This option lets you create a Test Execution with all the tests that are associated with the Test Plan.
Note: If the revision field is not configured in the create issue screen of the Test Execution for the selected Project, the field will not appear in the dialog. If there are some mandatory fields, the standard create issue screen will be shown.
With status...
This option lets you choose the Tests based on their consolidated status. A Test Execution will be created using those Tests.
Filters
A filter section is present above the Tests table to allow you to filter Tests by Assignee, Status, Test Set, Components, Environment, Board Folder or open text. It is also possible to add other fields to the filter by clicking on the More button and selecting the wanted fields.
Bulk action
You can select some Tests, using the checkbox next to the Test row, and then schedule a Test Execution for them by clicking Create Test Execution.
Clone Test Plan
A Test Plan along with its Test issue associations can be cloned.
To clone a Test Plan issue, select the "Clone" action in the issue page:
After this, an additional dialog will be shown.
And after the issue is created, its page will be opened.
On some occasions the cloned issue page may open before the Xray information is actually cloned and as a result the new Test Plan will appear empty.
When this happens the following information will be shown:
View on Board
The Tests web panel of the Test Plan issue provides a button that allows users to navigate to the corresponding Test Plan board for better test organisation.
Xray History
Any changes made to the Test Plan data are recorded on the Xray History section. These include:
- Linking the Test Plan with other entities (Test and Test Execution)
