Connecting to Testrail
You're viewing legacy documentation for API Fortress (deployed via an on-premises container). To view documentation for the new SaaS version of API Fortress — now known as Sauce Labs API Testing and Monitoring (with Sauce Connect tunnels) — see API Testing on the Sauce Labs Cloud.
Test case managers are often critical to helping modern teams manage cases, plans, and runs. Communication of the test results is key, and that's why API Fortress makes it easy to integrate with many leading platforms today. TestRail is one of them.
API Fortress makes it easy to automate the testing of your APIs, and to trigger those tests to run automatically on a schedule, and during a build process (eg: Jenkins). That test result data can be pushed to your TestRail instance automatically.
Here is a quick guide to setup of how to set it up.
First, click the gear icon in the upper right corner of any view in API Fortress, highlighted in the below image.
Next, we're going to click "Alerts Groups" on the left navigation bar, followed by "+ Alert Group" to create a new group, name it, and finally click the connector button. The GIF below demonstrates this procedure.
Next, we need to add the TestRail connector to the alert group. Click "+ Connector" and select TestRail in the dropdown that appears.
Next, we need to define the parameters that we're going to pass to the TestRail connector. Click the pencil icon to edit the parameters, and then fill out the fields in the modal.
- Username: Your TestRail Username.
- Password: The password for the TestRail account you're using.
- Project_Id: The ID (an integer) of the TestRail project you'd like the API Fortress results to populate.
- Domain: The subdomain of your TestRail instance. It's the part of the URL that comes between
Next, we need to add the alert group to the project. Go to the projects view and click the "settings" icon on the project that you'd like to use the connector for.
In the dropdown that appears, if you begin typing the name of the alert group in the bottom field, it will populate automatically. Select it and click the green check to complete the connection process.
Your project in API Fortress is now connected with TestRail! It's important to note that only test results that are generated automatically, either through the scheduler or an API call, will trigger the connector. Manually executed tests (Run Test button for example) will not trigger the connector.
As soon as a test is triggered automatically, we will see the pass/fail result appear in the project of our choice in TestRail, with a link to the test report in API Fortress. Everything you need to know about your API test results in your TestRail instance.