1. Functionize
  2. User Guide
  3. Integrations
  4. Full Integration

TestRail Integration

Follow

Functionize and TestRail Integration Overview

Integrate Functionize test automation with TestRail to make automated test results from Functionize visible in TestRail for reporting purposes. This native integration allows you to connect to TestRail Cloud. After setting up the integration, you can link a test from Functionize to the corresponding test case in TestRail. When the test is executed through an orchestration in Functionize, the orchestration results will populate into a TestRail test run. Both tools display mapped fields, including Status and ID, and provide hyperlinks for easy navigation between linked objects across the two platforms.

Setting up the Integration

To set up the native integration, configure the project mapping in the Functionize Team's Integration settings. Administrative permissions are required in Functionize to configure the integration with TestRail.

Note: We currently only support TestRail Cloud and The supported project type is 'Single Repository for all cases'.
mceclip0.png

Configure TestRail

  1. Navigate to API Settings:

    • Click on Administration from the top right corner.
    • Select Site Settings from the right navigation panel.
    • Select the API tab.
      mceclip1.png

  2. Add Custom Field:

    • Navigate from Administration >> Customizations >> Result Fields.
    • Click on the + Add Field to enter the new custom field for the Functionize Result Link.
      mceclip2.png
    • Fill out the field details:
      • Label: Functionize Result Link
      • System Name: functionize_test_result_link
      • Type: Url (Link)
      • Description: (Optional)
      • Templates and Projects: Select appropriate templates and projects to link to Functionize.
        mceclip1.png

Configure Functionize

  1. Navigate to Integration Settings:

    • As a Functionize Team Administrator, navigate to the Team tab.
    • Click on the Integrations tab.
    • Select the TestRail radio button from the left menu under the Test Case Management section.

  2. Establish the Connection:

    • Under Test Authentication/Connection, enter the credentials for your TestRail Cloud instance:
      • URL
      • Username
      • Password
      • Timeout (secs)
      • Test Plan Check
      • Proxy URL and Port (if needed)
    • Click the Test Sign In button to establish the connection.
      Note: These credentials must be for a TestRail Administrator since the integration will generate custom fields into TestRail once the connection is established.

  3. Map Projects and Statuses:

    • Set up the Functionize project(s) under the Projects Mappings section.
    • Select the Functionize Project and the Project Environment.
    • Select the TestRail Project from the dropdown menu.
    • Map the Functionize Status values (FAILED, INCOMPLETE, WARNING, PASSED) to TestRail Status values.

      Note: Statuses can be customized for the TestRail status values within TestRail. See how in the section below.
    • Click Save Mappings.

Optional: Customize TestRail Statuses

  1. Log into TestRail as an Administrator:

    • Click on the Administration tab.
    • Click on Customizations from the right navigation panel.
    • Click on the Statuses tab.
      mceclip5.png

  2. Customize Status Names:

    • Rename statuses as desired (e.g., name an Unnamed status to Warning).
    • Ensure the status is active.
    • Click Save Status.
      mceclip6.png
  3. Now the new TestRail Status will be available in the dropdown menu for TestRail Statuses in the Project Mappings configuration, see below:

Using the Functionize and TestRail Integration

Functionize + TestRail Integration Flow Overview

Once you have completed setting up the integration, you can now use it. This integration is designed to make the best use of both tools. When manual tests from TestRail are ready to be automated, you can easily automate those tests using Architect. To learn how to create automated tests using Architect, check out this guide: Getting Started with Architect.

Once the automated test is created using Architect, you can link the Functionize test to the corresponding TestRail test case. Next, run the test using a Functionize orchestration, and the Functionize orchestration results will be populated in TestRail for viewing. Through this workflow, you will be able to navigate easily between both tools using hyperlinks and view the integrated data. See the flow below:
TestRail flow diagram

Linking Test Cases

  1. Navigate to the Linked Project in Functionize:

    • Click on View Project.
    • All tests in the linked project will display the TestRail logo.
    • Link each individual test to a TestRail test case by clicking on the + Link Test hyperlink.

  2. Link Functionize Test to TestRail:

    • In the TestRail Integration pop-up window, find the TestRail test case.
    • Select the test case using the radio button and click Link Test.
    • A confirmation message will display, indicating the test case has been linked successfully.

Running an Orchestration

  • An orchestration groups tests to run multiple tests in parallel or sequentially.
  • Functionize orchestration results are sent to TestRail, included in dashboard and management QA reports.

Viewing Results in TestRail

Each time the Functionize orchestration is executed on the Functionize Cloud, it will create a new Test Run in TestRail. The Test Run will show all the test cases that were executed as part of that  Functionize orchestration.

  1. In TestRail, navigate into your linked project and then click on Test Runs & Resultsfrom the top navigation bar
  2. Click into the test run name from the Test Runs & Results page, by default, the test run will be created by the integration using this syntax:
    <Name of Functionize Orchestration>: <Date and Timestamp of Execution>
    mceclip2.png

  3. On the Test Run page, the execution results from Functionize orchestration can be seen
    Note: You do NOT need to be a Functionize user to view the details. If you click the Functionize link, you will see the Functionize orchestration and test results in read-only mode. This is particularly useful if you want to share the details with your developers or other non-Functionize users.
  4. To view the details of the execution, click on the Functionize links (see image below):
    • Functionize Orchestration Link: Click on this link to view the orchestration result in Functionize
    • Functionize Result Link: Click on this link to view the specific test result in Functionize
      2021-04-23_15-01-44.png

Enable Functionize Result Link Column

  1. To view the Functionize Result Link column for your TestRail tests, you can enable it by clicking on the Columns button:
    mceclip0.png

  2. In the Add Column window, select the Functionize Result Link All option and click the Update Columns button to save
    mceclip1.png

 

 

Related articles