Skip to content

Jira (with Xray and Zephyr support)#

Jira is a powerful work management tool for all kinds of use cases, from requirements and test case management to agile software development.

Zebrunner supports integration with both Cloud and Server/DC Jira distributions.

For Automation Reporting distribution of Zebrunner, this integration allows users to:

  1. Link issues to failed automated tests
  2. View history of issues, linked to a particular test
  3. Automatically link not closed issues to failed tests based on history of failure reasons
  4. Preview issue linked to a test directly in Zebrunner
  5. Link Xray and Zephyr test cases to automated tests (for more information about this functionality, refer to the documentation of your automation framework)
  6. Track test case executions in Jira
  7. Preview Xray and Zephyr test cases attached to an automated test

For Test Case Management distribution of Zebrunner, this integration allows users to:

  1. Link issues to test case executions, allowing to track discrepancy in expected behavior
  2. View history of issues, linked to executions of a particular test case
  3. Link issues as requirements to test cases
  4. View issue linked to a test case or a test case execution directly from Zebrunner
  5. Use Jira issues as requirements to generate missing test cases with AI
  6. Install Zebrunner for Jira app from Atlassian Marketplace to their Jira workspaces. More info about the app's functionality can be found here

Jira Cloud#

Obtaining API token#

  1. Log in to your Atlassian account and go to API tokens management view of account Security section
  2. Click the Create API token button
  3. Give the token a label (e.g. zebrunner) and press the Create button
  4. Copy the generated token

01-generate-token.png

Note

Zebrunner will perform requests to Jira API on behalf of the user, whose credentials are specified for the integration. Make sure that user has sufficient read permissions within Jira workspace and project(s) for integration to work correctly.

Configuring integration#

The following steps need to be performed to add an integration with Cloud distribution of Jira:

  1. Navigate to Setting → Integrations → Jira
  2. Click the Integration button
  3. Select Cloud as the Jira type, enter your Jira hostname, username (or email) and API token
  4. Select the Zebrunner projects and Jira projects to add the integration to. For more information about selecting Zebrunner projects, refer to the Selecting projects documentation. For more information about selecting Jira projects, refer to the Selecting Jira projects section
  5. (optional) Click the Test button to check connectivity
  6. Click the Save button

02-create-integration.png

Note

You can configure multiple integrations for the same Jira workspace with different selected projects. This way you can limit the visibility of data between Zebrunner and Jira.

Selecting Jira projects#

Info

Jira projects selection is only available for Jira Cloud.

As well as for the Zebrunner projects, when creating or editing a Jira integration, you can specify a list of Jira projects in which the integration will be enabled. Unlike the Zebrunner projects selection, you can choose any of the following options for multiple coexisting integrations for the same Jira workspace:

  • Configure without project selection

The integration will not be associated with any Jira project. All the attempts of searching or linking issues will give no results.

  • Enable for all projects

The integration will be enabled for all current and future Jira projects.

  • Enable for specific projects

The integration will be enabled only for the selected projects.

jira-select-projects.png

Optional: configuring Xray#

If you are using Xray Jira plugin for test case management, it is possible to connect it to Zebrunner by completing the steps below.

Note

It is assumed that you already have Jira configured as described above.

Obtaining Client Id and Client Secret#

  1. Log in to your Jira workspace

  2. Go to Apps in the header and select Manage your apps section in the dropdown

    Note: if you don't see Manage apps section, you probably don't have permissions. In this case, contact your Jira administrator.

  3. In the left sidebar, find Xray section and click on API Keys

  4. Press the Create API Key button
  5. In the pop-up, pick a user for whom the key will be generated and press the Generate
  6. Copy the generated Client Id and Client Secret

08-xray-client-id-client-secret.png

Configuring Xray plugin for Jira integration#

  1. Either click button for an existing Jira integration or continue creating a new one
  2. Tick the Enable TCM checkbox and select Xray from the dropdown menu
  3. Enter https://xray.cloud.getxray.app as host (regardless of your Jira host), Client Id and Client Secret
  4. Click the Save button

03-create-with-xray.png

Integration is now configured. The Test button now checks connection with both Jira and Xray.

