Zephyr Squad Integration

Functionize integrates with Zephyr Squad to provide users and teams more visibility into automated test results. You can integrate Functionize with Zephyr however 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. Seeing 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 allows you to easily automate your manual Zephyr tests without code using Architect. Using the integration, you can easily see linked information from both tools and click on hyperlinks to easily jump 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. Submit the results into Zephyr. (This can be done automatically depending on the integration settings.)
  6. See 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.
  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 Test Sign In and the status next to the button should update to Connection established with a green check mark when ready.
  5. Scroll down to the Project Mappings section. Here you will select the Functionize and Zephyr projects you wish to link together and select the appropriate testing environment to be used. Map the Functionize test statuses to the Zephyr test statuses as you would like them reported.
  6. Multiple projects may be added, however each must be mapped individually.
  7. Click Submit to save your connection details.


Linking Test Cases via Project Page

  1. Open the Functionize project you have linked with Zephyr. On the left panel, confirm you have selected the testing environment previously mapped with your Zephyr project.
  2. The list of tests in the main panel will display the Zephyr logo + Link Test.Zep1.png
  3. Click Link Test to open the Zephyr Linking window.Zep2.png
  4. Select the corresponding Zephyr test case. 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 your test. The Zephyr logo + Link Test will be displayed to the right above the test Actions. Click Link Test.
  2. Select the corresponding Zephyr test case. 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 page, then click Create New Orchestration.Zep6.png
  2. Enter the relevant information on the Details Tab.
  3. On the Advanced Tab, select how you'd like results of each Orchestration run sent to Zephyr.
  4. Click Add New.
  5. Confirm the test cases to include and click Submit.Zep9.png
  6. Click the Play button in the Execute column to start the Orchestration, then click Run Orchestration in the confirmation modal.
  7. Open the Actions menu and select Orchestration Results.Zep10.png
  8. If you select "On Demand" for submitting data to the TCM during creation, the Orchestration Results page displays a button labeled Submit to Zephyr as well as a Fix Version selection menu. Select the Fix Version, then click Submit to Zephyr
  9. A dialog will confirm the results have been sent and a link to the execution will be visible under the Submit to Zephyr button.
    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. ZepO2.png

Zephyr Execution 

We've implemented two-way linking between Functionize and Zephyr which enables you to see execution result details in Zephyr and Functionize Orchestrations as well as 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 including 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.

Please 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.