Module: ChefSpec::API::DpkgPackageMatchers

Defined in:
lib/chefspec/api/dpkg_package.rb

Overview

Since:

  • 3.0.0

Instance Method Summary collapse

Instance Method Details

#install_dpkg_package(resource_name) ⇒ ChefSpec::Matchers::ResourceMatcher

Assert that a dpkg_package resource exists in the Chef run with the action :install. Given a Chef Recipe that installs “apache2” as a dpkg_package:

dpkg_package 'apache2' do
  action :install
end

The Examples section demonstrates the different ways to test a dpkg_package resource with ChefSpec.

Examples:

Assert that a dpkg_package was installed

expect(chef_run).to install_dpkg_package('apache2')

Assert that a dpkg_package was installed with predicate matchers

expect(chef_run).to install_dpkg_package('apache2').with_version('1.2.3')

Assert that a dpkg_package was installed with attributes

expect(chef_run).to install_dpkg_package('apache2').with(version: '1.2.3')

Assert that a dpkg_package was installed using a regex

expect(chef_run).to install_dpkg_package('apache2').with(version: /(\d+\.){2}\.\d+/)

Assert that a dpkg_package was not installed

expect(chef_run).to_not install_dpkg_package('apache2')

Parameters:

  • resource_name (String, Regex)

    the name of the resource to match

Returns:

Since:

  • 3.0.0


39
40
41
# File 'lib/chefspec/api/dpkg_package.rb', line 39

def install_dpkg_package(resource_name)
  ChefSpec::Matchers::ResourceMatcher.new(:dpkg_package, :install, resource_name)
end

#purge_dpkg_package(resource_name) ⇒ ChefSpec::Matchers::ResourceMatcher

Assert that a dpkg_package resource exists in the Chef run with the action :purge. Given a Chef Recipe that purges “apache2” as a dpkg_package:

dpkg_package 'apache2' do
  action :purge
end

The Examples section demonstrates the different ways to test a dpkg_package resource with ChefSpec.

Examples:

Assert that a dpkg_package was purged

expect(chef_run).to purge_dpkg_package('apache2')

Assert that a dpkg_package was purged with predicate matchers

expect(chef_run).to purge_dpkg_package('apache2').with_version('1.2.3')

Assert that a dpkg_package was purged with attributes

expect(chef_run).to purge_dpkg_package('apache2').with(version: '1.2.3')

Assert that a dpkg_package was purged using a regex

expect(chef_run).to purge_dpkg_package('apache2').with(version: /(\d+\.){2}\.\d+/)

Assert that a dpkg_package was not purged

expect(chef_run).to_not purge_dpkg_package('apache2')

Parameters:

  • resource_name (String, Regex)

    the name of the resource to match

Returns:

Since:

  • 3.0.0


76
77
78
# File 'lib/chefspec/api/dpkg_package.rb', line 76

def purge_dpkg_package(resource_name)
  ChefSpec::Matchers::ResourceMatcher.new(:dpkg_package, :purge, resource_name)
end

#remove_dpkg_package(resource_name) ⇒ ChefSpec::Matchers::ResourceMatcher

Assert that a dpkg_package resource exists in the Chef run with the action :remove. Given a Chef Recipe that removes “apache2” as a dpkg_package:

dpkg_package 'apache2' do
  action :remove
end

The Examples section demonstrates the different ways to test a dpkg_package resource with ChefSpec.

Examples:

Assert that a dpkg_package was removed

expect(chef_run).to remove_dpkg_package('apache2')

Assert that a dpkg_package was removed with predicate matchers

expect(chef_run).to remove_dpkg_package('apache2').with_version('1.2.3')

Assert that a dpkg_package was removed with attributes

expect(chef_run).to remove_dpkg_package('apache2').with(version: '1.2.3')

Assert that a dpkg_package was removed using a regex

expect(chef_run).to remove_dpkg_package('apache2').with(version: /(\d+\.){2}\.\d+/)

Assert that a dpkg_package was not removed

expect(chef_run).to_not remove_dpkg_package('apache2')

Parameters:

  • resource_name (String, Regex)

    the name of the resource to match

Returns:

Since:

  • 3.0.0


113
114
115
# File 'lib/chefspec/api/dpkg_package.rb', line 113

def remove_dpkg_package(resource_name)
  ChefSpec::Matchers::ResourceMatcher.new(:dpkg_package, :remove, resource_name)
end