Automation V3: Zephyr Cloud and Server
This guide shows you how to use Provar’s integration with Zephyr Cloud and Zephyr Server to:
- Connect to your Zephyr Cloud and Zephyr Server instances
- Upload and download tests to and from Zephyr
- Create Test Plans to run your test against Zephyr
- Execute your Test Plan
Note: Zephyr’s Enterprise Edition is not currently supported.
Prerequisites
The ZAPI plug-in for Zephyr needs to be installed into your JIRA instance. This is required for both Zephyr Cloud and Zephyr Server.
Connecting to Zephyr Cloud
Step 1: Make a note of your JIRA API token.
If you don’t already have a JIRA API token, see Appendix A: Creating a JIRA API token. Make a note of the API token value.
Step 2: Make a note of your Zephyr key.
If you don’t already have a ZAPI Key, see Appendix B: Creating a ZAPI key. Make a note of the Name, Access Key, and Secret Key.
Step 3: Create a Zephyr Cloud connection in Provar.
In Provar Desktop, navigate to the Settings view. Click the Zephyr Cloud connection option from Add a Zephy Integration connection in the + menu.
This opens the New Zephyr Cloud connection dialog.
Step 4: Fill in the connection details.
Fill in the rest of the fields in the form using the values you gathered in Steps 1 & 2 above.
The Project Key is the prefix of all of your tests in Zephyr. For example, if your tests start with TEST- (e.g., TEST-0001), your Project Key is TEST. Change the JIRA endpoint to match your JIRA Cloud instance’s web address. The JIRA username is usually your email address. The Zephyr username is the name from the ZAPI System Key (see Step 2 above).
Step 5: Test the connection.
Use the Test button to check that Provar can connect to your Zephyr Cloud instance.
Connecting to Zephyr Server
Step 1: Create a Zephyr Server connection in Provar.
In Provar Desktop, navigate to the Settings view. Click the Zephyr Server connection option from Add a Zephy Integration connection in the + menu.
This opens the New Zephyr Server connection dialog.
Step 2: Fill in the Connection Details.
Fill in the rest of the fields in the form.
The project key is the prefix of all of your tests in Zephyr. For example, if your tests start with TEST- (e.g., TEST-0001), then your project key is TEST. Change the JIRA endpoint to match your JIRA server instance network address. The JIRA username is usually your email address.
Step 3: Test the connection.
Use the Test button to check that Provar can connect to your Zephyr Cloud instance.
Uploading tests to Zephyr
This allows you to add test cases from Provar into Zephyr. You can also upload Zephyr tests with changes you’ve made to your Provar test cases.
Step 1: Open the Upload to Zephyr Cloud dialog.
From Provar’s Navigator view, right-click on the Tests folder and choose Upload to Zephyr.
Step 2: Choose the test cases to be uploaded.
Check the checkbox next to the test cases you want to upload, then click Upload.
Tips
You can use the filter field and checkboxes at the top of the dialog to find the test cases you want to upload.
- If you’re not seeing a test case you expect to be there, try clicking on the All Files checkbox.
- Clicking a folder’s checkbox will check or uncheck all of its child items
- The Zephyr Test column shows the existing Zephyr test that will be updated. You can use the link hyperlinks in the Actions column to update a different test.
Downloading tests into Provar
This allows you to add Zephyr tests to Provar. You can also update Provar test cases with changes you’ve made to your Zephyr tests.
Step 1: Open the Download to Zephyr Cloud dialog.
From Provar’s Navigator view, right-click on the Tests folder and choose Download to Zephyr.
Step 2: Choose the tests to be downloaded or uploaded.
Check the checkbox next to the Zephyr tests you want to download, and then click Download.
Tips
You can use the filter field and checkboxes at the top of the dialog to find the tests you want to download
- If you’re not seeing a test you expect to be there, try clicking the All Files checkbox.
- The Provar Test Case column shows the existing Provar test case that will be updated. You can use the link hyperlinks in the Actions column to update a different test case.
Create a Test Plan
Test Plans allow you to run your Provar test cases with features including Pie charts, PDF reports and/or Notification emails. You can also add Zephyr reporting to your Test Plans.
Step 1: Create a new Test Plan.
Navigate to the Plans section and click the drop-down Add a new test plan option.
This opens the New Provar Test Plan wizard.
Fill in the Test Plan name and ensure that Zephyr Cloud or Zephyr Server is selected under Reporting before clicking Finish.
Step 2: Configure the Test Plan.
The New Test Plan wizard automatically opens the Test Plan for editing.
Configure the Test Plan by filling in the Zephyr version and Test Cycle you want your test cases reported into. You can also specify a folder. In the Tests view, copy and paste the test cases you’d like to execute into the Test Plan.
Tips
- The version needs to exist in Zephyr.
- Provar will create missing Test Cycles and folders if the appropriate Create missing checkboxes are checked.
- Add Zephyr reporting to your existing Test Plans via the plus sign icon in the editor’s toolbar.
- The Enable Zephyr Cloud/Server reporting checkbox allows you to disable Zephyr reporting without removing its settings from the Test Plan.
Add a plan folder
You can further organize the test cases you execute by adding plan folders to your Test Plan.
Step 1: Create a new plan folder.
In the Plans view, right-click on your Test Plan and choose Add a new plan folder.
This opens the New Plan Folder wizard. Fill in the plan folder name and click Finish.
Step 2: Configure the plan folder.
The New Plan Folder wizard automatically opens the plan folder for editing.
You can then configure the Zephyr settings for the plan folder by, for example, specifying a Zephyr folder. In the Tests view, copy and paste the test cases you’d like to execute into the plan folder.
Tips
- You can create as many levels of plan folders as you like. They can be nested inside each other.
- Any settings you leave blank will be inherited from any parent plan folder and/or the Test Plan.
Running the Test Plan
Step 1: Start the test run.
In the Plans view, right-click the Test Plan (or one of its plan folders or test instances) and choose Run Plan Item.
- The Test Plan (or plan folder or test instance) will start running in the Executions view.
- At the end of each test execution, the results will be reported into Zephyr against the version, Test Cycle, and folders specified in the Test Plan.
Appendix A: Creating a JIRA API token
Log on to your JIRA Cloud instance, click on your Profile, and choose Account Settings.
Choose Security from the menu on the left and then Create and Manage API tokens as shown.
Use the Create API Token button on the API tokens screen to create a new one and make a note of its value.
Appendix B: Creating a ZAPI key
Log on to JIRA Cloud and open JIRA settings from the menu pane on the left.
Choose System and then ZAPI. It is at the bottom of the System menu pane.
You will now be on the ZAPI Key Administration page, from where you can create a new System Key or copy the details of an existing one. Take note of the Name, Access Key, and Secret Key of the entry you want Provar to connect through.
