Zephyr for Jira Test Management
Zephyr for Jira - Test Management provides a full featured and sophisticated test management solution all inside Jira.
Zephyr for Jira and Jira Cloud is an app developed by SmartBear.
On this page:
Data Import
This documentation page describes the latest eazyBI for Jira Server version and eazyBI for Jira Cloud.
Data Import in Server version
If you have installed Zephyr app for Jira Server then in Jira import options section Add-ons you will see an option Zephyr. In the section select checkbox and after the next data import Zephyr specific measures and dimensions will be available for your reports.
Data Import in Cloud version
eazyBI uses ZAPI app to import data from Zephyr Cloud version.
- Make sure you have ZAPI app installed on your Jira Cloud. Note that it might take up to one day to activate ZAPI components.
- In Zephyr for Jira Cloud, go to section Importer -> API Keys and generate Zephyr API keys (Secret Key and Access Key). It is essential to generate keys with the same user that will be used for data import in eazyBI. Please see Zephyr documentation for more information on Zephyr API keys.
- In eazyBI, Jira import options section Add-ons you will see an option Zephyr which is available when you have installed Zephyr app for Jira Cloud. Enter generated API keys in fields ZAPI Access Key and ZAPI Secret Key.
After the next data import, Zephyr specific measures and dimensions will be available for your reports.
Limit imported test executions
Option to limit imported testing data is available on Cloud and since eazyBI version 6.2.
To reduce import time and the testing data in the cube, you can import only the most recent test executions.
Set a relative time limit for test executions like 3 months to import tests execution from the last three months or a particular date like Jun 14 2020 to set a date range from that date until now. Test executions are imported if they are created (test is added to the cycle) within the time limit (for scheduled test executions) or with execution date within the time limit (for executed or in progress test executions). If there is no limit set, then all test executions are imported.
You can set a limit to all eazyBI accounts through advanced settings.
[jira.zephyr] test_executions_limit = "3 months"
Another option is setting the limit for an individual eazyBI account. In the import options, add the period in the field "Imported Test Execution limit".
If there are import limits applied for the whole eazyBI instance using advanced setting, then the limit in import options won't exceed the limit in advanced settings. In such a way, the overall limits can be set on the eazyBI account, and, in an individual account, this time can be reduced more.
Zephyr Dimensions
Zephyr tests are issues with a specific type "Test". To represent Zephyr tests in reports use Issue dimension.
After the import the following additional Zephyr specific dimension will be added:
| Zephyr Test Cycle | All test cycles will be shown in this dimension and organized in Project, Version and Cycle levels. If there are any ad-hoc tests then (ad hoc) cycle will be shown for the corresponding projects and versions. |
|---|---|
| Zephyr Test Executed by | Users who executed tests. |
| Zephyr Test Status | Test execution status – by default there are UNEXECUTED, PASS, FAIL, WIP and BLOCKED statuses, but, in addition, there can be other user-defined statuses. |
Zephyr Defect | Defect issues added during a testing. The dimension is organised in Project and Defect levels. |
Zephyr Requirement | Requirements linked to tests issues. The dimension is organised in Project and Requirement levels. Dimension is not available for Jira Cloud version. |
Zephyr Test Assignee | User who is assigned to a test execution. |
Zephyr Measures
Zephyr specific measures can be analyzed by the Zephyr specific dimensions as well as by Issue dimension (where individual tests executions are registered as issues with type "Test") and by other standard dimension members which correspond to the issue with type "Test".
Zephyr Tests created | How many test cases are created. Count of issues with type "Test". Used together with Fix Version dimension, relates to fix version assigned to a Test. On a timeline related to a test creation date. The measure Zephyr Tests created is not related to the test execution dimensions, Zephyr Test Cycle, Zephyr Test Executed by, Zephyr Test Status, Zephyr Defect, Zephyr Test Assignee. To analyze test relation to test cycles and execution results, use execution related measures, like, Zephyr Tests with executions, instead. |
|---|---|
| Zephyr Tests scheduled | How many tests are scheduled within selected dimensions but not yet executed. If a test is scheduled for several test cycles, then eazyBI count it for each test cycle. Used together with Zephyr Test Status dimension, relates to status UNEXECUTED. Used together with Fix Version dimension, represents scheduled tests of test cycles for selected fix version. On a timeline related to the date when a test added to a test cycle. |
| Zephyr Tests executed | How many tests are executed within selected dimensions. If a test is executed in several test cycles, then eazyBI counts it for each test cycle. Used together with Zephyr Test Status dimension, relates to all statuses except UNEXECUTED. Used together with Fix Version dimension, represents executed tests of test cycles for selected fix version. On a timeline related to a test execution date. |
| Zephyr Tests defect count | Linked defect count for each test executions. Includes duplication defects, if defect is linked to the several test executions. Used together with Fix Version dimension, represents defect count by a version of a test cycle. |
Zephyr Test steps | How many test steps are in tests assigned for test cycle. Used together with Fix Version dimension, represents test steps by a version of a test cycle. Used together with Zephyr Test Status dimension, represents test step count by the execution status of a test, not steps. The measure is not available for Jira Cloud version. |
Zephyr Tests with executions | How many tests have at least one test execution (scheduled, in progress or completed). If a tests has several test executions, then eazyBI count it as one test. Used together with Fix Version dimension, represents count of tests by version of test cycle. On a timeline related to the end date of test cycle (scheduled test executions) or test execution date (completed and in progress test executions). |
Zephyr Calculated Fields
Also following calculated members will be created.
| Zephyr Test last executed date | Last execution date for a test issue. This is an issue property and should be used together with Issue dimension. Value does not change according to selected Test Cycle or other dimensions. |
|---|---|
| Zephyr Test last executed by | Last executor for a test issue. This is an issue property and should be used together with Issue dimension. Value does not change according to selected Test Cycle or other dimensions. |
| Zephyr Test last execution status | Last execution status for a test issue. This is an issue property and should be used together with Issue dimension. Value does not change according to selected Test Cycle or other dimensions. |
Zephyr Requirement status | Current status of the requirement issue. This is a requirement property and should be used together with Zephyr Requirement dimension. Property is not available for Jira Cloud version. |
Zephyr Defect status | Current status of the defect issue. This is a defect property and should be used together with Zephyr Defect dimension. |
Zephyr Defect created | Date and time when defect issue is created. This is a defect property and should be used together with Zephyr Defect dimension. |
Zephyr Defect assignee | User who is assigned to a defect issue. This is a defect property and should be used together with Zephyr Defect dimension. |
| Zephyr Test Cycle description | Description of a Zephyr test cycle. This is a test cycle property and should be used together with Zephyr Test Cycle dimension. |
| Zephyr Test Cycle build | Build of a Zephyr test cycle. This is a test cycle property and should be used together with Zephyr Test Cycle dimension. |
| Zephyr Test Cycle environment | Environment of a Zephyr test cycle. This is a test cycle property and should be used together with Zephyr Test Cycle dimension. |
| Zephyr Test Cycle start date | Planned start date for a Zephyr test cycle. This is a test cycle property and should be used together with Zephyr Test Cycle dimension. |
| Zephyr Test Cycle end date | Planned end date for a Zephyr test cycle. This is a test cycle property and should be used together with Zephyr Test Cycle dimension. |
Zephyr Test Cycle created by | User who created a Zephyr test cycle. This is a test cycle property and should be used together with Zephyr Test Cycle dimension. |
Zephyr Test Execution count | How many times tests have been executed, are executing or scheduled for test cycle. |
Properties
Zephyr tests as well as requirements and defects are Jira issues and also represented in Issue dimension. You can define a calculated measure to get any issue property which is imported in eazyBI also for Zephyr specific dimensions. To access issue property use function get().
For example, to get priority for Zephyr Requirement, copy a formula of issue property Issue Priority and replace dimension name [Issue] with [Zephyr Requirement] like this:
[Priority].[Priority].getMemberNameByKey(
[Zephyr Requirement].CurrentHierarchyMember.get('Priority ID')
)
Private eazyBI
You can import Zephyr custom fields also when using Private eazyBI. Add the following settings in the configuration file config/eazybi.toml configuration file to enable Zephyr data import. There are more details on the needed configuration for data from Jira apps.