qTest Integration

Starting from version 7.0.1, Katalon Studio supports qTest Integration plugin. Please visit our store to download this plugin and read more about its details.

Enable qTest Integration

  1. Open qTest integration settings at Project > Settings > Integration > qTest.

  2. Check the Enable integration checkbox. Next, you can either manually setup the qTest integration, or let the wizard do it for you.

Manual Setup

  1. qTest Version: On Authentication form, select the version of your qTest. (The 7 or higher option is recommended because APIs of earlier versions might be deprecated soon).

  2. Generate Token: Click on Generate button to create the token to be used during integration session.  Fill in valid information on the Generate new token dialog. For example: Once Katalon Studio successfully connects to your qTest using provided information, the token will be generated.

  3. Select other submitting options as following:

    Where:

    Field Description
    Automatically submit test run result Results of executed test cases will be uploaded automatically to qTest.
    Submit test run result to latest approved version Test run result will be submitted to latest approved version of mapped qTest test case.
    Report format Additional attachments for reports to be upload to qTest.
  4. Test Case Mapping: Select the Test Case Repositories setting. You can create mappings between qTest modules and Katalon Test Case folders here. Click on the Add command. The Create Test Case Repository dialog will be displayed. Click OK when you are done with the settings.

  5. Test Suite Mapping: Select the Test Suite Repositories setting. You can create mappings between qTest projects and Katalon Test Suite folders here. Click on the Add command. The Create Test Suite Repository dialog will be displayed. Click OK when you are done with the settings.

    You should select test suites that contain those test cases defined in Test Case Repositories settings

Wizard Setup

Click on the Quick Setup... link to open the Wizard.

  1. Enter authentication information and select your qTest version. Once your qTest account is successfully connected, proceed to step 2.

  2. Select your qTest project.

3.1. Select qTest module. This is the place to store uploaded Katalon test cases.

3.2. Select Katalon Test Case folder to be uploaded to the qTest module of step 3.

3.3. Select Katalon Test Suite folder to be integrated with qTest.

  1. Optional settings when uploading to qTest. Please refer to Manual Setup for more details of each option.

  2. Complete all previous steps to finish qTest setup wizard.

Upload test cases to qTest

Test cases folder must be registered in Test Case Repositories before you can upload test cases to qTest.

Upload a single test case

  1. You have two methods to upload a test case to predefined qTest Module

    1. Navigate to the Integration tab of the test case. Click on the Upload button.

    2. In the Tests Explorer view, right click on the test case to trigger its context menu. Select the qTest > Upload option.

  2. Uploaded Test Case will have qTest icon at the bottom right of the icon as shown below
     

  3. You can also go to qTest to verify that the Katalon Studio test case is uploaded to the integrated qTest module. Refer to Enable qTest Integration for details about setting up an integrated qTest module.

  4. Katalon Studio will also retrieve the information regarding the above qTest test case and display them in the Integration tab of the Katalon test case.

    Where:

    FieldDescription
    Test Case IDThe ID of the integrated qTest test case.
    AliasThe alias of the integrated qTest test case.
    Parent ID

    The ID of the integrated qTest module.

  5. Click the Navigate button to quickly open the integrated qTest test case from Katalon Studio.

Upload test case folder

Test cases folder must be registered in Test Case Repositories before you can upload test cases to qTest.

  1. In the Tests Explorer view, right click on the test case folder to trigger its context menu. Select the qTest > Upload option.

  2. Once the uploading process finished, you can verify by qTest icon at the bottom right of test case icon as shown below

    Or you can go to qTest to verify that the Katalon test cases within the selected folder are uploaded to the integrated qTest module.

Download qTest test case

  1. Select Test Design in qTest, move any test cases to be downloaded into the integrated qTest module. Refer to Enable qTest Integration for details about setting up an integrated qTest Module in Katalon Studio.

  2. In Tests Explorer of Katalon Studio, right click on the test case folder which is integrated with qTest module above (Refer to Enable qTest Integration for more details).
    Right Click > qTest > Download option from the context menu.

  3. The Downloaded test case preview dialog is displayed. All test cases within the integrated qTest module that are available for download are listed. Click OK to continue.

    Test cases that are already integrated will not be displayed again.

  4. Once the downloading process finished, you can view new integrated test cases in Tests Explorer of Katalon Studio.

Disintegrate a test case from qTest

Remove the connection between Katalon test cases and qTest test cases.

  1. You have two methods to break the connection between a test case and qTest:

    1. Navigate to the Integration tab of the test case. Click on the Disintegrate button.

    2. In the Tests Explorer view, Right click > qTest > Disintegrate.

  2. Click OK on the Confirmation dialog. The connection from this test case to qTest will be removed.

Disintegrate a test case folder from qTest

You can break the connection between a Katalon Studio test case folder (together with all its test cases) and qTest system by following the steps below:

  1. In the Tests Explorer view, right click on the test case folder. Select the qTest > Disintegrate.

  2. Click OK on the Confirmation dialog. The connection from this folder (and all its test cases) to qTest will be removed.

Register qTest location for test suite

