Configure qTest Integration In Katalon Studio

Enabling qTest Integration in Katalon Studio

qTest is an ultimate test management tool. Integrating it with Katalon will help in better managing test cases.

Follow the below steps to integrate qTest integration:

Step 1: The first step is to install the qTest integration plugin. You can find this plugin in the Katalon store.

Step 2: Open Katalon and activate the qTest plugin. Click on the Profile icon to activate the plugin and select the Reload plugin option. 

Step 3: The last step is to open the qTest integration settings and tick the Enable Integration checkbox. 

Congratulations! You have successfully enabled qTest integration.

Set up qTest integration in Katalon Studio​

After enabling qTest, we now set up the integration in Katalon. There are two ways to do this setup, either manually or using a setup wizard. Let us learn about each method.

Set up qTest integration via the Setup Wizard​.

Follow the below steps to set up using the qTest Integration setup wizard.

Step 1: After you check tick the Integration checkbox, a pop-up window will appear. It will ask you to open a setup wizard. Clicking Yes will open up a setup wizard dialog box.

You will now see a total of 5 sections you need to fill. 

Step 2: The first section is the Authentication section. This section will verify you as a valid qTest account holder. Choose your qTest version and enter the qTest account details. After entering the correct information, click Connect Account to verify. 

Step 3: Select your project in the second section, qTest project.

Step 4: The third section is the Test Structure Mapping section. In this section, we map the tests between the two systems. It consists of three parts which we look at in detail.

1. The first one is the qTest module section. This section allows you to store the uploaded test cases. You should select your required qTest module.
    
2. As the next step, you go to the Katalon Test Case Folder section. You select a test case folder that integrates with your selected qTest module. 
    
3. The last part is the Katalon Test Suite Folder. You can choose a test suite folder if you wish to integrate it with the chosen qTest module.

 

Step 5: The last section is the Executions Option. This section allows you to select your desired settings for uploading test cases to qTest. 

After completing the above steps, click Finish to end the process.

Set up qTest integration manually​

Let us now learn how to set up qTest manually. Follow the below steps.

Step 1: Go to the Authentication section and select your qTest version. You will now need to generate a token for authentication. You can do so by either logging in with a username and password or by using an SSO token. 

Step 2: Login With Username and Password: 

1. Start by clicking Generate. The Generate New Token dialog box will appear.
    
2. Fill the correct qTest account details and click Generate again. This step will generate the token.

 

Step 3: Login With SSO token:

1. SSO stands for Single Sign-On token. To use this token, you need to have a bearer token value. Open the qTest manager, and sign in to your account. 
    
2. Open the download qTest Resources page and go inside the API and SDK section. You will find the bearer token value there. 
    
3. Copy and paste the token format into the token test field.
    

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

 

Step 4: Now you will find a list of test submission options. You can select the options according to your requirement. 

Step 5: If you also wish to conduct a mapping of test cases, follow the steps below:

1. You can map qTest modules with the test case folders inside the Test Case Repositories tab. You can find this tab inside the qTest directory present inside the plugins folder.
    
2. Click Add. This step will open the Create Test Case Repository dialog box.
    
3. Choose your required qTest module and the Katalon folder containing the test cases to be mapped. Then click Ok. Your test cases are now mapped to your qTest module. 

 

Step 6: To map test suites, follow the below steps.

1. Open the Test Suite Repositories and click Add. The Create Test Suite Repository dialog box will appear.
    
2. Choose the qTest module and the test suite you wish to map. Click OK.

 

Your test suite is now mapped to your qTest project.

Map test status between qTest and Katalon Studio

Follow the below steps to map the test status between the two tools.

Step 1: Open your qTest module and activate the Automation Integration settings. Now map the automation status to the test run status in qTest.

Step 2: Open Katalon Studio and go to Execution Status Mapping. Now check the qTest API’s status column. You have to input the value that matches Automation Status correctly.

