1. Functionize
  2. User Guide
  3. Integrations
  4. Full Integration

Zephyr Squad Integration

Follow

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

Why add Functionize to Zephyr? Functionize enables you to easily automate your manual Zephyr tests, without code. 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
  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 Setup

  1. Open Integration Settings:

    • Go to the Team page and then the Integrations tab.
    • Select Zephyr Squad from the Test Case Management section.

  2. Provide Credentials:

    • Enter the URL for your Jira project.
    • Enter your Zephyr Username and Password.
    • If applicable, enter your Proxy URL and Port.
    • Click the Test Sign In button to establish the connection.

  3. Map Projects and Statuses:

    • Select the Functionize and Zephyr projects you wish to link.
    • Choose the appropriate Project Environment.
    • Map the Functionize Test Statuses to the Zephyr Test Statuses.
    • Click Save Mapping to save your integration connection details.

Linking Test Cases via Project Page

  1. Open Functionize Project:

    • Confirm you have selected the Project Environment previously mapped with your Zephyr project.

  2. Link Test:

    • Click the Zephyr logo + Link Test next to the test you want to link.
    • Select the corresponding Zephyr test case and click Link Test.

  3. Edit Link:

    • Once a test is mapped, the Zephyr test name will be listed with a pencil icon to edit the connection at any time.

Linking Test Cases via Test Detail Page

  1. Open Test Detail Page:

    • Click the Zephyr logo + Link Test above the test actions.

  2. Link Test:

    • Select the corresponding Zephyr test case and click Link Test.

  3. Edit Link:

    • Once a test is mapped, the Zephyr test name will be listed with a pencil icon to edit the connection at any time.
      Note: If you select a Zephyr test case already linked to a Functionize test, a warning will appear indicating the link will be overridden by the new connection.

Map the Same Project to Multiple Zephyr Instances

  1. Open Integration Settings:

    • Go to the Team page and click on the Integrations tab.

  2. Select Zephyr Squad:

    • On the left panel, select Zephyr Squad from the Test Case Management section.

  3. Provide Initial Zephyr Credentials:

    • In the main panel for the first Zephyr instance (Zephyr_1), provide the necessary credentials:
      • URL: Enter the URL for your Jira project.
      • Jira Username: Enter your Zephyr username.
      • Jira Password: Enter your Zephyr password.
      • Proxy URL and Port: If applicable, enter your proxy details.
    • Click the Test Sign In button to verify the connection. The status next to the button should update to indicate readiness.

  4. Map Projects and Environments:

    • Scroll down to the Project Mappings section.
    • Select the Functionize and Zephyr projects you wish to link.
    • Choose the appropriate Project Environment.
    • Map the Functionize Test Statuses to the Zephyr Test Statuses as desired.

  5. Save Mappings:

    • Click Save Mapping to save your integration connection details for both Zephyr instances.

  6. Add a New Zephyr Instance:

    • Click on the Add New button to configure another Zephyr instance.
    • A new tab (Zephyr_2) will appear for the second instance.

  7. Provide Additional Zephyr Credentials:

    • In the new Zephyr panel (Zephyr_2), provide the necessary credentials:
      • URL: Enter the URL for your Jira project.
      • Jira Username: Enter your Zephyr username.
      • Jira Password: Enter your Zephyr password.
      • Proxy URL and Port: If applicable, enter your proxy details.
    • Click the Test Sign In button to verify the connection. The status next to the button should update to indicate readiness.

  8. Map Additional Projects and Environments:

    • Scroll down to the Project Mappings section for the new Zephyr instance.
    • Select the Functionize and Zephyr projects you wish to link.
    • Choose the appropriate Project Environment.
    • Map the Functionize Test Statuses to the Zephyr Test Statuses as desired.

  9. Save Mappings:

    • Click Save Mapping to save your integration connection details for both Zephyr instances.

Linking of Multiple Zephyr Integration in the Project via Project Page

  1. Open the Functionize Project:

    • Open the Functionize project that you have linked with Zephyr.

  2. Select Project Environment:

    • On the left panel, confirm you have selected the Project Environment that was previously mapped with your Zephyr project.

  3. List of Tests:

    • The list of tests in the main panel will display the Zephyr logo with the option to + Link Test.
    • Click Link Test next to the test you want to link.

  4. Select Zephyr Integration:

    • From the dropdown menu, select the appropriate Zephyr integration.
    • Choose the Zephyr test case you want to link to your Functionize test.
    • Click Link Test.

  5. Verify Mapping:

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

  6. Link Another Test Case:

    • Click on the Zephyr logo with + Link Test for another test case.
    • Click Link Test.

  7. Select Another Zephyr Integration:

    • From the dropdown menu, select the second Zephyr integration (Zephyr_1 or another configured integration).
    • Choose the corresponding Zephyr test case to link to your Functionize test.
    • Click Link Test.

  8. Verify Additional Mapping:

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

 

Sending Results to Zephyr

  1. Create and Configure Orchestration:

    • Go to the Orchestrations tab and click + Create New Orchestration.
    • Enter relevant information and configure settings under the Advanced tab.
    • Select Submit Linked Test to TCM on Advance tab for how results should be sent to Zephyr.
    • Select Zephyr Fix Version and Zephyr Test Cycle on Integrations tab.
    • Click Confirm and Submit.

  2. Execute and view Orchestration:

    • Execute the orchestration on demand, on a schedule, or via a CI/CD pipeline.
    • Open the Orchestration Results and click the Results button under the Actions column.
    • If you selected 'On Demand' for Submit Linked Test to TCM during Orchestration creation, then on the Orchestration Results page Click on Submit to Zephyr, 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
    • Zephyr Mapping Popup window will appear and select the Zephyr Fix Version from the drop-down menu and  Zephyr Test Cycle from the drop-down menu, after selecting those fields, click the Submit button
    • A toast message will appear to confirm the results have been sent to Zephyr and a link to the execution will be visible.
      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

Related articles