qTest Integration

Requirements:

  • Katalon Studio version 7.0.1 onwards.
  • An active Katalon Studio Enterprise license. To learn more about activating your Katalon Studio license, you can refer to this document: Activate Katalon license.

Install the qTest Integration plugin

Download and install the qTest Integration plugin from the Katalon Store here: qTest Integration.

Return to Katalon Studio and activate your plugin. To do so, click on the Profile icon, then click Reload Plugin. If you want to use the plugin in console mode, refer to this document: Use Plugins in Console Mode.

Enable qTest integration

  1. Open the qTest integration settings:
  • For Katalon version 7.5.5 onwards: Go to Project > Settings > Plugins > qTest
  • For versions older than 7.5.5: Go to Project > Settings > Integration > qTest
  1. Check the Enable integration checkbox.

    Enable qTest integration

Configure qTest integration

Notes:

  • From version 7.9.0 onwards, Katalon Studio supports pushing screenshots (PNG files) to qTest to generate reports.

You can configure qTest integration manually or with the Setup Wizard as follows:

Setup Wizard

To open the setup wizard, after checking the Enable Integration box, click Yes in the pop-up window.

The Wizard Setup box

Alternatively, you can also click on the Quick Setup... hyperlink.

The Wizard Setup hyperlink

In the displayed qTest Integration Setup Wizard dialog, complete all items to finish the setup.

  1. Select your qTest version and enter you qTest account for authentication information. Once your qTest account is connected successfully, proceed to step 2.

    Notes:

    • In the version options, we recommend selecting 7 or higher. This is because earlier versions might be deprecated soon.
    Choose qTest version in the Wizard Setup box
  2. Select your qTest project.

    Select qTest project in the Wizard Setup box
  3. In the Test Structure Mapping section, you need to map the tests between the two systems.

    3.1. In the qTest module section: select one of the qTest modules fetched from your account to store the uploaded Katalon test cases.

    Choose qTest module in the Wizard Setup box

    3.2. In the Katalon Test Case folder section: select a test case folder to integrate with the qTest module from step 3.1.

    Choose test case folder in the Wizard Setup box

    3.3. In the Katalon Test Suite folder section: select a test suite folder to integrate with the qTest module from step 3.1.

    Choose test suite folder in the Wizard Setup box
  4. In the Execution Options section, choose the settings for uploading results to qTest.

    Execution Options
    Field Description
    Automatically submit test run result Results of executed test cases are uploaded automatically to qTest.
    Submit test run result to the latest approved version Test run results are submitted to the latest approved version of the mapped qTest test case.
    Report format Additional attachments for reports to be upload to qTest.
  5. Click Finish.

Manual Setup
  1. In the Authentication section, select your qTest version.

    Notes:

    • In the version options, we recommend selecting 7 or higher. This is because earlier versions might be deprecated soon.
    Authentication in the Manual Septup
  2. To generate a token for authentication, you can choose either log in with username and password or with an SSO token.

    Log in with username and password
    • Click Generate. The Generate new token dialog opens.
    Generate new token dialog
    • Fill in your qTest account information. Then click Generate.
    Fill in account information
    • KS connects to qTest using the provided information. The token is generated.
    Log in with SSO token
    • If you are using Single Sign-On (SSO) to log in to qTest, ignore the Generate button, copy and paste the following token format in the Token text field:

    {"access_token":"<bearer_token_value>","token_type":"bearer","scope":"read write create delete administration execute import export share baseline"}

    • To find the <bearer_token_value>, access qTest Manager. Sign in with your SSO account. Navigate to the Download qTest Resources page. In the API & SDK section, you can see the Bearer Token value.
    Bearer token
  3. Select your preferred test submission method from the following options:

    Submitting options
    Field Description
    Automatically submit test run result Results of executed test cases are uploaded automatically to qTest.
    Submit test run result to the latest approved version Test run results are submitted to the latest approved version of the mapped qTest test case.
    Report format Additional attachments for reports to be upload to qTest.
  4. Conduct test case mapping.

    • To create mappings between qTest modules and Katalon Test Case folders, go to Project > Settings > Plugins > qTest > Test Case Repositories.
    Test case mapping
    • Click Add. The Create Test Case Repository dialog opens.

    • Choose your qTest project and module, then browse the Katalon folder for the test case you wish to map with.

    • Click OK when you are done.

      Browse mapping test cases
  5. Conduct test suite mapping.

    • To create mappings between qTest projects and Katalon Test Suite folders, go to Project > Settings > Plugins > qTest > Test Suite Repositories.

      Enable HTML reports
    • Click Add. The Create Test Suite Repository dialog opens.

    • Choose your qTest project, and browse the Katalon folder for the test suite you wish to map with.

    • Click OK when you are done.

      Enable HTML reports

      Notes:

      • You should select test suites that contain test cases defined in the Test Case Repositories settings.