Congrats! You have now successfully mapped the test status between qTest and Katalon Studio.

Manage test cases between qTest and Katalon Studio

Uptill now, we have successfully integrated qTest and Katalon. Let us now learn how to manage interactions between the test cases in the two platforms. If we want to submit test results from Katalon Studio to qTest, we must have the test cases in both tools. 

Considering this statement, one of the three cases may arise:

Step 1: The test cases are present in Katalon but not in qTest. In this case, we upload the Katalon test cases to qTest.

Step 2: The second case is the opposite of the first one. Here we have test cases present in qTest but not in Katalon. We can simply download the test cases from qTest in Katalon.

Step 3: If you have test cases in both Katalon and qTest, then you just need to map the test cases using the database ID.

Let us now consider all these three cases one by one.

Upload Katalon Studio test cases to qTest​

We can upload a single test case or a complete set of test cases to qTest.

To upload a single test case to qTest, follow these steps.

Step 1: Open the Tests Explorer panel and right-click on the test case you want to upload. Select qTest > Upload.

Step 2: You can also go to the Integration tab of the test case and click Upload.

To upload a test case folder to qTest, go to the Tests Explorer panel and right-click on the required folder. Select qTest > Upload.

Good going, ninja! Your test cases/folders are now uploaded.

Download qTest test cases to Katalon Studio​

If you want to download test cases from qTest in Katalon studio, follow these steps.

Step 1: Go to the Test Design tab in qTest. Bring the test cases into the qTest module that is linked to Katalon.

Step 2: Now switch to Katalon Studio and download the test case/folder.

Step 3: A preview dialog box will appear where you can choose the test cases to download. Select the test cases and click Ok.

Once downloaded, you can view the test cases in the integrated test folder.

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

In this section, we will learn how to map Katalon’s test case to a qTest test case using the database ID in a few simple steps.

Step 1: In qTest, you can find your test case database ID in the test case URL.

Step 2: Choose a test case to link to the qTest test case above. Use the following format to add the value. <qTest Database ID> <Katalon test case name>.

Step 3: Go to the test case editor and open the Integration tab. Now click on the Link qTest test case. 

Step 4: Save your changes. 

Your test cases are linked to qTest successfully.

Manage qTest test cases version and synchronization​

Now, it may happen that a linked test case gets updated in qTest. Therefore, we need to update it in Katalon and fetch the latest version. 

Let us first learn to check version updates in a group.

Step 1: Click the qTest icon on the menu bar and select Check For Updates.

Step 2: The Check For Updates dialog box will appear. Now select the test cases you want to check for updates and click OK. 

Step 3: The test engine will retrieve the information from the qTest server.

Check for version updates and sync test steps in a test case

Step 1: Go to the test editor and open the Integration tab. Click Check for Updates and fetch the latest version of the test case. 

Step 2: The qTest Integration Update dialog box will appear. Click Sync up if you want to save the latest state of the test steps and their version. 

Disintegrate Studio test cases from qTest​

Until now, we have learned to link test cases between Katalon and qTest. Let us now look at how to disintegrate the Katalon test cases from qTest.

Disintegrate a Katalon Studio test case from qTest

Follow the below steps to unlink a single test case from qTest.

Step 1: Open a test case, go to the Integration tab and click Disintegrate.

Step 2: A Confirmation dialog box will appear. Click OK. This step will break the connection between the qTest and the test case.

Disintegrate a test case folder from qTest

Follow these steps to unlink multiple test cases.

Step 1: Move all the test cases to a folder you wish to unlink.

Step 2: Once the test cases are moved into the folder, right-click on the folder and select qTest > Disintegrate.

Step 3: A Confirmation dialog box will appear. Click OK. All your test cases present in the folder are unlinked now.

Manage test suites between qTest and Katalon Studio

Good going, ninja! Till now, you have successfully linked your test cases with qTest. But the work is not done. Now, we need to upload the test suites to qTest. We can do this either manually or automatically. 

