Test Automation provides users with the ability to easily import test results from various test automation frameworks directly into Zephyr test execution cycles, which ensures complete visibility and traceability into your automated test process. You import test results by executing an automation task, in which you specify the file to be uploaded or a software agent (ZBot) that will upload the file (see below). When you import test results by using Test Automation, Zephyr creates the corresponding test cases in the cycles and folders you specified when creating the automation task, and you can then work with them in Zephyr for Jira as you normally would.
Create an automation task
To create an automation task, perform the following steps:
1. Navigate to the Zephyr > Test Automation page:
2. Click Create Automation Task.
3. In the subsequent dialog, populate all the required fields. The set of fields differs depending on the value specified in the Import Method field. If you select Upload in this field, you will have to specify the results file to be uploaded. If you select ZBot, you will have to specify a software agent (ZBot) that will upload the file.
You use ZBot if you don’t have direct access to the file containing test results. ZBot is a software agent that links Zephyr for Jira with the automation framework being used. ZBot is configured once by a system administrator and is always up and running on the testing server. You can download ZBot on the Test Automation page or in the Create Automation Task dialog upon selecting ZBot in the Import Method field (see the image below).
Sample configuration for the Upload import method:
Sample configuration for the ZBot import method:
The dialog has the following fields:
The default value. A single user can manually specify the results file to be uploaded from one of the supported test automation frameworks.
Use ZBot if your team doesn’t have direct access to the results file on the testing server.
Automation Task Name
The name of your automation task.
Additional information about your automation task.
The test automation framework you will export test results from.
Upload File (if you selected Upload in the Import Method field)
Choose the file you want to upload. For example, a JUnit XML report. Zephyr for Jira will automatically create a test case and set the test execution status based on the information specified in this file.
Result Path (if you selected ZBot in the Import Method field)
The path to the results file created by the automation framework. This path must be specified in the context of the server or computer where the test runner is located.
ZBot (if you selected ZBot in the Import Method field)
Select a ZBot that will upload the file. ZBot must be previously installed on the same server or computer where the test runner is located. You can download ZBot by clicking Download ZBot on the Test Automation page, or in the Create Automation Task dialog upon selecting ZBot in the Import Method field.
Select the version (release) to store the results of the automation task.
Select a test cycle to store the results of the automation task. To create a new cycle, click Create Cycle.
Select a folder to store the results of the automation task. To create a new folder, click Create Folder.
Assign the test execution results to a specific user.
Cycle Start Date
The start date of the test execution cycle.
Cycle End Date
The end date of the test execution cycle.
Schedule Automation Task
The date and time the automation task will be executed.
The type of the issue.
The name of the current project.
The user who created the task.
4. Click Create. This will save the information and create the task. The newly created task will appear in the table on the Test Automation page. The task will have the Unexecuted status:
The Test Automation page lists all the tasks you have created. By default, the task details include the following:
The name of the automation task.
The status of the automation task. Possible values:
The release version selected by the user.
Additional information about the automation task.
The framework used for the automation task.
Specifies the upload mode. Possible values:
Upload - the user specified the results file to be uploaded.
ZBot - the user used ZBot to upload the results.
The cycle that stores the results of the automation task.
The folder that stores the results of the automation task within the test cycle.
Click the ellipsis button to execute, edit or delete the task.
Execute -Executes the automation task. The results will be imported to Zephyr for Jira.
Edit -Select it to change the field values of the automation task. For example, you may want to change the file to be uploaded, or choose another cycle.
Delete - Use it to completely delete the task. This action cannot be undone.
To customize the columns, click Columns:
Execute an automation task
To execute an automation, click the ellipsis button in the Actions column and select Execute from the drop-down menu:
When you execute an automation task, the status of the task changes from Unexecuted to In Progress. It takes some time to execute the task. When the execution is completed, the task status changes to either Success or Fail. If a task fails, you will see a warning icon. Click it to learn what you need to do to execute the task successfully:
The status workflow of automation tasks is the following: Unexecuted → In Progress → Success/Fail.
When you execute an automation task, the test results are imported to Zephyr for Jira from the specified location. Zephyr will create the specified cycle, folder, test cases, and will update the test execution status of the existing test cases to match the results from your automation task.
To update an existing execution and avoid duplicate execution, use the existing cycle or folder while creating or editing your automation task. In this case, Zephyr will update the results in the same cycle or folder for every run and you will be able to see the difference in the execution history.
In the image above, you can see that we created a task for the junit cycle. After executing the task, we can navigate to the Cycle Summary, select the junit cycle and see that the automation task has imported the results, created test cases for the automation task, and then executed individual test cases as well to match the results of the imported automation task: