Quick start

Follow these steps to get up and running in 10 minutes.


  • Start ReadyAPI and lets configure your first project. The highlighted properties below are required and must be configured to reflect your TestRail environment settings.

""

  • Export ReadyAPI project into TestRail. Simply right click on Firefly: Export to TestRail. Firefly plugin will show a progress bar and live export status in the Firefly log tab.

""

Note: Export to TestRail action can also be invoked from the ReadyAPI testsuite or testcase. Project action will export/update the entire project. Whereas, testsuite or testcase level actions will only export/update the specified testsuite and testcase respectively.

""

  • The ReadyAPI tests should now be visible in the specified TestRail Suite\Section

""

  • Run tests from ReadyAPI

""

  • Viewing Test Results in TestRail. By default, Firefly creates a new TestRail Run for each execution:

""

""

Mapping results to TestRail Test Run

Usually customers want to store all results into one run in TestRail. In such a case they need to set TR_run_name field on either ReadyAPI Project or TestSuite level:

""

If TR_run_name property is set, then firefly finds a run with specified name (case insensitive) and adds results into it. If run with the given name does not exist, Firefly will create a new one for you. Here is a new run with name "Test Run" in TestRail:

""

All subsequent runs in ReadyAPI will result in adding a new results to a test cases inside the same run in TestRail.

Mapping results to TestRail Test Plan

It is natural for TestRail users to organize their runs into Test Plans, so Firefly allows users to map their results directly to test plans.

To map results to a test plan, user needs to set plan name into TR_plan_name property of ReadyAPI project.

""

If plan name is set, firefly searches for a plan in TestRail project by name (case insensitive) and if it does not exist, it creates a new one and add a new run in it. If TR_run_name is also set, then it will create a new run with the given name (or just adds a new result to an existing run).

""

Mapping Test Run/Plan to Milestone

To assign Test Run or Test Plan to a milestone user just need to set a name of milestone to TR_milestone property of a ReadyAPI Project.

This property can contain a name of a milestone, e.g. milestone1 or a path to a nested milestone, e.g. milestone1\milestone2.

""

When milestone property is set, then firefly finds an existing or creates new milestones and map Test Plan or Test Run to it:

""