gem

Use the gem InSpec audit resource to test if a global Gem package is installed.


Syntax

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

describe gem('gem_package_name', 'gem_binary') do
  it { should be_installed }
end

where

  • ('gem_package_name') must specify a Gem package, such as 'rubocop'
  • ('gem_binary') can specify the path to a non-default gem binary, defaults to 'gem'
  • be_installed is a valid matcher for this resource


Resource Property Examples

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

Verify that a gem package is installed, with a specific version

describe gem('rubocop') do
  it { should be_installed }
  its('version') { should eq '0.33.0' }
end

Verify that a gem package is not installed

describe gem('rubocop') do
  it { should_not be_installed }
end

Verify that a gem package is installed in an omnibus environment

describe gem('pry', '/opt/ruby-2.3.1/embedded/bin/gem') do
  it { should be_installed }
end

Verify that a gem package is installed in a chef omnibus environment

describe gem('chef-sugar', :chef) do
  it { should be_installed }
end

Verify that a gem package is installed in a chef-server omnibus environment

describe gem('knife-backup', :chef_server) do
  it { should be_installed }
end


Matchers

For a full list of available matchers, please visit our matchers page.

be_installed

The be_installed matcher tests if the named Gem package is installed:

it { should be_installed }

version

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

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