Set Up Jenkins for Ranorex Test Execution

Before you create a Jenkins project for Ranorex test execution, install the required dependencies, start Jenkins in an interactive Windows session, and complete the initial Jenkins configuration.

Prerequisites

Make sure you have:

• Downloaded and installed Jenkins.
• Installed the correct Java version.
• Added the Ranorex Studio solution to a GitHub repository.

Check the Java Version

Jenkins requires Java. To check the installed Java version:

1. Open Command Prompt or PowerShell.

2. Run the following command:

   java --version

3. Confirm that the required Java version is installed.

Configure the Java Environment Variables

If Java is installed but the java command is not recognized, configure the Java environment variables.

To configure the variables:

1. Press the Windows key and enter PowerShell.
2. Right-click Windows PowerShell and select Run as administrator.

3. Set the JAVA_HOME environment variable:

   [Environment]::SetEnvironmentVariable("JAVA_HOME", "C:\Program Files\Java\jdk-21.0.5+11", "Machine")

4. Add the Java bin directory to the system Path:

   [Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\Program Files\Java\jdk-21.0.5+11\bin", "Machine")

5. Close and reopen Command Prompt or PowerShell.
6. Run java --version again to confirm that Java is available.

Note: The Java installation path depends on the installed Java version. Replace the example path with the path on your machine.

Start Jenkins in an Interactive Session

Ranorex performs UI automation and therefore requires access to the Windows desktop session. Run Jenkins interactively under a logged-in Windows user.

Important: Do not run Jenkins as a Windows service when executing Ranorex UI tests. A Windows service does not provide the interactive desktop session required for UI automation.

The recommended setup is:

1. A Windows user is logged in.
2. Jenkins runs interactively in that user's session.
3. The Jenkins project starts the Ranorex UI test.

To start Jenkins:

1. Open Command Prompt or PowerShell as an administrator.

2. Go to the directory where Jenkins is installed. For example:

   cd C:\Jenkins

3. Start Jenkins:

   java -jar jenkins.war

4. Wait until Jenkins displays the following message:

   Jenkins is fully up and running

5. Open the following address in a browser:

   http://localhost:8080

6. Keep the terminal window open while executing Ranorex tests.

Note: During the first startup, the terminal may display the initial Jenkins administrator password.

Unlock Jenkins

When you open a new Jenkins installation for the first time, Jenkins prompts you for an administrator password.

To retrieve the password:

1. Open the following file:

   C:\Users\<username>\.jenkins\secrets\initialAdminPassword

2. Copy the password.
3. Paste it into the Administrator password field on the Unlock Jenkins page.

4. Click Continue.

   

Complete the Initial Plugin Setup

After you unlock Jenkins:

1. On the Customize Jenkins page, select Select plugins to install.
2. Select the plugins required for the initial Jenkins setup.
3. Install the selected plugins.

The following plugins are included in the setup shown in this guide:

• GitHub: Enables Jenkins integration with GitHub.

  

• JUnit: Allows Jenkins to publish JUnit test results. This plugin is optional.

  

The MSBuild plugin is not required for the basic Ranorex integration. Install it only if Jenkins must build the Ranorex solution before running the test.

Create the Administrator User

After Jenkins installs the selected plugins:

1. On the Create First Admin User page, enter the required user information.
2. Confirm the password.
3. Enter the full name and email address.

4. Save the administrator user.

   

When the Jenkins is ready page appears, continue to the Jenkins dashboard.

Install the Ranorex Test Execution Plugin

After the initial Jenkins setup is complete, install the Ranorex plugin.

To install the plugin:

1. From the Jenkins dashboard, select Manage Jenkins.

2. Select Plugins.

   

3. Open the Available plugins tab.

   

4. Search for Ranorex.

5. Select Ranorex Test Execution Execution Plugin.

   

6. Install the plugin.

After the plugin is installed, you can create and configure a Jenkins Freestyle project.