chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/api/service.rb

@@ -0,0 +1,246 @@
+module ChefSpec::API
+  # @since 0.0.1
+  module ServiceMatchers
+    ChefSpec::Runner.define_runner_method :service
+
+    #
+    # Assert that a +service+ resource exists in the Chef run with the
+    # action +:disable+. Given a Chef Recipe that disables "apache2" as a
+    # +service+:
+    #
+    #     service 'apache2' do
+    #       action :disable
+    #     end
+    #
+    # To test the content rendered by a +service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +service+ resource with ChefSpec.
+    #
+    # @example Assert that a +service+ was disabled
+    #   expect(chef_run).to disable_service('apache2')
+    #
+    # @example Assert that a +service+ was disabled with predicate matchers
+    #   expect(chef_run).to disable_service('apache2').with_pattern('apa*')
+    #
+    # @example Assert that a +service+ was disabled with attributes
+    #   expect(chef_run).to disable_service('apache2').with(pattern: 'apa*')
+    #
+    # @example Assert that a +service+ was disabled using a regex
+    #   expect(chef_run).to disable_service('apache2').with(patthen: /(.+)/)
+    #
+    # @example Assert that a +service+ was _not_ disabled
+    #   expect(chef_run).to_not disable_service('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def disable_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :disable, resource_name)
+    end
+
+    #
+    # Assert that a +service+ resource exists in the Chef run with the
+    # action +:enable+. Given a Chef Recipe that enables "apache2" as a
+    # +service+:
+    #
+    #     service 'apache2' do
+    #       action :enable
+    #     end
+    #
+    # To test the content rendered by a +service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +service+ resource with ChefSpec.
+    #
+    # @example Assert that a +service+ was enabled
+    #   expect(chef_run).to enable_service('apache2')
+    #
+    # @example Assert that a +service+ was enabled with predicate matchers
+    #   expect(chef_run).to enable_service('apache2').with_pattern('apa*')
+    #
+    # @example Assert that a +service+ was enabled with attributes
+    #   expect(chef_run).to enable_service('apache2').with(pattern: 'apa*')
+    #
+    # @example Assert that a +service+ was enabled using a regex
+    #   expect(chef_run).to enable_service('apache2').with(patthen: /(.+)/)
+    #
+    # @example Assert that a +service+ was _not_ enabled
+    #   expect(chef_run).to_not enable_service('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def enable_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :enable, resource_name)
+    end
+
+    #
+    # Assert that a +service+ resource exists in the Chef run with the
+    # action +:reload+. Given a Chef Recipe that reloads "apache2" as a
+    # +service+:
+    #
+    #     service 'apache2' do
+    #       action :reload
+    #     end
+    #
+    # To test the content rendered by a +service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +service+ resource with ChefSpec.
+    #
+    # @example Assert that a +service+ was reload
+    #   expect(chef_run).to reload_service('apache2')
+    #
+    # @example Assert that a +service+ was reload with predicate matchers
+    #   expect(chef_run).to reload_service('apache2').with_pattern('apa*')
+    #
+    # @example Assert that a +service+ was reload with attributes
+    #   expect(chef_run).to reload_service('apache2').with(pattern: 'apa*')
+    #
+    # @example Assert that a +service+ was reload using a regex
+    #   expect(chef_run).to reload_service('apache2').with(patthen: /(.+)/)
+    #
+    # @example Assert that a +service+ was _not_ reload
+    #   expect(chef_run).to_not reload_service('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def reload_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :reload, resource_name)
+    end
+
+    #
+    # Assert that a +service+ resource exists in the Chef run with the
+    # action +:restart+. Given a Chef Recipe that restarts "apache2" as a
+    # +service+:
+    #
+    #     service 'apache2' do
+    #       action :restart
+    #     end
+    #
+    # To test the content rendered by a +service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +service+ resource with ChefSpec.
+    #
+    # @example Assert that a +service+ was restarted
+    #   expect(chef_run).to restart_service('apache2')
+    #
+    # @example Assert that a +service+ was restarted with predicate matchers
+    #   expect(chef_run).to restart_service('apache2').with_pattern('apa*')
+    #
+    # @example Assert that a +service+ was restarted with attributes
+    #   expect(chef_run).to restart_service('apache2').with(pattern: 'apa*')
+    #
+    # @example Assert that a +service+ was restarted using a regex
+    #   expect(chef_run).to restart_service('apache2').with(patthen: /(.+)/)
+    #
+    # @example Assert that a +service+ was _not_ restarted
+    #   expect(chef_run).to_not restart_service('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def restart_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :restart, resource_name)
+    end
+
+    #
+    # Assert that a +service+ resource exists in the Chef run with the
+    # action +:start+. Given a Chef Recipe that starts "apache2" as a
+    # +service+:
+    #
+    #     service 'apache2' do
+    #       action :start
+    #     end
+    #
+    # To test the content rendered by a +service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +service+ resource with ChefSpec.
+    #
+    # @example Assert that a +service+ was started
+    #   expect(chef_run).to start_service('apache2')
+    #
+    # @example Assert that a +service+ was started with predicate matchers
+    #   expect(chef_run).to start_service('apache2').with_pattern('apa*')
+    #
+    # @example Assert that a +service+ was started with attributes
+    #   expect(chef_run).to start_service('apache2').with(pattern: 'apa*')
+    #
+    # @example Assert that a +service+ was started using a regex
+    #   expect(chef_run).to start_service('apache2').with(patthen: /(.+)/)
+    #
+    # @example Assert that a +service+ was _not_ started
+    #   expect(chef_run).to_not start_service('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def start_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :start, resource_name)
+    end
+
+    #
+    # Assert that a +service+ resource exists in the Chef run with the
+    # action +:stop+. Given a Chef Recipe that stops "apache2" as a
+    # +service+:
+    #
+    #     service 'apache2' do
+    #       action :stop
+    #     end
+    #
+    # To test the content rendered by a +service+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +service+ resource with ChefSpec.
+    #
+    # @example Assert that a +service+ was stopped
+    #   expect(chef_run).to stop_service('apache2')
+    #
+    # @example Assert that a +service+ was stopped with predicate matchers
+    #   expect(chef_run).to stop_service('apache2').with_pattern('apa*')
+    #
+    # @example Assert that a +service+ was stopped with attributes
+    #   expect(chef_run).to stop_service('apache2').with(pattern: 'apa*')
+    #
+    # @example Assert that a +service+ was stopped using a regex
+    #   expect(chef_run).to stop_service('apache2').with(patthen: /(.+)/)
+    #
+    # @example Assert that a +service+ was _not_ stopped
+    #   expect(chef_run).to_not stop_service('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def stop_service(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :stop, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/smartos_package.rb

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

data/lib/chefspec/api/solaris_package.rb

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

data/lib/chefspec/api/subversion.rb

@@ -0,0 +1,154 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module SubversionMatchers
+    ChefSpec::Runner.define_runner_method :subversion
+
+    #
+    # Assert that a +subversion+ resource exists in the Chef run with the
+    # action +:checkout+. Given a Chef Recipe that checks out "svn://..." as a
+    # +subversion+:
+    #
+    #     subversion 'svn://...' do
+    #       action :checkout
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +subversion+ resource with ChefSpec.
+    #
+    # @example Assert that a +subversion+ was checked out
+    #   expect(chef_run).to checkout_subversion('svn://...')
+    #
+    # @example Assert that a +subversion+ was checked out with predicate matchers
+    #   expect(chef_run).to checkout_subversion('svn://...').with_user('svargo')
+    #
+    # @example Assert that a +subversion+ was checked out with attributes
+    #   expect(chef_run).to checkout_subversion('svn://...').with(user: 'svargo')
+    #
+    # @example Assert that a +subversion+ was checked out using a regex
+    #   expect(chef_run).to checkout_subversion('svn://...').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +subversion+ was _not_ checked out
+    #   expect(chef_run).to_not checkout_subversion('svn://...')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def checkout_subversion(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:subversion, :checkout, resource_name)
+    end
+
+    #
+    # Assert that a +subversion+ resource exists in the Chef run with the
+    # action +:export+. Given a Chef Recipe that exports "svn://" as a
+    # +subversion+:
+    #
+    #     subversion 'svn://' do
+    #       action :export
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +subversion+ resource with ChefSpec.
+    #
+    # @example Assert that a +subversion+ was exported
+    #   expect(chef_run).to export_subversion('svn://')
+    #
+    # @example Assert that a +subversion+ was exported with predicate matchers
+    #   expect(chef_run).to export_subversion('svn://').with_user('svargo')
+    #
+    # @example Assert that a +subversion+ was exported with attributes
+    #   expect(chef_run).to export_subversion('svn://').with(user: 'svargo')
+    #
+    # @example Assert that a +subversion+ was exported using a regex
+    #   expect(chef_run).to export_subversion('svn://').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +subversion+ was _not_ exported
+    #   expect(chef_run).to_not export_subversion('svn://')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def export_subversion(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:subversion, :export, resource_name)
+    end
+
+    #
+    # Assert that a +subversion+ resource exists in the Chef run with the
+    # action +:force_export+. Given a Chef Recipe that force_exports "svn://" as a
+    # +subversion+:
+    #
+    #     subversion 'svn://' do
+    #       action :force_export
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +subversion+ resource with ChefSpec.
+    #
+    # @example Assert that a +subversion+ was force_exported
+    #   expect(chef_run).to force_export_subversion('svn://')
+    #
+    # @example Assert that a +subversion+ was force_exported with predicate matchers
+    #   expect(chef_run).to force_export_subversion('svn://').with_user('svargo')
+    #
+    # @example Assert that a +subversion+ was force_exported with attributes
+    #   expect(chef_run).to force_export_subversion('svn://').with(user: 'svargo')
+    #
+    # @example Assert that a +subversion+ was force_exported using a regex
+    #   expect(chef_run).to force_export_subversion('svn://').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +subversion+ was _not_ force_exported
+    #   expect(chef_run).to_not force_export_subversion('svn://')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def force_export_subversion(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:subversion, :force_export, resource_name)
+    end
+
+    #
+    # Assert that a +subversion+ resource exists in the Chef run with the
+    # action +:sync+. Given a Chef Recipe that syncs "svn://" as a
+    # +subversion+:
+    #
+    #     subversion 'svn://' do
+    #       action :sync
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +subversion+ resource with ChefSpec.
+    #
+    # @example Assert that a +subversion+ was synced
+    #   expect(chef_run).to sync_subversion('svn://')
+    #
+    # @example Assert that a +subversion+ was synced with predicate matchers
+    #   expect(chef_run).to sync_subversion('svn://').with_user('svargo')
+    #
+    # @example Assert that a +subversion+ was synced with attributes
+    #   expect(chef_run).to sync_subversion('svn://').with(user: 'svargo')
+    #
+    # @example Assert that a +subversion+ was synced using a regex
+    #   expect(chef_run).to sync_subversion('svn://').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +subversion+ was _not_ synced
+    #   expect(chef_run).to_not sync_subversion('svn://')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def sync_subversion(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:subversion, :sync, resource_name)
+    end
+  end
+end