Test Cases Module
- 2 Managing 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.
Key Features of the Test Cases Module:
Arrange Test Cases into folders and sub-folders.
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.
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.
Filters
Filter requirements using system or custom fields across all modules. To learn more about filters, refer Filtering Assets document.
Folder Management
Organize your requirements in a hierarchical structure using folders. To learn more about available actions, refer to Basic Folder Operations document.
Bulk Operations
Perform bulk operations at the folder level within or across projects. To learn more, refer to the Bulk Operations document.
Test Case Module List View Columns
By default, the system displays the Entity Key, Summary, and Version columns. You can include additional columns such as Priority, Latest Execution Status, Testing Type, Dates, and counts for linked Requirements, Test Cases, Test Suites, and more from the Arrange Column Icon.
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.
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.
Displaying Entities from Sub-Folders at Parent Folder
You can include or exclude requirements from sub-folders at the parent folder level.
To hide the entities from the sub-folder:
Open the Options drop-down as shown in image.
Deselect Include Entities from Sub-Folder.
Test Case Detail
To access the test case detail page, click the Test Case Entity Key in the grid view or Right-click the Entity Key to open it in a new tab. The requirement details page contains:
A. Individual Section Tabs (Editable)
B. Combined View (Read-Only View)
Notes
Refer to the Manage Attachments to learn more about the attachments tab.
You can customize the detail page view by changing the order of tabs. The system preserves the tab order for each user.
Refer to the User Navigation page for navigation details.
Managing Test Cases
You can create, edit, copy, move, archive, and delete test cases. Admins can grant permissions from Roles in the Customization screen.
To create a new test case, refer to Creating New Test Cases
You can import test cases from Excel and Jira. Learn more about Importing Test Cases from Excel.
Editing or 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 or 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.
To update to the latest version, click the sync button.
A confirmation message will appear, confirming the reset of the execution status.
Notes
The synced version does not display previously linked issues.
After syncing, the execution status of the test case will change to Not Run.
Any new test steps added in the latest version are reflected on the execution screen.
You can use different versions of a test case for testing.
Learn more about Test Case Versioning.
Archiving a Test Case
Archiving removes test cases from all associated folders and moves them to a dedicated “Archived” bucket. To view archived test cases, apply Show Only Archived Test Cases filter in the test case list view.
A. Archiving from the Test Case Detail Page
To archive a test case from the detail page, perform the following steps:
Open the test case details page by selecting the test case.
Click the Archive icon located at the top right corner of the page.
The test case is archived after confirmation.
B. Archiving from the Test Case module list view
To archive a test case from the test case module list view page, perform the following steps:
Open the test cases module.
The test case list view opens with a list of existing test cases within the project or folder.
Click the Cog icon for the test case you want to archive and select Archive. The test case is archived after confirmation.
Archiving a Specific Test Case Version
To Archive a Specific Test Case Version, read the document: Archiving a Specific Test Case Version
Unarchiving a Test Case
To unarchive an archived test case, perform the following steps:
Click on filters
Select Show Only Archived Test Cases.
Click the cog icon next to the archived test case.
Click Unarchive.
Deleting Entire Test Cases
Deleting a test case is a two-step process: Archive the test case and then delete it.
To delete a test case, perform the following steps:
Archive the Test Case
All the versions of the test case must be archived to delete that particular test case.
Delete the Test Case
This will permanently delete the test case, including all its archived versions.
Deleting from the Test Case Detail Page
You can delete a test case from the test case details page.
To delete a test case from the detail page, perform the following steps:
To view archived test cases, select the Show Only Archived Test Cases check box in the filters section.
Search for the archived test case you want to delete.
Click the Cog icon next to the archived test case and select Delete.
Deleting from the Test Case List View
You can also delete a test case from the Test Case List View.
To delete a test case from the Test Case List View, perform the following steps:
To view archived test cases, select the Show Archived Items check box in the filters section.
It displays archived test cases along with other test cases.
Search for the archived test case you want to delete.
Click the Cog icon next to the archived test case and select Delete.
Deleting a Specific Test Case Version
For instructions on deleting a specific test case version, refer to the section Deleting a Specific Test Case Version
Share Test Cases with Other Users
You can share the test case summary and test case link with other members of the team for easy access to the latest version.
To share a test case, perform the following steps:
Open the Test Cases details page.
Click on the Share icon at the top (refer to the image below).
Enter one or more email addresses.
Write a message (optional but recommended) describing the test case or required actions.
Click on the Share button.
Copy Test Case Link
Users can copy the test case link and share it with other users to provide direct access to a specific test case. Authorized members can access the test case directly via the shared link.
URL Syntax
https://<URL>>/#/<AssetType>/<AssetKey>
For example,
Steps to Copy a Test Case
Open the test case details page.
Locate and click on the Copy Link icon on the breadcrumb navigation.
You can share this link through any preferred communication channel.
You can share this link with team members using email, chat, or other communication methods.
Bulk Operations on Test Cases
Read Bulk Operations
Linking Requirements to Test Cases
You can link requirements to the corresponding test cases to ensure traceability, allowing testers to validate that all requirements are covered by test cases and easily track testing progress.
This linkage applies to all versions of the test case, ensuring that any updates to the test case maintain the requirement's relevance.
→ Use Case: Users link requirements with related test cases for testing. Testers get the idea of what is developed by studying requirements, and on that basis, they write test cases to describe how to test the developed application. Thus, linking the test case with the requirement gives relevance between the two what is developed and what to test.
Linking Requirements
Requirements can be linked to a test case through the Requirements tab available on the Test Case Details page.
To Link Requirements to a test case, perform the following steps:
Go to the Requirements tab of the test case details page or the test case edit page.
Click on the Link button.
It opens the Link Requirements screen, displaying a list of all available requirements.
You can filter the requirements, sort the requirements, or manage the view as needed.
You can link a single requirement or multiple requirements to a test case.
For linking a Single Requirement, click the Link () icon on the right.
For linking Multiple Requirements, select the desired requirements and click the Link and Close button (as shown in the above image).
You can also link multiple requirements from different projects to a single test case.
Linking Requirements Across Projects
To link multiple requirements from different projects, perform the following steps:
Select Project from the Project drop-down in the top-left corner.
The associated requirements for the selected project will be displayed.
Tick the checkboxes next to the relevant requirements.
After selecting the requirements from one project, click Link before switching to another project.
Once all requirements are linked, click Link and Close.
Note
If you're linking requirements from multiple projects, ensure you select and link the requirements from one project before switching to another, as any unlinked selections will be cleared when you switch projects.
Selecting Version
To link a specific version of a requirement, expand the requirement and select the specific version.
Filtering Requirements
To find the relevant requirements, you can apply basic as well as advanced filters on the requirement records. Labels and Folder path filters further aid in searching records.
Requirements of Release and Cycle of This Test Case
When viewing test assets of other projects, the Requirements of Release and Cycle of this Test case checkbox remains unavailable. For test cases within the same project, this check box enables the users to view only those test cases that are associated with the same Release and Cycle to which the test case is linked.
Linking Requirements by Entity Key
This feature allows users to link requirements to a test case using comma-separated requirement entity keys.
Notes
A maximum of 500 entities can be linked at once.
The requirement key will be ignored if a relevant requirement with that key is not found.
If a single key is mentioned multiple times, it will be linked only once.
If an older version of the requirement is already linked and you are linking the same requirement key, then the latest version will not replace the older version. It will be skipped.
Archived versions will be skipped from linking. Only the latest unarchived version of entities will be linked.
To link requirements by entity key, perform the following steps:
Go to the Requirements tab of the test case.
Click on the Link By Entity Key button.
It opens the Link Requirements pop-up. Mention comma-separated Requirement keys.
Click Link.
The requirements with the mentioned keys get linked to the test case.
Viewing Linked Requirements
The linked requirements are shown on the lower grid pane.
If the requirements linked are from other projects, the Entity Key of the corresponding project will be displayed. Click on the Requirement Entity Key to view the requirement detail page in the respective project.
Unlinking Requirements from a Test Case
To unlink requirements from a test case, follow these steps:
Go to the Requirements tab on the test case details page.
To unlink a single requirement: Click the Unlink icon next to the requirement to remove. The requirement is unlinked after confirmation.
To unlink multiple requirements, select the requirements from the test case and click the Unlink Selected button.
Syncing the Latest Test Case Version with Requirements
You can sync the latest version of the test case to its linked requirements individually or in bulk. The sync feature in the Requirement tab under the Test Case module allows you to sync the test case version with individual requirements or with multiple requirements.
For example, the current version of the test case is v2. All the requirements are linked to this version of the test case. Now, a new version (v3) is created. Users can sync the v3 of test case with the linked requirements.
(A) Sync the Latest Test Case Version with a Single Requirement
To sync the latest test case version with a single requirement, perform the following steps:
Go to the Test Case module.
Select the Requirement tab.
Sync with a Single Requirement:
When a new version of the test case is created, the sync icon under the Test Case Version column appears blue.
Click on this blue sync icon to update the linked requirement with the latest version of the test case.
This action ensures that the linked requirement is aligned with the most recent version of the test case.
(B) Syncing the Latest Test Case Version with Multiple Requirements in Bulk
If multiple requirements are linked to a test case and a new version of the test case is available, you can bulk sync all linked requirements to the latest test case version.
To sync the latest test case version with multiple requirements in bulk, perform the following steps:
Go to the Requirement tab on the Test Cases Detail Page.
Select the requirements you want to sync the latest test case version.