Jenkins Integration

Overview

This topic provides instructions on how to integrate Jenkins with the Unified Agent.

Unified Agent Configuration

The following integration uses environment variables to configure the Unified Agent so that the default configuration values are used.

For more information, see:

Authentication

For all the following examples, you will need to add the WhiteSource apiKey and a userKey to Jenkins Credential Manager, as a secret text.

For more information, see:

Pipeline Job on Linux/Unix and Windows Using CURL

In the 'Pipeline' select Definition: Pipeline script, and add the following lines to the script:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 node { environment { WS_APIKEY = credentials('whitesource-apikey') WS_WSS_URL = "https://saas.whitesourcesoftware.com/agent" WS_USERKEY = credentials('whitesource-serviceaccount-userkey') WS_PRODUCTNAME = "Your Product Name" WS_PROJECTNAME = "${JOB_NAME}" }   stage('Download Unified Agent') {    sh 'curl -LJO https://unified-agent.s3.amazonaws.com/wss-unified-agent.jar'   }   stage('Run Unified Agent') {     sh 'java -jar wss-unified-agent.jar'   } }

Note the following:

  • For Windows, replace sh with bat and download CURL, add it to your PATH environment variable, and restart Jenkins to load the new PATH variable.

  • It is advised to use the download curl command only once a week to download the latest version of the Unified Agent for performance reasons, and not as part of every build. You can do this using a scheduler task, such as cron.

  • You can combine the two stages into one stage.

Pipeline Job on Windows Using PowerShell

In the 'Pipeline', select Definition: Pipeline script and add the following lines to the script:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 node { environment { WS_APIKEY = credentials('whitesource-apikey') WS_WSS_URL = "https://saas.whitesourcesoftware.com/agent" WS_USERKEY = credentials('whitesource-serviceaccount-userkey') WS_PRODUCTNAME = "your-product-name" WS_PROJECTNAME = "${JOB_NAME}" } stage('Download Unified Agent') { bat 'powershell bitsadmin /transfer mydownload /dynamic /download /priority FOREGROUND https://unified-agent.s3.amazonaws.com/wss-unified-agent.jar $pwd\wss-unified-agent.jar' } stage('Run Unified Agent') { bat 'java -jar wss-unified-agent.jar' } }

Note the following:

  • Make sure that Background Intelligent Transfer Service (BITS) is enabled on the node running the job.

  • You can combine the two stages into one stage.

Free Style Job on Linux/Unix and Windows Using CURL

  1. Download CURL, add it to your PATH environment variable.

  2. Restart Jenkins in order for it to load the new PATH variable.

  3. Go to Build Environment, click Use secret text(s) or file(s) and add your whitesource-apikey and whitesource-userkey credentials

  4. Go to Build, click on Add build step and then select Execute shell, Execute Windows batch command, or Run with timeout.

  5. Add the following commands on the new Command window:

    1 2 3 4 5 curl -LJO https://unified-agent.s3.amazonaws.com/wss-unified-agent.jar set WS_PRODUCTNAME=your-product-name set WS_PROJECTNAME=${JOB_NAME} set WS_WSS_URL=https://saas.whitesourcesoftware.com/agent java -jar wss-unified-agent.jar

Free Style Job on Windows Using PowerShell

  1. Go to Build Environment, click Use secret text(s) or file(s) and add your whitesource-apikey and whitesource-userkey credentials.

  2. Go to Build, click on Add build step and then select Execute Windows batch command or Run with timeout.

  3. Add the following commands:

    1 2 3 4 5 powershell bitsadmin /transfer mydownload /dynamic /download /priority FOREGROUND https://unified-agent.s3.amazonaws.com/wss-unified-agent.jar $pwd\wss-unified-agent.jar set WS_PRODUCTNAME=your-product-name set WS_PROJECTNAME=${JOB_NAME} set WS_WSS_URL=https://saas.whitesourcesoftware.com/agent java -jar wss-unified-agent.jar

Note the following:

  • Make sure that Background Intelligent Transfer Service (BITS) is enabled on the node that is running the job.