Skip to main content

Map Ranorex Tests to Azure DevOps Test Cases

Use the Azure DevOps (ADO) Test Plan integration to map Ranorex tests to Azure DevOps Test Case work items. This mapping helps you keep automated tests and your ADO test plan in sync by maintaining a persistent association between Ranorex tests and ADO Test Cases.

Before you begin

Make sure you have:

  • An Azure DevOps organization and project are available. See Create ADO project & Git repo.
  • A Ranorex Studio solution containing the tests you want to map.

  • ADO permissions to Read Test Plans, Test Cases, and Work Items.

  • Permission to create the required connection, including access to a valid Personal Access Token (PAT).

Tip: If your goal is to execute tests from Azure Test Plans, complete this mapping first, then continue with Create and execute an ADO pipeline and Create a Release pipeline.

Configure the ADO connection 

Create the connection from your Ranorex solution to your Azure DevOps project.

  1. In Ranorex Studio, open the solution you want to integrate.
  2. Select the Tools option in the toolbar menu of Ranorex Studio and select ADO Integration to open the wizard. 

  3. In the Azure DevOps Connection wizard, configure the settings for the integration:
     Token (PAT)

  4. After completing entering these details, click Test Connection to verify.
  5. Click Continue.

Map Ranorex tests to ADO Test Cases 

After the connection is configured, use the Test Case Mapper to link Ranorex tests to ADO Test Case work items.

Open the Test Case Mapper

The screen of this mapper shows two panels described below:

  • Left panel: Shows local Ranorex tests from the directory you selected in the wizard.
  • Right panel: Shows ADO Test Cases, which are retrieved from your ADO project when you fetch them.

Note: The list of ADO Test Cases is not automatically refreshed. Use Fetch ADO Tests whenever you need to load or refresh the list from ADO.

  1. In Ranorex Studio, make sure a solution is open and the ADO connection has been configured.
  2. From the main menu, select Tools > ADO Integration > Test Case Mapper.
  3. Wait for the Test Case Mapper window to open and load the local test list in the left panel.

Fetch ADO Test Cases

Load the available ADO Test Cases into the right panel.

  1. In the Test Case Mapper window, locate the Fetch ADO Tests button.
  2. Click Fetch ADO Tests.
  3. Wait for the ADO Test Cases to load in the right panel.

Hint: Use the search fields in each panel to quickly find specific Ranorex tests or ADO Test Cases, especially in large test suites or projects.

Create mappings

You can map a single Ranorex test to a single ADO Test Case:

Map a single Ranorex test to a single ADO Test Case

  1. In the left panel, select the Ranorex test you want to map.
  2. In the right panel, select the ADO Test Case you want to link to the Ranorex test.
  3. Click Map.
  4. Verify that the mapping appears in the current mappings area (see section Manage current mappings).

Repeat these steps for each pair of Ranorex test and ADO Test Case you need to map.

Manage current mappings

The Test Case Mapper provides a real-time view of all established mappings and options to modify or remove them.

View mappings

As you create mappings, they are displayed in the Current Mappings area of the Test Case Mapper. This view typically shows:

  • The Ranorex test.
  • The ADO Test Case is mapped to.
  • The current mapping status.

Use this view to confirm that each Ranorex test is linked to the correct ADO work item.

Unmap individual tests

  1. In the Current Mappings list, select the mapping you want to remove.
  2. Click Unmap (or the equivalent option for individual unmapping).
  3. Confirm that the mapping no longer appears in the list.

Unmap all tests

Use Unmap All to clear all existing mappings, for example, when restructuring your tests or changing your mapping approach.

  1. In the Current Mappings area, click Unmap All.
  2. Confirm the action if prompted.
  3. Verify that the list of mappings is empty.

Note: Unmapping a test only affects the mapping configuration between Ranorex and ADO. It does not delete the underlying Ranorex tests or ADO Test Case work items.

Unmap selected

You can use Shift to select multiple and then Unmap Selected button

Save mappings

Mappings are stored in a dedicated configuration file so that Ranorex can reuse them across sessions.

Mapping storage (ado_test_map.json)

Ranorex saves the mappings to a JSON file:

  • File name: ado_test_map.json

This file contains the information needed to keep Ranorex tests associated with their corresponding ADO Test Cases.

Important: Do not manually edit the ado_test_map.json file unless instructed by Ranorex Support. Incorrect changes may cause mappings to be lost or misaligned.

Save mappings to disk

  1. After creating or updating mappings in the Test Case Mapper, click Save Mappings.
  2. Wait for the save operation to complete.
  3. Close the Test Case Mapper when finished.

The ado_test_map.json file is updated, and the mappings are available the next time you open Ranorex Studio and the Test Case Mapper.

Hint: Always click Save Mappings after adding, changing, or removing mappings. This ensures that your changes are stored and used in subsequent test runs and sessions.

Remove connection to ADO

Use Remove Connection to ADO to disconnect the current Ranorex solution from your Azure DevOps project.

When to remove the connection

Removing the ADO connection is useful when:

  • You need to connect the solution to a different ADO organization or project.
  • You need to update the PAT in a controlled way.
  • You no longer want this solution to interact with ADO.

Remove the ADO connection

  1. In Ranorex Studio, open the solution that is currently connected to ADO.
  2. From the main menu, select Tools > ADO Integration > Remove Connection to ADO.
  3. Confirm the removal if prompted.

After the connection is removed:

  • The solution is no longer connected to the ADO project.
  • The ado_test_map.json file has been deleted.
  • Test Case Mapper and Remove Connection to ADO become faded/disabled again.
  • To re-enable the integration, run Start ADO Wizard and configure a new connection.

Note: Removing the connection only affects the link between the Ranorex solution and ADO. It does not delete any Ranorex tests or ADO Test Cases.

Related articles 


 

Was this article helpful?
Powered by Zendesk