Vortex

This section applies specifically to the Zephyr Enterprise product. The information below is generally used to ensure that system administrators can update their Zephyr Enterprise product instance on a Linux environment.

What is Vortex?

The value of Vortex is to Organize the Automated Test cases in Zephyr platform and see results
When Vortex job is run it posts the test cases into ZE, schedules and executes the test cases according to 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

This section provides step-by-step instructions to configure and use Vortex. Please refer to steps provided below:

Vortex configuration:

Install Zephyr
Go to the zephyr Installation Directory eg: C:\Program Files\Zephyr\license
Copy the zautomation.lic license file in license folder
Restart the Zephyr service

How to validate Vortex Installed properly or not:

Launch zephyr eg : http://localhost:81/flex/html5
Login as Manager >> Select any project
Check the project Apps
Click on Vortex >> It should be selected and should show in Green color
Add Job and Execute Job

In Vortex we have Automation and Folder watcher. In both the widgets we are supporting with the below frameworks only with Junit xml format.

Cucumber
JUnit
Selenium
TestNG
Tricentis Tosca
UFT
eggPlant

Automation:

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

Folder Watcher:

Folder Watcher also does the same job as Automation does, but the difference is in Automation user has to execute the job, whereas in Folder watcher, user will configure the job with Result folder with an 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 ZE UI

How to Add and Execute Automation Job:

Install Zephyr
Install Zbot and configure with any user having all the permission of Test Repository, Test Planning and Test execution (Manager , lead , custom user etc)
Login as (Manager , lead , custom user etc) in Zephyr
Click on Vortex
Select Automation
Click on + button to add job and save the Job
Click on E button and give cycle, phase names and select assign user and save
Once Job is scheduled, it will give 3 notifications ( New, In-progress, Completed )
Once Job is completed based on the Automation report file it will create testcases in Test Repository, Create 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 testcases it will add attachment and logs

Note:

Since cucumber supports BDD framework, in ZE it will create testcase with test steps. For remaining frameworks only testcases will be present not testcase with test steps
In eggPlant we will give result path as csv file instead of xml file. (eg : D:\egg plant\Files\EggPlant\test.suite\Results\SuiteStatistics.csv )
For every failed testcase it will attach logs and screenshots in Test Execution
For cucumber if any of the step will fail, the next steps will not be executed and testcase status will be fail
To run the Automation and Folder watcher user should install Zbot. Follow the instructions mentioned in page : http://localhost/zephyr/zbot/ and install Zbot
User can create their automated scripts through any framework, and they can execute their scripts by Eclipse or bat file or sh file or through Jenkins or Maven etc... This depends from one user to another user configuration. By end after executing their script they must have generated reports in any format like JSON, XML, PDF etc... We are supporting only JUnit XML now, and we are supporting only the above mentioned frameworks. The output report xml file consists of how many testcases present, and how many is pass and how many is fail, and if it is fail what is the error (Attached sample out put file for cucumber :
Result path should give wihout double quotations eg : C:\Users\jagadeesh\Desktop\cucumber1.xml

Sample automated xml report files for all the frameworks is available at : \\192.168.100.203\SHARE\QA\Vortex\Files

How to Add and Execute Folder Watcher Job:

Install Zephyr
Install Zbot and configure with any user having all the permission of Test Repository, Test Planning and Test execution (Manager , lead , custom user etc)
Login as (Manager , lead , custom user etc) in Zephyr
Click on Vortex
Select Folder Watcher
Click on + button to add job and save the Job
Trigger the script through Jenkins or Maven or sh file or bat file or eclipse etc.... Once execution of script is completed it will create report file in the folder path and it will give notifications in Folder watcher
After applying notifications, Job will be completed. Based on the Automation report file it will create testcases in Test Repository, Create 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 testcases it will add attachment and logs

After adding job, it will keep on watching the folder path every 2 minutes ( based on sleep over time, since we have given 2 minutes it will keep on watching the folder for every 2 mins). So now if user will go and trigger his script through Jenkins or if user has triggered his script though bat file or sh file or maven file etc...it will create output file in the folder path . So this folder watcher will take that file and post the results to ZE UI same as what Automation do