npm resource

Use the npm Chef InSpec audit resource to test if a global NPM package is installed. NPM is the the package manager for Node.js packages, such as Bower and StatsD.

Availability

Install

This resource is distributed with Chef InSpec and is automatically available for use.

Version

This resource first became available in v1.0.0 of InSpec.

Syntax

A npm resource block declares a package and (optionally) a package version:

describe npm('npm_package_name') do
  it { should be_installed }
end

where

• ('npm_package_name') must specify an NPM package, such as 'bower' or 'statsd'
• be_installed is a valid matcher for this resource

You can also specify additional options:

describe npm('npm_package_name', path: '/path/to/project') do
  it { should be_installed }
end

The path specifies a folder, that contains a node_modules subdirectory. It emulates running npm inside the specified folder. This way you can inspect local NPM installations as well as global ones.

Examples

The following examples show how to use this Chef InSpec audit resource.

Verify that bower is installed, with a specific version

describe npm('bower') do
  it { should be_installed }
  its('version') { should eq '1.4.1' }
end

Verify that statsd is not installed

describe npm('statsd') do
  it { should_not be_installed }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

be_installed

The be_installed matcher tests if the named Gem package and package version (if specified) is installed:

it { should be_installed }

version

The version matcher tests if the named package version is on the system:

its('version') { should eq '1.2.3' }