inspec/lib/resources/npm.rb

# encoding: utf-8
# author: Christoph Hartmann
# author: Dominik Richter

class NpmPackage < Inspec.resource(1)
  name 'npm'
  desc 'Use the npm InSpec audit resource to test if a global npm package is installed. npm is the the package manager for Nodejs packages, such as bower and StatsD.'
  example "
    describe npm('bower') do
      it { should be_installed }
    end
  "

  def initialize(package_name)
    @package_name = package_name
    @cache = nil
  end

  def info
    return @info if defined?(@info)

    cmd = inspec.command("npm ls -g --json #{@package_name}")
    @info = {
      name: @package_name,
      type: 'npm',
      installed: cmd.exit_status == 0,
    }
    return @info unless @info[:installed]

    pkgs = JSON.parse(cmd.stdout)
    @info[:version] = pkgs['dependencies'][@package_name]['version']
    @info
  end

  def installed?
    info[:installed] == true
  end

  def version
    info[:version]
  end

  def to_s
    "Npm Package #{@package_name}"
  end
end