TestOps logo
Try TestOps

Integration with Jira Data Center and Jira Server

Jira Data Center (previously known as Jira Server) is the self-hosted edition of the popular Jira issue tracker. This article describes how to configure the integration between a Jira Data Center instance and Allure TestOps.

Lists of launches and test results from Allure TestOps are added to Jira issues using an iFrame component. For this to work, Allure TestOps does not have to be accessible from the Jira server, but it must be accessible from the user's device. This also means that the integration may be affected by the user's web browser settings, especially if the Jira Data Center instance uses HTTPS. If your users will report any problems anyway, please consult the Troubleshooting section or contact our support team.

For adding an issue link to a test case manually, Jira must be accessible from the Allure TestOps server.

To use automatic linking between test cases and issues, a test author needs to define a relation using an Allure Report adapter for their test framework. Here's an example of such a definition:

import { test } from "@playwright/test";
import { allure } from "allure-playwright";

test("Some test", async ({ page }) => {
  allure.label("jira-prod", "BUG-123");
  // ...
});

This code defines a relation between the test and the “BUG-123” issue in the “jira-prod” issue tracker. To make this an actual link in the web interface, Allure TestOps will use an issue mapping for “jira-prod”, as configured on step 2.4.

Note that while the example above works, in a real project we recommend to define your own wrapper function instead of specifying the key in allure.label() every time. Please consult the Allure Report documentation for your test framework.

1. Install the plugin for Jira

  1. In Jira, click the gear icon in the top right corner and select Manage apps.

    If asked, enter the Jira administrator's password.

  2. Using the search box, find the Allure TestOps for Jira plugin.

  3. Click Install next to the plugin.

  4. In the dialog that appears, click Accept & install.

    Wait until the plugin is downloaded and installed.

After you finish this part of the configuration, Allure TestOps will support links to Jira issues in both test launches and specific test results.

First, the administrator needs to specify the URL of the Jira instance.

Then, any project owner needs to create an authentication token in Jira, add it to Allure TestOps, and configure issue mapping.

The issue links are on the right side of the test case information block.

2.1. Specify Jira URL in Allure TestOps

  1. Log into Allure TestOps using an administrator account.

  2. Go to Administration → Integrations.

  3. Click + Add integration in the top right corner of the page.

  4. In the dialog that appears, select Jira Server (DC).

  5. Fill in the fields:

    • Name — a name to help you recognize the integration, e.g., “Jira production”.
    • Endpoint — the URL of the Jira instance, e.g., “https://jira.example.com/”.

  6. If your Jira Data Center instance uses a self-signed SSL certificate, check the Disable certificate validation checkbox.

  7. Click Add integration.

2.2. Create a token in Jira

Skip this if you prefer to use your username and password as the credentials.

  1. In Jira, click your avatar and go to Profile.

  2. In the menu on the left, click Personal Access Tokens.

  3. Click Create token.

  4. Fill in the fields:

    • Token Name — a name to help you recognize the token, e.g., “Token for Allure TestOps”.
    • Expiry date — how long the token must stay valid. After this date, the integration will stop working, and you will need to create a new token to continue using the integration. To create a token that never expires, uncheck Automatic expiry.

  5. Click Create.

    The new token will become temporarily visible. Copy it.

    You will need this token on the next step.

2.3. Add the Jira credentials to Allure TestOps

  1. In Allure TestOps, open your project.

  2. Go to Settings → Integrations.

  3. Under the Available integrations, find the Jira Data Center integration and click Add integration next to it.

  4. In the dialog that appears, enter the credentials for connecting to Jira. You can do it via basic authentication or token authentication.

    On the basic tab, enter the username and password of the Jira user.

    On the token tab, enter the token that you got on step 2.2.

  5. Click Test connection. If the credentials are correct, a "Connection established" message will appear within a few seconds.

  6. Click Add integration to save the settings.

2.4. Configure issue mapping

  1. In Allure TestOps, open your project.

  2. Go to Settings → Issues.

  3. Click + Create.

  4. Fill in the fields:

    • Key — a short integration identifier that you are going to use when writing the tests.
    • Issue tracker — the name of the integration that you added on step 2.1.

    Issue mapping is made in the project settings.

  5. Click Submit.

3. Configure embedding data into Jira

After you finish this part of the configuration, your Jira Data Center instance will support links to Jira issues in both test launches and specific test results.

First, make sure that secure cookies are enabled for Allure TestOps. Then, get the integration ID and use it when configuring the plugin in Jira.

The Allure block is located on the issue page in Jira.

3.1. Enable secure cookies in Allure TestOps

This section assumes that both Allure TestOps and Jira Data Center are configured to use the encrypted HTTPS protocol. In other cases, please contact our support team.

For security reasons, a user's web browser may block sharing cookies between two different websites, such as Allure TestOps and Jira. This may prevent the embedding on the Jira issue details page.

To fix this, make sure that the “secure cookie” setting is enabled for your Allure TestOps installation.

In the values.yaml file, set network.tls.secureCookie to true.

In the .env file, set TESTOPS_SECURE_COOKIE to true.

Save the changes and restart Allure TestOps.

In the /opt/testops/conf/testops.conf file, set ALLURE_SECURE to true.

Save the changes and restart Allure TestOps.

