Zephyr (Enterprise Level) Integration

Mapping Zephyr Test Cases with Avo Assure Scenarios

  1. The user has to log in to Avo Assure with valid credentials.

  2. The user has to click the Integrations plugin to display the Integration window.

  3. The user has to click the Zephyr button.

  4. The user has to enter the Zephyr Login credentials and click the Submit button. Note: a) Users can save their Azure Login credentials in Settings, which will auto-populate the login data on subsequent logins. b) The left block depicts Zephyr tests' details, and the right block depicts Assure scenarios.

  5. Zephyr login can be done in two ways:

    • Basic Login:

      • Zephyr URL

      • Zephyr Username

      • Zephyr Password

      Enter the above details and click the 'Submit' button.

    • Token-based login (Recommended when Zephyr SSO is enabled):

      • Zephyr URL

      • Zephyr API Token

      Enter the above details and click the 'Submit' button.

  6. From the Zephyr tests section, the user has to select the Project from the select project drop-down.

  7. The user has to select the Release from the select Release drop-down.

  8. The user has to select the Testcase.

  9. From the Avo Assure Scenarios Section, the user has to select the Project from the Select Project drop-down.

  10. The user has to select the Scenario.

  11. To synchronize the user story, the user has to click the Synchronize icon and click the Save button.

  12. To view the mapped files, the user has to click the View Mapped Files button. The Mapped files window will be displayed.

  13. To view the requirement details of the Zephyr test case, the user has to click the 'i' icon and the Test Details dialog box will be displayed with the required details of the Zephyr test case.

  14. If the requirement is not mapped to Zephyr Test Case as mentioned in the Prerequisites section, a dialog box will be displayed with the No requirement details found.

  15. To unsynchronize the user story, the user must click the Unsynchronize icon and the Save button.

Executing Mapped Scenario

  1. The user has to click the Execute button, and the Execution Profile window will be displayed.

  2. The user has to click the Create Profile button, and the Create Execution Profile window will be displayed.

  3. The user has to enter the profile name in the Profile Name field.

  4. The user has to select the Mapped Scenario.

  5. The user has to select the required browser from the Browsers drop-down.

  6. The user has to select the Zephyr Integration from the Integration drop-down, and the Zephyr dialog box will be displayed.

  7. The user has to select the Authentication type as Token, enter the Zephyr URL in the Enter Zephyr URL field, enter the API token in the Enter API Token field, and click the Save button.

  8. The user has to click the Save button, the Execution Profile will be created, click the Execute button, and the Execute Now dialog box will be displayed.

  9. The user has to select the Avo Assure Client radio button, search and select the Available Avo Assure Client, and click the Execute button.

  10. Execution will start on the selected Avo Assure Client.

  11. After the Execution completion/termination, the status of executed scenarios (mapped) will be updated in Zephyr.

  12. Avo Assure Client console will display the following message:

Types of Mapping

Following three types of synchronization are provided in Zephyr Integration:

  1. One Zephyr test to One Avo Assure Scenario (1-1).

  1. One Zephyr test to Multiple Avo Assure Scenarios (1-N). NOTE: a) Multiple entries of Zephyr test cases/Assure scenarios can be selected using the ‘Ctrl’ key. b) Mac users can't select multiple Zephyr test cases/Assure scenarios.

  1. Multiple Zephyr tests to One Avo Assure Scenario (N-1). NOTE: a) Multiple entries of Zephyr test cases/Assure scenarios can be selected using the ‘Ctrl’ key. b) Mac users can't select multiple Zephyr test cases/Assure scenarios.

Import Mappings

Avo Assure users can gather and map Zephyr testcases and Avo Assure scenarios (belonging to a specific phase or module). An Excel file imports the necessary Zephyr Testcase IDs and Avo Assure Scenarios for mapping.

NOTE: a) The first row of the Excel sheet is considered as a header which should contain the title: "TestCaseId" refers to the column containing the Zephyr Test Case IDs, and "Scenario" refers to the column containing the Avo Assure Scenario names. The titles are case-insensitive. b) In case the user wants to map multiple Zephyr Test Case IDs to one Avo Assure Scenario or one Zephyr Test Case ID to multiple Avo Assure Scenarios, then multiple values can be provided in the cell by separating these values using a semicolon (;).

