Course 5: Applause TestRail Integration

Learn how to integrate TestRail test case management system with Applause.

Applause TestRail Integration

Applause - TestRail Integration is an integration service between the Applause platform and TestRail test case management system to allow the transfer of test cases and results between the two platforms to keep the test cases and test results in sync for analysis and reporting.

The integration is based on TestRail APIs and comes with a few limitations. Please make sure to check the Limitations section below for more information.




What You Can Do

Once the integration is successful, you should be able to do the following:

  • Transfer test cases between the Applause platform and TestRail

  • Transfer test results to TestRail from the Applause platform (with TS team assistance)




What You Need

To set up the integration, you need the following things:

  • Cloud-hosted instance of TestRail (can be referred by a URL) with existing projects

  • A TestRail user account for syncing with Applause; we suggest using a separate account only for Applause

  • A TestRail API key. To create an API key in TestRail, please refer to this link

Setting Up the Applause TestRail Integration

There are four main steps required to integrate TestRail with the Applause platform.




Step 1: Establish the Connection
  1. Open Applause platform and click Account & Settings.

  2. Select Data Export and click the “New Connector” button.

  3. Provide a connector name and select “TestRail” as the connector type.

  4. Provide your TestRail URL, user account email and the API key.

  5. Click “Fetch Projects”.
    • If the connection is successful, your TestRail projects will be visible under Projects Mapping section

    • If the connection is not successful, check your TestRail instance and API key details






Step 2: Project Mapping

Next, the TestRail project needs to be mapped to the Applause Products.

  1. Select the TestRail project from the list.

  2. Next, select one or more Applause Products which you want to link to the selected TestRail project.

  3. Click “Save and continue”.

You need to create one connector for each TestRail project. Also, remember an Applause Product can be part of only one TestRail Project.




Step 3: Fields Mapping
  1. Moving on, map each Applause test case required field to a relevant TestRail field.
    • Select “None” if there’s no relevant TestRail field for a particular Applause field and provide a default value for the specific field

  2. Next, map the TestRail required fields to Applause fields.

  3. Map the optional fields similarly if you want.





Step 4: Test Case Results Mapping
  1. Finally, map each Applause test case result field to a relevant TestRail field.

  2. Review the fields and test results mapping carefully.

  3. Click “Save” to save the connector and all configurations.

Your TestRail instance is now successfully integrated with the Applause platform.





Limitations
  • Applause TestRail connector uses TestRail APIs based on TestRail release 7.1 and above. We recommend connecting to the cloud based TestRail instance versus on-premise installation which might have an older TestRail version

  • Applause TestRail connector can map a single TestRail project to one or more Applause products. However, you can use multiple connectors if you have multiple TestRail projects

  • Once the Project to Products mapping of a TestRail connector is saved, it cannot be changed. If any changes are needed, then the connector should be deleted and a new connector needs to be set up

  • The TestRail connector doesn’t provide any conflict detection or resolution when the same test case has different changes across the systems. The imported test case will override the existing one

  • Transferring test results feature is not available in the Applause platform. Consult with your SDM if you want to transfer test results to TestRail




Best Practices
  • We strongly recommend that you establish your primary system (either TestRail or Applause platform) as a system of truth and make all the changes in that system and update the changes to the other system through the connector. If there are different changes made in the two systems, then when a sync happens, the changes will be overwritten in the destination system

  • There is not a clear one-to-one mapping of result steps between TestRail and Applause. In Applause, we have Step Instruction, Expected Result, Status, Actual Result and attachments for a step. To match this correctly, we recommend you to create custom Step Results fields, which will result in a separate field for Actual Result and Status for each step:

    "custom_step_results": [
    {
    "content": "Step 1",
    "expected": "Expected Result 1",
    "actual": "Actual Result 1",
    "status_id": 1
    },



Connector Synchronization Logs

To access the connector synchronization logs:

  1. Click “Data Export” on the left navigation.
  2. Click on the Connector Logs tab.
  3. Select the connector to view logs for.
  4. Specify the date range to access the logs.
  5. Each line in the log shows the log for a synchronization job. You can expand by clicking on the right arrow.
  6. To view more details on the specific synchronization task, click on the task log.