Assign TestComplete Tests as Automations to Zephyr Test Cases

To bind your TestComplete project to a Jira project

To link TestComplete test items to Zephyr test cases

To link script-defined test cases to Zephyr test cases

To temporary disable sending test results

To remove test associations

To unbind a TestComplete project from a Jira project

If your TestComplete project is not bound to a Jira project yet, click Connect to Zephyr Squad on the TestComplete toolbar.

On the resulting Properties > Zephyr Squad page, specify the credentials you use to connect to your Jira project, Zephyr API keys (if needed) and your Jira project:

Click the image to enlarge it.

Tip: You can set the connection settings as your default project properties. All the projects you will create later will have these properties specified. You can then modify them on the Properties > Zephyr Squad page of those projects, if needed.

1. Add automated tests (for example, script routines or keyword tests), to your project’s Execution Plan. To learn how to do this, see Execution Plan -Test Items - Common Tasks.

2. Mark the test items you want to use for automation as test cases in the Execution Plan editor.

3. Click the ellipsis button in the Link to external test case column of the added test item.

   If your project is already bound to Zephyr Squad, select the needed Zephyr test case in the resulting Link to external test case wizard:

   

   Click the image to enlarge it.

   Otherwise, in the Link to external test case wizard, first, specify the connection settings. If the specified connection settings are valid, TestComplete will retrieve a list of available Zephyr test cases. Select the needed test case:

   

   Click the image to enlarge it.

   – or –

   Type the needed Zephyr test case key manually using the following format:

   zfj://<your_test_case_key>

   Your TestComplete project must be bound to a Jira project. To learn how to do it, see above.

If you use script tests, you can mark script routines or even arbitrary code fragments as test cases and send their results to your Jira project directly from the code:

Your TestComplete test project must be bound to a Jira project as described above.

1. Open your script units, analyze your code and learn which routines and code fragments match your Zephyr test cases.

2. To mark the beginning of the code whose results you want to send to Jira, use the aqTestCase.Begin method. Specify the name that will be used to post the results to the TestComplete test log and specify the Zephyr test case to which you want to assign the results, in the zfj://<test-case-key> format.

   aqTestCase.Begin("My test", "zfj://PROJ-1")

3. To mark the end of the needed code, use the aqTestCase.End method.

For example, in the code snippet below, the aqTestCase.Begin and aqTestCase.End methods mark part of the Main script routine as a separate “Create an order” test case and send its test results to the OR-1 test case in a Jira project:

def main():
  page = Aliases.browser.page 
  
  #...
  
  # Sets the beginning of the "Create an order" test
  aqTestCase.Begin("Create an order", "zfj://OR-1");

  page.Aspnetform.table.cell1.linkOrder.Click()
  #...
  page.Wait()
  
  # Sets the end of the "Create order" test
  aqTestCase.End()
  
  table = page.Aspnetform.table.cell.panelContent.panel.table
   
  #...
  
  Aliases.browser.Close()

When you run the main routine, TestComplete will treat all the code between the aqTestCase.Begin and aqTestCase.End methods as a separate test, send its results to Jira, and assign it to the specified Zephyr test case.

In TestComplete, click Reporting to Zephyr Squad on the TestComplete toolbar.

– or –

If you run your tests by using the command line, use the /DisableExternalReporting command-line argument.

If the test is assigned to a Zephyr test case in the project’s Execution Plan editor, clear the test’s Link to external test case column.

If the test is assigned to a Zephyr from code using the aqTestCase.Begin and aqTestCase.End methods, remove the method calls from your code.

To temporary unbind a TestComplete project from a Jira project, click Reporting to Zephyr Squad on the TestComplete toolbar.

To unbind the project completely:

1. Open the Execution Plan editor of your project and remove test item associations (see above).

2. Open the Properties > Zephyr Squad page of your project and clear the connection settings.

3. Save the changes.

TestComplete will stop sending test results to your Jira project.