Xray results reporting

With Xray results reporting, your team can publish a continuous, up-to-date record of your mabl testing in your Xray projects. For teams in more regulated industries, this integration helps you ensure compliance with industry standards, document key evidence for audits, and provide better visibility into the testing process.

This article explains how to set up Xray results reporting in mabl.

• Set up the integration
• Associate mabl tests with Xray

Setup

Gather your Xray credentials

To connect mabl with Xray, you’ll need to gather the necessary credentials from Xray: client ID and client secret.

To get these credentials, a Jira admin for your Xray project must first create an API key. The API key must be associated with an Xray user that has sufficient permissions to browse Xray projects and create, edit, and link issues within the relevant Xray project.

Copy and save the client ID and client secret. You’ll need these for the later setup steps in mabl.

Add the integration in mabl

In the mabl app, go to the integrations page: Settings > Integrations. In the Available integrations section, click on the + Setup button for Xray sync.

On the integration setup page, provide the following connection details:

• Name - if you plan on integrating with multiple Xray projects, give it a unique name
• Xray client ID - the client ID from your Xray credentials
• Xray client secret - the client secret from your Xray credentials
• Project key - the unique, shorthand identifier of your project. For example, if issues are “PROJ-789” and “PROJ-790”, your project key is “PROJ”. Keep in mind that the project key is case sensitive.

Select which results to sync

At a minimum, mabl will report run metadata, including the status (pass/fail) and execution start/end times. In the Result synchronization section, you can configure the integration to report additional details:

• Sync failed steps only - indicate whether you want mabl to send all results or only results for failed steps.
• Map status and evidence for steps - sync mabl test step artifacts to Xray step-level evidence. If you enable this setting, be sure to follow our recommended workflow of step-level sync.
• Artifact types - specify which step-level artifacts should be sent to Xray

When you save the integration, you can start associating tests with your Xray project! Note that subsequent updates to Results sync settings will only impact new connections. It will not change the settings for existing associations with Xray tickets.

Associate mabl tests with Xray

After setting up the integration, you can start associating mabl tests with your Xray project. The following table outlines how mabl entities map to Xray entities:

Associate existing tests

To associate an existing mabl test with an Xray Test Case, go to the test details page in mabl and click on the pencil icon to update info.

In the Update test information modal, click on the Xray button and enter the Xray project and Xray Test Case ID. Note that the Custom test case management field is intended for configuring a custom integration and should not be used for Xray results reporting.

Sync results

After associated mabl tests run, you can publish the results in Xray. From the test output page in mabl, click on the refresh icon next to the Xray ID.

When you sync a test run, the results are published in your Xray project.

An Xray Test Case with mabl results published in an associated Test Execution