- \n
- Using\u00a0defect URLs to link test results to Lighthouse<\/li>\n
- Using\u00a0reference URLs to link test cases to Lighthouse<\/li>\n
- Using the\u00a0defect plugin for Lighthouse to push and look up Lighthouse issues in the Defects field of test results<\/li>\n
- Using the reference plugin for Lighthouse to look up\u00a0Lighthouse issues in the References field of TestRail entities such as test cases, test runs, and milestones<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n
You don\u2019t 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.<\/p>\n
\n\nDefect URLs<\/h2>\n
\n\nThe 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.<\/p>\n
The\u00a0Defect View URL\u00a0<\/strong>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.<\/p>\n
The\u00a0Defect Add URL\u00a0<\/strong>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 \u2018Defects\u2019 menu in TestRail\u2019s\u00a0Push Defect From Anywhere\u00a0<\/a>feature. This link allows you to jump to Lighthouse\u2019s New Issue form to report a new bug.<\/p>\n
If you see the\u00a0\u2018Add\u2019\u00a0<\/strong>link, you can copy the ID of your new Lighthouse issue and enter it into any Defects or References field inside TestRail.<\/p>\n
To configure Lighthouse\u2019s URLs in TestRail, select\u00a0Administration > Integration<\/strong>. You can alternatively enter separate bug tracker URLs for each project under\u00a0Administration > Projects<\/strong>. Use the following example URLs to configure the addresses:<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
Lighthouse Hosted\nDefect View Url: http:\/\/name.lighthouseapp.com\/projects\/<projectid>\/tickets\/%id%\nDefect Add Url: http:\/\/name.lighthouseapp.com\/projects\/<projectid>\/tickets\/new<\/pre>\n
\n\nPlease 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.<\/p>\n
If you have the defect plugin configured, you\u2019ll also be able to hover over the defect ID to view the issue details directly from within TestRail.<\/p>\n
Reference URLs<\/h2>\n
\nThe reference URLs are implemented in a very similar manner to Defect URLs described above. The primary difference is Reference URLs are used for the \u2018References\u2019 field on various TestRail entities (instead of the Defects field).<\/p>\n
The Reference\u00a0View URL<\/strong>\u00a0is 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.<\/p>\n
The Reference\u00a0\u00a0Add URL\u00a0<\/strong>is also configured in the same way as the Defect Add URL. Once configured, an\u00a0\u2018Add\u2019<\/strong>\u00a0link will appear next to each References field in your instance or project. If you use the\u00a0\u2018Add\u2019<\/strong>\u00a0link, you can copy the ID of your new Lighthouse issue and enter it into any Defects or References field inside TestRail.<\/p>\n
If you have the Reference plugin configured, you\u2019ll 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.<\/p>\n
\n\nDefect Plugin<\/h2>\n
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\u00a0Administration > Integration<\/strong>\u00a0and select\u00a0Lighthouse<\/em>\u00a0in the\u00a0Defect Plugin<\/strong>\u00a0dropdown list. The next step is to configure all the necessary connection settings in the\u00a0Configuration\u00a0<\/strong>field. Project-specific plugins and configuration settings can optionally be specified under\u00a0Administration > Projects<\/strong>.<\/p>\n<\/div>\n<\/div>\n
\n\nWhen the defect plugin has been configured, a new\u00a0Push<\/em>\u00a0link 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.<\/p>\n<\/div>\n<\/div>\n
![\"\"](\"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-content\/uploads\/lighthouse_push_defect-1024x590.png\")
<\/a><\/span><\/div>\n\n\nOnce 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.<\/p>\n
\n\nCustomizations<\/h2>\n
\nThe 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 \u2018on\u2019 or \u2018off\u2019 in their respective [push.fields] and [hover.fields] sections, or change the order in which they appear by the fields in each section.<\/p>\n
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.<\/p>\n
The Lighthouse Defect Plugin also supports modifying field properties.<\/p>\n
In addition to enabling, disabling, or re-organizing fields as described above, it\u2019s 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.<\/p>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
[push.field.description]\nlabel=Detailed Description\nrequired=true<\/pre>\n
\n\n\n\n\n\n\nPlease see below for full list and explanation of the available field options:<\/p>\n
\n\n\n
\n \nOption<\/th>\n Description<\/th>\n<\/tr>\n<\/thead>\n \n label<\/td>\n Specifies the display name of the field in the Push Defect dialogue<\/td>\n<\/tr>\n \n size<\/td>\n Specifies whether the field is displayed as a compact field\u00a0(compact)<\/em>\u00a0or uses the full width of the dialogue\u00a0(full)<\/em><\/td>\n<\/tr>\n \n remember<\/td>\n Specifies if previously selected values for this field should be remembered and restored the next time the Push Defect dialogue is opened<\/td>\n<\/tr>\n \n required<\/td>\n 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<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n Attachments<\/h2>\n
\nThe 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.<\/p>\n
Reference Plugin<\/h2>\n
\nReference 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.<\/p>\n
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.<\/p>\n
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.<\/p>\n
Additional Customizations<\/h2>\n
TestRail also supports custom defect plugins. If your team uses TestRail Server, it is possible to further customize the defect plugin (or build your own) to support additional field types or other data. Please see our Defect plugins documentation<\/a>\u00a0for additional information.<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"This topic explains how to integrate TestRail with Lighthouse. There are currently two ways to integrate TestR […]<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":6734,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_et_pb_use_builder":"","_et_pb_old_content":"","_et_gb_content_width":"","footnotes":""},"class_list":["post-19020","page","type-page","status-publish","hentry"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/19020","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/comments?post=19020"}],"version-history":[{"count":13,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/19020\/revisions"}],"predecessor-version":[{"id":24017,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/19020\/revisions\/24017"}],"up":[{"embeddable":true,"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/pages\/6734"}],"wp:attachment":[{"href":"https:\/\/docs.testrail.techmatrix.jp\/testrail\/docs\/9\/wp-json\/wp\/v2\/media?parent=19020"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}