Build a Ranorex Solution in Jenkins with MSBuild

The basic Ranorex integration does not require a separate MSBuild step. However, if your continuous integration process requires Jenkins to build the Ranorex solution before test execution, install and configure the MSBuild plugin.

The Jenkins project then performs the following actions:

1. Retrieves the Ranorex Studio solution from GitHub.
2. Builds the solution with MSBuild.
3. Runs the test suite with the Ranorex Test Execution plugin.
4. Generates the Ranorex report and displays the results.

Prerequisites

Make sure you have:

• Installed Microsoft Visual Studio or Visual Studio Build Tools.
• Included MSBuild in the Visual Studio installation.
• Installed the Ranorex Test Execution plugin in Jenkins.
• Added the Ranorex Studio solution to a GitHub repository.

Find the MSBuild Installation Path

To locate MSBuild.exe:

1. Open PowerShell.

2. Run the following command:

   Get-ChildItem -Path "C:\Program Files (x86)" -Filter "MSBuild.exe" -Recurse -ErrorAction SilentlyContinue

The MSBuild path depends on the installed Visual Studio version and edition. For example:

C:\Program Files (x86)\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin

Install the MSBuild Plugin

To install the plugin:

1. From the Jenkins dashboard, select Manage Jenkins > Plugins.
2. Open the Available plugins tab.
3. Search for MSBuild.
4. Select MSBuild Plugin.
5. Install the plugin.
6. Restart Jenkins if required.

Configure MSBuild in Jenkins

To configure the MSBuild installation:

1. Select Manage Jenkins > Tools.
2. Find MSBuild installations.
3. Click Add MSBuild.
   
4. In Name, enter a logical name for the MSBuild installation.
5. In Path to MSBuild, enter the MSBuild installation path.
   
6. Click Save.

Create and Configure the Freestyle Project

Create a Freestyle project and configure the GitHub credentials and repository as described in Create and Run a Jenkins Freestyle Project.

Add the MSBuild Build Step

Add the MSBuild step before the Ranorex test execution step.

To add the build step:

1. In the Jenkins project configuration, go to Build Steps.
2. Click Add build step.
3. Select Build a Visual Studio project or solution using MSBuild.
   
4. From MSBuild Version, select the MSBuild installation configured under Manage Jenkins > Tools.
5. In Project Path, enter the path to the Ranorex solution file (.sln).
   Examples: MyRanorexSolution.sln and Automation\MyRanorexSolution.sln

Add the Ranorex Test Execution Step

After the MSBuild build step:

1. Click Add build step.
2. Select Run a Ranorex test suite.
3. Configure the Ranorex test suite or project location.
4. Configure the required test execution settings and report options.
5. Click Save.

Run the Jenkins Project

To run the project:

1. Click Build Now.

Jenkins performs the following actions:

1. Checks out the GitHub repository.
2. Compiles the Ranorex solution with MSBuild.
3. Executes the test suite with the Ranorex Test Execution plugin.
4. Generates the Ranorex report.
5. Displays the results.