Cloud release date: 16-April-2021
The TestRail 7.1 release contains improvements to the attachments dialogue throughout TestRail, geared towards more flexible and intuitive use of attachments when creating test cases, runs, plans and milestones, and when adding results or pushing defects to your integrated tools.
We know how important it is to be able to supplement the design and results of your testing with screenshots, gifs, documents, and other artifacts. Attaching that information to your test cases and inserting it into fields so it can be viewed alongside instructions or testing results are important capabilities for any tester. And so, it’s with great pride that we announce TestRail 7.1, containing a range of enhancements intended to make life easier for attachment power users – and everybody else!
This will be a phased release, so if you don’t notice the new features in your TestRail Cloud instance just yet, hold tight—TestRail 7.1 will be coming your way soon!
To make life easier for administrators, we also added a new attachment management area in the administration console, and included a filter to help you identify exactly which attachments may be ripe for pruning.
We also fixed a bunch of issues along the way, and made some performance improvements under the hood… Keep reading for the details!
Click here to watch the recording of TestRail 7.1 webinar.
Improved UX when adding/removing attachments to/from entities inside of TestRail
One of the main things you’ll notice in 7.1 is the new attachment dialogue when it comes to uploading attachments to your TestRail entities (cases, runs, plans, milestones, test results, and defect pushes where supported).
The dialogue introduces the idea of a media library. In addition to simply uploading artefacts and attaching them to your test cases in an ad-hoc fashion (‘scuse the testing pun!), your attachments now become part of a library from which they can be re-used in the future.
As such, the dialogue includes a number of other features intended to support the use and re-use of attachments across TestRail entities, including across projects if needed. You can upload attachments to the attachment library by browsing your local filesystem or drag-and-drop.
As you build up a library of attachments, you can sort through them to find the attachments you need by Date, Name or Size. You can also search for a specific attachment(s) by name—and to make that easier, we’ve added the capability to change the names of your attachments by clicking on the attachment and viewing its details:
The Attachment Details view opens a wealth of further information and adjustment opportunities. You can:
- Change the attachment name
- View the file type, size, and upload timestamp
- View and copy the unique URL for the attachment
- Change the projects the attachment is visible in
- Delete the attachment
- Replace the attachment with a new one and keep the same name and URL
- View the attachment at full resolution
We think you’ll agree: that’s all pretty swish.
In addition, you also have the ability to refer to an attachment throughout TestRail, and update the referenced attachment in all places using the Replace function.
But that’s not all…
New attachment management console for administrators
In TestRail 7.1, we continue to improve the administrators’ lot by introducing a new attachment management console in the Admin area. If you have a hosted TestRail Cloud instance, you’ll see that as of 7.1 we’ve split out the data functions onto different tabs within the Data Management menu:
On the new Attachments tab, administrators will also be able to carry out all of the actions available in the improved attachments dialogue, with the benefit of being able to see all attachments across all projects.
This means that administrators can also take advantage of the search and filtering mechanisms to prune attachments from their instances if they’re no longer needed, helping to reduce the storage footprint of the instance.
Improved attachment performance and management
While adding these features, we’ve made some significant changes under the hood of TestRail, implementing a whole new database structure for the management of attachments to improve performance and help make sure that attachments can be searched and filtered for effectively.
For our hosted TestRail Cloud customers, no actions are required to take advantage of this benefit. It’s all done in the background for you.
For server customers, some additional installation requirements need to be followed to enable the configuration of a Cassandra database.
We’ve made a few adjustments to the attachment API endpoints as well.
By popular request, we’ve added run_id, plan_id and plan_entry_id’s to the associated get_attachments_for_run, get_attachments_for_plan and get_attachments_for_plan_entry endpoints.
We’ve improved the behavior of the various add and get attachment endpoints so that they align better with what we’ve come to understand is the (still somewhat complex) expected behavior:
- get_attachments_for_run returns plan entry attachments if no run-specific attachments have been added.
- get_attachments_for_run returns run attachments if plan entry runs specific attachments have been added.
- attachments added to runs in plans via the add_attachment_to_run endpoint are visible when viewing the runs in the UI.
- ID’s of attachments added to a run in a plan via add_attachment_to_run endpoint is returned when calling get_attachments_for run endpoint.
- get_attachments_for_plan_entry only returns attachment IDs for the requested plan entry.
Other things to mention here are that the ID of the attachments returned via get_attachment endpoints has changed from a simple integer to a reference:
You’ll also see some additional attachment metadata fields in the attachment response bodies. Please do check the attachments API page for further details.
Whilst carrying out these improvements, we fixed or tweaked behavior in a number of other places too:
- By default, attachments will no longer be deleted when the entity to which an attachment is associated is removed (e.g. a test case, or run), so as to prevent problems where attachments are utilized in other entities in TestRail. Attachments must now be deleted explicitly from within the attachment library dialogue.
- This rule applies to the removal of attachments from fields and sidebars also. The attachment will remain in the attachment library unless it is explicitly deleted.
- We were aware of similar issues whereby attachments could be orphaned in the event they were uploaded to a dialogue (e.g. a test result) and the dialogue was subsequently abandoned. The use of an attachments library means all attachments are uploaded to the library and must be explicitly deleted from it.
- We have added a filter to the Attachment management console in the administration area which will allow administrators to easily identify and remove attachments that are no longer linked to a valid entity (e.g. attachments that used to be linked to a test case or run which have now been deleted). Administrators should use the “Orphaned” filter for this purpose.
- We expect that problems in other areas (such as attachments added to plan entries) will be resolved by the library mechanism also.