Create and Set Up a Jenkins Project

After Jenkins creates the project, the project configuration page opens automatically.

Jenkins projects can be configured in many ways. This article focuses on the settings required to integrate Ranorex Studio tests with Jenkins.

After you create the project, Jenkins opens the project configuration page automatically.

To open the project configuration page later: 

1. Open the project and click Configure.
   

In this section, configure how Jenkins accesses the repository that contains your version-controlled files.

In this example, GitHub is used as the repository provider. To configure source code management:

1. In Repository URL, enter the URL of your GitHub repository.
2. If your repository requires authentication, select or enter the required credentials under Credentials.
   

Add and configure an MSBuild step so Jenkins can build the Ranorex Studio solution correctly:

1. Click Add build step.
2. Click Build a Visual Studio project or solution using MSBuild.
3. Select an MSBuild version (defined as part of plugin configuration).
4. Enter the path to the Visual Studio solution file (.sln) generated for your Ranorex Studio solution. The path must be relative to the root of your version-controlled repository.
   

Finally, add a build step to run the Ranorex test suite:

1. Click Add build step.
2. Click Run a Ranorex test suite.
3. Enter the path to the test suite file (.rxtst) relative to the solution folder.
   

In addition to the required settings, the Run a Ranorex test suite build step includes advanced settings that let you customize the test run.

To access these settings, click Advanced... in the build step.

Ranorex run configuration

Here you can specify the run configuration to use for the test run.

If you do not specify a run configuration, Jenkins uses the run configuration that was active the last time the Ranorex Studio solution was saved.

1. The available run configurations in the test suite view in Ranorex Studio
2. The desired run configuration needs to be spelled the same way in the Jenkins field

Change report directory, name, and file extension

You can change the default report directory and report name in Jenkins.

If you leave these fields empty, Jenkins uses the default values shown below the fields.

Example

1. Custom report directory. The path must be relative to the output folder (bin/debug) of the Ranorex Studio project
2. Custom report name with Jenkins variables. You can also use the available Ranorex Studio report name placeholders
3. File extension selector: rxlog and xml are available
4. The console output when building a project with the above settings

Note: Jenkins provides variables that can be used as placeholders for build-related values, for example in file names. For an overview of the available variables, refer to the official Jenkins documentation.

JUnit-compatible report

Many CI systems use the JUnit format to process test result data. When this option is enabled, Ranorex creates an additional copy of the report in JUnit format.

To use this feature:

1. Ensure you have the Jenkins JUnit plugin installed and active, as explained in Install and configure plugins.
2. Activate the JUnit-compatible report.
   
3. In the Jenkins project, click Add post build action.
4. Click Publish JUnit test result report.
5. Under Test report XMLs, enter the Ranorex Studio report directory.
   

After the build runs, the build summary contains a link to the JUnit report.

Compressed copy of Ranorex report

To create a compressed copy of the report:

1. Enable Compressed report copy.
2. Enter a custom directory if needed. The path must be relative to the output folder (bin/Debug) of the Ranorex Studio project. If left empty, the default report directory is used.
3. Enter a custom name for the compressed report if needed. You can use Jenkins variables and Ranorex Studio placeholders.
   

Note: There is a range of variables available in Jenkins that serve as placeholders for various Jenkins parameters. You can use these in file names, for example. For an overview of the available variables, please refer to Official Jenkins documentation.

Ranorex TestRail integration

These settings let you pass test results to TestRail. They correspond to the command line parameters used for the TestRail integration.

Reference: The command line parameters for the TestRail integration are explained in Command line execution.
The TestRail integration itself is explained in TestRail integration.

Global parameters

If the test suite contains global parameters, you can define values for them here. These values override the existing parameter values when the build runs.

To define values, use the following format:

ParameterName=Value

Separate multiple parameters with semicolons.

Command line arguments

In this field, you can pass any command line arguments supported by Ranorex Studio.

Reference: All command line arguments are explained in Command line execution

Build artifacts are files that are created as a result of the build, i.e. the executable build of the test and the report files. You can make these artifacts available for download from Jenkins, which is more convenient than hunting for the files in the respective directories.

To do so:

1. In the Jenkins project, click Add post build action.
2. Click Archive the artifacts.
3. Specify the files you want to archive.
   

Example

The post-build step archives all files in the /myReports/ directory whose names include the Jenkins build name and build number, and whose file extension contains rx.

After the build finishes, the archived artifacts are available for download in Jenkins.