/
Zephyr Vortex

Zephyr Vortex

Apr 24, 2020

Overview

What is Vortex?

  • The value of Vortex is to Organize the Automated Test cases in Zephyr platform and see results

  • When the Vortex job is run, it posts the test cases into Zephyr, schedules and executes the test cases according to the automation report

Benefits to user

  • Integration with test automation tools/frameworks- Selenium, UFT and Tricentis

  • Users can get the complete picture of automated and non-automated test cases in Zephyr application

  • Increase ROI by reducing time to setup and maintain integration

  • Provides easy to use workflow and intuitive UI to setup integration with Automation Frameworks 

Vortex Configuration

  1. Install Zephyr

  2. Go to the zephyr Installation Directory eg: C:\Program Files\Zephyr\license

  3. Copy the  zautomation.lic license file in license folder

  4. Restart the Zephyr service

How to Validate Vortex is Installed Properly

  1. Launch Zephyr.

  2. Login as Manager →  Select any project 

  3. Click on Vortex →  It should be visible and should show in Green color

  4. Add Job and Execute Job

In Vortex we have Automation and Folder watcher. In both the widgets, Zephyr supports the following frameworks (JUnit xml format). 

  1. SoapUI PRO

  2. TestComplete

  3. Cucumber

  4. JUnit

  5. Selenium

  6. TestNG

  7. Tricentis Tosca

  8. UFT

  9. eggPlant

Automation: 

 Automation is mainly to post a bunch of automation report into ZE UI. When Automation job is executed it posts the test cases into ZE, schedules and executes the test cases according to automation report. If there are any failed test cases, in the Test execution section, it will add logs and attachment.

Folder Watcher:

Folder Watcher also does the same job as Automation does, but the difference is that an Automation user has to execute the job, whereas in Folder watcher, user will configure the job's result folder with a sleep over time (eg: 2 minutes). So for every 2 minutes, this Folder watcher will watch the result folder and if any report file will generate, it will take that generated automated file and post the results to Zephyr.

How to Add and Execute Automation Job

Prior to using Vortex

General Vortex perquisites

  1. Install Zephyr.

  2. Install Zbot and configure with any user having all the permission of Test Repository, Test Planning and Test execution (manager, lead, or any custom user).

  3. Login as (manager, lead, or a custom user that has access to Vortex).

  1. Click on Vortex.

  2. Select Automation.

  3. Click on '+' button to add job.

  4. Fill in the mandatory fields that are highlighted red and then save the job.

  5. Click on the 'E' button to execution the automation job.

  6. Once the job is scheduled, it will give 3 notifications on the status of the job (New, In-progress, Complete).

  7. Once the job is completed based on the Automation report file, it will create test cases in Test Repository, create the cycle with the given name in Test Planning with the given start and end dates, and finally in Test execution it will post the results, and for failed test cases it will add any attachments and logs.

1. Click on Vortex.

2. Select Automation.

3. Click on the '+' button in the top right to add a job.

4. Fill in the mandatory fields that are highlighted red and then save the job.

  • Enter in a name for the automation job.

  • Select the framework that you are using for the automation job. Zephyr has multiple frameworks that can be used with Vortex along with the introduction to using Soap UI Pro and TestComplete.

  • Enter in the results path for the automation job.

  • Select the Zbot being used for the automation job.

  • Enter in a cycle name for to perform the automation job's executions.

    • Here you can decide whether you want to reuse the same test cycle for all the automation runs or create a new test cycle every time the automation job is run (you can include the timestamp to the test cycle as well).

  • Use the folder selector to select where to house the test cases for the automation job.

  • Select the user in Zephyr that you would like to assign the job to.

  • Select the test cycle start and end dates.

Cycle Start and End Date Selection Limitations

How vortex works with the project and vortex job start and end dates

  • Users are able to select the cycle start and end dates as per release start and end date.

  • If the project has a start date, no end date, and no release end date, then the user will be able to select the cycle start date using the release start date and the end date will be any date from the release start date.

  • The release end date will be considered while selecting the cycle end date if the project has no end date.

Identifying when Vortex is not working due to the cycle start and end dates being out of range

  • If the project end date is beyond the current date (Ex: the current date 08/23/2019 and the project start date is 08/01/2019, the end date is 08/20/2019) while configuring a job, the user will receive an error in the UI when trying to click on the save button stating 'Project has completed'.

  • If the user selects a future date as the project start date (Ex: the current date 08/23/2019 and the project start date is 08/20/2019, the end date is 08/30/2019) while configuring a job, the user will receive an error in the UI when trying to click on the save button stating 'Project has completed'.

  • When executing a vortex job with the above errors, the user will get the project is completed error and in the zephyr logs, the logs will contain information regarding the cycle creation failure and the update cycle method will also be logged as failed within the zbot logs.

5. Click on the 'E' button to execute the automation job.

6. Once the job is scheduled, it will give 3 notifications on the status of the job (New, In-progress, Complete).

  • Click on the 'Apply' button to apply the notifications.