qTest - Katalon Studio parity report

Requirements:

  • Katalon Studio version 7.8.0 onwards.

To enable parity reports generation, go to Project Settings > Plugins > qTest, check the Generate the parity report after test execution box.

Parity reports

Katalon Studio will generate test suite and test suite collection reports when you turn on this setting. This parity report provides a quick check of the version and test step contents of your integrated test cases between two systems.

Notes:

  • Only test cases with a unique ID are counted. Duplicate test cases are counted as one.

To view the generated parity report, open the <your-project-folder>/Reports folder.

Open the parity report in the project folder

Execution Status Mapping

Requirements:

  • Katalon Studio version 7.9.0 onwards.
  1. To submit execution results from Katalon Studio to qTest Manager, activate the Automation Integration settings and map the automation status to the test run status in qTest. You can learn more about activating the Automation Integration settings in the Tricentis document here: Activate Automation Integrations.

    Map test status in qTest

    Click the image to enlarge it.

    Map test status in Katalon Studio

    Click the image to enlarge it.

  2. Map the Katalon Studio test status to the qTest test status.

    To do so, in Katalon Studio, go to Project > Settings > Plugins > qTest > Execution Status Mapping. In the qTest API's status column, input the value that matches the Automation Status you configured earlier from step 1.

    Map test status in Katalon Studio

Upload test cases to qTest

Katalon allows you to upload a test case or all test cases in a test case folder to qTest.

Upload a test case to qTest

Requirements:

  • The test case you wish to upload must be located in the integrated test case folder with qTest. To learn more about integrating a test case folder with qTest, refer to step 4 in Manual Setup. See above: Manual Setup.

To upload a test case to an integrated qTest module, do as follows:

  • In the Tests Explorer panel, right-click on the test case to trigger its context menu. Select qTest > Upload.

    Upload a test case
  • Alternatively, you can also navigate to the Integration tab of the test case. Click Upload.

    Upload a test case
  • Uploaded test cases have a qTest icon at the bottom right of the icon as shown below:

    Upload a test case
  • You can also go to qTest to verify whether the Katalon Studio test case is successfully uploaded to the integrated qTest module.

    Upload a test case
  • You can also see the following information in the Integration tab of the integrated test case.

    Test case information
    Field Description
    Test Case ID The ID of the integrated qTest test case.
    Alias The alias of the integrated qTest test case.
    Parent ID The ID of the integrated qTest module.
    Version The qTest test case version.

    Tips:

    • You can quickly open the integrated test case in qTest by clicking Navigate.

Upload a test case folder to qTest

Requirements:

  • The test case folders you wish to upload should be added in Project > Settings > Plugins > qTest > Test Case Repositories. To learn more about adding a test case folder in the Test Case Repositories, refer to step 4 in Manual Setup. See above: Manual Setup.
  • In the Tests Explorer panel, right-click on the test case folder to trigger its context menu. Select qTest > Upload.

    Upload test case folder
  • The uploaded test case folder and test cases have a qTest icon at the bottom right of the icon as shown below:

    Upload test case folder
  • Alternatively, you can go to qTest to verify whether the Katalon test cases within the selected folder are successfully uploaded to the integrated qTest module.

    Upload test case folder

Download qTest test cases to Katalon

  1. In qTest, switch to the Test Design tab. Move the test cases you wish to download into the qTest module that is integrated with Katalon Studio. 

    For example, we want to download the Login_myAccount test case to Katalon Studio. We move it to the Login qTest module, which we have integrated with Katalon Studio beforehand.

    Move test case to the integrated folder in qTest
  2. Switch to Katalon Studio. In the Tests Explorer panel, right-click the test case folder that is integrated with the above qTest module. Select qTest > Download.

    Download qTest test case
  3. The Downloaded test case preview dialog opens. You can see all test cases in the integrated qTest module that are available for download. Select the test case you want to download. Click OK to continue.

    Downloaded test case preview

    Notes:

    • Test cases that are downloaded will not be displayed again.
  4. Once the downloading process is finished, you can view the downloaded test cases in the integrated test case folder.

    View downloaded test cases

Disintegrate test cases from qTest

Katalon allows you to disintegrate a test case or all test cases in a test case folder from qTest.

Disintegrate a test case from qTest

