Test Cases Module
- 1.1 Introduction
- 1.2 Test Case Module UI
- 1.3 Managing Test Case Folders
- 1.4 Test Case Detail Page UI
- 1.4.1 Navigation
- 1.4.2 Organize Tabs
- 1.4.3 Tabbed View vs. Combined View
- 2 Managing Test Cases
- 2.1 Create New Test Case
- 2.2 Importing Test Cases
- 2.3 Editing/Updating a Test Case
- 2.4 Dependent Test Cases
- 2.5 Archiving a Test Case
- 2.6 Archiving a Specific Test Case Version
- 2.7 Unarchiving a Test Case
- 2.8 Deleting Entire Test Cases
- 2.9 Share Test Cases with Other Users
- 2.10 Bulk Operations on Test Cases
- 3 Linking Requirements to Test Cases
- 4 Linking Test Suites to Test Cases
- 5 Linking Test Suites and Requirements in Bulk
- 6 Linking Issues to Test Cases
- 7 Associate Release & Cycles
- 8 Test Case Versions
- 9 Change Log
- 10 Import Test Cases
- 11 Export Test Cases
- 12 Export Test Case Detail in PDF
- 13 Best Practice Recommendations
Introduction
The Test Cases Module is the central repository of test cases. This module enables you to create, organize, reuse, and manage test cases.
In QMetry, you can use a single test case repeatedly. You can link a test case to multiple requirements and test suites as well as associate it with multiple releases and cycles. The execution status of test cases is independent per cycle which means you can repeatedly execute the same test case for different cycles without affecting the test results between separate runs.
Permissions
Key Features of the Test Cases Module:
Arrange Test Cases into folders and subfolders
Add and Edit Test Cases.
Import Test Cases from Excel and Jira.
Execute Test Cases for ad-hoc testing.
View the Status of individual Test Cases.
Link relevant Requirements and Issues to Test Cases.
Set Predecessor and Successor relationships between Test Cases.
Test Case Module UI
The test case module grid view offers various customization options.
Sorting and Clear Sorting
You can sort the folder structure alphabetically or by date (newest first or oldest first).
Sorting
Clear Sorting
Filters
You can filter test assets by any system or custom fields across all module grids. Basic filters like Summary, Release, and Cycle are available by default. For advanced filtering, click the "+" icon to add custom filter fields.
Basic Filters
Advanced Filters
A. Basic: By default, test cases can be filtered by summary, release, and cycle. Enter specific values in these fields to retrieve test cases that match the specified criteria.
B. Advanced: You can also apply advanced filters to refine the test cases based on fields beyond the basic options.
To apply advanced filters, these are the steps:
Click the + icon (Refer to the image below).
Select the desired fields for filtering.
Enter the filter values.
Click Save and Apply.
For example, you want to filter test assets by Priority and Entity Key.
Click the + icon and select the fields on the drop-down list. You can apply an advanced filter on Entity Key to search for test cases using comma-separated entity IDs, without specifying the complete Entity Key.
Note
Filtered views are automatically saved for future use, eliminating the need to reapply the same filters repeatedly.
Reset Filters and Clear Filter Value
The Clear Filter Values clears out the values in the filters without removing the fields themselves.
The Reset Filters option will reset the filter to default. All the selected fields for Advanced Filter will be removed from the filter.
Reset Filters
Clear Filter Values
Manage Grid Columns
The Arrange Columns option in the Test Case Module grid enables you to customize the asset view. Refer to the Manage Grid Columns page to know more.
Test Case Module List View Columns
You can customize the columns in the list view to meet your specific needs. By default, the Entity Key, Summary, and Version columns are displayed. You also have the option to include additional columns such as Priority, Latest Execution Status, Testing Type, Dates, and counts for linked Requirements, Test Cases, Test Suites, and more.
Latest Execution Status
You can view the Latest Execution Status column in the Test Case List View. This column indicates the current execution status based on settings configured under Customization on the Execution Status tab.
Refer Execution Status Management to know more.
When you select the Latest Execution Status field, the grid view shows the most recent execution status of the test case.
Click on the status to view further details of the test execution.
Notes
The Latest Execution Status can be calculated once every 24 hours per project.
After generating the status, the Generate button will be disabled for the next 24 hours.
Testing Type
The Testing Type field indicates how the test case was generated in QMetry: Manual or Automated.
Test cases created through the UI or imported from Excel are classified as Manual, while those created via Automation APIs are marked as Automated. This field is read-only and cannot be edited.
Managing Test Case Folders
You can organize and manage test cases in a folder-based hierarchy. You can further group related test cases and organize them systematically during authoring or post-authoring.
It helps to carry out bulk operations like move, copy, editing, deleting, and executing all test cases under one folder.
The count of test assets in the folder hierarchy is displayed alongside the folder name. The count includes active + archived test cases + shareable test cases.
For example, this is the folder hierarchy: Folder A → Folder B → Folder C
Folder A has 5 test cases, Folder B has 3 test cases, and Folder C has 2 test cases; then the count will be displayed as follows.
Folder A (10) <------ Parent Folder
Folder B (5) <------Child Folder
Folder C (2) <------Subfolder of Child Folder
Include or Exclude Test Cases from Sub-Folders at the Parent Folder
You can include or exclude test assets from subfolders at the parent folder level. By default, Include Entities from Sub-folder remains selected, and entities from sub-folders are displayed at the parent folder level on the module list view.
To hide the entities from a sub-folder, open the Options drop-down and deselect Include Entities from Sub-Folder.
Learn about the available actions for folders in Basic Folder Operations.
Refer to Bulk Copy/Move at the directory level within/across the project to know more about Bulk operations.
Test Case Detail Page UI
Click the Test Case Entity Key in the grid view to open the test case detail page UI. Right-click the Entity Key to open it in a new tab.
Navigation
You can navigate through the requirements in two ways - using the previous and next buttons or breadcrumb navigation.
Refer to the User Navigation to learn more.
Organize Tabs
The detail page of QMetry assets has different tabs on it. Users can customize the view of the detail page by changing the order of tabs. The tab order is preserved per user.
For example, the tab order of the Test Cases module is changed by user "A" for project "PRO1". Now "A" is switching to another project "PRO2". The tabs can be seen in the same order as in project "PRO1".
Tabbed View vs. Combined View
The test case detail page displays:
A. Individual Section Tabs (Editable)
B. Combined View (Read-Only View)
A. Individual Section Tabs
There are individual tabs for - Steps, Details, Dependent Test Cases, Requirements, Release & Cycles, Test Executions, Issues, Version, Attachments, Comments, Change Log, and Children. Each tab displays relevant details. You can edit/modify a test case from this screen.
B. Combined View (Read Only View)
The tab displays the consolidated information about the entire test case.
Managing Test Cases
With the necessary permissions, you can create, edit, copy, move, archive, and delete test cases. Admins can grant permissions from Roles in the Customization screen.
Let’s have a detailed look at these features.
Create New Test Case
You can manually create test cases within a project, incorporating details such as test steps, preconditions, and other required information.
To add a test case, perform the following steps:
Click the New button.
In the Add Test Case screen, enter system fields, test steps, and other necessary details.
Click the Create button to save the test case.
System Fields, Test Steps, User Defined Fields, and Risk Analysis
When creating a test case, you need to enter specific details related to the test case. Let’s review the fields to understand what information to include.
System Fields
In the System Fields section, enter the following details:
Field Name | Description |
|---|---|
Summary | Provide a brief overview of the test case, outlining its purpose. |
Priority | Assign a priority level to the test case: Minor, Major, Blocker, Critical, or Trivial. |
Labels | Choose one or more labels to classify the test case. |
Status | Select appropriate status: New, Approved, In Progress, and Ready to Review. |
Owner | Assign an owner from users with access to the current project. |
Test Case Category | Categorize the test case as Regression, Performance, Security, Functional etc. |
Estimated Time | Specify the estimated execution time for the test case in minutes. |
Description | Add a description in plain text or rich text. |
Folder Path | Select a specific folder for storing the assets during creation. (Default is root folder) |
All About Rich Text Editor
Notes
To use rich text, enable the Enable Rich Text parameter for the Project from Project Management under the Projects tab.
Refer to Enable Rich Text Editor for more details.
Rich Text: Use the Rich Text Editor to format text, insert images, hyperlinks, and tables, ensuring all critical details are included.
Adding Images: You can add multiple images simultaneously. Images can be added by:
Entering an Image URL.
Browsing the Desktop to upload an image.
Copying and pasting the image directly into the description box. You can copy and paste multiple images
Notes
The supported file formats of the image are JPG, JPEG, PNG, and GIF.
The maximum file size should be 1 MB for images uploaded through browsing.
You can view added images by clicking on them within the description box. Users can paste the HTML/XML content into the Source editor of the Large Text field type and it auto-renders the code to show the text outputs on the screen.
You can also download the added image by clicking on the image and then selecting the Download icon in the top right corner.
User-Defined Fields
If custom fields are added to the test case module from Customizations under the Manage Field tab for this project, they will appear in this section.
Adding Test Steps
You can add, view, edit, and delete test steps within a test case.
Permissions
Permissions are managed through Customization under the Roles tab, where user roles are assigned specific rights for Test Case operations.
You can perform these actions based on the permissions granted to their roles.
To add new test steps, perform the following steps:
Go to the Steps section on the Create Test Case screen.
Click the expand icon to view test steps in full-screen mode.
Hover over the right end of the row to display the edit pencil and cog icon.
To add a test step, select one of the following methods:
Hover over the Step Description cell and click the Edit icon (pencil). Alternatively, use the TAB key to navigate.
Click the cog icon for the current test step and select Insert Row to add a new step next to it.
A blank row is added with an auto-generated step number.
Enter the Step Description, Input Data, Expected Outcome, and other UDF details in the respective fields.
Repeat the process to add additional steps as needed.
Note
Test steps support both Plain Text and Rich Text.
To insert a Shareable Test Case, perform the following steps:
Click on the cog ( ) icon for the current test step and select Insert Shareable Test Case.
Select the shareable test cases from the Link Shareable Test Case Screen and click on the link.
To Copy Steps from an Existing Test Case, perform the following steps:
Click on the cog ( ) icon for the current step and select Copy Steps from an Existing Test Case.
Click on the relevant test case and select the steps to be copied.
Click Copy or Copy & Close.
Alternatively, you can also insert shareable test case or copy steps from an existing test case by clicking on the “+” icon.
User-Defined Test Step Fields
If you have added UDFs to the test steps, then they are displayed on the Test Steps section as columns beside the default fields of test steps.
You can set UDFs from Customizations under the Manage Field tab.
Show or Hide and Re-arrange Test Step Columns
You can organize the test steps columns in the panel through drag and drop operation. You can also opt to hide/show Input Data, Expected Outcome and other UDF columns on the screen.
Click Save once you make any changes to the Test Steps panel.
Any changes in the test steps column arrangement will reflect in other places where the test steps panel is used. For example, column arrangement changes on the Execution screen will reflect in the following places.
Test Case Create Screen
Test Case Detail Screen
Create a New Version Screen
Exploratory Testing Screen
Editing Entered Test Steps
While creating test cases, you can go back to a previous test step and make necessary modifications.
To edit the entered steps, perform the following actions:
There are two ways in which you can edit a test step:
Click on the Edit icon at the right.
Hover over the test description, input data, or expected outcome, and the edit icon will appear. It allows you to do inline editing in the field.
Make necessary changes and press tab or click anywhere on the screen.
Risk Analysis
Note
To enter risk analysis details, the super admin must first enable the risk analysis field for the project from Project Management under the General Settings tab.
When creating a test case, you can enter risk analysis details, including Risk Type, Risk Category, Likelihood, and Impact. Based on these values, the system automatically calculates the risk priority number and the extent of testing required. These values help in setting the priority of the test cases in the right order.
After entering all the required details, click the Create button. The test case will be saved, and you will be redirected to the Test Case module list view page. The newly created test case will automatically be assigned a unique Test Entity Key.
Test cases are added at the Project level. The Test Case module's main screen shows test cases according to the selected folder.
Importing Test Cases
You can import test cases from Excel and Jira. Learn more about Importing Test Cases from Excel.
Editing/Updating a Test Case
Click on the Test Case Entity Key for the test case you want to modify.
To edit test case steps, navigate to the steps tab and locate the Edit button in the top-left corner. Clicking this button provides two editing options: in-line editing and test step editing.
Inline Editing
You can edit the test case steps, step description, input data, expected outcome, and other user-defined fields directly by hovering over and clicking on specific cells.
Note
In-place edits will update the existing test case without creating a new version.
To edit the steps with in-line editing, perform the following steps:
Navigate to the cell you want to update.
Hover over the desired cell to display it in editable mode.
Click on the cell and make the necessary modifications directly in the field.
Steps for Test Case Editing
You can also edit the test case steps by clicking on the Edit icon for a particular test step.
Clicking on this edit icon will open the step section displaying the step description, input data, expected outcome, and custom fields. You can switch between the fields.
In the expanded view, the Large Text UDFs have separate tabs while all the other UDFs are combined in a single tab named Other.
Other tab: UDFs other than Large Text appear in a combined view, where you can edit the fields inline.
You can perform the following actions on this screen:
To go back to the Step Description section, click on the Move to Step button.
You can use the Previous Step and Next Step buttons to navigate to the previous/next steps.
Use the New Step button to add a new step next to the current step.
Once you are done with editing the test step, click Apply to save the changes.
Actions on Test Step Rows
Insert Row
Insert Shareable Test Case
Copy Test Steps from an Existing Test Case
You can also perform these actions on a specific test step by clicking the cog icon at the right end of the row.
Actions on Test Step Cog Icon
You can perform the following actions on the Steps grid:
Action | Description |
|---|---|
Insert Row | Add a new step at the end or next to the current step. |
Insert Shareable Test Case | Add a shareable test case. |
Remove Row | Delete the selected step. |
Duplicate Row | Copy the selected step. |
Move | Change the position of the step by selecting a new index. |
Copying Steps from an Existing Test Case | Copy repetitive steps from an existing test case for reuse. |
Copying Steps from an Existing Test Case
The Copy Steps from an Existing Test Case option displays a list of all test cases within the current project. To copy steps from a different project, select a desired project from the top-left section of the screen.
When copying test steps from another project, all system-defined column values will be copied, while only the user-defined field (UDF) values that are common between the two projects will be included. Any user-defined fields that are not shared between the projects will be excluded from the copy.
You can refine the test case list using the filter option, allowing you to filter based on the summary, release, cycle, test case status, or test case folder.
To view the steps within a test case, click the + icon next to the test case key. Select the required steps and click on Copy or Copy and Close.
Notes
Shareable Test Cases added as Steps cannot be copied.
Steps from shareable test cases can be copied from the filtered list when Show Only Shareable Test Case is selected.
A copy icon will highlight the copied steps, and hovering over the icon will display details of the source test case.
An info icon appears for copied steps. Hovering over the icon displays attachment-related details in a tooltip. Attachments are copied along with the steps, but they will only become visible and editable after saving the copied steps.
Changing the Order of Test Case Steps
While executing the test suite, the test case steps appear in the same sequence as arranged in the test case.
To reorder test case steps, perform the following steps:
On the Steps tab, click the cog icon to the right of the step.
Select Move and choose the new index for the step.
Adding Attachments to Test Steps
You can add attachments to test case steps either by clicking the attachment button for a test step or by embedding attached images/files in rich text fields.
Read Managing Attachments to know more
Deleting or Removing Test Case Steps
You can delete unwanted test case steps by clicking the remove icon.
Deleting or Removing Test Steps in Bulk
To delete test steps in bulk, perform the following steps:
Select the test steps that you want to delete. The Delete button gets enabled on the selection of test step(s).
Click on the Delete button.
Click Update.
Editing or Updating Test Case Details
You can edit the values of both system-defined and user-defined fields from the Details tab.
To update the test case in bulk, perform the following steps:
Navigate to the test case details screen.
Access the Details tab.
Hover over the values you wish to edit.
Enter the new values and click the checkmark to save your changes.
Note
Changing the folder path moves the asset to a different folder.
Dependent Test Cases
You can establish test case dependencies from the Dependent Test Cases tab in the test case details screen to manage the execution order. This ensures a logical and organized testing process, as one test case's execution depends on the successful completion of another.
For more information, refer to Test Case Dependencies.
Creating a New Version of the Test Case
Permissions
Ensure your role includes versioning rights.
The admin can configure versioning rights from the Customization screen under the Roles tab.
If test case steps are added or edited in an already executed test case, save it as a new version to retain the original details. Updating overwrites the previous details, while creating a new version preserves the original values and creates a new version of the test case with updated details.
The Save as New Version button is visible on the screen only if you have versioning rights.
To save changes as a new version:
Create a New Version: Use the Save as New Version button to create a new version of the test case with the updated details.
Option A: Click on the Cog icon for the test case and select Create New Version.
Option B: Open the Test Case Detail Page and click on the Create New Version icon on the header.
Save as New Version: Make the required changes and click Save as New Version to create an updated version of the test case.
Option A: From Cog Icon
Option B: From the Test Case details Page
If you add/edit test steps within a test case, it will ask you to create a new version of the test case to save the content of steps along with test case parameters. The associated test suite will still be associated with the previous version of the test case.
Handling Test Case Execution Status
When saving a new version of a test case that has been previously executed, you have two options:
Auto Sync Latest Version
If selected, the test case version will be updated, and its execution status will reset to Not Run on the Test Run screen.
Example: If TC1 previously had a “Passed” status in TS1, and the user updates TC1 and creates a new version, then TS1 will display TC1’s status as Not Run.
Manual Sync
If auto sync is not selected, a sync icon will appear beside the current version of the test case on the Test Run screen.