Upload test execution results from Katalon Studio to TestRail

Katalon Studio supports uploading test execution results of a test suite to TestRail as a Test Run in two ways:

• To a new Test Run: By prefixing the test suite name with S<ID>, where <ID> is a unique suite identifier. Katalon will create a new TestRail Test Run during execution.

• To an existing Test Run: By prefixing the test suite name with R<ID>, where <ID> corresponds to the ID of an existing Test Run in TestRail. The test results will be appended to that Test Run.

Requirements

• You have configured TestRail integration in Katalon Studio. See Configure TestRail integration in Katalon Studio

Upload test results to a new test run in TestRail

To upload test results from Katalon Studio to a new test run in TestRail, follow these steps:

1. In Katalon Studio, create a new test suite or a dynamic test suite.
2. Prepend the name of the test suite with the text S<ID>, where <ID> is the test suite ID of your choice.
   
3. Add the mapped test cases to the test suite.
   
4. Execute a test suite.
   A new Test Run is created in your TestRail project.

   

5. To view the Test Run details, click on the Test Run.
   
6. In case you want to upload multiple test results to TestRail at the same time, you can add mapped test suites to a test suite collection.
   
   Katalon Studio will generate separate Test Runs in TestRail in correspondence with the executed Katalon test suites.

Upload test results to an existing Test Run in TestRail

To upload test results to an existing Test Run in TestRail, follow these steps:

1. In Katalon Studio, create a new test suite or a dynamic test suite.
2. Prepend the name of the test suite with the text R<ID>, where <ID> is the Test Suite ID of your choice.
   To view the Test Run ID, open your TestRail project and click on the Test Run. The ID is displayed next to the Test Run name.
   We can see that R8 is the ID of the created Test Run.

   

   We prepend the Test Suite with the text R8 as follows:

   

3. Add the mapped test cases to the test suite.
   If you are executing a dynamic test suite, you can query test cases associated with an existing Test Run in TestRail. See Query test cases linked to TestRail in a dynamic test suite.
4. Execute a test suite.
   After we execute the Test Suite, the R8 Test Run is updated with new test results.

   

Best practices

To successfully upload test results from Katalon Studio to TestRail:

• Ensure mapped test cases are added to the test suite.
• The plugin must be properly configured in the Project > Settings > Plugins > TestRail section.
• A valid TestRail API token or password must be provided.
• All required custom fields must be configured with valid static values.
• Use a Test Suite Collection to upload multiple test suites simultaneously—each suite will be associated with its own Test Run in TestRail.

If the configuration is invalid or required fields are missing or incorrectly typed, the plugin will either:

• Skip uploading that field;
• Log a warning, or;
• Prevent the upload entirely depending on the severity of the mismatch.