Report bugs using Jira integration

Test Reporting & Analytics allows you to easily report and track bugs or issues in your test suite directly on Jira without navigating away from Test Reporting & Analytics.

Integrate Test Reporting & Analytics with Jira

Depending on your Jira instance type, choose the appropriate procedure:

• Jira on cloud
• Jira self-hosted

Prerequisite

Ensure that you have an Atlassian user account.

Jira on cloud

To integrate Jira with Test Reporting & Analytics on cloud:

1. Sign in to Test Reporting & Analytics.
2. Select Integrations from the left pane.
   

3. On the Integrations page, click Connect under the Jira logo.
   

   

4. Select Jira On Cloud from the Instance Type menu.
5. You can connect Jira with OAuth or using PAT.
   • a. Connect with OAuth
     • Redirects you to the Atlassian access page.
     • Click Accept to allow BrowserStack Jira Integration access to your Atlassian account. On successful completion, Jira status under the Test Reporting & Analytics section, changes to Connected.
   • b. Connect using PAT (Personal Access Token)
     • Enter your Atlassian host name and email ID.
     • To get your API access token, click Get your API token. It redirects you to the Jira website.
     • In Jira, under API Tokens, click Create API token.
     • Enter a label for your token and click Create.
     • Copy the generated API token right away. Note, it will not be visible again.
     • Return to Test Reporting & Analytics, enter the hostname, email, and the copied token.
     • Click Continue to connect with Test Reporting & Analytics. On successful completion, Jira status changes to Connected.

Jira self-hosted

It explains the following:

• Prerequisites
• Integrate Jira self-hosted

Prerequisites

BrowserStack Local Library

To integrate BrowserStack with your self-hosted Jira instance, you need to set up the BrowserStack Local Binary. Follow these steps to ensure proper configuration.

This gives you the setup needed to connect your local environment to BrowserStack before you start the integration.

Integrate Jira self-hosted

To integrate Jira self-hosted with your Test Reporting & Analytics:

1. On the left navigation bar of Test Reporting & Analytics, click Integrations.
2. On the Integrations page, click Connect under the Jira logo.
3. Select Self Hosted from the menu.
4. Click Continue with Jira.
5. Enter your Atlassian host URL and API token to complete the integration. To get your API access token, click Get your API token.
6. Click Continue. On successful completion, Jira status changes to Connected.

After successful authentication, the Jira tile should indicate a connected status. Your Jira self-hosted instance is now integrated with the Test Reporting & Analytics, allowing you to create and track issues directly from the tool.

Report an issue on Jira

1. On Test Reporting & Analytics, go to Builds and select the required failed test.

2. On the Timeline Debugging pane, click Report a bug.
   

   

3. Select a project from the Project drop-down menu in the window that appears. Test Reporting & Analytics automatically picks up all the fields in your Jira project.
   

   

4. On the Create Issue tab, select the issue type.
   
5. Enter the details about the bug. Click Show all fields to view all the fields.
   
6. Expand Additional meta data added with description to view all the test related metadata that Test Reporting & Analytics auto-populates. For more information, see the Metadata to aid in debugging section.
7. Click Create.
   

You will receive a success message that the Jira issue was created.

You can click View issue on the success message to view the bug on Jira.

The Jira bug gets associated with the test run.

Metadata to aid in debugging

When you report a Jira bug, Test Reporting & Analytics logs the following metadata and other information to the Jira bug and makes debugging easier:

• Session URL to view the issue on BrowserStack
• Build Name
• Build ID
• CI Environment
• CI Build URL
• Test Name
• Test URL
• Test Status
• Operating System
• Browser name and version
• Host Name
• Defect Type
• Duration
• isAutoAnalyzed flag
• Status of Build Runs
• Error message or exception
• Environment

As Test Reporting & Analytics automatically logs this information onto the Jira bug, you can reduce manual work, debug faster, and improve the data quality of your Jira bugs.

Update an issue on Jira

You can update an issue that is linked to a test run. You can also link an existing issue from the Jira board to a specific test run.

Ensure that you have integrated Jira with Test Reporting & Analytics as described in Jira on cloud or Jira self-hosted.

1. You can open the window to update a Jira bug in two ways:
   • From the Tests tab of Build Insights, hover the cursor over the timeline graph of a failed test and click Report a bug.
   • From the Timeline Debugging view, click the bug icon.
2. Select a project from the Project drop-down.
   
3. Click the Update existing issue tab and select the bug which you want to update from the Issue drop-down.
   
4. Click Show all fields to view additional fields. Update the details about the bug.
   
5. Click Update Issue.
   

You will receive a success message that the Jira issue was updated.

To disconnect the integration, click Disconnect on the Jira tab. In the Disconnect Jira dialog, type Disconnect in the box and click Disconnect again.