chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/api/notifications.rb

@@ -0,0 +1,38 @@
+module ChefSpec::API
+  # @since 0.9.0
+  module NotificationsMatchers
+    #
+    # Assert that a resource notifies another. Given a Chef Recipe that
+    # notifies a template resource to restart apache:
+    #
+    #     ifconfig '10.0.0.1' do
+    #       action :add
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +ifconfig+ resource with ChefSpec.
+    #
+    # @example Assert the template notifies apache of something
+    #   template = chef_run.template('/etc/apache2.conf')
+    #   expect(template).to notify('service[apache2]')
+    #
+    # @example Assert the template notifies apache to restart
+    #   expect(template).to notify('service[apache2]').to(:restart)
+    #
+    # @example Assert the template notifies apache to restart immediately
+    #   expect(template).to notify('service[apache2]').to(:restart).immediately
+    #
+    # @example Assert the template notifies apache to restart delayed
+    #   expect(template).to notify('service[apache2]').to(:restart).delayed
+    #
+    #
+    # @param [String] signature
+    #   the signature of the notification to match
+    #
+    # @return [ChefSpec::Matchers::NotificationsMatcher]
+    #
+    def notify(signature)
+      ChefSpec::Matchers::NotificationsMatcher.new(signature)
+    end
+  end
+end

data/lib/chefspec/api/ohai.rb

@@ -0,0 +1,43 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module OhaiMatchers
+    ChefSpec::Runner.define_runner_method :ohai
+
+    #
+    # Assert that an +ohai+ resource exists in the Chef run with the
+    # action +:reload+. Given a Chef Recipe that reloads "reload" as an
+    # +ohai+:
+    #
+    #     ohai 'reload' do
+    #       action :reload
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +ohai+ resource with ChefSpec.
+    #
+    # @example Assert that an +ohai+ was reloaded
+    #   expect(chef_run).to reload_ohai('reload')
+    #
+    # @example Assert that an +ohai+ was reloaded with predicate matchers
+    #   expect(chef_run).to reload_ohai('reload').with_system(true)
+    #
+    # @example Assert that an +ohai+ was reloaded with attributes
+    #   expect(chef_run).to reload_ohai('reload').with(system: true)
+    #
+    # @example Assert that an +ohai+ was reloaded using a regex
+    #   expect(chef_run).to reload_ohai('reload').with(system: Boolean)
+    #
+    # @example Assert that an +ohai+ was _not_ reloaded
+    #   expect(chef_run).to_not reload_ohai('reload')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def reload_ohai(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:ohai, :reload, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/package.rb

