Versions Compared

Old Version 5

changes.mady.by.user Helen Kosova (Deactivated)

Saved on

compared with

New Version 6

changes.mady.by.user Edward Stolyar (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel2

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

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 Zephyr Enterprise UI. When Automation job is executed it posts the test cases into Zephyr, 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 (for example, 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

...

  • 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).

...

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

...

  • 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 the E button to execute the automation job.

Image Removed

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.
  • It will create the cycle with the given name in Test Planning with the given start and end dates.
  • In Test execution, it will post the results and for failed test cases it will add any attachments and logs.

Image Removed

...

Note
titleVortex Automation Job Notes
  • Since cucumber supports BDD framework, in Zephyr Enterprise, it will create test cases with test steps. For the remaining frameworks, only test cases will be present and not the test cases with test steps.
  • In eggPlant, Zephyr will give the result path as a CSV file instead of XML file. For example, D:\egg plant\Files\EggPlant\test.suite\Results\SuiteStatistics.csv.
  • For every failed test case, it will attach screenshots or logs in the Test Execution.
  • For cucumber, if any of the steps fail, the next steps will not be executed and the test case status will be set as fail.
  • To run the Automation and Folder Watch, users should install Zbot and follow the instructions mentioned in page:
  • User can create their automated scripts through any framework, and they can execute their scripts by eclipse, bat file, sh file, Jenkins, Maven, etc. 
    • This depends from one user to another in user configuration.
    • After executing their script, they must have generated reports in any format like JSON, XML, PDF, etc.
    • Zephyr is only supporting JUnit XML now, and Zephyr are supporting only the above mentioned frameworks. The output report XML file consists of how many test cases are present, and how many passes and how many fail, and if it failed, it consists of the error.
  • Result path should as given:
    • C:\Users\jagadeesh\Desktop\cucumber1.xml

Reuse Existing Cycles and Phases

...

Using the previous example, we can reuse the existing cycle and phase that we created above.

1. Edit the existing job by selecting the job from the automation table in vortex.

2. Ensure that the 'Reuse same Test Cycle for all automation runs" is selected and then click on 'Add'.

  • Vortex jobs support multiple automation engineers running the same automation jobs in different machines and publishing results to the same Test Cycle/Phase in Zephyr.

Image Removed

 3. Click the E button to execute the automation job again.

Image Removed

4. Click the Apply button to apply the notifications.

Image Removed

5. The status should be set to complete after applying the notifications.

Image Removed

The new test folder will not be created in the test repository, it will remain the same as the previous job.

Image Removed

The new test cycle/phase will not be created in the Test Planning and Test Execution page, both will remain the same.

Image Removed

Image Removed

The execution history when reusing the same vortex job may display execution changes made by Vortex.

Image Removed

How to Add and Execute Folder Watcher Job

Note
titlePrior 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 Folder Watcher.
  3. Click on the '+' button to add a job.
  4. Fill in the mandatory fields that are highlighted red and then save the job.
  5. Trigger the script through Jenkins, Maven, sh file, bat file, eclipse, etc. Once the execution of script is completed, it will create the report file in the folder path and it will give notifications in folder watcher.
  6. After applying notifications, the job will be completed. Based on the Automation report file, it will create test cases in the Test Repository, create the cycle with the given name in Test Planning with the given start and end dates. 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 Folder Watcher.

Image Removed

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

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

Image Removed

Cycle Start and End Date Selection Limitations

How vortex works with the project and folder watcher 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 folder watcher 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.
Warning

When using folder watcher, users will still be able to execute a job irrespective of selecting a project start and end date. The Execution of the folder watcher job will not fail. This is not intended and we advise that you do not attempt to execute a folder watcher job without a start and end date.

Image Removed

After saving and adding the job, the job will be created with the status set as new.

Image Removed

After adding a job, it will keep on watching the folder path every 2 minutes.

...

5. Trigger the script through Jenkins, Maven, sh file, bat file, eclipse, etc. Once the execution of script is completed, it will create the report file in the folder path and it will give notifications in folder watcher.

So now, the user will go and trigger this script through Jenkins or through the bat file, sh file, maven file, etc.

...

The status will be completed when Job Information changes to complete.
Image Removed

7. After applying notifications, the job will be completed. Based on the Automation report file, it will create the following:

  • Test cases in the Test Repository
  • The cycle with the given name in Test Planning with the given start and end dates.
  • In Test execution, it will post the results, and for any failed test cases, it will add any attachments and logs.

We can then view them in the respective locations and pages.

...

Why automate test cases?

In Zephyr, you can automate your test cases to speed up the testing process, avoid human errors and increase the efficiency of test management. You can easily update the status of your tests in automatic mode using information provided by the supported test automation tools, such as TestComplete, SoapUI, and others. All this is done via Zephyr Vortex.

What is Vortex?

Zephyr Vortex is a set of means that allow you to create various automation jobs for automating your test cases. Yo can create three types of jobs:

  • Script Automation - jobs of this type trigger a automation script that retrieves data from the specified test automation tool through a software agent (see below) and passes it to Zephyr.

  • Suite Automation

  • Folder Watcher

...

You create a job in Vortex, and then execute it to automate your test cases. The way you do this depends on the type of your Vortex job.

Create a job

Before creating a Vortex job, you need to download ZBot, which is a software agent that connects Zephyr with test automation tools, and run it on the machine where you will execute your tests in the test automation tool being used.

To learn how to create various Vortex jobs, see Script Automation, Suite Automation and Folder Watcher.

See Also

ZBot Overview
Script Automation
Suite Automation
Folder Watcher