You can break the connection between a Katalon Studio test case and qTest by following the steps below:

  1. To disintegrate a test case from qTest, navigate to the Integration tab of the test case. Click Disintegrate.

    Disintegrate a test case from qTest

    Alternatively, you can right-click the test case you wish to disintegrate, select qTest > Disintegrate.

    Disintegrate a test case from qTest
  2. In the Confirmation dialog, click OK. The connection between the test case and qTest is removed.

Disintegrate a test case folder from qTest

You can break the connection between a Katalon Studio test case folder and qTest by following the steps below.

Notes:

  • Disintegrate a test case folder from qTest will also disintegrate all test cases in the folder from qTest.
  1. To disintegrate a test case folder from qTest, in the Tests Explorer view, right-click the test case folder you wish to disintegrate. Select qTest > Disintegrate.

    Disintegrate a test case folder from qTest
  2. In the Confirmation dialog, click OK. The connection between the test case folder and qTest is removed.

Upload test suites to qTest

Requirements:

  • The test suite you wish to upload to qTest should be located in the integrated test suite folder with qTest. To learn more about integrating a test suite folder with qTest, refer to step 5 in Manual Setup. See above: Manual Setup.

Register a qTest location for a test suite

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

    Register a qTest location for a test suite
  2. The Create Test Suite's parent dialog opens. Select a Parent folder, then choose the location to integrate with the Katalon test suite.

    Choose the parent folder
  3. In the Creation Options section, you can decide the integration behavior with the following options:

    Creation options
    Option Description
    Create only - Create an association between the Katalon test suite and the selected qTest location.
    - With this option, if you want to upload the Katalon test suite to the selected qTest location, you need to do it manually. See below: Upload a test suite manually
    Create and upload - Create an 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 an 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 the execution result of the Katalon test suite.

    Notes:

    • A test suite can be registered in many qTest locations, but only one qTest location can be set as default.
  4. Click OK to continue.  Once integrated, you can see the location and the name of the parent folder on qTest.

    Register a qTest location for a test suite
    Icon Description
    Successfully integrated icon The Katalon test suite is integrated with the qTest location.
    Unsuccessfully integrated icon The Katalon test suite is not integrated with the qTest location.

    You can also view the integration information, including Parent ID, Test Suite ID, and Alias, as shown below:

    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.

    Tips:

    • You can quickly open the uploaded test suite in qTest by clicking Navigate.
    Quickly navigate to qTest

Upload test suites manually

Notes:

  • Suppose you choose the Create and upload or the Create, upload and set as default option while registering a qTest location for a test suite. In that case, your test suite is automatically uploaded to the registered qTest location. You can skip this part.

Katalon allows you to upload a test suite or all test suites in a test suite folder to qTest.

  1. Upload a test suite manually:

    Requirements:

    • Make sure all test suites have at least one registered qTest location.
    • The selected test suites have not been uploaded yet.
    • To upload a test suite manually to the predefined qTest location, navigate to the Integration tab of the test suite. In the List of test suite's parents, select a qTest location, then click Upload.

      Upload test suites manually
    • Alternatively, you can also right-click on the test suite to trigger its context menu. Select qTest > Upload.

      Upload test suites manually
    • Once the uploading process finishes, you can go to qTest to verify whether the Katalon test suite is successfully uploaded to the registered qTest location.

      Upload test suites manually
  2. Upload a test suite folder manually:

    Requirements:

    • Make sure all test suites in the test suite folder have at least one registered qTest location.
    • At least one test suite in the selected test suites folder has not been uploaded yet.
    • In the Tests Explorer panel, right-click on the test suite folder to trigger its context menu. Select qTest > Upload.

      Upload test suites folder manually
    • Once the uploading process finishes, you can go to qTest to verify whether the Katalon test suites in the selected folder are uploaded to the registered qTest locations.

      Upload test suites folder manually

Disintegrate test suites from qTest

Katalon allows you to disintegrate a test suite or all test suites in a folder from qTest.

Disintegrate a test suite from qTest

You can remove the integration between the Katalon test suite and the registered qTest location by following the steps below:

  1. To remove the connection between a test suite and the registered qTest location, navigate to the Integration tab of the test suite. Select a qTest location, click Disintegrate.

    Disintegrate a test suite from qTest

    Alternatively, you can also right-click on the test suite you wish to disintegrate. Select qTest > Disintegrate.

    Disintegrate a test suite from qTest
  2. Click OK on the Confirmation dialog. The integration between the test suite and the registered qTest location is removed.

Disintegrate a test suite folder from qTest

You can break the connection between a Katalon Studio test suite folder and qTest by following the steps below:

