Integration with Jira Software Cloud

Jira Software Cloud is the cloud edition of the popular Jira issue tracker. This instruction describes how to configure the integration between Jira Software Cloud and Allure TestOps instances.

Integration with Jira Software Cloud allows you to:

• link Allure TestOps entities (test cases, launches, test results, defects, mutes) with Jira Software Cloud issues;
• create Jira Software Cloud issues directly from the defect view in Allure TestOps (see Linking defects to issues for more details);
• view and manage linked test cases from Allure TestOps within Jira Software Cloud issues;
• view linked launches and test results from Allure TestOps in Jira Software Cloud issues.

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 Jira Software Cloud, 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 your Allure TestOps instance uses HTTP instead of HTTP. If your users will report any problems anyway, please consult the Troubleshooting section or contact our support team.

For adding an issue 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. An example of such a definition:

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

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

This code defines a relation between the test and the “BUG-123” issue in the “jira” issue tracker. To make this an actual link in the web interface, Allure TestOps will use an issue mapping for “jira”, as configured in step 1.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.

Configuring the integration

To configure the integration in Allure TestOps, you need to have access to the sections:

• Administration — requires instance administrator permissions;
• Settings of a specific project — requires the project owner role.

To configure the integration with Jira:

1. Create a token in Jira.

2. At the Allure TestOps instance level, add the integration with Jira by providing:

   • integration name;
   • Jira URL.

3. At the instance or project level in Allure TestOps, enable the added integration for a project by providing Jira credentials.

4. Configure issue mapping in Allure TestOps.

5. Configure data embedding from Allure TestOps into Jira by installing the Allure TestOps plugin.

6. Enable issue lifecycle synchronization by configuring webhooks between Jira and Allure TestOps.

1. Enable Jira links in Allure TestOps

After completing this step, you’ll be able to add links to Jira issues in Allure TestOps entities.

1.1. Create token in Jira

1. In Jira, click your avatar and go to Profile.
2. Click Manage your account.
3. In the top navigation menu, go to the Security tab.
4. Under the API tokens section, click Create and manage API tokens.
5. Click Create API token.
6. Enter a name to help you recognize the token, for example, Token for Allure TestOps.
7. Click Create, then click Copy to copy the token into clipboard.

Save the token in a secure place. You’ll need it to enable the integration in the Allure TestOps project.

1.2. Add Jira integration in Allure TestOps

1. Go to your Allure TestOps instance.

2. Go to Administration → Integrations.

3. In the upper-right corner, click + Add integration.

4. From the list of available integrations, select Jira Software Cloud.

5. Fill in the fields

   • Name — name to help you recognize the integration, for example, Jira production.
   • Endpoint — URL of your Jira instance, for example, https://example.atlassian.net/.

6. Click Add integration.

1.3. Enable integration for Allure TestOps project

To enable the integration in the specific Allure TestOps project, use one of the two methods below:

• Using the administration panel
• Using project settings

1. Go to Administration → Integrations.

2. From the list of configured integrations, find and open your Jira Software Cloud integration.

3. Go to the Projects tab.

4. Click + to the right of the search field.

5. In the Project dropdown, select the desired Allure TestOps project.

6. In the dialog that appears, fill in the fields:

   • Username — email that you use to sign in to Jira Software Cloud.
   • API token — API token you saved in step 1.1.

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

8. Click Add integration to save the settings.

1. In Allure TestOps, open your project.

2. Go to Settings → Integrations.

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

4. In the dialog that appears, fill in the fields:

   • Username — email that you use to sign in to Jira Software Cloud.
   • API token — API token you saved in step 1.1.

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.

1.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 — short integration identifier that you are going to use when writing the tests, for example, jira.
   • Issue tracker — name of the integration that you added in step 1.2.

5. Click Submit.

2. Viewing Allure TestOps test cases and launches in Jira Cloud issues

To see linked Test Cases and Launches linked to Jira issues, you need to install Allure TestOps plugin for Jira Software cloud.

After completing of the following steps, you’ll be able to view the list of linked Allure TestOps entities in Jira issues.

2.1. Enable secure cookies in Allure TestOps

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 in the Jira issue details page.

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

• Kubernetes
• Docker Compose
• DEB
• RPM

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

1. In the .env file, set TESTOPS_SECURE_COOKIE to true.
2. Save the changes and restart Allure TestOps.

1. In the /opt/testops/conf/testops.conf file, set ALLURE_SECURE to true.
2. Save the changes and restart Allure TestOps.

1. In the /opt/testops/conf/testops.conf file, set ALLURE_SECURE to true.
2. Save the changes and restart Allure TestOps.

2.2. Find out integration ID in Allure TestOps

To find the ID of the added integration, use one of the two methods below:

• Using the administration panel
• Using project settings

1. Go to Administration → Integrations.

