chefspec 7.0.0 → 9.3.8

data/lib/chefspec/api/script.rb

@@ -1,278 +0,0 @@
-module ChefSpec::API
-  # @since 1.0.0
-  module ScriptMatchers
-    #
-    # Assert that a +ksh+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +ksh+:
-    #
-    #     ksh 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +ksh+ resource with ChefSpec.
-    #
-    # @example Assert that a +ksh+ was run
-    #   expect(chef_run).to run_ksh('command')
-    #
-    # @example Assert that a +ksh+ was run with predicate matchers
-    #   expect(chef_run).to run_ksh('command').with_cwd('/home')
-    #
-    # @example Assert that a +ksh+ was run with attributes
-    #   expect(chef_run).to run_ksh('command').with(cwd: '/home')
-    #
-    # @example Assert that a +ksh+ was run using a regex
-    #   expect(chef_run).to run_ksh('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +ksh+ was _not_ run
-    #   expect(chef_run).to_not run_ksh('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_ksh(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:ksh, :run, resource_name)
-    end
-
-    ChefSpec.define_matcher :ksh
-
-    #
-    # Assert that a +bash+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +bash+:
-    #
-    #     bash 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +bash+ resource with ChefSpec.
-    #
-    # @example Assert that a +bash+ was run
-    #   expect(chef_run).to run_bash('command')
-    #
-    # @example Assert that a +bash+ was run with predicate matchers
-    #   expect(chef_run).to run_bash('command').with_cwd('/home')
-    #
-    # @example Assert that a +bash+ was run with attributes
-    #   expect(chef_run).to run_bash('command').with(cwd: '/home')
-    #
-    # @example Assert that a +bash+ was run using a regex
-    #   expect(chef_run).to run_bash('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +bash+ was _not_ run
-    #   expect(chef_run).to_not run_bash('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_bash(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:bash, :run, resource_name)
-    end
-
-    ChefSpec.define_matcher :bash
-
-    #
-    # Assert that a +csh+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +csh+:
-    #
-    #     csh 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +csh+ resource with ChefSpec.
-    #
-    # @example Assert that a +csh+ was run
-    #   expect(chef_run).to run_csh('command')
-    #
-    # @example Assert that a +csh+ was run with predicate matchers
-    #   expect(chef_run).to run_csh('command').with_cwd('/home')
-    #
-    # @example Assert that a +csh+ was run with attributes
-    #   expect(chef_run).to run_csh('command').with(cwd: '/home')
-    #
-    # @example Assert that a +csh+ was run using a regex
-    #   expect(chef_run).to run_csh('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +csh+ was _not_ run
-    #   expect(chef_run).to_not run_csh('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_csh(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:csh, :run, resource_name)
-    end
-
-    ChefSpec.define_matcher :csh
-
-    #
-    # Assert that a +perl+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +perl+:
-    #
-    #     perl 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +perl+ resource with ChefSpec.
-    #
-    # @example Assert that a +perl+ was run
-    #   expect(chef_run).to run_perl('command')
-    #
-    # @example Assert that a +perl+ was run with predicate matchers
-    #   expect(chef_run).to run_perl('command').with_cwd('/home')
-    #
-    # @example Assert that a +perl+ was run with attributes
-    #   expect(chef_run).to run_perl('command').with(cwd: '/home')
-    #
-    # @example Assert that a +perl+ was run using a regex
-    #   expect(chef_run).to run_perl('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +perl+ was _not_ run
-    #   expect(chef_run).to_not run_perl('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_perl(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:perl, :run, resource_name)
-    end
-
-    ChefSpec.define_matcher :perl
-
-    #
-    # Assert that a +python+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +python+:
-    #
-    #     python 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +python+ resource with ChefSpec.
-    #
-    # @example Assert that a +python+ was run
-    #   expect(chef_run).to run_python('command')
-    #
-    # @example Assert that a +python+ was run with predicate matchers
-    #   expect(chef_run).to run_python('command').with_cwd('/home')
-    #
-    # @example Assert that a +python+ was run with attributes
-    #   expect(chef_run).to run_python('command').with(cwd: '/home')
-    #
-    # @example Assert that a +python+ was run using a regex
-    #   expect(chef_run).to run_python('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +python+ was _not_ run
-    #   expect(chef_run).to_not run_python('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_python(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:python, :run, resource_name)
-    end
-
-    ChefSpec.define_matcher :python
-
-    #
-    # Assert that a +ruby+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +ruby+:
-    #
-    #     ruby 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +ruby+ resource with ChefSpec.
-    #
-    # @example Assert that a +ruby+ was run
-    #   expect(chef_run).to run_ruby('command')
-    #
-    # @example Assert that a +ruby+ was run with predicate matchers
-    #   expect(chef_run).to run_ruby('command').with_cwd('/home')
-    #
-    # @example Assert that a +ruby+ was run with attributes
-    #   expect(chef_run).to run_ruby('command').with(cwd: '/home')
-    #
-    # @example Assert that a +ruby+ was run using a regex
-    #   expect(chef_run).to run_ruby('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +ruby+ was _not_ run
-    #   expect(chef_run).to_not run_ruby('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_ruby(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:ruby, :run, resource_name)
-    end
-
-    ChefSpec.define_matcher :ruby
-
-    #
-    # Assert that a +script+ resource exists in the Chef run with the
-    # action +:run+. Given a Chef Recipe that runs "command" using
-    # +script+:
-    #
-    #     script 'command' do
-    #       action :run
-    #     end
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +script+ resource with ChefSpec.
-    #
-    # @example Assert that a +script+ was run
-    #   expect(chef_run).to run_script('command')
-    #
-    # @example Assert that a +script+ was run with predicate matchers
-    #   expect(chef_run).to run_script('command').with_cwd('/home')
-    #
-    # @example Assert that a +script+ was run with attributes
-    #   expect(chef_run).to run_script('command').with(cwd: '/home')
-    #
-    # @example Assert that a +script+ was run using a regex
-    #   expect(chef_run).to run_script('command').with(cwd: /\/(.+)/)
-    #
-    # @example Assert that a +script+ was _not_ run
-    #   expect(chef_run).to_not run_script('command')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def run_script(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:script, :run, resource_name)
-    end
-
-
-    ChefSpec.define_matcher :script
-  end
-end

data/lib/chefspec/api/service.rb

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

@@ -1,117 +0,0 @@
-module ChefSpec::API
-  # @since 3.0.0
-  module SmartosPackageMatchers
-    ChefSpec.define_matcher :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