@@ -0,0 +1,192 @@
+module ChefSpec::API
+  # @since 0.0.1
+  module PackageMatchers
+    ChefSpec::Runner.define_runner_method :package
+
+    #
+    # Assert that an +package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "apache2" as an
+    # +package+:
+    #
+    #     package 'apache2' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +package+ resource with ChefSpec.
+    #
+    # @example Assert that an +package+ was installed
+    #   expect(chef_run).to install_package('apache2')
+    #
+    # @example Assert that an +package+ was installed with predicate matchers
+    #   expect(chef_run).to install_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +package+ was installed with attributes
+    #   expect(chef_run).to install_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +package+ was installed using a regex
+    #   expect(chef_run).to install_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +package+ was _not_ installed
+    #   expect(chef_run).to_not install_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:package, :install, resource_name)
+    end
+
+    #
+    # Assert that an +package+ resource exists in the Chef run with the
+    # action +:purge+. Given a Chef Recipe that purges "apache2" as an
+    # +package+:
+    #
+    #     package 'apache2' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +package+ resource with ChefSpec.
+    #
+    # @example Assert that an +package+ was purged
+    #   expect(chef_run).to purge_package('apache2')
+    #
+    # @example Assert that an +package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +package+ was purged with attributes
+    #   expect(chef_run).to purge_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +package+ was purged using a regex
+    #   expect(chef_run).to purge_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +package+ was _not_ purged
+    #   expect(chef_run).to_not purge_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:package, :purge, resource_name)
+    end
+
+    #
+    # Assert that an +package+ resource exists in the Chef run with the
+    # action +:reconfig+. Given a Chef Recipe that reconfigures "apache2" as an
+    # +package+:
+    #
+    #     package 'apache2' do
+    #       action :reconfig
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +package+ resource with ChefSpec.
+    #
+    # @example Assert that an +package+ was reconfigured
+    #   expect(chef_run).to reconfig_package('apache2')
+    #
+    # @example Assert that an +package+ was reconfigured with predicate matchers
+    #   expect(chef_run).to reconfig_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +package+ was reconfigured with attributes
+    #   expect(chef_run).to reconfig_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +package+ was reconfigured using a regex
+    #   expect(chef_run).to reconfig_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +package+ was _not_ reconfigured
+    #   expect(chef_run).to_not reconfig_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def reconfig_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:package, :reconfig, resource_name)
+    end
+
+    #
+    # Assert that an +package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "apache2" as an
+    # +package+:
+    #
+    #     package 'apache2' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +package+ resource with ChefSpec.
+    #
+    # @example Assert that an +package+ was removed
+    #   expect(chef_run).to remove_package('apache2')
+    #
+    # @example Assert that an +package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +package+ was removed with attributes
+    #   expect(chef_run).to remove_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +package+ was removed using a regex
+    #   expect(chef_run).to remove_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +package+ was _not_ removed
+    #   expect(chef_run).to_not remove_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:package, :remove, resource_name)
+    end
+
+    #
+    # Assert that an +package+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "apache2" as an
+    # +package+:
+    #
+    #     package 'apache2' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +package+ resource with ChefSpec.
+    #
+    # @example Assert that an +package+ was upgraded
+    #   expect(chef_run).to upgrade_package('apache2')
+    #
+    # @example Assert that an +package+ was upgraded with predicate matchers
+    #   expect(chef_run).to upgrade_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +package+ was upgraded using a regex
+    #   expect(chef_run).to upgrade_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:package, :upgrade, resource_name)
+    end
+
+  end
+end

data/lib/chefspec/api/pacman_package.rb

@@ -0,0 +1,155 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module PacmanPackageMatchers
+    ChefSpec::Runner.define_runner_method :pacman_package
+
+    #
+    # Assert that an +pacman_package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "apache2" as an
+    # +pacman_package+:
+    #
+    #     pacman_package 'apache2' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +pacman_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +pacman_package+ was installed
+    #   expect(chef_run).to install_pacman_package('apache2')
+    #
+    # @example Assert that an +pacman_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_pacman_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was installed with attributes
+    #   expect(chef_run).to install_pacman_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was installed using a regex
+    #   expect(chef_run).to install_pacman_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +pacman_package+ was _not_ installed
+    #   expect(chef_run).to_not install_pacman_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_pacman_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:pacman_package, :install, resource_name)
+    end
+
+    #
+    # Assert that an +pacman_package+ resource exists in the Chef run with the
+    # action +:purge+. Given a Chef Recipe that purges "apache2" as an
+    # +pacman_package+:
+    #
+    #     pacman_package 'apache2' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +pacman_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +pacman_package+ was purged
+    #   expect(chef_run).to purge_pacman_package('apache2')
+    #
+    # @example Assert that an +pacman_package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_pacman_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was purged with attributes
+    #   expect(chef_run).to purge_pacman_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was purged using a regex
+    #   expect(chef_run).to purge_pacman_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +pacman_package+ was _not_ purged
+    #   expect(chef_run).to_not purge_pacman_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_pacman_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:pacman_package, :purge, resource_name)
+    end
+
+    #
+    # Assert that an +pacman_package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "apache2" as an
+    # +pacman_package+:
+    #
+    #     pacman_package 'apache2' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +pacman_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +pacman_package+ was removed
+    #   expect(chef_run).to remove_pacman_package('apache2')
+    #
+    # @example Assert that an +pacman_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_pacman_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was removed with attributes
+    #   expect(chef_run).to remove_pacman_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was removed using a regex
+    #   expect(chef_run).to remove_pacman_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +pacman_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_pacman_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_pacman_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:pacman_package, :remove, resource_name)
+    end
+
+    #
+    # Assert that an +pacman_package+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "apache2" as an
+    # +pacman_package+:
+    #
+    #     pacman_package 'apache2' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +pacman_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +pacman_package+ was upgraded
+    #   expect(chef_run).to upgrade_pacman_package('apache2')
+    #
+    # @example Assert that an +pacman_package+ was upgraded with predicate matchers
+    #   expect(chef_run).to upgrade_pacman_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_pacman_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +pacman_package+ was upgraded using a regex
+    #   expect(chef_run).to upgrade_pacman_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +pacman_package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_pacman_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_pacman_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:pacman_package, :upgrade, resource_name)
+    end
+
+  end
+end

data/lib/chefspec/api/portage_package.rb

@@ -0,0 +1,155 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module PortagePackageMatchers
+    ChefSpec::Runner.define_runner_method :portage_package
+
+    #
+    # Assert that an +portage_package+ resource exists in the Chef run with the
+    # action +:install+. Given a Chef Recipe that installs "apache2" as an
+    # +portage_package+:
+    #
+    #     portage_package 'apache2' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +portage_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +portage_package+ was installed
+    #   expect(chef_run).to install_portage_package('apache2')
+    #
+    # @example Assert that an +portage_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_portage_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +portage_package+ was installed with attributes
+    #   expect(chef_run).to install_portage_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +portage_package+ was installed using a regex
+    #   expect(chef_run).to install_portage_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +portage_package+ was _not_ installed
+    #   expect(chef_run).to_not install_portage_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_portage_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:portage_package, :install, resource_name)
+    end
+
+    #
+    # Assert that an +portage_package+ resource exists in the Chef run with the
+    # action +:purge+. Given a Chef Recipe that purges "apache2" as an
+    # +portage_package+:
+    #
+    #     portage_package 'apache2' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +portage_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +portage_package+ was purged
+    #   expect(chef_run).to purge_portage_package('apache2')
+    #
+    # @example Assert that an +portage_package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_portage_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +portage_package+ was purged with attributes
+    #   expect(chef_run).to purge_portage_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +portage_package+ was purged using a regex
+    #   expect(chef_run).to purge_portage_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +portage_package+ was _not_ purged
+    #   expect(chef_run).to_not purge_portage_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_portage_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:portage_package, :purge, resource_name)
+    end
+
+    #
+    # Assert that an +portage_package+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "apache2" as an
+    # +portage_package+:
+    #
+    #     portage_package 'apache2' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +portage_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +portage_package+ was removed
+    #   expect(chef_run).to remove_portage_package('apache2')
+    #
+    # @example Assert that an +portage_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_portage_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +portage_package+ was removed with attributes
+    #   expect(chef_run).to remove_portage_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +portage_package+ was removed using a regex
+    #   expect(chef_run).to remove_portage_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +portage_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_portage_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_portage_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:portage_package, :remove, resource_name)
+    end
+
+    #
+    # Assert that an +portage_package+ resource exists in the Chef run with the
+    # action +:upgrade+. Given a Chef Recipe that upgrades "apache2" as an
+    # +portage_package+:
+    #
+    #     portage_package 'apache2' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +portage_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +portage_package+ was upgraded
+    #   expect(chef_run).to upgrade_portage_package('apache2')
+    #
+    # @example Assert that an +portage_package+ was upgraded with predicate matchers
+    #   expect(chef_run).to upgrade_portage_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that an +portage_package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_portage_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that an +portage_package+ was upgraded using a regex
+    #   expect(chef_run).to upgrade_portage_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +portage_package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_portage_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_portage_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:portage_package, :upgrade, resource_name)
+    end
+
+  end
+end