SEI TestRail integration
TestRail is a test management platform that helps you streamline your software testing processes, get visibility into QA, and release high-quality software.
Use the SEI TestRail integration to integrate SEI with TestRail.
Requirements
Before setting up the SEI TestRail integration, ensure that you have generated the TestRail API Key. The API can be generated from the TestRail platform settings. For more information, go to the TestRail API Key Documentation.
Note that the TestRail's API settings are correctly configured by enabling the API and session authentication in Site Settings.
Configure the integration
- Cloud
- Satellite
-
In your Harness Project, select the SEI Module, and go to your Account.
-
Select Integrations under Data Settings.
-
Select Available Integrations, locate the TestRail integration, and select Install.
-
Configure and save the integration.
- URL: Enter the URL for your TestRail instance.
- Username: The user name for the TestRail user that created the API key.
- API Key: Enter the TestRail API key.
- Name: Enter a name for the integration.
- Description and Tags are optional.
By completing these steps, you ensure that TestRail is configured to allow API access and authentication, which is crucial for the SEI TestRail integration to fetch data from the TestRail platform.
The steps for configuring the integration using Satellite is similar to configuring the integration on cloud, with the exception of using satellite to communicate with the TestRail server.
Make sure to select the satellite integration checkbox while configuring the integration. Once you save the integration a satellite.yml
file will be automatically generated and downloaded to your computer. Update it following the instructions here.
If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the Ingestion Satellite Troubleshooting and FAQs.
Here’s a sample satellite.yml
satellite:
tenant: <ACCOUNT_ID>
api_key: <ACCOUNT_API_KEY>
url: 'https://app.harness.io/gratis/sei/api' # Note that this URL is relative to the Environment of your Harness Account.
integrations:
- id: '<INTEGRATION_ID>'
application: testrails
url: '<TESTRAIL_URL>'
username: <TESTRAIL_USERNAME>
api_key: <TESTRAIL_API_KEY>