Add the label for the token you are going to create
Copy and save the token.
We'll use it later on during the configuration of the integration with Jira.
Allure TestOps Global level - enable Jira Cloud integration
You need to have ROLE_ADMIN authority to configure Allure TestOps instance on the global level.
Go to User menu > Administration > Integrations
In the upper-right corner click Add integration
Search for Jira Cloud
Click on the Jira Cloud banner
Provide the name of the integration
URL of Jira Cloud without http(s):// might be a good idea for the name
Provide Jira Cloud instance's URL to Endpoint field (e.g. https://testopstests.atlassian.net)
Finalise by clicking Add integration.
Next you'll see the following screen:
Here, you can also test the connection, update the parameters, or even delete the integration (which is bizarre considering you just added it). Webhooks are also configured on the global level. Webhooks are described at the end of this chapter.
You need to be a project owner to perform the following actions.
On the level of a project you need to add the created integration to the project you work in, and provide the credentials (secrets) to authorize Allure TestOps to be able to send API requests to Jira Cloud instance.
Setup the integration in your project
Go to the project's settings.
Go to the Integration section
Locate the Jira Cloud integration you want to add.
Click Add integration.
In the modal window enter the credentials you created on previous steps.
Test the connection.
Finalise the Integration settings by clicking on Add integration.
Using the integration with Jira Cloud
The integration we just added can be used as follows:
Adding the Jira issue (e.g. Feature or Story) link to test cases.
Adding the Jira issue (e.g. Task) link to launches.
Adding the Jira issue (e.g. Bug) to a defect in Allure TestOps.
Creating a Jira issue (e.g. Bug) from a defect in Allure TestOps.
To do: add examples for 1,2,3,4
Allure TestOps Jira plug-in
You need to be a Jira Cloud admin to install the Allure TestOps plug-in for Jira Cloud.
You need to have a ready to use integration with your Jira instance:
Integration with an instance of Jira Cloud issue tracker added globally
Integration is to be added on a project level with real credentials.
Allure TestOps plugin for your Jira Cloud instance is added to your instance from Atlassian market.
Allure TestOps instance must be working behind https (behind a reverse proxy) otherwise the plug-in won't work.
Allure TestOps cookies must be secure.
Check your configuration parameters of gateway service as follows:
Locate the parameters responsible for secure cookies
ALLURE_SECURE_COOKIE in .env file of docker compose deployment
secureCookies for Helm chart's values.yaml
ALLURE_SECURE in gateway configuration file of packages deployment
To use the plug-in you need to have an active account on Allure TestOps side.
The account can be with any authority (ADMIN, USER, AUDITOR).
Your browser must allow usage of 3rd party cookies.
Configuration of Allure TestOps plugin
You need to have either Jira administrator privileges or a Jira administrator close to you to configure Allure TestOps plugin for Jira.
Find the plugin
Click gear icon in the upper right corner.
Select Manage apps
Find Allure TestOps plug-in
Configure the plug-in
Add your Allure TestOps URL (the real one), e.g. https://demo.testops.cloud
Version of Allure TestOps has to be 4
if you are using the 3rd release of Allure TestOps, then you are reading wrong page
The integration ID is the system ID of the integration you added on the global level (under Administration section).
The required ID always stands before the integration's name.
Save the settings.
Allure TestOps plug-in for Jira is an iframe showing the information directly from Allure TestOps, it does not store any data in Jira database, ergo it requires direct connection to Allure TestOps instance.
The end user who expects to see the information from Allure TestOps needs to have an account (ROLE_AUDITOR will suffice) in Allure TestOps.
Allure TestOps plug-in for Jira uses Allure TestOps cookies to authenticate a user in Allure TestOps and show the data from Allure TestOps
The end users who expect to see the information from Allure TestOps needs to be authenticated in Allure TestOps in the same browser.
If all the settings are correct, you will see the following in your Jira issues.
Connection works, there are no test cases and/or launches linked to an issue
In case all is fine, but no there are no test cases and/or launches linked to current issue, you'll see the notification from Allure TestOps server No test cases for linked test cases section, and No launches for the launches section.
Connection works, there are test cases and/or launches linked to an issue
In case all is fine, and there are test cases and/or launches linked to current issue, you'll see the list of those:
Action is required
Connection works, current user is not logged in to Allure TestOps - Login buttons
If current user is not logged in to Allure TestOps, then the plugin will show fresh green Login button(s). You have a very difficult task — you need to decide which one you want to click.
After the decision and action are made, you will be redirected to Allure TestOps instance login page, where you need to login using your existing credentials.
Then you need to go back to Jira and refresh the page.
Allure TestOps Configuration is required
Connection works, current user is logged in to Allure TestOps - Login buttons do not disappear
If current user is logged in to Allure TestOps and the plugin still shows fresh green Login button(s), this could mean you haven't fulfilled the item #4 of the prerequisites.
Please go back to the prerequisites, check item #4 and configure Allure TestOps as described.
Browser settings alteration is required
Connection works, current user is logged in to Allure TestOps - Login buttons do not disappear
If previous solution (ALLURE_SECURE) still does not affect the behaviour, it's time to check your browser settings.
If current user is logged in to Allure TestOps and the plugin sill shows fresh green Login button(s), and the configuration contains all needed ALLURE_SECURE stuff, this could mean your browser does not allow the usage of 3rd party cookies (these are required the integration to work).
You need to uncheck the following parameter:
In Google Chrome and generally in all Chromium based browsers the following needs to be allowed for the integration to work properly.
The following settings in FireFox need to be checked and altered to allow 3rd party cookies.
Infrastructure troubleshooting is required
If you see the following or similar with an error where is is not expected, we have the worst case then
Infrastructure issues troubleshooting
When we're talking about the infrastructure there are usually 3 places to check:
Allure TestOps environment (firewalls, reverse proxies and other network elements processing the traffic)
Network (generally traffic between the Allure TestOps infrastructure and Jira infrastructure could be blocked)
Jira environment (firewalls, reverse proxies and other network elements processing the traffic)
Trying to identify the faulty party - direct connection
All the information you see in the jira plug-in is actually an iframe generated on Allure TestOps side, so if we exclude items 2 and 3 and check if you can access the iframe content directly and there are no errors in Allure TestOps:
Open developer tools of your browser.
Locale one of the elements related to Allure TestOps content
Locate the element on the page
Copy the src data of the iframe, so the string you have will look like follows:
AE-1 is the ID of jira issue, it'll be specific to your settings
integrationId=5 has to be the correct reference to the integration ID configures at Allure TestOps side.
Paste the copied string to browser's address bar. Check what your browser shows.
What your browser shows
If you see a message saying there are no test cases or no launches or yo u see a list oof test cases or launches related to this Jira issue, then settings are correct on Allure TestOps side.
If you still see sad face or an error message, you first need to check you've provided correct integration ID (integration must exist and it has to be an issue tracker).
If Issue tracker ID is correct, you need to check the network rules and make sure the connections to Allure TestOps are allowed.
If direct connection works
Here all the fun starts. You need to engage a network admin or a DevOps or whoever is responsible for the network and infrastructure on Jira side.
You need to check if the communication between Jira and Allure TestOps is allowed.
What if we have Jira Cloud?
In this case the infrastructure, network rules, white and black lists of IP addresses or FQDNs or even whole 2nd level domains are managed by Atlassian company and you need to file a tech support request to Atlassian.
We have experience with some cases when whole 2nd level domains (.tech for example) were blocked by Atlassian with no explanation.
Sync the lifecycle of a defect with Jira issue life cycle
Allure Test allow you syncing the life cycle of a bug in Jira with a defect linked to a bug.
The sync is done via webhooks Jira triggers on Allure TestOps side.
This operation requires administrative permissions on Jira side.
This operation requires ROLE_ADMIN permissions on Allure TestOps side.
Generate webhooks only if you are going to sync the life cycles of the bugs with the defects.
Generation of a webhook
In the user menu
Jump to the Administration section of Allure TestOps instance
Go to the integrations
Locate the integration with Jira instance.
Go to webhooks tab
Click Create webhook.
Copy whole webhook string and send this webhook it to your Jira administrator.
Configuring webhook on Jira side
In your Jira instance jump to settings (gear icon).
Scroll down to ADVANCED and select Webhooks.
Click +Create Webhook.
Name your webhook.
Add the webhook URL generated in Allure TestOps.
Select Issue updated event. Other events aren't needed.
Additionally, you can use JQL to watch for the events for a specific project to minimise the amount of requests.