chefspec 7.0.0 → 7.1.0

data/lib/chefspec/api/cab_package.rb

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

data/lib/chefspec/api/chef_gem.rb

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

data/lib/chefspec/api/chocolatey_package.rb

@@ -1,107 +0,0 @@
-module ChefSpec::API
-  # @since 4.6.0
-  module ChocolateyPackageMatchers
-    ChefSpec.define_matcher :chocolatey_package
-    #
-    # Assert that a +chocolatey_package+ resource exists in the Chef run with the
-    # action +:install+. Given a Chef Recipe that installs "7zip" as a
-    # +chocolatey_package+:
-    #
-    #     chocolatey_package '7zip' do
-    #       action :install
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +chocolatey_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +chocolatey_package+ was installed
-    #   expect(chef_run).to install_chocolatey_package('7zip')
-    #
-    # @example Assert that a +chocolatey_package+ was installed with attributes
-    #   expect(chef_run).to install_chocolatey_package('git').with(
-    #     version: %w(2.7.1),
-    #     options: '--params /GitAndUnixToolsOnPath'
-    #  )
-    #
-    # @example Assert that a +chocolatey_package+ was _not_ installed
-    #   expect(chef_run).to_not install_chocolatey_package('flashplayeractivex')
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def install_chocolatey_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:chocolatey_package, :install, resource_name)
-    end
-
-    #
-    # Assert that a +chocolatey_package+ resource exists in the Chef run with the
-    # action +:remove+. Given a Chef Recipe that removes "7zip" as a
-    # +chocolatey_package+:
-    #
-    #     chocolatey_package '7zip' do
-    #       action :remove
-    #     end
-    #
-    # To test the content rendered by a +chocolatey_package+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +chocolatey_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +chocolatey_package+ was removed
-    #   expect(chef_run).to remove_chocolatey_package('7zip')
-    #
-    # @example Assert that a specific +chocolatey_package+ version was removed
-    #   expect(chef_run).to remove_chocolatey_package('7zip').with(
-    #     version: %w(15.14)
-    #   )
-    #
-    # @example Assert that a +chocolatey_package+ was _not_ removed
-    #   expect(chef_run).to_not remove_chocolatey_package('7zip')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def remove_chocolatey_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:chocolatey_package, :remove, resource_name)
-    end
-
-    #
-    # Assert that a +chocolatey_package+ resource exists in the Chef run with the
-    # action +:upgrade+. Given a Chef Recipe that upgrades "7zip" as a
-    # +chocolatey_package+:
-    #
-    #     chocolatey_package '7zip' do
-    #       action :upgrade
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +chocolatey_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +chocolatey_package+ was upgraded
-    #   expect(chef_run).to upgrade_chocolatey_package('7zip')
-    #
-    # @example Assert that a +chocolatey_package+ was upgraded with attributes
-    #   expect(chef_run).to upgrade_chocolatey_package('git').with(
-    #     version: %w(2.7.1),
-    #     options: '-params "/GitAndUnixToolsOnPath"'
-    #  )
-    #
-    # @example Assert that a +chocolatey_package+ was _not_ upgraded
-    #   expect(chef_run).to_not upgrade_chocolatey_package('flashplayeractivex')
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def upgrade_chocolatey_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:chocolatey_package, :upgrade, resource_name)
-    end
-  end
-end

data/lib/chefspec/api/cookbook_file.rb

@@ -1,166 +0,0 @@
-module ChefSpec::API
-  # @since 0.0.1
-  module CookbookFileMatchers
-    ChefSpec.define_matcher :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