chefspec 7.0.0 → 7.1.0

data/lib/chefspec/api/template.rb

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

data/lib/chefspec/api/windows_package.rb

@@ -1,86 +0,0 @@
-module ChefSpec::API
-  # @since 0.5.0
-  module WindowsPackageMatchers
-    ChefSpec.define_matcher :windows_package
-
-    #
-    # Assert that a +windows_package+ resource exists in the Chef run with the
-    # action +:install+. Given a Chef Recipe that installs "7zip" as a
-    # +windows_package+:
-    #
-    #     windows_package '7zip' do
-    #       action :install
-    #     end
-    #
-    # To test the content rendered by a +windows_package+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_package+ was installed
-    #   expect(chef_run).to install_windows_package('7zip')
-    #
-    # @example Assert that a +windows_package+ was installed with predicate matchers
-    #   expect(chef_run).to install_windows_package('7zip').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_package+ was installed with attributes
-    #   expect(chef_run).to install_windows_package('7zip').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_package+ was installed using a regex
-    #   expect(chef_run).to install_windows_package('7zip').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_package+ was _not_ installed
-    #   expect(chef_run).to_not install_windows_package('7zip')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def install_windows_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_package, :install, resource_name)
-    end
-
-    #
-    # Assert that a +windows_package+ resource exists in the Chef run with the
-    # action +:remove+. Given a Chef Recipe that removes "7zip" as a
-    # +windows_package+:
-    #
-    #     windows_package '7zip' do
-    #       action :remove
-    #     end
-    #
-    # To test the content rendered by a +windows_package+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_package+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_package+ was removeped
-    #   expect(chef_run).to remove_windows_package('7zip')
-    #
-    # @example Assert that a +windows_package+ was removeped with predicate matchers
-    #   expect(chef_run).to remove_windows_package('7zip').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_package+ was removeped with attributes
-    #   expect(chef_run).to remove_windows_package('7zip').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_package+ was removeped using a regex
-    #   expect(chef_run).to remove_windows_package('7zip').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_package+ was _not_ removeped
-    #   expect(chef_run).to_not remove_windows_package('7zip')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def remove_windows_package(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_package, :remove, resource_name)
-    end
-  end
-end

data/lib/chefspec/api/windows_service.rb

@@ -1,286 +0,0 @@
-module ChefSpec::API
-  # @since 0.5.0
-  module WindowsServiceMatchers
-    ChefSpec.define_matcher :windows_service
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:configure_startup+. Given a Chef Recipe that configures startup for "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :configure_startup
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ had its startup configured
-    #   expect(chef_run).to disable_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ had its startup configured with predicate matchers
-    #   expect(chef_run).to disable_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ had its startup configured with attributes
-    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ had its startup configured using a regex
-    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ did _not_ have its startup configured
-    #   expect(chef_run).to_not disable_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def configure_startup_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :configure_startup, resource_name)
-    end
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:disable+. Given a Chef Recipe that disables "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :disable
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ was disabled
-    #   expect(chef_run).to disable_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ was disabled with predicate matchers
-    #   expect(chef_run).to disable_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ was disabled with attributes
-    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ was disabled using a regex
-    #   expect(chef_run).to disable_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ was _not_ disabled
-    #   expect(chef_run).to_not disable_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def disable_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :disable, resource_name)
-    end
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:enable+. Given a Chef Recipe that enables "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :enable
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ was enabled
-    #   expect(chef_run).to enable_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ was enabled with predicate matchers
-    #   expect(chef_run).to enable_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ was enabled with attributes
-    #   expect(chef_run).to enable_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ was enabled using a regex
-    #   expect(chef_run).to enable_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ was _not_ enabled
-    #   expect(chef_run).to_not enable_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def enable_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :enable, resource_name)
-    end
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:reload+. Given a Chef Recipe that reloads "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :reload
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ was reload
-    #   expect(chef_run).to reload_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ was reload with predicate matchers
-    #   expect(chef_run).to reload_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ was reload with attributes
-    #   expect(chef_run).to reload_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ was reload using a regex
-    #   expect(chef_run).to reload_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ was _not_ reload
-    #   expect(chef_run).to_not reload_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def reload_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :reload, resource_name)
-    end
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:restart+. Given a Chef Recipe that restarts "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :restart
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ was restarted
-    #   expect(chef_run).to restart_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ was restarted with predicate matchers
-    #   expect(chef_run).to restart_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ was restarted with attributes
-    #   expect(chef_run).to restart_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ was restarted using a regex
-    #   expect(chef_run).to restart_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ was _not_ restarted
-    #   expect(chef_run).to_not restart_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def restart_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :restart, resource_name)
-    end
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:start+. Given a Chef Recipe that starts "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :start
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ was started
-    #   expect(chef_run).to start_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ was started with predicate matchers
-    #   expect(chef_run).to start_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ was started with attributes
-    #   expect(chef_run).to start_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ was started using a regex
-    #   expect(chef_run).to start_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ was _not_ started
-    #   expect(chef_run).to_not start_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def start_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :start, resource_name)
-    end
-
-    #
-    # Assert that a +windows_service+ resource exists in the Chef run with the
-    # action +:stop+. Given a Chef Recipe that stops "BITS" as a
-    # +windows_service+:
-    #
-    #     windows_service 'BITS' do
-    #       action :stop
-    #     end
-    #
-    # To test the content rendered by a +windows_service+, see
-    # {ChefSpec::API::RenderFileMatchers}.
-    #
-    # The Examples section demonstrates the different ways to test a
-    # +windows_service+ resource with ChefSpec.
-    #
-    # @example Assert that a +windows_service+ was stopped
-    #   expect(chef_run).to stop_windows_service('BITS')
-    #
-    # @example Assert that a +windows_service+ was stopped with predicate matchers
-    #   expect(chef_run).to stop_windows_service('BITS').with_pattern('BI*')
-    #
-    # @example Assert that a +windows_service+ was stopped with attributes
-    #   expect(chef_run).to stop_windows_service('BITS').with(pattern: 'BI*')
-    #
-    # @example Assert that a +windows_service+ was stopped using a regex
-    #   expect(chef_run).to stop_windows_service('BITS').with(pattern: /(.+)/)
-    #
-    # @example Assert that a +windows_service+ was _not_ stopped
-    #   expect(chef_run).to_not stop_windows_service('BITS')
-    #
-    #
-    # @param [String, Regex] resource_name
-    #   the name of the resource to match
-    #
-    # @return [ChefSpec::Matchers::ResourceMatcher]
-    #
-    def stop_windows_service(resource_name)
-      ChefSpec::Matchers::ResourceMatcher.new(:windows_service, :stop, resource_name)
-    end
-  end
-end