chefspec 7.0.0 → 9.3.8

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

data/lib/chefspec/api/group.rb

@@ -1,154 +0,0 @@
-module ChefSpec::API
-  # @since 1.0.0
-  module GroupMatchers
-    ChefSpec.define_matcher :group
-
-    #
-    # Assert that a +group+ resource exists in the Chef run with the
-    # action +:create+. Given a Chef Recipe that creates "apache2" as a
-    # +group+:
-    #
-    #     group 'apache2' do
-    #       action :create
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +group+ resource with ChefSpec.
-    #
-    # @example Assert that a +group+ was created
-    #   expect(chef_run).to create_group('apache2')
-    #
-    # @example Assert that a +group+ was created with predicate matchers
-    #   expect(chef_run).to create_group('apache2').with_gid(1234)
-    #
-    # @example Assert that a +group+ was created with attributes
-    #   expect(chef_run).to create_group('apache2').with(gid: 1234)
-    #
-    # @example Assert that a +group+ was created using a regex
-    #   expect(chef_run).to create_group('apache2').with(gid: /\d+/)
-    #
-    # @example Assert that a +group+ was _not_ created
-    #   expect(chef_run).to_not create_group('apache2')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def create_group(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:group, :create, resource_name)
-    end
-
-    #
-    # Assert that a +group+ resource exists in the Chef run with the
-    # action +:manage+. Given a Chef Recipe that manages "apache2" as a
-    # +group+:
-    #
-    #     group 'apache2' do
-    #       action :manage
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +group+ resource with ChefSpec.
-    #
-    # @example Assert that a +group+ was managed
-    #   expect(chef_run).to manage_group('apache2')
-    #
-    # @example Assert that a +group+ was managed with predicate matchers
-    #   expect(chef_run).to manage_group('apache2').with_gid(1234)
-    #
-    # @example Assert that a +group+ was managed with attributes
-    #   expect(chef_run).to manage_group('apache2').with(gid: 1234)
-    #
-    # @example Assert that a +group+ was managed using a regex
-    #   expect(chef_run).to manage_group('apache2').with(gid: /\d+/)
-    #
-    # @example Assert that a +group+ was _not_ managed
-    #   expect(chef_run).to_not manage_group('apache2')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def manage_group(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:group, :manage, resource_name)
-    end
-
-    #
-    # Assert that a +group+ resource exists in the Chef run with the
-    # action +:modify+. Given a Chef Recipe that modifies "apache2" as a
-    # +group+:
-    #
-    #     group 'apache2' do
-    #       action :modify
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +group+ resource with ChefSpec.
-    #
-    # @example Assert that a +group+ was modified
-    #   expect(chef_run).to modify_group('apache2')
-    #
-    # @example Assert that a +group+ was modified with predicate matchers
-    #   expect(chef_run).to modify_group('apache2').with_gid(1234)
-    #
-    # @example Assert that a +group+ was modified with attributes
-    #   expect(chef_run).to modify_group('apache2').with(gid: 1234)
-    #
-    # @example Assert that a +group+ was modified using a regex
-    #   expect(chef_run).to modify_group('apache2').with(gid: /\d+/)
-    #
-    # @example Assert that a +group+ was _not_ modified
-    #   expect(chef_run).to_not modify_group('apache2')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def modify_group(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:group, :modify, resource_name)
-    end
-
-    #
-    # Assert that a +group+ resource exists in the Chef run with the
-    # action +:remove+. Given a Chef Recipe that removes "apache2" as a
-    # +group+:
-    #
-    #     group 'apache2' do
-    #       action :remove
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +group+ resource with ChefSpec.
-    #
-    # @example Assert that a +group+ was removed
-    #   expect(chef_run).to remove_group('apache2')
-    #
-    # @example Assert that a +group+ was removed with predicate matchers
-    #   expect(chef_run).to remove_group('apache2').with_gid(1234)
-    #
-    # @example Assert that a +group+ was removed with attributes
-    #   expect(chef_run).to remove_group('apache2').with(gid: 1234)
-    #
-    # @example Assert that a +group+ was removed using a regex
-    #   expect(chef_run).to remove_group('apache2').with(gid: /\d+/)
-    #
-    # @example Assert that a +group+ was _not_ removed
-    #   expect(chef_run).to_not remove_group('apache2')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def remove_group(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:group, :remove, resource_name)
-    end
-  end
-end

data/lib/chefspec/api/homebrew_package.rb

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