Jira Server integration
With the mabl integration for Jira Server and Data Center editions, software development teams get the following benefits:
- Capture issue details in Jira directly from mabl test results, including screenshot, DOM snapshot, network activity (HAR) file, and Chrome performance trance from the point of test failure
- Quickly triage a reported issue in Jira thanks to mabl’s comprehensive diagnostics data, including speed index, gathered from every step of the test
- Easily run a failed test in a local development environment using the mabl CLI to reproduce, debug and fix issues faster
- Quickly trace Jira issues to mabl tests and vice versa in both systems
The setup workflow involves the following key steps:
- Create a Jira Server integration in the mabl app
- Install the mabl plugin for Jira Server/Datacenter
- Configure the mabl plugin in your Jira instance, which may also require a firewall configuration
- Verify that everything works by creating a Jira issue from a failed mabl test result
If your Jira instance is behind a firewall, you will need to ensure that it can establish outbound (egress) connections to api.mabl.com over port
443(HTTPS) in order for the integration to work. You can also configure the mabl plugin to use an existing web proxy (see network settings info later on). Thanks to its secure design, no other Internet access is required for the integration to work in a bi-directional way.
Creating an integration in the mabl app
To setup the integration for your mabl workspace, it is best first go to the mabl app > Settings > Integrations and click on Setup for Jira Server.
Follow the on-screen instructions to create the integration in mabl which will generate an Integration ID and API Key that you will need to configure things on the Jira side.
Installing the mabl plugin in Jira
The mabl integration for Jira is available via the Atlassian Marketplace. Jira users will need the following permissions to configure the integration:
Jira Administrator: needed to perform the mabl plugin installation which will also create mabl Jira user (username: com.mabl.jira) that needs to be granted project admin permissions for all projects that the integration will be enabled so that the user can sync issues (e.g. create, update) between mabl and Jira.
Project Administrator: need to enable/disable the mabl integration for a specific project.
The integration creates issues as a Jira user called mabl. Make sure that this user has Create Permission privileges in the configured projects.
You can install the mabl app for your Jira instance with the following steps:
Log into your Jira instance as an admin.
Click the admin dropdown and choose Add-ons.
The Manage add-ons screen loads.
Click Find new apps or Find new add-ons from the left-hand side of the page.
Locate mabl for Jira via search.
Results include app versions compatible with your Jira instance.
Click Install to download and install your app.
The installation is now all set and you are ready to configure the integration.
Configuring the mabl plugin in Jira
As a Jira Administrator, go to the Manage add-ons or Manage apps page in Jira and click on the mabl Settings link in the left sidebar to configure the integration settings. At minimum, you will need to provide an Integration ID and an API key of type Issue Tracker for a given mabl workspace. See the section Creating an integration in the mabl app above for information on how to obtain them.
To configure the plugin to work with multiple mabl workspaces, simply add an additional API Key and Integration ID and click Save. Repeat that process for as many workspaces as needed.
If your company uses a web proxy to connect to the Internet, you can configure the mabl plugin to use your existing proxy configuration to connect to the mabl cloud.
In order for the integration to work, either your Jira instance or the configured proxy need to be able to establish establish outbound (egress) connections to api.mabl.com (IP 18.104.22.168 ) over port 443 (HTTPS) in order for the integration to work. You can also configure the mabl plugin to use an existing web proxy. Thanks to its secure design, no other Internet access is required for the integration to work in a bi-directional way.
The mabl plugin tries to poll the mabl API every few minutes to get updates from mabl about newly crated issues and to send updates back to mabl for the Jira issues such us their status.
Jira project configuration
With the plugin installed and network settings configured, you need to configure which Jira projects will use the integration so that mabl users can select those projects when creating Jira issues in mabl. To do so, please go to the settings for each Jira project and enable the
Use in mabl toggle.
All Jira projects configured to work with mabl will be listed on the mabl plugin settings page. From there, you can quickly go to change the project configuration to disable its mabl integration.
Verifying everything works
To verify that the integration works as expected, create a Jira issue from the mabl app and wait a minute until it is synced with Jira. To create the issue in mabl:
- Go to view the results of a failed test run
- Open the more actions menu in the top right corner of the page
- Click on Create Jira Server Issue and follow the on-screen instructions
The issue is created with a pending status in mabl and it will not appear in Jira until it is synced by the mabl plugin on the Jira side. This should take no longer than a minute. Once the issue is synced, it will appear in Jira and its status in mabl will no longer be pending. You can see the issues associated with a given test by going to the respective test details page in mabl under the Issues tab.
Creating Jira issues from mabl
Users can create an issue in Jira from either the mabl test results page or the test details page. Typical user workflow is to analyze results of a failed mabl test and create an issue in Jira to capture details about an issue with the application or its environment that the development team should review and resolve.
When creating a Jira issue form the test results page, mabl will automatically attach test diagnostics data that contains the following artifacts:
- Network activity HAR file
- DOM snapshot
- Chrome performance trace, if test run was in Chrome
All Jira issues are created with a pending status in mabl. This status indicates that the mabl plugin on the Jira side hasn't yet synced the issue with the Jira instance. The issue becomes available in Jira only after it has been synced by the mabl plugin, which will also update the issue status in mabl so it is no longer pending. The sync happens about once a minute.
All created Jira issues in mabl will be associated with a mabl test and respective test run and plan, where applicable.
Managing Jira issues in mabl
All mabl workspace users can see information about Jira issues created from mabl in two different places:
- Test results page, in the header
- Test details page > issues tab
- Tests page > issues tab
Showing associated Jira issues with a given test run in mabl makes it easy for users reviewing the test logs to see what issues have already been captured in Jira, and create new ones as needed.
Users can track the status of all Jira issues associated with a test from the Issues tab on the test details page in mabl. Issues linked to different runs of that tests will also be shown on that screen. Clicking on the issue ID will take the Jira to the issue details in Jira.
Reviewing issues from mabl in Jira
When a Jira user opens an issue created from mabl, they can easily see within the mabl panel the associated test, plan and latest test results. Those items are deep links into the mabl app, so that the user can click and see more details in mabl.
Software developers that start working on an issue can instantly review the attached diagnostics data from mabl, such as the last screenshot and DOM snapshot of the test run. Moreover, developers can significantly reduce the time it takes to reproduce the issue by using the mabl CLI to run the test in their local development environment to quickly get the application to the problematic state and take advantage of all locally available debugging tools.
Updated 4 months ago