Example of the data within an Excel sheet for importing mappings:

To import Zephyr to Avo mappings via an Excel sheet, perform the following steps:

  1. The user has to click the Integrations plugin to display the Integration window.

  2. The user has to click the Zephyr button, and the Zephyr Login window will be displayed.

  3. The user has to enter the Zephyr login credentials and click the Submit button.

  4. The user has to click the Import Mappings button, and the Import Mappings window will be displayed.

  5. The user has to click the Choose File button and select the file from the folder. NOTE: Only Excel files can be imported.

  6. The user has to select the sheet from the Select Sheet drop-down.

  7. The user has to select the project from the Select Project drop-down.

  8. The user has to select the release from the Select Release drop-down.

  9. The user has to select the phase/module from the Select Phase/Module field.

  10. The user has to select the Avo project from the Select Project drop-down and click the Import button.

  11. A toast message will be displayed as Successfully imported Mappings if all the mappings are successfully imported.

  12. If any of the rows in the provided Excel sheet are invalid OR a Zephyr Test Case ID is not found in the selected phase/module OR an Avo Assure Scenario is not found in the selected Avo Assure project, then the user will be prompted about these details.

Update mapping of Mapped Zephyr Test Cases

If the Zephyr test cases existing for a particular release/cycle/phase are to be reused, the Zephyr user can copy and paste these test cases to a different release/cycle/phase. This can result in Zephyr test cases having the same name but different IDs.

When execution is performed via Avo Assure after Zephyr integration is selected, this will update the execution results for the initial release/cycle/phase. For the execution results to be populated in the updated release/cycle/phase, existing test cases must be remapped.

Remapping of existing test cases can be done by performing the following steps:

Prerequisites:

When Zephyr test cases in the new location need to be mapped to the already mapped Avo Assure scenarios, then the Zephyr test cases in the new location must have the same name as the old Zephyr test cases.

  1. The user has to log in to the Zephyr Integration Screen and click the Update Mapping button.

  2. The Update Mapping Screen will consist of two sections: a) Left Section Mapped Zephyr Test Cases: This section will display the Zephyr test cases that are already mapped. b) Right Section Zephyr Folder Structure: This section will display the existing folder structure of the logged-in Zephyr instance.

  3. From the Mapped Zephyr Test Cases section, the user has to select the project from the Select Project drop-down.

  4. From the Select Release drop-down, the user has to select the release.

  5. The user must select the test case(s) whose mappings will be updated. Note: All test cases within the Release/Cycle/Phase can be selected at once by checking the checkbox against the required Release/Cycle/Phase.

  6. From the Zephyr Folder Structure section, select the project from the Select Project drop-down.

  7. From the Avo Assure Scenarios Section, the user has to select the Project from the Select Project drop-down.

  8. From the Select Release drop-down, the user has to select the release.

  9. The user has to select the Phase to which the test cases must be found and mapped.

  10. The user has to click the Update button.

  11. Once the update is complete, the mapping will be created and saved according to the criteria listed below.

    • Suppose all the Zephyr test cases with the same names are found at the updated folder location (hierarchy). In that case, all the previous mappings will be overwritten by mappings from the Zephyr test cases at the new location to the previously targeted Avo Assure scenarios.

    • If multiple Zephyr test cases with the same name are found in the modified folder location (hierarchy), then

      1. The found test cases (unique) will be mapped from the new location to the previously targeted Avo Assure scenarios.

      2. The multiple found test cases will be NOT mapped, and these Zephyr test cases will be shown in the pop-up under the ‘No matches found’ section.

      3. The user will be notified of the above events.

    • If Zephyr test cases with the same names are unable to be found in the updated folder hierarchy, then

      1. The found test cases will be mapped from the new location to the previously targeted Avo Assure scenarios.

      2. The Zephyr test cases that are unavailable will be shown in popup under ‘Not Found’ section.

      3. The user will be notified of the above events.

Unsync Mapped Files

  1. In the View mapped files screen, the mapped files can be unsynced in two different ways:

    • The user has to select the Zephyr testcase and click the Unsync icon button.

  • The user has to select the Avo Assure scenario and click the Unsync button.

Last updated