Xray Integration

Functionize and Xray Integration Overview

Functionize integrates with Xray to provide users and teams with more visibility into automated test results and metrics. Whether Xray is deployed within Jira Cloud, Server, or Data Center, this integration enables seamless reporting and management of both manual and automated tests.

Why Integrate with a Test Management Tool?

  • Automation Coverage: Share automated test results with a wide audience, enhancing the value of your testing efforts.
  • Centralized Reporting: View both manual and automated test results from a single location.
  • Enhanced Automation: Easily automate your manual Xray tests without code using Functionize's Architect.
  • Seamless Navigation: Access linked information from both tools and navigate easily between them using hyperlinks.

Integration Workflow

  1. Create a Manual Xray Test: Create and prepare the manual test in Xray.
  2. Create the Automated Test in Functionize: Use Functionize's Architect to automate the test.
  3. Link Tests: Link the automated Functionize test with the Xray manual test.
  4. Create an Orchestration in Functionize: Include the linked test(s) in the orchestration.
  5. Submit Results: Automatically or manually submit the Functionize orchestration results to Xray.
  6. View Results in Xray: See the orchestration results in Xray, which can be included in any existing Xray dashboards and management reports.

Initial Xray Setup in Functionize

Steps to Set Up the Integration

  1. Open the Team Page:

    • Navigate to the Team page and then the Integrations tab.
  2. Select Xray:

    • On the left, select Xray from the Test Case Management section.
    • Select either Cloud or Server/Data Center.
  3. Provide Connection Details:

    • Enter the URL for the Jira project.
    • Enter Jira Username.
    • Enter Jira API Token (not user password). For Jira API token assistance, refer to Manage API tokens for your Atlassian account.
    • Enter Xray Client ID.
    • Enter Xray Client Secret. Xray Client details can be found in your Jira account by a Jira Admin by accessing Apps > Manage Apps > API Keys. For further assistance, refer to Global Settings: API Keys.
    • Click Test Sign In. The status next to the button should update to Connection established with a green check mark when ready.
  4. Map Projects and Statuses:

    • Scroll down to the Project Mappings section.
    • Select the Functionize and Xray Projects to link together.
    • Select the appropriate Functionize Project Environment.
    • Map the Functionize Test Statuses to the Xray Test Statuses.
    • Click Save Mapping to save your connection details.

Linking Test Cases

  1. Open the Functionize Project:

    • Open the Functionize project linked with Xray.
    • On the left panel, confirm the selected project environment previously mapped with the Xray project on the Teams > Integration page.
  2. Link Test:

    • The list of tests on the Test Details page main panel will display the + Link Test button.
    • Click the + Link Test button to open the Xray Integration window.
    • Select the corresponding Xray manual test case and click Link Test.
    • Once a test is mapped, the Xray manual test name will be listed in place of + Link Test along with a pencil and X icon to edit or delete the link at any time.

Sending Results to Xray

An orchestration is a grouping of tests designed to run multiple tests in parallel or sequentially. The testing results from a Functionize orchestration can then be sent to Xray for inclusion in dashboard and management QA reports. To learn how to create an orchestration within Functionize, check out this guide: Create an Orchestration.

  1. Create Orchestration:

    • Open the Orchestrations page and click Create New Orchestration.
    • Enter the relevant information on the Details tab.
  2. Advance Tab:

    • On the Advanced tab, select how the results of each Functionize orchestration run will be sent to Xray.
    • Select an Xray Test Plan on the Integrations to connect to this Functionize orchestration, if applicable. Choose the Xray Test Plan Name from the dropdown menu.
    • Click Add new.
    • Confirm the Functionize test cases to include and click Submit.
    • Click the Start button in the Execute column to start the Functionize orchestration.
    • Click Confirm in the Re-run Orchestration confirmation modal.
    • Click the Result button in the Actions column to check the Orchestration Results.
  3. Submit Results to Xray:

    • When the orchestration has completed, connect the Functionize orchestration to an Xray Test Plan (if using 'On Demand' for Submit Linked Tests to TCM in your Functionize orchestration Advanced settings).
    • Click Submit to Xray. A modal will open showing the name of the Xray Execution and a link to the execution will be visible next to the Xray logo .
      Note: This updates the connection for future runs of this Functionize orchestration but does not connect results of executions run prior to the test plan being connected.

Viewing Results in Xray

Functionize and Xray support two-way linking, enabling you to view test execution result details in both platforms. Each connected test in Functionize and Xray includes links to navigate between the tools. All test results from a single orchestration are consolidated into a single Test Execution issue in Xray, including cross-browser and multiple dataset testing. If any configuration of a test case fails, the linked test case will be marked as a failure within that Xray Test Execution.

Note: If an automated test in Functionize is included in the orchestration but not linked to a corresponding manual test in Xray, the results table will provide information but will not be included in the overall Test Execution status section of the Xray Test Execution.

By following these steps, you can efficiently integrate Functionize with Xray, ensuring comprehensive test management and visibility across both platforms.