Skip to main content

Migrating from TestRail to Testiny

This guide shows how to migrate test cases from TestRail to Testiny. We recommend using our importer that uses the TestRail API where you can migrate:

  • existing users
  • test cases including attachments, custom field values, text formatting and linked Jira requirements

Alternatively, you can also export a TestRail XML file and import it, but this will not import attachments.

info
If you encounter any problems while importing your existing test cases or migrating from another tool, please do not hesitate to ask in the forum. Our support team is always available to assist you.
Supported fields

You can migrate test cases from TestRail using Steps, Expected Results, Mission and Goal fields. BDD/Gherkin test cases are also supported as well as all custom fields, attachments and Jira references.

Migrate via TestRail API​

Testiny supports the migration via TestRail API so that you can migrate your test cases including images and attachments, as well as custom field values, text formatting and linked Jira requirements. Follow these steps:

  1. In TestRail, make sure that the API is enabled (in Administration > Site Settings > API), as shown in the screenshot below. If the API is not enabled yet, check the option Enable API and then click Save settings.

TestRail: Enable API

  1. If you have not generated a TestRail API key yet, do so (in My Settings > API Keys) by clicking Add Key as shown in the screenshot below.
  2. Type in a name for your API Key and click Generate Key and save the API key for later.
  3. Finally, don't forget to click Save Settings to save the generated API key.

TestRail: Generate API key

  1. Go to your Testiny project and choose Import from the menu as shown in the screenshot below.

Folders menu item 'Import'

  1. Select TestRail and click Import from TestRail.
Import source picker with the TestRail tile selected
  1. Enter your TestRail API credentials: provide the TestRail instance address (the URL of your TestRail instance), the email address of your TestRail user and the TestRail API key.
    Then click Connect.
TestRail connection form with the TestRail instance address, email address and TestRail API key fields
note

Please note that the TestRail instance must be publicly reachable so that Testiny can send API requests and migrate the data.

  1. You can now:
  • Import test cases:
    • Choose from which TestRail project you would like to import the test cases.
    • If you have been using Jira to track requirements, you can also configure a Jira integration in Testiny and migrate linked requirements as well (the Jira integration needs to connect to the same Jira integration you used in TestRail for references).
    • If you just want to try the migration, you can also set a limit to only retrieve a small number of test cases.
    • Then click Continue.
  • Import users: Click Import users from TestRail to migrate users.

TestRail project selection with the Jira requirements and test case limit options, and the User information found dialog that opens after clicking Import users from TestRail

  1. After you click Continue, Testiny retrieves the test cases from TestRail, automatically detects the available settings, and displays the corresponding field mapping A. Field mappings define how fields from your TestRail test cases are aligned with fields in Testiny.
  • If a custom field from TestRail does not already exist in Testiny, you can create it automatically by selecting Copy from TestRail. Testiny will then generate the field and associate it with the appropriate attribute B.
  • Look for the info icon C, which highlights that references from TestRail are also used to link requirements in Testiny.

TestRail Field Mapping

Once you confirm the automatic mapping (and apply any manual adjustments if needed), a preview of the test cases to be imported will be shown in the main view below 1.

TestRail API Importer Preview

In 2, you can re-adjust the field mapping. In 3, you will find advanced settings. For the TestRail import, you can define whether attachments should be imported, set the TestRail API rate limit, or decide whether markdown should be converted to Testiny's rich text formatting. For further information about general importer settings, please refer to the Importer Settings.

  1. Finally, if there are no errors and you're satisfied with the preview, click Import to finalize the import and add the test cases to your project.
    A summary dialog appears after the import, showing detailed statistics and any error messages. Copy the data to the clipboard (Copy all data to the clipboard) or dismiss the dialog by selecting either Save summary and close (this action downloads an HTML report of the import) or just Close.

Import summary

Migrate via TestRail XML File​

Testiny also supports the import of test cases from TestRail XML files, including custom field values, separate steps and text formatting. You just need to export the test cases from TestRail as XML and drag & drop the file into Testiny’s importer.

warning

Since TestRail does not include any images or files in its XML exports, images and attachments cannot be migrated this way. You would need to migrate via TestRail API or you need to add the images after the import manually.

Follow these steps:

  1. Export test cases from TestRail. See TestRail’s documentation on how to export test cases to XML.

  2. Go to your Testiny project and choose Import from the menu as shown in the screenshot below.

Folders menu item 'Import'

  1. Select TestRail XML and click Import from TestRail XML.
Import source picker with the TestRail XML tile selected
  1. Then drag & drop the XML file or click Select file to open the file dialog.

  2. After selecting a file, Testiny tries to automatically detect all the settings, such as the field mappings, and shows you a preview of the test cases that will be imported. The field mappings show which fields from your XML file map to which fields in Testiny.
    In case a custom field (value) does not yet exist in Testiny, you can click Fix automatically so that Testiny creates the custom field (values) for you. For a detailed explanation of all available settings, please refer to the Importer Settings.

  3. Finally, if there are no errors and you're satisfied with the preview you can click Import to finalize the import and add the test cases to your project.

info
If you encounter any problems while importing your existing test cases or migrating from another tool, please do not hesitate to ask in the forum. Our support team is always available to assist you.