chefspec 7.0.0 → 7.1.0

data/lib/chefspec/api/file.rb

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

data/lib/chefspec/api/freebsd_package.rb

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

data/lib/chefspec/api/gem_package.rb

@@ -1,191 +0,0 @@
-module ChefSpec::API
-  # @since 0.5.0
-  module GemPackageMatchers
-    ChefSpec.define_matcher :gem_package
-
-    #
-    # Assert that a +gem_package+ resource exists in the Chef run with the
-    # action +:install+. Given a Chef Recipe that installs "community-zero" as a
-    # +gem_package+:
-    #
-    #     gem_package 'community-zero' do
-    #       action :install
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +gem_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +gem_package+ was installed
-    #   expect(chef_run).to install_gem_package('community-zero')
-    #
-    # @example Assert that a +gem_package+ was installed with predicate matchers
-    #   expect(chef_run).to install_gem_package('community-zero').with_version('1.2.3')
-    #
-    # @example Assert that a +gem_package+ was installed with attributes
-    #   expect(chef_run).to install_gem_package('community-zero').with(version: '1.2.3')
-    #
-    # @example Assert that a +gem_package+ was installed using a regex
-    #   expect(chef_run).to install_gem_package('community-zero').with(version: /(\d+\.){2}\.\d+/)
-    #
-    # @example Assert that a +gem_package+ was _not_ installed
-    #   expect(chef_run).to_not install_gem_package('community-zero')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def install_gem_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:gem_package, :install, resource_name)
-    end
-
-    #
-    # Assert that a +gem_package+ resource exists in the Chef run with the
-    # action +:purge+. Given a Chef Recipe that purges "community-zero" as a
-    # +gem_package+:
-    #
-    #     gem_package 'community-zero' do
-    #       action :purge
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +gem_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +gem_package+ was purgeed
-    #   expect(chef_run).to purge_gem_package('community-zero')
-    #
-    # @example Assert that a +gem_package+ was purgeed with predicate matchers
-    #   expect(chef_run).to purge_gem_package('community-zero').with_version('1.2.3')
-    #
-    # @example Assert that a +gem_package+ was purgeed with attributes
-    #   expect(chef_run).to purge_gem_package('community-zero').with(version: '1.2.3')
-    #
-    # @example Assert that a +gem_package+ was purgeed using a regex
-    #   expect(chef_run).to purge_gem_package('community-zero').with(version: /(\d+\.){2}\.\d+/)
-    #
-    # @example Assert that a +gem_package+ was _not_ purgeed
-    #   expect(chef_run).to_not purge_gem_package('community-zero')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def purge_gem_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:gem_package, :purge, resource_name)
-    end
-
-    #
-    # Assert that a +gem_package+ resource exists in the Chef run with the
-    # action +:reconfig+. Given a Chef Recipe that reconfigures "community-zero"
-    # as a +gem_package+:
-    #
-    #     gem_package 'community-zero' do
-    #       action :reconfig
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +gem_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +gem_package+ was reconfigured
-    #   expect(chef_run).to reconfig_gem_package('community-zero')
-    #
-    # @example Assert that a +gem_package+ was reconfigured with predicate matchers
-    #   expect(chef_run).to reconfig_gem_package('community-zero').with_version('1.2.3')
-    #
-    # @example Assert that a +gem_package+ was reconfigured with attributes
-    #   expect(chef_run).to reconfig_gem_package('community-zero').with(version: '1.2.3')
-    #
-    # @example Assert that a +gem_package+ was reconfigured using a regex
-    #   expect(chef_run).to reconfig_gem_package('community-zero').with(version: /(\d+\.){2}\.\d+/)
-    #
-    # @example Assert that a +gem_package+ was _not_ reconfigured
-    #   expect(chef_run).to_not reconfig_gem_package('community-zero')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def reconfig_gem_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:gem_package, :reconfig, resource_name)
-    end
-
-    #
-    # Assert that a +gem_package+ resource exists in the Chef run with the
-    # action +:remove+. Given a Chef Recipe that removes "community-zero" as a
-    # +gem_package+:
-    #
-    #     gem_package 'community-zero' do
-    #       action :remove
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +gem_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +gem_package+ was removeed
-    #   expect(chef_run).to remove_gem_package('community-zero')
-    #
-    # @example Assert that a +gem_package+ was removeed with predicate matchers
-    #   expect(chef_run).to remove_gem_package('community-zero').with_version('1.2.3')
-    #
-    # @example Assert that a +gem_package+ was removeed with attributes
-    #   expect(chef_run).to remove_gem_package('community-zero').with(version: '1.2.3')
-    #
-    # @example Assert that a +gem_package+ was removeed using a regex
-    #   expect(chef_run).to remove_gem_package('community-zero').with(version: /(\d+\.){2}\.\d+/)
-    #
-    # @example Assert that a +gem_package+ was _not_ removeed
-    #   expect(chef_run).to_not remove_gem_package('community-zero')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def remove_gem_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:gem_package, :remove, resource_name)
-    end
-
-    #
-    # Assert that a +gem_package+ resource exists in the Chef run with the
-    # action +:upgrade+. Given a Chef Recipe that upgrades "community-zero" as a
-    # +gem_package+:
-    #
-    #     gem_package 'community-zero' do
-    #       action :upgrade
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +gem_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +gem_package+ was upgradeed
-    #   expect(chef_run).to upgrade_gem_package('community-zero')
-    #
-    # @example Assert that a +gem_package+ was upgradeed with predicate matchers
-    #   expect(chef_run).to upgrade_gem_package('community-zero').with_version('1.2.3')
-    #
-    # @example Assert that a +gem_package+ was upgradeed with attributes
-    #   expect(chef_run).to upgrade_gem_package('community-zero').with(version: '1.2.3')
-    #
-    # @example Assert that a +gem_package+ was upgradeed using a regex
-    #   expect(chef_run).to upgrade_gem_package('community-zero').with(version: /(\d+\.){2}\.\d+/)
-    #
-    # @example Assert that a +gem_package+ was _not_ upgradeed
-    #   expect(chef_run).to_not upgrade_gem_package('community-zero')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def upgrade_gem_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:gem_package, :upgrade, resource_name)
-    end
-  end
-end

data/lib/chefspec/api/git.rb

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