Upload Katalon Studio test suites to qTest automatically​

Follow the below steps to upload your test suites automatically. 

Step 1: Go to the Integration tab of the test suite and click on the New Parent button.

Step 2: A dialog box will appear. Here, choose the location to link with the test suite.

Step 3: Here, you also will find the Creation Options section. This section allows you to 

automatically select an option out of a pair of options to upload the test case.

Step 4: Click OK. You will now see the name and location of the parent folder on qTest.

Your test suite would connect successfully if you correctly filled in all the information. Information related to Parent ID, Alias, and Test Suite ID will be visible. 

Upload Katalon Studio test suites to qTest manually​

Let us see how to manually upload a test suite or a group of test suites in a folder to qTest. Follow these steps.

Step 1: Go to the Integration tab of the test suite and click on the New Parent button.

Step 2: A dialog box will appear. Here, choose the parent folder and select the location to link with the test suite.

Step 3: Look at the Creation Options section and choose the Create only option. This step connects the test suite to the selected qTest location. 

Step 4: Now, to upload the test suite, right-click on it and choose qTest > Upload. 

Step 5: After the uploading process completes, go to qTest by clicking Navigate and check if the test suites are uploaded to the registered qTest locations.

Disintegrate test suites from qTest​

Just like a single test case, we can also unlink a test suite or a group of test suites from qTest.  Let us learn both these methods.

Disintegrate a test suite from qTest

Step 1: You can simply right-click on the test suite you want to unlink. Select qTest > Disintegrate. Alternatively, you can also open the Integration tab, select a qTest location, and click Disintegrate.

Step 2: A Confirmation dialog box will appear. Click OK. The connection is now broken.

Disintegrate a test suite folder from qTest

If you want to unlink multiple test suites, transfer them to a test suite folder. Open the Tests Explorer and right-click on the test suite folder. Select qTest > Disintegrate. A Confirmation dialog box will appear. Click OK. All the test suites present in the folder are now disconnected from qTest. 

Generate qTest - Katalon Studio Parity Reports

Katalon also allows you to generate qTest parity reports. Follow these steps.

Step 1: Open the project settings, and go to Plugins > qTest. Check the Generate the parity report after test execution box. Katalon starts to generate test suite and collection reports. 

These reports quickly check test step contents and the version control of the test cases integrated between the two systems. 

Step 2: You can view the generated parity reports inside the reports folder of your project. 

Frequently Asked Questions

What is the significance of the Accept Alert keyword in Katalon?

Accept Alert (acceptAlert()) is a WebUI keyword in Katalon. It provides popups for alerts, confirmation, and prompt messages. The users just click the OK button, and the popup disappears.

What is the use of the Authentication keyword in Katalon?

Authentication is a Web UI keyword in Katalon. The system will enter the username and password if you go to a page requiring authentication.

How do you find a particular element in a Windows application while testing?

We can find a particular element or a group of elements using the findElements() keyword. It finds the element using the locator value of that element. For example, Windows.findElements(‘toggle_btn’).

Conclusion

Hey Ninja! We hope you enjoyed reading this article. We started our discussion with how to enable qTest integration. Further, we discussed how to map test cases and upload test results. You should now be able to configure qTest Integration in Katalon Studio.

If you wish to learn more about Katalon and its various testing divisions, you can refer to blogs on 

• Web services test design in Katalon.
• Mobile test design in Katalon. 
• WebUI testing in Katalon 
• Tests and Projects in Katalon, and
• STS Download

 

Do visit our website to read more such blogs. Make sure you enroll in our courses. You can take mock tests, solve problems, and interview puzzles. Also, you can check out some exciting interview stuff- interview experiences and an interview bundle for placement preparations. Do upvote our blog to help fellow ninjas grow.

Keep Grinding! 🦾

Happy Coding! 💻