2. From the list of configured integrations, find your Jira Software Cloud integration.

3. Copy the ID displayed to the left of the integration name.

   You’ll need this ID to configure the Allure TestOps plugin in Jira.

1. In Allure TestOps, open your project.

2. Go to Settings → Integrations.

3. Under Added integrations, find your Jira Software Cloud integration.

4. Copy the ID displayed to the left of the integration name.

   You’ll need this ID to configure the Allure TestOps plugin in Jira.

2.3. Enable Allure TestOps plugin for Jira

• Installation from scratch
• Configuration of installed plugin

1. Go to the Atlassian Marketplace https://marketplace.atlassian.com
2. Search for Allure TestOps for Jira
3. Then click Get it now and complete the installation.
4. Then configure the installed application.

If the application was installed before, then follow the next steps

1. In Jira, go to the page https://admin.atlassian.com
2. In the upper left corner click the menu Switch sites or apps – button with 4 squares.
3. Then click Products.
4. In the sidebar on the left, go to Sites and products.
5. Then click on the name of your site.
6. On the next page in the sidebar click Connected apps
7. Click ⋯ Allure TestOps for Jira, then Configure.

Then configure the application as follows.

• Enabled — must be selected.
• Endpoint — URL of your Allure TestOps instance, for example, https://testops.example.com. Make sure there’s no tailing slash in the URL, as it may cause plugin issues.
• Version — Version 4.x.x is to be selected if you have deployed Allure TestOps of version 4 and the following ones.
• Integration ID — Jira Software Cloud integration ID you copied in step 2.2.

Parameter Panels location:

• Test Cases — Show in main issue panel.
• Launches — Show in main issue panel.

To complete the settings Click Save.

3. Enabling synchronization of the defects lifecycle with issues statuses

For defects created in Allure TestOps and linked to Jira Software Cloud issues, you can manage their status (Open/Closed) automatically based on the life cycle stage of the linked Jira issue.

Allure TestOps uses incoming webhooks to manage defects lifecycles. Jira supports triggering webhooks to notify external systems when an issue status changes. When Allure TestOps receives such notification, it finds all defects linked to the issue and updates their status accordingly.

3.1. Create webhook in Allure TestOps

1. Go to your Allure TestOps instance.
2. Go to Administration → Integrations.
3. From the list of configured integrations, find and open your Jira Software Cloud integration.
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’ll need this URL in the next step.

3.2. Add webhook from Allure TestOps to Jira

1. In Jira, click the Settings icon in the upper-right corner and select System.

2. In the sidebar on the left, under Advanced, click WebHooks.

3. Click Create a WebHook.

4. Fill in the fields:

   • Name — name to help you recognize the webhook.
   • Status — Enabled.
   • URL — webhook URL that you saved in step 3.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.

Test cases and Launches blocks display the Login button

If you are signed in to Allure TestOps but you still see the Login button 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 is allowed.

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

• Google Chrome
• Mozilla Firefox
• Apple Safari

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

2. Select Allow third-party cookies.

   

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.

   

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

2. Go the Privacy tab.

3. Clear the Prevent cross-site tracking checkbox.

   

Allure TestOps blocks 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.

Allure TestOps blocks display a connection failure icon or an error message

If the Allure TestOps blocks display a connection failure indicator (an icon or the text “502 Bad Gateway”) instead of data from Allure TestOps, go to your Allure TestOps instance and make sure that it is available.

If Allure TestOps opens but the problem remains, this means that the Jira Software Cloud policy does not allow the web page to communicate with the iFrame from your Allure TestOps domain. To solve this problem, you will need to contact Atlassian support. Before you do, we recommend you to identify the URL of the iframe section that isn’t displaying.

1. In Jira, open an issue page where the Allure TestOps content is expected to be displayed.

2. Open the developer tools in your browser:

   • Google Chrome
   • Mozilla Firefox
   • Apple Safari
   1. In the top menu, go to View → Developer → Developer Tools.
   2. Click the Select an element in the page to inspect it icon or press Ctrl+Shift+C.
   1. In the top menu, go to Tools → Browser Tools → Web Developer Tools.
   2. Click the Pick an element from the page icon or press Ctrl+Shift+C.
   1. Make sure that features for web developers are enabled.
   2. In the top menu, go to Develop → Show Web Inspector.
   3. Click the Start element selection icon or press Command+Shift+C.

3. Hover the area where the content from Allure TestOps is expected to be displayed. In the HTML source tree, find the <iframe> element that corresponds to it.

4. Copy the URL of the src attribute in the <iframe> element.

   

   The web page may contain multiple <iframe> elements, some of them within others. Make sure that the URL that you copied points to the Allure TestOps domain.

5. Write to Atlassian support, providing them with the iFrame's URL and asking for the assistance or explanation why is it being blocked.