This guide is designed to help you manually transition from TestRail Server to TestRail Cloud. We'll cover the key differences between the platforms, what can and cannot be migrated, and step-by-step instructions to ensure a smooth migration of your test cases and configurations.
Most customers would want to migrate to TestRail Cloud for the purpose of not having to maintain the instance. For example, on TestRail Cloud our team manages all instance maintenance, backups, and upgrades. However, there are some key differences to consider before migrating.
Key differences between TestRail Server and TestRail Cloud
- API rate limit: TestRail Cloud has an API rate limit for performance. On TestRail Professional, the API rate limit is 180 requests per minute. On TestRail Enterprise it is 300 requests per minute. If you use heavy automation on TestRail Server this would be something to consider.
- Custom reports & defect plugins: Custom reports & custom defect plugins are only possible on TestRail Server, as access to the file system is required.
- Authentication methods: Authentication via AD/LDAP connections is currently only possible on TestRail Server. While SSO is possible on TestRail Cloud Enterprise via SAML 2.0, OAuth 2.0, OpenID Connect connections for authentication are not yet supported.
- Search performance: TestRail Cloud uses Elasticsearch for the Search functionality, which might be more performant for larger databases.
- MySQL vs SQL Server: While TestRail Server offers the flexibility to choose between MySQL and older versions of SQL Server, TestRail Cloud exclusively supports the latest stable version of MySQL (MySQL 8). This is an important consideration when making your choice.
- Backups: TestRail Cloud ensures regular backups of your data. This practice proves highly convenient for Disaster Recovery purposes. Additionally, Enterprise customers have the flexibility to choose their backup hours, minimizing any potential disruption to user activities.
Migratable and Non-Migratable Entities
| Entity | CSV/Excel Migration | XML Migration |
| Test Cases | ✅ | ✅ |
| Test Runs & Results | ❌ | ❌ |
| Attachments | ❌* | ❌* |
| Users | ❌* | ❌* |
*entity can be uploaded separately
Preparing your TestRail Cloud Instance
To ensure consistency between your Server and Cloud instances, follow these steps:
- Configure Custom Fields: Recreate custom fields used in your Server instance:
- Add Users: Invite your team members to the new Cloud instance:
- Set Up User Permissions and Roles: Assign appropriate roles and permissions to each user:
Exporting Test Cases from TestRail Server
To migrate your test cases, you first need to export them from your Server instance:
- Log In: Access your TestRail Server instance.
- Navigate to Test Cases: Select the project containing the test cases.
- Select Export Option: Click on the export icon or option.
- Choose Format: Select CSV/Excel or XML format for export.
- Save File: Download and save the exported file to your local machine.
Importing Test Cases into TestRail Cloud
After exporting, you can import the test cases into your Cloud instance - Import Using CSV/Excel:
- Log In: Access your TestRail Cloud instance.
- Navigate to Test Cases: Select the project for import.
- Select Import Option: Click on the Import button.
- Choose CSV/Excel: Select the CSV/Excel import option.
- Upload File:Browse and select the exported file.
- Map Fields: Ensure that the fields from your file map correctly to the fields in TestRail.
- Import: Complete the import process.
Uploading Attachments
After importing test cases, you may need to reattach the associated files. Here's how you can upload attachments in bulk and link them back to your test cases:
- Navigate to the Data Management Section: Go to TestRail Administration > Data Management > Attachments.
- Upload Files: Under "Select Files", you can drag and drop files or select them manually from your device.
- Link Files to Test Cases: Once files are uploaded, they can then be linked back to specific test cases.
Frequently Asked Questions (FAQ)
We've compiled answers to some common questions to assist you during the migration process. Please refer to them below:
1. Why can't I migrate test runs and results to TestRail Cloud?
Test runs and results are tied to specific configurations and historical data that aren't supported through CSV/Excel or XML imports. Migrating this data requires complex database operations, which are not available in manual migrations. You can use our API to import Test Runs and Test Results, but this will require custom scripting to create relationships to existing Test Cases and is a complex task.
2. Can I automate the migration process using the API?
While TestRail's API allows for data retrieval and creation, the Cloud API rate limits (180 requests per minute for TestRail Professional and 300 for TestRail Enterprise) make it challenging to migrate large volumes of data efficiently. Additionally, some entities like Test Results have complex relationships that are difficult to handle via API.
3. How do I handle custom fields during migration?
Before importing your test cases, ensure that all custom fields from your TestRail Server instance are recreated in the TestRail Cloud instance with the exact names and configurations. This ensures that the data maps correctly during import.
4. What happens to my user accounts and permissions during migration?
User accounts and permissions are not migrated automatically. You'll need to re-invite users to your TestRail Cloud instance and manually assign them the appropriate roles and permissions. This also serves as an opportunity to cleanup your user base.
5. Is there a way to migrate attachments in test runs and results?
Attachments linked to Test Runs and Results cannot be migrated through the import process. You would need to manually upload these attachments and associate them with the relevant Test Runs or Results, which can be time-consuming.
6. Can I continue using my existing integrations with reference/defect tracking tools?
In TestRail Cloud, you can set up integrations with supported reference/defect tracking tools. You'll need to re-configure these to align with your existing TestRail Server integrations. Find out more about TestRail Cloud’s integrations here.
7. How do I manage API rate limits if I rely heavily on automation?
You may need to adjust your automation scripts to throttle API requests according to the rate limits. Consider implementing request queues or delays to ensure you stay within the allowed number of requests per minute.
8. Are there any features exclusive to TestRail Cloud that I can take advantage of after migrating?
Yes, TestRail Cloud offers features like Elasticsearch for improved search performance and regular automated backups. Find out more about the differences between TestRail Cloud and TestRail Server here.
9. What support is available during the migration process?
Our support team is available to assist you with any questions or issues you encounter during migration. While we cannot perform the migration for you, we can provide guidance and best practices.
10. How long does the manual migration process typically take?
The duration varies depending on the size of your data and the complexity of your configurations. Planning the migration during a low-activity period and involving key team members can help expedite the process.
11. Do I need to create a TestRail Cloud subscription, and if so, how?
Yes, to migrate to TestRail Cloud, you need to purchase a subscription to set up the instance and start the migration process. More information about TestRail’s subscription and billing options can be found here. For help with this process, please reach out to our Customer Success team here.