Integration With Zephyr for Jira - Tutorial

In this tutorial, we assume that you are already familiar with Jira and have a Jira project with test cases that you want to automate.

To complete this tutorial, you will need the following:

• A Jira account. If you do not have a Jira account, you can sign up for a free trial.

• The Zephyr for Jira app installed on your Jira server. If you do not have the app, you can install a trial version.

  To learn how to install the app, see the Installation section of the app in Atlassian Marketplace.

• The ZAPI app installed on your Jira server. If you do not have the app, you can install a trial version.

  To learn how to install the app, see the Installation section of the app in Atlassian Marketplace.

• A classic Jira project. If you do not have a suitable Jira project, you can create one. To learn how to do this, see Create a project in the Jira documentation.

  Currently, Zephyr for Jira does not support next-gen Jira projects.

• At least one Zephyr test case must be added to your Jira project. You will assign your TestComplete test to that test case. To learn how to create Zephyr tests, see Create Tests (for Jira Cloud) or Create Tests (for Jira Server).

• TestComplete 14.10 (or later).

• The Zephyr for Jira Integration plugin must be enabled in TestComplete. By default, this plugin is installed and enabled automatically when you install TestComplete.

• A TestComplete project with a test you will use to automate your Zephyr test case.

  Note: If you are new to TestComplete, we recommend that you first go through the Getting Started tutorial to learn how to create projects and record tests.

• Your computer (where TestComplete is installed) must be able to access your Jira project.

In this tutorial, we use a sample Jira project called WebStore:

Click the image to enlarge it.

The project already has the Zephyr for Jira Cloud app installed and configured:

Click the image to enlarge it.

In addition, our sample Jira project already contains several test cases we would like to automate:

Click the image to enlarge it.

If you use Zephyr for Jira Cloud, you will need Zephyr API keys to access Zephyr test cases from TestComplete:

Note: If you use Zephyr for Jira Server, skip this step.

1. Open your web browser and connect to your Jira project.

2. In the Jira main menu, click Tests.

3. In the Importer section, click API Keys.

4. If no keys have been generated yet, click Generate new key.

5. Copy the generated Access key and Secret key.

Click the image to enlarge it.

Note: It may take some time for newly generated keys to become active. TestComplete will not be able to access your Zephyr test cases until the keys become active.

1. Launch TestComplete and open the project that contains the tests you want to use as automations for your Zephyr test cases.

   If you do not have suitable tests, create them.

2. Click Connect to Zephyr for Jira on the TestComplete toolbar.

3. On the resulting Properties > Zephyr for Jira page of the project, specify the connection settings:

   

   Click the image to enlarge it.

4. To make sure the specified connection settings are valid and your TestComplete project can connect to your Jira server, click Test Connection.

   

5. In the Project text box, click the ellipsis button and select your Jira project:

   

   Click the image to enlarge it.

6. You can also specify the project’s release and test cycle to which the test results will be sent. You can also specify them later by using command line arguments. The arguments can be helpful when you run your tests automatically, for example, from your CI system.

   In this tutorial, we will run our tests manually, so we will specify the release version and test cycle on the Zephyr for Jira page of the project.

   In the Version text box, click the ellipsis button and select the needed release from the resulting Select Release Version dialog:

   

   Click the image to enlarge it.

   In the Cycle text box, click the ellipsis button and select the needed test cycle from the resulting Select Cycle dialog:

   

   Click the image to enlarge it.

   Note: If you do not specify a release version, TestComplete will send the test results to the default Unscheduled version. If you do not specify a test cycle, TestComplete will send the test results to the default Ad hoc test cycle.

7. Save the changes.

1. Switch to the Execution Plan editor of your project. This editor specifies the tests to be run when you run your test project.

   If your project does not have test items, create them

   If your project does not have test items, create themIf your project does not have test items, create them

   1. Click New Test Item on the editor toolbar.

   2. In the Execution entity column of the added test item, click the ellipsis button and select the needed test in the Select Test dialog:

      

      Click the image to enlarge it.

   3. If needed, specify the test item's name, the number of iterations, parameters, and the behavior in case an error occurs. To learn more about test items and their parameters, see Execution Plan Editor.

   In our sample WebStore_Sample_Project project, we have several test items specified:

   

   Click the image to enlarge it.

2. Make sure the test item you want to use is marked as a test case. Only those items that are marked as test cases can be used to automate Zephyr test cases.

3. Select the needed test case and click the ellipsis button in its Link to external test case column.

4. TestComplete will connect to your Jira project and show the Link to External Test Case wizard with a list of available test cases:

   

   Click the image to enlarge it.

   Select the needed test case and click Finish.

5. If needed, repeat steps 1–3 to assign more test cases to the Zephyr test cases.

6. Save the changes.

To execute test automations assigned to Zephyr test cases, you run the appropriate test cases in TestComplete. You can run test cases from the TestComplete UI, or you can run them from the command line or from your CI system.

For simplicity, in this tutorial, we will run a test case from the TestComplete UI:

1. Select the test case assigned to a Zephyr test case and click Run Focused Item on the toolbar.

2. TestComplete will run the test case and send the test item results to Jira:

   

   Click the image to enlarge it.

In Jira, you can view TestComplete test results the same way you view test case executions. If a TestComplete test case is executed without errors, the test execution status in Jira will be Pass:

Click the image to enlarge it.

Otherwise, the test execution status will be Fail:

Click the image to enlarge it.

You can view the first error message posted to the TestComplete test log in the Comment section of the test execution in Jira. The screenshot of your computer’s desktop will also be attached to the execution.

This concludes the tutorial. You have assigned a TestComplete test to a Zephyr test case in a Jira project and run the test. As you can see, automating test cases with TestComplete is easy.

To learn more about TestComplete integration with Zephyr for Jira, see the following topics: