...

Overview

The plugin allows Node.js based projects to integrate with WhiteSource Mend open source management. Once configured and executed the plugin will create or update WhiteSource Mend projects and enforce inventory policies. Note the following:

...

Installing the Plugin

Install WhiteSource Mend Globally:

$ npm install -g whitesourceMend

Ubuntu Issues

If you experience trouble running WhiteSource Mend globally on Ubuntu after installing locate the WhiteSource Mend package by running:

$ which whitesourceMend

and then create an alias to run WhiteSource run Mend globally:

$ alias whitesourceMend="node path/to/whitesourceMend"

Troubleshooting: Having trouble finding "node" in Ubuntu?

...

Configuring the Plugin

Create a "whitesourceMend.config.json" file in your project root directory and input your WhiteSource Mend API Token found in the Admin Integration API page:

{
	"apiKey":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
	"checkPolicies":true,
	"productName":"My Product",
	"productVer":"1.0.0",
 
	"projectName":"My Project",
	"projectVer":"1.0.0",
	"devDep": true
 
}

General Parameters

Resolving NPM Dependencies

...

If you scan a private registry that requires an access token, add the property "registryAccessToken" to the WhiteSource Mend config file.

Executing the Plugin

Make sure you have package.json and whitesourceMend.config.json files located at project root.

Run the plugin with this command:

$ whitesourceMend run

WhiteSource Mend dependency report is saved in the project's "whitesourceMend.report.json" auto-generated file and posted to your WhiteSource Mend dashboard.

Custom config file location

If you want to use whitesourceMend.config.json file that is not located under the project root please run:

$ whitesourceMend run -c c:\path\to\file\whitesourceMend.config.json

In order to use multiple build environments (e.g npm and bower) it is recommended to use different whitesourceMend.config.json file for each build environment (i.e each of them in a different location)

...

To do so, run the plugin inside your yarn project folder with the following command:

$ whitesourceMend yarn

Debugging Instructions

...

If the "ls" process fails, please investigate your project and fix it.

WhiteSource Mend cannot run when the native npm ls command fails.

...

When encountering issues running the NPM plugin, follow these instructions:

1. Uninstall WhiteSourceMend: "npm uninstall whitesourceMend"

2. Install the updated version: "npm install -g whitesourceMend"

3. All config files are left as is (so you can use the same whitesourceMend.config.json file)

If the issue persists after running the plugin, send the npm-shrinkwrap.json, package.json, npm-debug.log
and the WhiteSource Mend log files (located in the project's root and prefixed with ws-log) to support@whitesourcesoftwaresupport@Mendsoftware.com.

Exit Code

Starting version 1.1.1 and later, the following exit codes are displayed upon scan completion:

...

Exit Codes in Bash

The exit codes WhiteSource Mend returns in the Bash command language should be treated as 'x' modulo 256: 

• Exit code 0 is equivalent to code 0 (0 mod 256 = 0)

• Exit code -1 is equivalent to code 255 (-1 mod 256 = 255)

• Exit code -2 is equivalent to code 254 (-2 mod 256 = 254)

• Exit code -3 is equivalent to code 253 (-3 mod 256 = 253)

• Exit code -4 is equivalent to code 252 (-4 mod 256 = 252)

• Exit code -5 is equivalent to code 251 (-5 mod 256 = 251)

...

$ [sudo] npm update -g whitesourceMend

Running NPM Using Jenkins

...

1. You are using "Freestyle Project"  as a Jenkins job.

2. NPM is installed - download here

3. WhiteSource Mend NPM plugin is installed:

   Code Block
   $ [sudo] npm install -g whitesourceMend

   
   

4. In order to add the plugin to your job - Go to your job → configure → Add build step and use the following command:
   

5. Add "whitesourceMend.config.json" file as described above.