The selected Katalon test suites folder must be registered in Test Suite Repositories settings before you can upload the test suites within to qTest.

  1. Navigate to the Integration tab of the test suite. Click on the New parent button.

  2. The Create Test Suite's parent dialog is displayed where you can select Parent folder.

    From the test structure, select the location to be integrated with the Katalon test suite then click OK to continue. Further options are as following:

    OptionDescription
    Create only
    • Create association between the Katalon test suite and the selected qTest location.
    Create and upload
    • Create association between the Katalon test suite and the selected qTest location.
    • Upload the Katalon test suite to the selected qTest location.
    Create, upload and set as default
    • Create association between the Katalon test suite and the selected qTest location.
    • Upload the Katalon test suite to the selected qTest location.
    • Set the qTest location as default for uploading execution result of the Katalon test suite.
  3. Once integrated, Katalon Studio will provide details information such as location and name of parent folder on qTest, integration information ( Parent IID, Test Suite ID, and Alias) as shown below:

    Where:

    Icon Description
    The Katalon test suite is integrated to the qTest location.
    The Katalon test suite is not integrated to the qTest location.

    If the selected qTest location is integrated, then the related information can be viewed in the Integration Information section where:

    Field Description
    Test Suite ID The ID of the integrated qTest test suite.
    Alias The alias of the integrated qTest test suite.
    Parent ID The ID of the integrated qTest location.
  4. You can also quickly navigate to qTest parent folder where the test suite(s) is uploaded by clicking on the Navigate button.

Upload test suites to qTest

Katalon Studio test suites are usually uploaded automatically by selected options in Creation Option when registering.There is a way to upload Katalon Studio test suite manually. Below instruction shows how to do it for a single test suite or test suite folder:

Upload single test suite

  1. You have two methods to upload a test suite to predefined qTest location:

    1. Navigate to the Integration tab of the test suite. Select a qTest location that is yet to be integrated from the List of test suite's parent and click on the Upload button.

    2. In the Tests Explorer view, right click on the test suite to trigger its context menu. Select the qTest > Upload option.

      The Upload option is available only when:

      + There must be at least one registered qTest location as Parent of Katalon Studio's test suite

      + Selected qTest location is NOT integrated yet.

      Please be cautious: Katalon test suite will be uploaded to all qTest locations that meet the above criteria accordingly.

  2. Once the uploading process finishes, you can go to qTest to verify that the Katalon test suite is uploaded to the registered qTest location.

Upload test suite folder

  1. In the Tests Explorer view, right click on the test suite folder to trigger its context menu. Select the qTest > Upload option.

    The Upload option is available only when:

    + There must be at least one registered qTest location as Parent of Katalon Studio's test suite

    + Selected qTest location is NOT integrated yet.

    Please be cautious: Katalon test suite folder will be uploaded to all qTest locations that meet the above criteria accordingly.

  2. Once the uploading process finishes, you can go to qTest to verify that the Katalon test suites within the selected folder are uploaded to the registered qTest locations.

Disintegrate a test suite from qTest

Remove the integration between Katalon test suites and its registered qTest locations.

  1. You have two methods to remove the connection between a test suite and registered qTest locations:

    1. Navigate to the Integration tab of the test suite. Select a qTest location and click on the Disintegrate button.
    2. In the Tests Explorer view, right click on the test suite to trigger its context menu. Select the qTest > Disintegrate option.
  2. Click OK on the Confirmation dialog. The integration between this test suite and all registered qTest locations will be removed.

Disintegrate a test suite folder from qTest

You can remove the integration between a test suite folder (together with all its test suites) and all registered qTest locations by following the steps below:

  1. In the Tests Explorer view, right click on the test suite folder to trigger its context menu. Select the qTest > Disintegrate option.
  2. Click OK on the Confirmation dialog. The integration between this folder (as well as all of its test suites) and qTest will be removed.

Upload test execution results

In order for a test execution to be uploaded to qTest, the following conditions need to be fulfilled:

  • The associated test case is integrated to qTest. Refer to Integrate test case for more details.

  • The associated test suite is integrated to qTest. Refer to Integrate test suite for more details.

  • The integrated qTest location is set as default. Refer to Integrate test suite for more details.

  • The version of qTest test case need to be at least 1.0. For example:

Upload test results automatically

The test result from Katalon Studio will be upload to qTest automatically in case the Automatically submit test run result option is checked in qTest Integration settings.

  1. Execute an integrated Katalon test suite.

  2. Open the generated test execution report.

  3. In the Test Cases Table, the status of all test execution will be displayed accordingly.


    Where:

    IconDescription

    The execution result of the test case is integrated to qTest.

    The execution result of the test case is not integrated to qTest.
  4. Select an integrated execution from Test Cases Table and you can find related information of qTest in Integration tab of Test Case's Log. (You need to select Show Test Case Details to access this section)

    where:

    FieldDescription
    Test Run AliasThe alias of the integrated qTest test run.
    Test Log IDThe ID of the test log (i.e., execution history record) created in qTest.
    Attachment

    This is to let users know whether all the execution log and report are sent to qTest as an attachment. (i.e. Yes or No)

    If yes, you can go to qTest and find them under related execution history record, as illustrated below:

Upload test results of a test case manually

  1. Execute an integrated Katalon test suite.

  2. Open the generated test execution report.

  3. In the Test Cases Table, right click on the test case to trigger its context menu. Select the qTest > Upload option.

  4. Once the uploading process finished, you can go to qTest to verify that the test execution is uploaded to qTest test run accordingly.

Upload test results of a test suite manually

  1. In the Tests Explorer view, right click on the test execution to trigger its context menu. Select the qTest > Upload option. (You can select the Upload option from Report folders to upload multiple test execution if needed)

  2. Once the uploading process finished, you can go to qTest to verify that all test execution are uploaded to qTest test runs accordingly.

Feedback