JIRA Xray is a test management platform that integrate with JIRA platform. Cerberus integrate with Xray on both Cloud and DC versions.

Pre-requisites

  • A JIRA platform with Xray app installed.

  • A few Cerberus Tescases and at least a campaign

If you are using a JIRA Cloud platform, you will have to configure the authentification detailed on chapter 1. and then define the testcase links between Cerberus and Xray on chapter 3. If you are using a JIRA DC platform, you will have to configure the authentification detailed on chapter 2. and then also define the testcase links between Cerberus and Xray on chapter 3.

1. Configure Cerberus with JIRA Authentification (if using JIRA Cloud)

  • On JIRA side, go to JIRA Menu Apps >> Manage your Apps then select API Key from the left menu.

FR

  • Click on Create API Key button in order to open a new modal screen that will ask you to select the user that will act as Cerberus. Click on Generate button. A client id and client secret is generated.

FR

  • On Cerberus Side, set the 2 parameters cerberus_xraycloud_clientid and cerberus_xraycloud_clientsecret with the Client ID and Secret defined from JIRA Side.

FR

2. Configure Cerberus with JIRA Authentification (if using JIRA DC)

  • On JIRA side, go to JIRA Menu Administration.

FR

  • Then select your organisation.

FR

  • Then Go to Settings.

FR

  • Then Go to API Keys.

FR

  • Then Click on Create API Key.

FR

  • Choose a name and an expiration date for your key.

FR

  • Then copy the created key.

FR

  • On Cerberus Side, set the 2 parameters cerberus_xraydc_token with the previously created API Key and cerberus_xraydc_url with the URL to your JIRA instance following the schema : http://yourserver.com (NB : /rest/raven/2.0/api will be added by Cerberus in order to access the API).

FR

3. Link the Cerberus Testcases with JIRA Xray

  • Edit Testcase header of every of your testcase that you want to link with JIRA Xray in order to

    • feed External provider to JiraXray-Cloud if using a Cloud version of Xray or JiraXray-DC if you are using the DC version.

    • feed External Reference to the Epic reference (ex : CER-1)

  • Execute your campaign that contain the executions. After a while you will see on the Tag Detail section the reference of the Test Execution Epic on JIRA side with a button that will bring you to the new Epic Xray screen.

At the end of every testcase execution, Cerberus will make API call to Xray in order to create the 'Test Execution' Epic if it doesn’t exist and add the Cerberus execution inside it as a test run.

FR

The button will bring you to the JIRA page :

FR

Note

In case or error you can consult the Log viewer from Administration menu that will report the URL called and error received from the JIRA server. That error message also appear on Campaign execution screen as a tooltip on the ERROR field
Note

Token Cache duration can be tuned thanks to parameter : cerberus_xray_tokencache_duration
Note

Environments can be send to JIRA XRay if you activate parameter : cerberus_xray_sendenvironments_enable