Optional: configuring Zephyr Squad#

If you are using Zephyr Squad Jira plugin for test case management, it is possible to connect it to Zebrunner by completing the steps below.

Note

It is assumed that you already have Jira configured as described above.

Obtaining Access Key, Secret Key, and Account Id#

  1. Log in to your Jira workspace
  2. Select a project with configured Zephyr Squad plugin
  3. From expand menu on the left side click the Zephyr Squad button
  4. In the Integrations section, click the API keys
  5. Click the Generate new key button
  6. Copy the generated Access Key and Secret Key
  7. Click the Profile and Settings icon located in the top right corner and choose Profile
  8. From the browser address bar, copy your Account Id. URL will have the following format: https://<workspace>.atlassian.net/jira/people/<accountId>

06-zephyr-squad-api-keys.png

Configuring Zephyr Squad plugin for Jira integration#

  1. Either click button for an existing Jira integration or continue creating a new one
  2. Tick the Enable TCM checkbox and select the Zephyr Squad from the dropdown menu
  3. Paste copied Account Id, Access Key and Secret Key
  4. Click the Save button

04-create-wth-zephyr-squad.png

Integration is now configured. The Test button now checks connection with both Jira and Zephyr Squad.

Optional: configuring Zephyr Scale#

If you are using Zephyr Scale Jira plugin for test case management, it is possible to connect it to Zebrunner by completing the steps below.

Note

It is assumed that you already have Jira configured as described above.

Obtaining Access Token#

  1. Log in to your Jira workspace

  2. Click the Profile and Settings icon located in the top right corner of the screen and choose the Zephyr Scale API Access Tokens

    Note: if you don't see Zephyr Scale API Access Tokens section, you probably don't have permissions. In this case, contact your Jira administrator

  3. Click the Create access token button

  4. Copy the generated token

07-zephyr-scale-access-token.png

Configuring Zephyr Scale plugin for Jira integration#

  1. Either click button for an existing Jira integration or continue creating a new one
  2. Tick the Enable TCM checkbox and select the Zephyr Scale from the dropdown menu
  3. Paste copied Access token
  4. Click the Save button

05-create-with-zephyr-scale.png

Integration is now configured. The Test button now checks connection with both Jira and Zephyr Scale.

Jira Server/DC#

The following steps need to be performed to add an integration with Server/DC distribution of Jira:

  1. Navigate to Setting → Integrations → Jira
  2. Click the Integration button

  3. Select the Server/DC as the Jira type, enter your Jira hostname, username (or email) and password

    Note: Server/DC Jira deployment doesn't provide possibility to generate an API token for authentication, so Jira password has to be used instead.

  4. Select the projects to add the integration to. For more information, refer to Selecting projects documentation

  5. (optional) Click the Test button to check connectivity
  6. Click the Save button

Optional: configuring Xray#

If you have Xray for Jira Server installed, it will be configured automatically - no additional steps required.

Optional: configuring Zephyr#

Not supported

Jira app#

The Jira app enables seamless integration between Zebrunner and Jira, allowing you to display test cases, executions and test runs from Zebrunner workspaces directly within Jira issues.

Note

The Jira app can be used in Jira Software and Jira Service Management projects, and is available for Zebrunner Test Case Management and Testing Platform subscriptions.

Configuration of Zebrunner workspace#

Preparing the integration#

To get started, either choose or create a Jira integration within your Zebrunner workspace. During setup, select the specific projects on both Zebrunner and Jira sides. The selected projects will limit the visibility of data between the two systems.

jira-select-projects.png

Enabling the Jira app#

To enable the Jira app for a prepared integration, perform the following steps:

  1. Click the 3-dot button next to the Jira integration and select Enable Jira app

  2. In the modal, click the Install app in Jira button. You will be redirected to Atlassian Marketplace where you need to get the app

    install-jira-app.gif

  3. In the same modal, authorize the connection between Zebrunner and Jira by clicking the Authorize with Jira button. Confirm the connection

  4. Once authorized, you will see a Jira app is enabled label for the integration

    enable-jira-app.gif

Note

Multiple integrations for the same Jira workspace may have the Jira app enabled.

Disabling the Jira app#

