Example plugin: Build Katalon Studio's TestRail Integration plugin

Setting page

The below image shows the setting page to set up the TestRail configuration plugin. Fill in the details and click on Apply and Close button.

Add an icon to the toolbar

Use the following code to add the icon to the toolbar.

<extension
        point="com.katalon.platform.extensions">
    <point
            id="com.katalon.plugin.testrail.TestRailToolItemDescription"
            extensionPointId="com.katalon.platform.api.extension.newToolItem"
            implementationClass="com.katalon.plugin.testrail.TestRailToolItemDescription">
    </point>
</extension>

Add a setting page

Use the following code to Add a setting page.

<extension
      point="com.katalon.platform.extensions">
  <point
        id="com.katalon.plugin.testrail.TestRailPluginPreferencePage"
        extensionPointId="com.katalon.platform.api.extension.pluginPreferencePage"
        implementationClass="com.katalon.plugin.testrail.TestRailPluginPreferencePage">
  </point>
</extension>

Link Katalon Studio’s Test Cases with TestRail’s Test Cases

To verify this, open the test case, then click on the integration section at the bottom.

Below is the code for the same.

<extension
        point="com.katalon.platform.extensions">
    <point
            id="com.katalon.plugin.testrail.TestRailTestCaseIntegrationPage"
            extensionPointId="com.katalon.platform.api.extension.testCaseIntegrationViewDescription"
            implementationClass="com.katalon.plugin.testrail.TestRailTestCaseIntegrationViewDescription">
    </point>
</extension>

Execute Test Cases selectively based on TestRail’s settings

Use the following code to get this feature:

<extension
        point="com.katalon.platform.extensions">
    <point
            id="com.katalon.plugin.dynamic_execution.TestRailFilteringTestSuiteImpl"
            extensionPointId="com.katalon.platform.api.extension.dynamicQueryingTestSuiteDescription"
            implementationClass="com.katalon.plugin.testrail.TestRailQueryingTestSuite">
    </point>
</extension>

Sending result to TestRail

Use the code below to implement this:

<extension
        point="com.katalon.platform.extensions">
    <point
            id="com.katalon.plugin.testrail.TestRailEventListenerInitializer"
            extensionPointId="com.katalon.platform.api.extension.eventListener"
            implementationClass="com.katalon.plugin.testrail.TestRailEventListenerInitializer">
    </point>
</extension>

Frequently Asked Questions

How do I get the integration key in TestRail?

Fill in your TestRail username. Log in as an Admin account and go to "My Settings," then to the "API Keys" tab.

Can TestRail run automated tests?

You may add a new button to the TestRail UI to activate automated test runs using UI scripts. When you click it, an HTTP request is sent to the executor, which begins the automated tests.

Is TestRail a test management tool?

TestRail is a web-based solution for managing test cases. It is used to monitor, track, and organize software testing activities by testers, developers, and team leads.

Conclusion

To sum up the article, today, we learned about the TestRail plugin and its features and to build the Katalon Studio’s TestRail Integration plugin.

We hope that this blog has helped you understand the Katalon Studio and its working. To learn more about Katalon and its several features, you can refer to

• Mobile Testing in Katalon Studio | Learn & Practice from Coding Ninjas Studio 
• WebUI Testing in Katalon Studio | Learn & Practice from Coding Ninjas Studio 
• Mobile Test Design in Katalon Studio | Learn & Practice from Coding Ninjas Studio
   

You can also visit our website to read more such blogs. Make sure you enroll in the courses we provide, take mock tests, solve problems, and interview puzzles. Also, you can prepare for interviews with interview experiences and an interview bundle.

Keep learning and keep growing, Ninjas!