Notes:

  • Disintegrate a test suite folder from qTest will also disintegrate all test suites in the folder from qTest.
  1. In the Tests Explorer view, right-click on the test suite folder you wish to disintegrate. Select qTest > Disintegrate.

    Disintegrate a test suite from qTest
  2. Click OK on the Confirmation dialog. The integration between the test suite folder and qTest is removed.

Upload test execution results

Requirements:

  • The associated test case is uploaded to qTest. For further instructions, see above Upload test cases to qTest.
  • The associated test suite is uploaded to qTest. For further instructions, see above Upload test suites to qTest.
  • A registered qTest location for the associated test suite is set as default.
  • The qTest test case version is at least 1.0.

Upload test results automatically

  1. To automatically upload the test execution results, check the Automatically submit test run results option in Project > Settings > Plugins > qTest.

  2. Add an uploaded test case to an uploaded test suite.

  3. Execute an uploaded Katalon test suite.

  4. Open the generated test execution report.

  5. In the Test Cases Table section, the status of all test execution is displayed with the following information.

    the Test Cases Table section
    Icon Description
    Successfully uploaded icon The execution result of the test case is uploaded to qTest.
    Unsuccessfully uploaded icon The execution result of the test case is not uploaded to qTest.
  6. To find the qTest information, click Show Test Case Details. In the Test Case's Log table, go to the Integration tab.

    Show test case details

    You can view the following information:

    Field Description
    Test Run Alias The alias of the integrated qTest test run.
    Test Log ID The ID of the test log created in qTest, for example, execution history record.
    Attachment This lets users know whether all the execution logs and reports are sent to qTest as an attachment. (i.e., Yes or No)
    If yes, you can go to qTest and find them under the related execution history record, as illustrated below:

    Click the image to enlarge it.

Upload test case results manually

  1. Add an uploaded test case to an uploaded test suite.

  2. Execute the uploaded Katalon test suite.

  3. Open the generated test execution report.

  4. In the Test Cases Table section, right-click the test case you wish to upload the test result. Select qTest > Upload.

    Upload test case results manually
  5. Once the uploading process is finished, you can go to qTest to verify whether the test execution is uploaded successfully to qTest test run.

    Upload test case results manually

Upload test suite results manually

  1. In the Tests Explorer panel, open the Reports folder. Right-click the test execution result you wish to upload. Select qTest > Upload.

    To upload all test executions, you can right-click the Report folder, select qTest > Upload.

    Upload test suite results manually
  2. Once the uploading process is finished, you can go to qTest to verify whether the test execution is uploaded successfully to the qTest test run.

qTest Test Cases Version Control and Synchronization

Requirements:

  • Katalon Studio version 7.8.0 onwards.
  • The qTest integration enabled.
  • The associated test case is uploaded to qTest. For further instructions, see above Upload test cases to qTest.

Katalon allows you to check which Katalon Studio test cases need updating when the integrated qTest test cases change the test step content. You can do so with one or many test cases. In each Katalon test case, you can also retrieve the latest content of the integrated qTest test case.

Check for version updates in bulk

  1. Click on the qTest icon on the menu bar.

  2. Select Check for updates.

    Upload test suite result manually
  3. In the Check for updates dialog, select test cases you wish to check for update. Click OK.

    The check for update dialog

    Wait for the test engine to retrieve information from the qTest server.

    Check for version updates

    Click the gif to enlarge it.

Check for version updates in a test case

In a test case editor, open the Integration tab, click Check for updates to fetch the latest qTest test case version and test steps content. Wait for the test engine to retrieve information from the qTest server.

Check for version updates in a test case

Wait for the test engine to retrieve information from the qTest server. If you wish to save the latest content of test steps and test case version, in the pop-up qTest Integration Update dialog, click Sync up.

Check for version updates

Click the gif to enlarge it.

Map a Katalon test case to a qTest test case by database ID

Requirements:

  • Katalon Studio version 7.9.0 onwards.
  • qTest integration enabled.
  • The Katalon test case must be located in the integrated test case folder with qTest. To learn more about integrating a test case folder with qTest, refer to step 4 in Manual Setup. See above: Manual Setup.

Katalon Studio provides an easy way to map a Katalon test case to an existing qTest test case. Follow these steps:

  1. In qTest, you can get a qTest test case database ID in the test case URL.

    Get qTest test case database ID in qTest
  2. In Katalon Studio, select a test case you want to link to the above qTest test case. Add the copied value to its name in the following format: <qTest Database ID> <Katalon test case name>.

    Copy ID database in the test case
  3. Open the test case editor, select the Integration tab.

  4. Click Link qTest Test Case.

    Link qTest Test case
  5. Save your change when the test case is linked to qTest successfully.

    Link qTest Test case successfully

Feedback