Jenkins and Sauce OnDemand Plugin Quickstart Guide

This quickstart guide contains setup instructions that allow you to:

• Install and configure your own Jenkins build server
• Connect your Jenkins instance to a GitHub account via the GitHub/Jenkins plugin
• Install the Sauce OnDemand Jenkins Plugin

Table of Contents

These are the steps to follow to ensure you've configured your Jenkins Server correctly:

• Install Prerequisite Software
  • Install JDK
  • Install Git
  • Install Jenkins
  • Git/Jenkins Plugin
• Configure the Sauce OnDemand Jenkins Plugin
  • Install Sauce OnDemand Jenkins Plugin
  • Configure Your SauceLabs Credentials
  • Test the SauceLabs OnDemand Jenkins Plugin

Install Prerequisite Software

Install JDK 8 or 11

Jenkins requires a Java 8 or 11 runtime environment. See the following page for requirements and further details.

Install Git

Git is a version control system that lets you check out code from a repository, work with that code on your own branch, and then merge that code with any changes that have been made by other developers. Git is an essential tool for distributed development teams, and is a critical component of the continuous integration/continuous development toolchain.

Install Jenkins

Below are step-by-step instructions on how to configure Jenkins on the OS of your choice.

Install Git Jenkins Plugin

The Git/Jenkins plugin allows us to trigger jobs in Jenkins based on activity in a specific git repository.

1. On your Jenkins Administration page, click Manage Jenkins
2. Click Manage Plugins
3. In the Plugins Page, select Git Plugin checkbox.
4. At the bottom of the page, select Download now and Install after restart
5. After the download completes, return to your dashboard and re-select Manage Jenkins.
6. You will see the plugin listed amongst the rest

Configure the Sauce OnDemand Jenkins Plugin

The Sauce OnDemand Jenkins plugin allows you to use SauceLabs VMs during your build and deploy cycles.

Below are the steps on how to configure the OnDemand plugin as a Jenkins build step. If at any point you require further explanation, please visit this Sauce Labs Wiki page for further explanation.

Install Sauce OnDemand Jenkins Plugin

1. On your Jenkins Administration page, click Manage Jenkins
2. Click Manage Plugins
3. Click the Available tab.
4. In the list of plugins, find and select Sauce OnDemand Plugin.
5. Click Download now and Install after restart.

   The plugin file is fairly large, so the download may take several minutes.

6. In the plugin installation dialog, select Restart Jenkins when installation is complete and no jobs are running.

Configure Your SauceLabs Credentials

In order to use the Sauce OnDemand Plugin, you must authenticate your SauceLabs account.

The plugin provides an interface for storing your SauceLabs auth credentials as environment variables on the Jenkins Server so that you don't need to hard code the values.

1. Restart Jenkins and go to your Administration Page.
2. On the left-hand side, click Credentials.
3. You can select an existing domain, or select Add domain.

   If you don't see these options it means you are not a Jenkins Admin. Confirm you have admin privileges before continuing.

4. Select the domain of your choice, and then select Add Credentials.
5. Under Kind, select Sauce Labs.
6. Enter your Sauce Labs Username and Access Key

   If you're not sure how to access your SauceLabs credentials go to the saucelabs.com Dashboard, select the arrow next to your account name, and select User Settings. Then copy the information to your local clipboard.

7. Click OK to save the credentials.

If you have SSH access, you can use Jenkin's remote access API to create credentials with curl like so:

JENKINS_CRUMB=$(curl -s 'http://jenkins-admin:jenkins-admin-password@127.0.0.1:8080/crumbIssuer/api/xml?xpath=concat(//crumbRequestField,":",//crumb)')

curl -s -XPOST -H ${JENKINS_CRUMB} http://jenkins-admin:jenkins-admin-password@127.0.0.1:8080/credentials/store/system/domain/_/createCredentials \
--data-urlencode 'json={
  "": "0",
  "credentials": {
    "scope": "GLOBAL",
    "id": "sauce-id",
    "description": "sauce labs auth",
    "username": "your-sauce-username",
    "apiKey": "your-sauce-access-key",
    "restEndpoint": "https://saucelabs.com/",
    "$class": "hudson.plugins.sauce_ondemand.credentials.SauceCredentials"
  }
}'

Test the SauceLabs OnDemand Jenkins Plugin

1. Open the Jenkins Dashboard
2. Select Create New Jobs or Create New Item
3. Select Freestyle Project
4. Name the job jenkins-saucelabs-github-test and select OK
5. In the job configuration, select Source Code Management
6. Select the Git radial button

   If the radial button doesn't appear, try re-installing the plugins followed by a restart and re-login to your Jenkins dashboard.

7. Enter the Git repository URL to pull from GitHub

   You may receive an error message the first time you enter a repo URL. This generally happens if you don't have git installed on your local machine.

8. If you're repository is private enter your GitHub credentials in the Credentials section, then click Add.

   If you've enabled 2 factor auth for your GitHub Account, add an SSH Key specific to your Jenkins instance by following the instructions here or here

9. Save the configuration.

   Note: it's best to ensure the repo you've set in Source Code Management has a legitimate Selenium test, if you're unsure feel free to use one of our examples in our sample frameworks GitHub organization.

10. Return to the dashboard and run the job. Monitor the dashboard for any errors thrown, if not then you've successfully configured the Jenkins + Github integration.