Create and Run a Jenkins Freestyle Project

Create a Jenkins Freestyle project to retrieve a Ranorex Studio solution from GitHub and run its test suite with the Ranorex Test Execution plugin.

Prerequisites

Make sure you have:

• Completed the initial Jenkins setup.
• Started Jenkins in an interactive Windows session.
• Installed the Ranorex Test Execution plugin.
• Added the Ranorex Studio solution to a GitHub repository.
• Created a GitHub personal access token for Jenkins.

Add GitHub Credentials

Add the GitHub credentials that Jenkins will use to access the repository.

To add the credentials:

1. From the Jenkins dashboard, select Manage Jenkins > Credentials.
2. Select System.
3. Select Global credentials.
4. Click Add Credentials.
   
5. From Kind, select Username with password.
   
6. Configure the credential:
   
   • Username: Enter your GitHub username.
   • Password: Enter your GitHub personal access token.
   • ID: Enter the name of the GitHub repository that contains the Ranorex solution.

7. Example:

   github-ranorex-demo

8. Click Create or Save.

Create the Freestyle Project

To create the project:

1. From the Jenkins dashboard, select New Item.
   
2. Enter a name for the Jenkins project.
3. Select Freestyle project.
4. Click OK.

Jenkins opens the project configuration page.

Configure the GitHub Repository

Configure the source code management settings so Jenkins can retrieve the Ranorex solution from GitHub.

To configure the repository:

1. In the Jenkins project configuration, go to Source Code Management.
2. Select Git.
3. In Repository URL, enter the GitHub repository URL.
4. From Credentials, select the GitHub credential created earlier.
5. Under Branches to build, enter the branch.
   

Example

• Repository: https://github.com/company/ranorex-demo.git
• Credentials: github-ranorex-demo
• Branch: */main

Add the Ranorex Test Execution Build Step

Add the build step that runs the Ranorex test suite.

To add the build step:

1. Go to Build Steps.
2. Click Add build step.
3. Select Run a Ranorex test suite.
4. Configure:
   • The Ranorex test suite or project location.
   • The test execution settings.
   • The report options.

The Ranorex Test Execution plugin:

• Starts the test suite.
• Executes the Ranorex tests.
• Collects the results.
• Publishes the Ranorex report.

For the basic integration, you do not need to add:

• An Execute Windows batch command build step.
• A manual call to the test executable.
• A separate MSBuild step.

Run the Jenkins Project

To run the project:

1. Click Save.
2. Click Build Now.

Jenkins performs the following actions:

1. Checks out the Ranorex project from GitHub.
2. Runs the Ranorex test suite.
3. Generates the Ranorex report.
4. Displays the test results.