This topic explains how to integrate TestRail with Lighthouse. There are currently two ways to integrate TestRail with Lighthouse, namely:
-
- Using defect URLs to link test results to Lighthouse
- Using reference URLs to link test cases to Lighthouse
- Using the defect plugin for Lighthouse to push and look up Lighthouse issues in the Defects field of test results
- Using the reference plugin for Lighthouse to look up Lighthouse issues in the References field of TestRail entities such as test cases, test runs, and milestones
You don’t have to use all listed integration options and you can mix and match the integration with other tools. Configuring the integration usually only takes a few minutes and this guide explains how to configure the integration and how it works.
Defect URLs
The defect URLs are used to let TestRail know how to convert a Defect ID into a URL for your Lighthouse instance. There are two types of URLs: View URLs and Add URLs.
The Defect View URL is used to build a link to Lighthouse based on the Defect ID, so you can simply click on an ID to open the issue directly in Lighthouse.
The Defect Add URL is used to create a link to the issue creation screen inside Lighthouse. Once the URL is configured, a new Add link appears next to the Defects field in the Add Test Result dialog and the ‘Defects’ menu in TestRail’s Push Defect From Anywhere feature. This link allows you to jump to Lighthouse’s New Issue form to report a new bug.
If you see the ‘Add’ link, you can copy the ID of your new Lighthouse issue and enter it into any Defects or References field inside TestRail.
To configure Lighthouse’s URLs in TestRail, select Administration > Integration. You can alternatively enter separate bug tracker URLs for each project under Administration > Projects. Use the following example URLs to configure the addresses:
Lighthouse Hosted Defect View Url: http://name.lighthouseapp.com/projects/<projectid>/tickets/%id% Defect Add Url: http://name.lighthouseapp.com/projects/<projectid>/tickets/new
Please make sure to replace <name> and <project ID> with the actual name of the site and Project ID in Lighthouse you want to integrate with.
If you have the defect plugin configured, you’ll also be able to hover over the defect ID to view the issue details directly from within TestRail.
Reference URLs
The reference URLs are implemented in a very similar manner to Defect URLs described above. The primary difference is Reference URLs are used for the ‘References’ field on various TestRail entities (instead of the Defects field).
The Reference View URL is configured in the same manner as described above and allows TestRail to create a direct link to a Lighthouse based on an ID entered into a References field.
The Reference Add URL is also configured in the same way as the Defect Add URL. Once configured, an ‘Add’ link will appear next to each References field in your instance or project. If you use the ‘Add’ link, you can copy the ID of your new Lighthouse issue and enter it into any Defects or References field inside TestRail.
If you have the Reference plugin configured, you’ll also be able to hover over a Reference ID to view the issue details directly from within TestRail. Keep reading to learn how to use and configure the Defect and Reference Plugins.
Defect Plugin
Defect plugins can be used to implement a deeper bug tracker integration and TestRail comes with a ready-to-use Lighthouse defect plugin. To configure the defect plugin, select Administration > Integration and select Lighthouse in the Defect Plugin dropdown list. The next step is to configure all the necessary connection settings in the Configuration field. Project-specific plugins and configuration settings can optionally be specified under Administration > Projects.
When the defect plugin has been configured, a new Push link is shown next to the Defects field in the Add Test Result dialog. Clicking the link will open a popup dialog that enables you to push a bug report to Lighthouse without leaving TestRail.
Once the test result is added, hovering the mouse cursor over an issue ID will open a window with useful information and status details about the issue in Lighthouse.
Customizations
The Lighthouse defect plugin was built to work with a standard Lighthouse configuration. TestRail allows you to customize the fields which appear in the Push dialog as well as when hovering over Defect IDs. Preconfigured push fields and hover fields can be set to ‘on’ or ‘off’ in their respective [push.fields] and [hover.fields] sections, or change the order in which they appear by the fields in each section.
Please keep in mind some fields (such as the title field) are always enabled and may not appear in these sections due to always beings required by either TestRail or Lighthouse.
The Lighthouse Defect Plugin also supports modifying field properties.
In addition to enabling, disabling, or re-organizing fields as described above, it’s also possible to change additional options per field. To do this, you would define a section for the field, such as [push.field.description] and specify additional options within this section.
[push.field.description] label=Detailed Description required=true
Please see below for full list and explanation of the available field options:
| Option | Description |
|---|---|
| label | Specifies the display name of the field in the Push Defect dialogue |
| size | Specifies whether the field is displayed as a compact field (compact) or uses the full width of the dialogue (full) |
| remember | Specifies if previously selected values for this field should be remembered and restored the next time the Push Defect dialogue is opened |
| required | Specifies if this field is mandatory or optional and whether users are required to enter a value for this field in the Push Defect dialogue |
Attachments
The Lighthouse Defect Plugin supports submitting attachments to Lighthouse as well. This field can be turned on and off, but cannot be customized. To submit one or more attachments to Lighthouse, simply drag the attachment to the attachments or description areas of the push dialog or click on the area to choose an attachment from your file system.
Reference Plugin
Reference plugins can be used to retrieve additional information from IDs entered into the References field of TestRail entities, such as test cases, test runs, and milestones. The Reference Plugin is configured on the References tab of the integration settings in the same manner the Defect Plugin is configured.
The plugin supports hovering over Reference IDs but does not support a Push dialog for the References field. It is also possible to customize the fields which appear via link hovering, as described above.
If you have the Defect Plugin already configured for Lighthouse, you can simply copy your [connection] and [hover.fields] sections from the Defect Plugin into the Reference plugin configuration. Alternatively, you can choose different fields to be displayed for References and Defects.