Zephyr Squad Integration

Zehphyr Sqaud Integration Overview

Functionize integrates with Zephyr Squad to provide users and teams with more visibility into automated test results. You can integrate Functionize with Zephyr, regardless of how it's deployed with Jira: Cloud, Server, or Data Center.

Why integrate with a test management tool? Automation coverage and test results are more valuable when shared with a wide audience, especially in large organizations. Viewing Functionize test results in Zephyr allows you to report both manual and automated test results from a single place.

Why add Functionize to Zephyr? Functionize enables you to easily automate your manual Zephyr tests, without code, using Architect. With the integration, you can effortlessly access linked information from both tools and click on hyperlinks to navigate back and forth between them.

Here is the high-level integration flow after setup:

  1. Zephyr manual test is created and ready to be automated
  2. Create the test in Functionize using Architect
  3. Link the automated Functionize test with the Zephyr manual test
  4. Create an orchestration in Functionize using the linked test
  5. Execute the Functionize orchestration as part of a release test cycle
  6. Submit the results into Zephyr, which can be done automatically, depending on the integration settings in Functionize
  7. View the orchestration results in Zephyr

Initial Set up

  1. Open the Team page, then the Integrations tab

  2. On the left, select Zephyr Squad from the Test Case Management section on the left side panel
  3. In the main panel, provide credentials for the connection, enter the URL for your Jira project, your Zephyr Username and Password, and if applicable your Proxy URL and Port
  4. Click and the status next to the button should update to when ready 
  5. Scroll down to the Project Mappings section, you will select the Functionize and Zephyr Projects you wish to link together and choose the appropriate Project Environment to be used and map the Functionize Test Statuses to the Zephyr Test Statuses as you would like them to be reported

  6. Multiple projects may be added, however each must be mapped individually, but using the Add Project button
  7. Click Save Mapping to save your integration connection details


Linking Test Cases via Project Page

  1. Open the Functionize project you have linked with Zephyr
  2. On the left panel, confirm you have selected the Project Environment previously mapped with your Zephyr project
  3. The list of tests in the main panel will display the Zephyr logo + Link Test, click Link Test

  4. Select the corresponding Zephyr test case to link to and then click Link Test

  5. Once a test is mapped, the Zephyr test name will be listed in the place of Link Test along with a pencil icon to edit the connection at any time

Linking Test Cases via Test Detail Page

  1. Open the Test Detail page for a test, the Zephyr logo + Link Test will be displayed to the right above the test actions and then click Link Test

  2. Select the corresponding Zephyr test case to link to and click Link Test

  3. Once a test is mapped, the Zephyr test name will be listed in the place of Link Test along with a pencil icon to edit the connection at any time
    Note: If you select a Zephyr test case which has already been linked to a Functionize test, you will receive a warning that the link will be overridden by the new connection.


Sending Results to Zephyr

  1. Open the Orchestrations tab, then click + Create New Orchestration

  2. Enter the relevant information on the Details tab

  3. On the Advanced tab, select Submit Linked Test to TCM for how you would like results of each Orchestration run sent to Zephyr

  4. Click Confirm
  5. Confirm the test cases to include and click Submit
  6. Then execute the Orchestration either On Demand, on a Schedule or via CI/CD Pipeline
  7. Open the Orchestration Results, under the Actions column click the Results button

  8. If you selected 'On Demand' for Submit Linked Test to TCM during Orchestration creation, then on the Orchestration Results page, a Fix Version drop-down menu and a Test Cycle drop-down menu will appear, after selecting those fields, click the Submit to Zephyr button

  9. A toast message will appear to confirm the results have been sent to Zephyr and a link to the execution will be visible under the Zephyr Fix Version field
    Note: If you select an automatic submission during orchestration creation, the execution link will be visible when you open the Orchestration Results page with no button for manual submission.

Zephyr Execution 

We've implemented two-way linking between Functionize and Zephyr, enabling you to see execution result details in both Zephyr and Functionize Orchestrations.

This includes links to each connected test in both Zephyr and Functionize. All test results from a single Orchestration will be added to a single Test Execution issue in Zephyr, encompassing cross-browser and multiple dataset testing. If any configuration of a test case fails (any browser, any dataset), the linked test case will be marked as a failure within that Test Execution.

Note: That if a test in Functionize is included in the orchestration, but is not linked to a corresponding test in Zephyr, the results table will provide information, but it will not be included in the Overall Execution Status section