To disable the Jira app for an integration, perform the following steps:

  1. Click the 3-dot button next to the integration and select Disable Jira app
  2. In the modal, click the Confirm button
  3. After confirmation, Jira app is enabled label will be removed

disable-jira-app.gif

Note

After disabling the Jira app for an integration, the Jira app’s configuration page will still display the Zebrunner workspace. This is because other integrations within the Zebrunner workspace may integrate with this Jira workspace. To completely remove connections with all integrations in the Zebrunner workspace, remove the workspace from the configuration page in Jira.

Configuration of Jira workspace#

When the app is installed, you can view and delete Zebrunner workspaces that are connected to the workspace.

Note

You must have workspace owner/admin permissions to access this page.

To navigate to the configuration page, perform the following steps:

  1. Open your Jira workspace
  2. Click the Apps dropdown and select Manage your apps
  3. In the User-installed apps list, click on Zebrunner for Jira
  4. Click the Configure button

jira-app-configure-page.gif

To delete a Zebrunner workspace you need to click the Delete button next to the URL of the Zebrunner workspace.

jira-app-delete-workspace.gif

Note

This action will delete connection with the Zebrunner workspace from Jira and will remove the Jira app is enabled label for all the corresponding Jira integrations in Zebrunner.

Accessing Zebrunner data in Jira issue#

Once the app is enabled, you can view information about the linked Zebrunner test cases (along with their latest executions) and test runs directly within the Jira issues. To link a test case or a test run to a Jira issue, you need to specify the issue as Requirement for the test case or test run in Zebrunner in the corresponding system field.

To open the Zebrunner widget inside a Jira issue, you need to click the Apps button and select Zebrunner. Due to Jira's limitation, you have to open the widget this way inside every issue where you want to access the data from Zebrunner, but have to do this only once per issue.

The widget is organized into tabs, each of which displays specific data from Zebrunner.

Test Cases tab displays the test cases linked to the Jira issue. Key details include the test case title, priority, automation state, the last five execution results, and specific details for each execution. Also, there is a link to the test case in Zebrunner.

jira-app-issue-test-cases.gif

Test Runs tab provides an overview of test runs linked to the Jira issue, showing details such as the environment, configurations, test case statistics chart, and link to the test run in Zebrunner.

jira-app-issue-test-runs.gif

Note

  • To open the Zebrunner widget in Jira projects, you must have user-level or higher permissions.
  • To open the Zebrunner widget in Jira Service Management projects, you must have workspace owner/admin permissions.
  • To view information within the Zebrunner widget, you must have user-level or higher permissions.

Linking test cases#

You can link test cases directly from a Jira issue, allowing you to associate Zebrunner test cases with specific Jira issues for enhanced traceability.

Note

To perform this action, you must have the role of Engineer or higher in at least one the Zebrunner project included in the integration.

To link test cases you should do following steps:

  1. Click Link test case(s)
  2. Select a project from the Target project dropdown menu. Please note that only projects for which you have sufficient permissions will be available in the dropdown
  3. Choose the test cases you wish to link
  4. Click Confirm to finalize the linking process

jira-app-link-test-cases.gif

After completing these steps:

  • The linked test cases will appear in the Test Cases tab within the Zebrunner widget in Jira
  • In Zebrunner, the Jira issue will be listed under the Requirements field of the linked test cases, providing a direct reference to the associated Jira issue
  • The linking event will be recorded in the change log of the test cases

Unlinking test cases#

To remove the association between a Zebrunner test case and a Jira issue, unlink the test case directly from the Jira issue.

Note

To perform this action, you must have the role Engineer or higher in the Zebrunner projects whose test cases you want to unlink.

To unlink a test case, follow these steps:

  1. Choose the test case you want to unlink. Please note that you must have sufficient permissions for the project the test case belong to
  2. Click Unlink
  3. Click Confirm

jira-app-unlink-test-cases.gif

After completing these steps:

  • The unlinked test case will be removed from the Test Cases grid in the Zebrunner widget within the Jira issue
  • In Zebrunner, the Jira issue will no longer appear under the Requirements field of test case, indicating that the association has been removed
  • The unlinking event will be recorded in the change log of the test case