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

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

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 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

02-create-integration.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.

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