In the /opt/testops/conf/testops.conf file, set ALLURE_SECURE to true.

Save the changes and restart Allure TestOps.

3.2. Find out the integration ID in Allure TestOps

  1. Log into Allure TestOps using an administrator account.

  2. Go to Administration → Integrations.

  3. Find the Jira Data Center integration.

    Copy the ID that is shown next to the integration name. You will need this ID on the next step.

    The Allure integration ID is visible next to the integration name.

3.3. Configure the plugin in Jira

  1. In Jira, click the gear icon in the top right corner and select Manage apps.

    If asked, enter the Jira administrator's password.

  2. In the menu on the left, click Manage apps.

  3. Expand the Allure TestOps for JIRA section and click Configure.

    The “Configure” button is in the plugin item on the “Manage apps” page.

  4. Fill in the fields:

    • General settings

      • Config — if you are configuring the plugin for the first time or if you need to add an integration with a new Allure TestOps instance, select “Create new config”. Otherwise, select the URL of the instance for which you want to update the settings.
      • Endpoint — the URL of your Allure TestOps instance, e.g., “https://testops.example.com”. Make sure not to include the trailing slash in the URL, as it can cause incorrect behaviour of the plugin.
      • Version — “Version 4.x.x”.
      • Integration ID — the identifier that you got in Allure TestOps on step 3.2.

    • Panels location

      • Test Cases — the location for the test results list.
      • Launches — the location for the launches list.

    • Access

      • Selected groups, Groups — for which Jira groups the plugin will be enabled. To enable it for users from all groups, leave Selected groups unchecked.
      • Selected projects, Projects — for which Jira projects the plugin will be enabled. To enable it for users from all projects, leave Selected projects unchecked.

    While the Panel location options allow you to move lists to the right side (as demonstrated on the screenshot above), doing so is not recommended. Unlike the main area, the right side of Jira's interface is very limited in width, which can make the Allure TestOps list inconvenient on most displays.

  5. Click Save.

4. Enable synchronization of the issue lifecycles

Allure TestOps supports Jira's webhooks. A webhook a way for Jira to notify an external system about a status change of an issue. When receiving such a notification, Allure TestOps will look for any defects related to the issue and update their status correspondingly.

To enable the lifecycle synchronization, generate a webhook in Allure TestOps and add it to Jira.

4.1. Generate a webhook in Allure TestOps

  1. Log into Allure TestOps using an administrator account.

  2. Go to Administration → Integrations.

  3. Find the Jira Data Center integration and click its name.

  4. Go to the Webhooks tab.

  5. Click + Create webhook, then click Confirm creation.

  6. In the dialog that appears, click the Copy icon to copy the webhook URL into clipboard.

    You will need this URL on the next step.

4.2. Add the webhook to Jira

  1. In Jira, click the gear icon in the top right corner and select System.

  2. In the menu on the left, click Advanced → WebHooks.

  3. Click Create a WebHook.

  4. Fill in the fields:

    • Name — a name to help you recognize the webhook.
    • Status — “Enabled”.
    • URL — the webhook URL that you got on step 4.1.
    • Issue related events — select “Issue → updated”.

  5. Click Create at the bottom of the page.

Troubleshooting

In Jira issues, viewing and managing Allure TestOps entities is done through an iFrame component. Below are examples of possible errors that may appear in the iFrame, along with recommendations for resolving them.

iFrame sections display login buttons

The iFrame sections display login buttons.

If you are logged into Allure TestOps but you still see the Login buttons in Jira, this is most likely caused by the security settings in your web browser. Follow the browser-specific instructions below to make sure that the proper communication between Jira and the Allure TestOps iFrame is allowed.

Each user who encounters this error needs to do these steps.

  1. Go to your browser settings to the Privacy and security → Third-party cookies section (chrome://settings/cookies).

  2. Select Allow third-party cookies.

    The “Allow third-party cookies” option is in the “Privacy and security” section.

  1. Go to your browser settings to the Privacy & Security section (about:preferences#privacy).

  2. Under Enhanced Tracking Protection, select Custom.

  3. Make sure that the Cookies checkbox is selected.

  4. In the drop-down list next to the Cookies checkbox, select Cross-site tracking cookies.

    The “Cookies” setting is available when the “Custom” tracking protection mode is chosen.

  1. In the top menu, go to Safari → Settings.

  2. Go the Privacy tab.

  3. Clear the Prevent cross-site tracking checkbox.

    The “Prevent cross-site tracking” setting is in the “Privacy” section.

iFrame sections are empty

The iFrame sections are empty.

Empty iFrame sections usually indicate that your Jira instance uses HTTPS while Allure TestOps uses HTTP. Unfortunately, such a configuration is not supported. We recommend switching to HTTPS for both products. See Enabling HTTPS.

Once you have enabled HTTPS for Allure TestOps, be sure to replace “http” with “https” in the plugin settings.

iFrame sections display the message “Couldn't connect to Allure TestOps”

The iFrame sections display the message “Couldn't connect to Allure TestOps”.

The message “Couldn't connect to Allure TestOps” means that an incorrect integration ID is specified in the plugin settings in Jira.

To fix the error:

  1. Find the relevant integration ID in Allure TestOps.
  2. Make sure that this ID is specified in the plugin settings.
© Qameta Software Inc. All rights reserved.