Supported Zephyr Squad editions
Zephyr Squad is available for different Jira Software editions: Cloud, Server, and Data Center. ReadyAPI supports only Zephyr Squad Cloud.
|Note:||You can also use ReadyAPI command-line runners to configure automatic runs using Zephyr Enterprise. To learn how to do that, see the Zephyr Enterprise documentation.|
About Zephyr Squad
Zephyr Squad adds a test issue type to your Jira projects. You use tests to declare test steps and describe the expected results. You organize tests by releases, link them to other Jira issues (tasks, stories, bugs and so on), assign tests to QA engineers and store the results of test runs.
For each release, you use one or more test cycles to plan your testing process and monitor the test results:
To learn more about Zephyr Squad, see its documentation.
How integration works
Zephyr Squad contains information on how tests should be run and stores their results. QA engineers have to run tests manually and enter the results in Zephyr Squad.
Using Zephyr Squad integration in ReadyAPI, you can automate test runs and pass their results to Jira.
When you map your ReadyAPI project to Zephyr Squad, you bind it to an individual test cycle and associate a functional test case with a Zephyr Squad test. Thus, each time you run the test case, ReadyAPI will post its results to the test execution of the related test in the specified test cycle:
|Note:||ReadyAPI will not update Zephyr Squad tests that are not included in the test cycle you set in your project options.|
To start using the integration, make sure your Jira instance has the Zephyr Squad - Test Management for Jira app installed:
Log in to your Jira instance as an administrator.
Open Apps > Find new apps from the top menu.
Search for Zephyr Squad:
Install the Zephyr Squad - Test Management for Jira app. To do this, select the app and click Try for free in the subsequent dialog:
1. Connect ReadyAPI to Jira
Open ReadyAPI Preferences.
Switch to the Zephyr Integration tab.
Specify all the settings on the tab:
Option Description JIRA Cloud URL The URL of your Jira instance. Zephyr Base URL The URL of the Zephyr Squad Cloud API:https://prod-api.zephyr4jiracloud.com/connect Login The username or email address of the user on behalf of which ReadyAPI will post the results. This user must have the appropriate permissions. If you use an API token (for example, when you use two‑step verification), you must use the email address. API Token or Password The API token or password of the user account. If you use two-step verification you must use an API token.How to get an API tokenHide steps
In Jira, open your profile and click Manage your account.
Select the Security section and click Create and manage API tokens.
Click Create API token.
Specify a name for the API token and click Create.
Copy the created token to ReadyAPI.
You will not be able to see the created API token after you close the dialog, so make sure you have copied it to ReadyAPI. Access Key
The access and secret keys for your Zephyr Squad installation.
To check whether your settings are correct, click Test Connection.
2. Map a ReadyAPI project to Zephyr Squad
To post the results of test case runs to Zephyr Squad test executions, you need to map your test cases to Zephyr Squad tests. To do this:
Open your project and click Map to Zephyr:
Specify the following options in the subsequent dialog:
Option Description Project Name The name of the Jira project. Version The release version of the Jira project with which you want to associate the ReadyAPI project. Cycle The test cycle with which you want to associate the ReadyAPI project.
Associate test cases with Zephyr Squad tests by using a drop-down list next to each test case.
Tip: You also associate a test case in the Test Case options dialog.
View ReadyAPI test results in Jira
Each time you run a test case, ReadyAPI posts the results of the test case run to the associated Zephyr Squad test execution within the specified test cycle:
For each failed test execution, ReadyAPI posts a comment with detailed information on what went wrong.
|ReadyAPI replaces the existing comments.|
To see the comments, select the needed test execution and switch to the Detail view: