chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/api/cookbook_file.rb

@@ -0,0 +1,166 @@
+module ChefSpec::API
+  # @since 0.0.1
+  module CookbookFileMatchers
+    ChefSpec::Runner.define_runner_method :cookbook_file
+
+    #
+    # Assert that a +cookbook_file+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "/tmp/config" as a
+    # +cookbook_file+:
+    #
+    #     cookbook_file '/tmp/config' do
+    #       action :create
+    #     end
+    #
+    # To test the content rendered by a +cookbook_file+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +cookbook_file+ resource with ChefSpec.
+    #
+    # @example Assert that a +cookbook_file+ was created
+    #   expect(chef_run).to create_cookbook_file('/tmp/config')
+    #
+    # @example Assert that a +cookbook_file+ was created with predicate matchers
+    #   expect(chef_run).to create_cookbook_file('/tmp/config').with_backup(false)
+    #
+    # @example Assert that a +cookbook_file+ was created with attributes
+    #   expect(chef_run).to create_cookbook_file('/tmp/config').with(backup: false)
+    #
+    # @example Assert that a +cookbook_file+ was created using a regex
+    #   expect(chef_run).to create_cookbook_file('/tmp/config').with(user: /apa(.+)/)
+    #
+    # @example Assert that a +cookbook_file+ was _not_ created
+    #   expect(chef_run).to_not create_cookbook_file('/tmp/config')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_cookbook_file(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:cookbook_file, :create, resource_name)
+    end
+
+    #
+    # Assert that a +cookbook_file+ resource exists in the Chef run with the
+    # action +:create_if_missing+. Given a Chef Recipe that creates "/tmp/config"
+    # if missing as a +cookbook_file+:
+    #
+    #     cookbook_file '/tmp/config' do
+    #       action :create_if_missing
+    #     end
+    #
+    # To test the content rendered by a +cookbook_file+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +cookbook_file+ resource with ChefSpec.
+    #
+    # @example Assert that a +cookbook_file+ was created if missing
+    #   expect(chef_run).to create_cookbook_file_if_missing('/tmp/config')
+    #
+    # @example Assert that a +cookbook_file+ was created if missing with predicate matchers
+    #   expect(chef_run).to create_cookbook_file_if_missing('/tmp/config').with_backup(false)
+    #
+    # @example Assert that a +cookbook_file+ was created if missing with attributes
+    #   expect(chef_run).to create_cookbook_file_if_missing('/tmp/config').with(backup: false)
+    #
+    # @example Assert that a +cookbook_file+ was created if missing using a regex
+    #   expect(chef_run).to create_cookbook_file_if_missing('/tmp/config').with(user: /apa(.+)/)
+    #
+    # @example Assert that a +cookbook_file+ was _not_ created if missing
+    #   expect(chef_run).to_not create_cookbook_file('/tmp/config')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_cookbook_file_if_missing(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:cookbook_file, :create_if_missing, resource_name)
+    end
+
+    #
+    # Assert that a +cookbook_file+ resource exists in the Chef run with the
+    # action +:delete+. Given a Chef Recipe that deletes "/tmp/config" as a
+    # +cookbook_file+:
+    #
+    #     cookbook_file '/tmp/config' do
+    #       action :delete
+    #     end
+    #
+    # To test the content rendered by a +cookbook_file+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +cookbook_file+ resource with ChefSpec.
+    #
+    # @example Assert that a +cookbook_file+ was deleted
+    #   expect(chef_run).to delete_cookbook_file('/tmp/config')
+    #
+    # @example Assert that a +cookbook_file+ was deleted with predicate matchers
+    #   expect(chef_run).to delete_cookbook_file('/tmp/config').with_backup(false)
+    #
+    # @example Assert that a +cookbook_file+ was deleted with attributes
+    #   expect(chef_run).to delete_cookbook_file('/tmp/config').with(backup: false)
+    #
+    # @example Assert that a +cookbook_file+ was deleted using a regex
+    #   expect(chef_run).to delete_cookbook_file('/tmp/config').with(user: /apa(.+)/)
+    #
+    # @example Assert that a +cookbook_file+ was _not_ deleted
+    #   expect(chef_run).to_not delete_cookbook_file('/tmp/config')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_cookbook_file(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:cookbook_file, :delete, resource_name)
+    end
+
+    #
+    # Assert that a +cookbook_file+ resource exists in the Chef run with the
+    # action +:touch+. Given a Chef Recipe that touches "/tmp/config" as a
+    # +cookbook_file+:
+    #
+    #     cookbook_file '/tmp/config' do
+    #       action :touch
+    #     end
+    #
+    # To test the content rendered by a +cookbook_file+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +cookbook_file+ resource with ChefSpec.
+    #
+    # @example Assert that a +cookbook_file+ was touched
+    #   expect(chef_run).to touch_cookbook_file('/tmp/config')
+    #
+    # @example Assert that a +cookbook_file+ was touched with predicate matchers
+    #   expect(chef_run).to touch_cookbook_file('/tmp/config').with_backup(false)
+    #
+    # @example Assert that a +cookbook_file+ was touched with attributes
+    #   expect(chef_run).to touch_cookbook_file('/tmp/config').with(backup: false)
+    #
+    # @example Assert that a +cookbook_file+ was touched using a regex
+    #   expect(chef_run).to touch_cookbook_file('/tmp/config').with(user: /apa(.+)/)
+    #
+    # @example Assert that a +cookbook_file+ was _not_ touched
+    #   expect(chef_run).to_not touch_cookbook_file('/tmp/config')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def touch_cookbook_file(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:cookbook_file, :touch, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/cron.rb

@@ -0,0 +1,80 @@
+module ChefSpec::API
+  # @since 0.7.0
+  module CronMatchers
+    ChefSpec::Runner.define_runner_method :cron
+
+    #
+    # Assert that a +cron+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "ping nagios" as a
+    # +cron+:
+    #
+    #     cron 'ping nagios' do
+    #       action :create
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +cron+ resource with ChefSpec.
+    #
+    # @example Assert that a +cron+ was created
+    #   expect(chef_run).to create_cron('ping nagios')
+    #
+    # @example Assert that a +cron+ was created with predicate matchers
+    #   expect(chef_run).to create_cron('ping nagios').with_home('/home')
+    #
+    # @example Assert that a +cron+ was created with attributes
+    #   expect(chef_run).to create_cron('ping nagios').with(home: '/home')
+    #
+    # @example Assert that a +cron+ was created using a regex
+    #   expect(chef_run).to create_cron('ping nagios').with(home: /\/home/)
+    #
+    # @example Assert that a +cron+ was _not_ created
+    #   expect(chef_run).to_not create_cron('ping nagios')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_cron(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:cron, :create, resource_name)
+    end
+
+    #
+    # Assert that a +cron+ resource exists in the Chef run with the
+    # action +:delete+. Given a Chef Recipe that deletes "ping nagios" as a
+    # +cron+:
+    #
+    #     cron 'ping nagios' do
+    #       action :delete
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +cron+ resource with ChefSpec.
+    #
+    # @example Assert that a +cron+ was deleted
+    #   expect(chef_run).to delete_cron('ping nagios')
+    #
+    # @example Assert that a +cron+ was deleted with predicate matchers
+    #   expect(chef_run).to delete_cron('ping nagios').with_home('/home')
+    #
+    # @example Assert that a +cron+ was deleted with attributes
+    #   expect(chef_run).to delete_cron('ping nagios').with(home: '/home')
+    #
+    # @example Assert that a +cron+ was deleted using a regex
+    #   expect(chef_run).to delete_cron('ping nagios').with(home: /\/home/)
+    #
+    # @example Assert that a +cron+ was _not_ deleted
+    #   expect(chef_run).to_not delete_cron('ping nagios')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_cron(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:cron, :delete, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/deploy.rb

@@ -0,0 +1,117 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module DeployMatchers
+    ChefSpec::Runner.define_runner_method :deploy
+
+    #
+    # Assert that a +deploy+ resource exists in the Chef run with the
+    # action +:deploy+. Given a Chef Recipe that deploys "/tmp/path" as a
+    # +deploy+:
+    #
+    #     deploy '/tmp/path' do
+    #       action :deploy
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +deploy+ resource with ChefSpec.
+    #
+    # @example Assert that a +deploy+ was deployed
+    #   expect(chef_run).to deploy_deploy('/tmp/path')
+    #
+    # @example Assert that a +deploy+ was deployed with predicate matchers
+    #   expect(chef_run).to deploy_deploy('/tmp/path').with_repo('ssh://...')
+    #
+    # @example Assert that a +deploy+ was deployed with attributes
+    #   expect(chef_run).to deploy_deploy('/tmp/path').with(repo: 'ssh://...')
+    #
+    # @example Assert that a +deploy+ was deployed using a regex
+    #   expect(chef_run).to deploy_deploy('/tmp/path').with(repo: /ssh:(.+)/)
+    #
+    # @example Assert that a +deploy+ was _not_ deployed
+    #   expect(chef_run).to_not deploy_deploy('/tmp/path')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def deploy_deploy(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:deploy, :deploy, resource_name)
+    end
+
+    #
+    # Assert that a +deploy+ resource exists in the Chef run with the
+    # action +:force_deploy+. Given a Chef Recipe that force_deploys "/tmp/path" as a
+    # +deploy+:
+    #
+    #     deploy '/tmp/path' do
+    #       action :force_deploy
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +deploy+ resource with ChefSpec.
+    #
+    # @example Assert that a +deploy+ was force_deployed
+    #   expect(chef_run).to force_deploy_deploy('/tmp/path')
+    #
+    # @example Assert that a +deploy+ was force_deployed with predicate matchers
+    #   expect(chef_run).to force_deploy_deploy('/tmp/path').with_repo('ssh://...')
+    #
+    # @example Assert that a +deploy+ was force_deployed with attributes
+    #   expect(chef_run).to force_deploy_deploy('/tmp/path').with(repo: 'ssh://...')
+    #
+    # @example Assert that a +deploy+ was force_deployed using a regex
+    #   expect(chef_run).to force_deploy_deploy('/tmp/path').with(repo: /ssh:(.+)/)
+    #
+    # @example Assert that a +deploy+ was _not_ force_deployed
+    #   expect(chef_run).to_not force_deploy_deploy('/tmp/path')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def force_deploy_deploy(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:deploy, :force_deploy, resource_name)
+    end
+
+    #
+    # Assert that a +deploy+ resource exists in the Chef run with the
+    # action +:rollback+. Given a Chef Recipe that rolls back "/tmp/path" as a
+    # +deploy+:
+    #
+    #     deploy '/tmp/path' do
+    #       action :rollback
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +deploy+ resource with ChefSpec.
+    #
+    # @example Assert that a +deploy+ was rolled back
+    #   expect(chef_run).to rollback_deploy('/tmp/path')
+    #
+    # @example Assert that a +deploy+ was rolled back with predicate matchers
+    #   expect(chef_run).to rollback_deploy('/tmp/path').with_repo('ssh://...')
+    #
+    # @example Assert that a +deploy+ was rolled back with attributes
+    #   expect(chef_run).to rollback_deploy('/tmp/path').with(repo: 'ssh://...')
+    #
+    # @example Assert that a +deploy+ was rolled back using a regex
+    #   expect(chef_run).to rollback_deploy('/tmp/path').with(repo: /ssh:(.+)/)
+    #
+    # @example Assert that a +deploy+ was _not_ rolled back
+    #   expect(chef_run).to_not rollback_deploy('/tmp/path')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def rollback_deploy(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:deploy, :rollback, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/directory.rb

@@ -0,0 +1,80 @@
+module ChefSpec::API
+  # @since 0.0.1
+  module DirectoryMatchers
+    ChefSpec::Runner.define_runner_method :directory
+
+    #
+    # Assert that a +directory+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "/tmp" as a
+    # +directory+:
+    #
+    #     directory '/tmp' do
+    #       action :create
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +directory+ resource with ChefSpec.
+    #
+    # @example Assert that a +directory+ was createed
+    #   expect(chef_run).to create_directory('/tmp')
+    #
+    # @example Assert that a +directory+ was createed with predicate matchers
+    #   expect(chef_run).to create_directory('/tmp').with_user('svargo')
+    #
+    # @example Assert that a +directory+ was createed with attributes
+    #   expect(chef_run).to create_directory('/tmp').with(user: 'svargo')
+    #
+    # @example Assert that a +directory+ was createed using a regex
+    #   expect(chef_run).to create_directory('/tmp').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +directory+ was _not_ createed
+    #   expect(chef_run).to_not create_directory('/tmp')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_directory(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:directory, :create, resource_name)
+    end
+
+    #
+    # Assert that a +directory+ resource exists in the Chef run with the
+    # action +:delete+. Given a Chef Recipe that deletes "/tmp" as a
+    # +directory+:
+    #
+    #     directory '/tmp' do
+    #       action :delete
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +directory+ resource with ChefSpec.
+    #
+    # @example Assert that a +directory+ was deleteed
+    #   expect(chef_run).to delete_directory('/tmp')
+    #
+    # @example Assert that a +directory+ was deleteed with predicate matchers
+    #   expect(chef_run).to delete_directory('/tmp').with_user('svargo')
+    #
+    # @example Assert that a +directory+ was deleteed with attributes
+    #   expect(chef_run).to delete_directory('/tmp').with(user: 'svargo')
+    #
+    # @example Assert that a +directory+ was deleteed using a regex
+    #   expect(chef_run).to delete_directory('/tmp').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +directory+ was _not_ deleteed
+    #   expect(chef_run).to_not delete_directory('/tmp')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_directory(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:directory, :delete, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/dpkg_package.rb

@@ -0,0 +1,117 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module DpkgPackageMatchers
+    ChefSpec::Runner.define_runner_method :dpkg_package
+
+    #
+    # 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.
+    #
+    # @example Assert that a +dpkg_package+ was installed
+    #   expect(chef_run).to install_dpkg_package('apache2')
+    #
+    # @example Assert that a +dpkg_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_dpkg_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dpkg_package+ was installed with attributes
+    #   expect(chef_run).to install_dpkg_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dpkg_package+ was installed using a regex
+    #   expect(chef_run).to install_dpkg_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dpkg_package+ was _not_ installed
+    #   expect(chef_run).to_not install_dpkg_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_dpkg_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dpkg_package, :install, resource_name)
+    end
+
+    #
+    # 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.
+    #
+    # @example Assert that a +dpkg_package+ was purged
+    #   expect(chef_run).to purge_dpkg_package('apache2')
+    #
+    # @example Assert that a +dpkg_package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_dpkg_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dpkg_package+ was purged with attributes
+    #   expect(chef_run).to purge_dpkg_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dpkg_package+ was purged using a regex
+    #   expect(chef_run).to purge_dpkg_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dpkg_package+ was _not_ purged
+    #   expect(chef_run).to_not purge_dpkg_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_dpkg_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dpkg_package, :purge, resource_name)
+    end
+
+    #
+    # 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.
+    #
+    # @example Assert that a +dpkg_package+ was removed
+    #   expect(chef_run).to remove_dpkg_package('apache2')
+    #
+    # @example Assert that a +dpkg_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_dpkg_package('apache2').with_version('1.2.3')
+    #
+    # @example Assert that a +dpkg_package+ was removed with attributes
+    #   expect(chef_run).to remove_dpkg_package('apache2').with(version: '1.2.3')
+    #
+    # @example Assert that a +dpkg_package+ was removed using a regex
+    #   expect(chef_run).to remove_dpkg_package('apache2').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that a +dpkg_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_dpkg_package('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_dpkg_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:dpkg_package, :remove, resource_name)
+    end
+  end
+end