chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/api/powershell_script.rb

@@ -0,0 +1,43 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module PowershellScriptMatchers
+    ChefSpec::Runner.define_runner_method :powershell_script
+
+    #
+    # Assert that a +powershell_script+ resource exists in the Chef run with the
+    # action +:run+. Given a Chef Recipe that runs "/tmp" as a
+    # +powershell_script+:
+    #
+    #     powershell_script '/tmp' do
+    #       action :run
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +powershell_script+ resource with ChefSpec.
+    #
+    # @example Assert that a +powershell_script+ was runed
+    #   expect(chef_run).to run_powershell_script('/tmp')
+    #
+    # @example Assert that a +powershell_script+ was runed with predicate matchers
+    #   expect(chef_run).to run_powershell_script('/tmp').with_user('svargo')
+    #
+    # @example Assert that a +powershell_script+ was runed with attributes
+    #   expect(chef_run).to run_powershell_script('/tmp').with(user: 'svargo')
+    #
+    # @example Assert that a +powershell_script+ was runed using a regex
+    #   expect(chef_run).to run_powershell_script('/tmp').with(user: /sva(.+)/)
+    #
+    # @example Assert that a +powershell_script+ was _not_ runed
+    #   expect(chef_run).to_not run_powershell_script('/tmp')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def run_powershell_script(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:powershell_script, :run, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/registry_key.rb

@@ -0,0 +1,166 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module RegistryKeyMatchers
+    ChefSpec::Runner.define_runner_method :registry_key
+
+    #
+    # Assert that a +registry_key+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "HKEY_LOCAL_MACHINE\\SOFTWARE" as a
+    # +registry_key+:
+    #
+    #     registry_key 'HKEY_LOCAL_MACHINE\\SOFTWARE' do
+    #       action :create
+    #     end
+    #
+    # To test the content rendered by a +registry_key+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +registry_key+ resource with ChefSpec.
+    #
+    # @example Assert that a +registry_key+ was created
+    #   expect(chef_run).to create_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    # @example Assert that a +registry_key+ was created with predicate matchers
+    #   expect(chef_run).to create_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with_recursive(false)
+    #
+    # @example Assert that a +registry_key+ was created with attributes
+    #   expect(chef_run).to create_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with(recursive: false)
+    #
+    # @example Assert that a +registry_key+ was created using a regex
+    #   expect(chef_run).to create_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with(values: Array)
+    #
+    # @example Assert that a +registry_key+ was _not_ created
+    #   expect(chef_run).to_not create_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_registry_key(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:registry_key, :create, resource_name)
+    end
+
+    #
+    # Assert that a +registry_key+ resource exists in the Chef run with the
+    # action +:create_if_missing+. Given a Chef Recipe that creates "HKEY_LOCAL_MACHINE\\SOFTWARE"
+    # if missing as a +registry_key+:
+    #
+    #     registry_key 'HKEY_LOCAL_MACHINE\\SOFTWARE' do
+    #       action :create_if_missing
+    #     end
+    #
+    # To test the content rendered by a +registry_key+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +registry_key+ resource with ChefSpec.
+    #
+    # @example Assert that a +registry_key+ was created if missing
+    #   expect(chef_run).to create_registry_key_if_missing('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    # @example Assert that a +registry_key+ was created if missing with predicate matchers
+    #   expect(chef_run).to create_registry_key_if_missing('HKEY_LOCAL_MACHINE\\SOFTWARE').with_recursive(false)
+    #
+    # @example Assert that a +registry_key+ was created if missing with attributes
+    #   expect(chef_run).to create_registry_key_if_missing('HKEY_LOCAL_MACHINE\\SOFTWARE').with(recursive: false)
+    #
+    # @example Assert that a +registry_key+ was created if missing using a regex
+    #   expect(chef_run).to create_registry_key_if_missing('HKEY_LOCAL_MACHINE\\SOFTWARE').with(values: Array)
+    #
+    # @example Assert that a +registry_key+ was _not_ created if missing
+    #   expect(chef_run).to_not create_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_registry_key_if_missing(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:registry_key, :create_if_missing, resource_name)
+    end
+
+    #
+    # Assert that a +registry_key+ resource exists in the Chef run with the
+    # action +:delete+. Given a Chef Recipe that deletes "HKEY_LOCAL_MACHINE\\SOFTWARE" as a
+    # +registry_key+:
+    #
+    #     registry_key 'HKEY_LOCAL_MACHINE\\SOFTWARE' do
+    #       action :delete
+    #     end
+    #
+    # To test the content rendered by a +registry_key+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +registry_key+ resource with ChefSpec.
+    #
+    # @example Assert that a +registry_key+ was deleted
+    #   expect(chef_run).to delete_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    # @example Assert that a +registry_key+ was deleted with predicate matchers
+    #   expect(chef_run).to delete_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with_recursive(false)
+    #
+    # @example Assert that a +registry_key+ was deleted with attributes
+    #   expect(chef_run).to delete_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with(recursive: false)
+    #
+    # @example Assert that a +registry_key+ was deleted using a regex
+    #   expect(chef_run).to delete_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with(values: Array)
+    #
+    # @example Assert that a +registry_key+ was _not_ deleted
+    #   expect(chef_run).to_not delete_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_registry_key(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:registry_key, :delete, resource_name)
+    end
+
+    #
+    # Assert that a +registry_key+ resource exists in the Chef run with the
+    # action +:delete_key+. Given a Chef Recipe that delete_keys "HKEY_LOCAL_MACHINE\\SOFTWARE" as a
+    # +registry_key+:
+    #
+    #     registry_key 'HKEY_LOCAL_MACHINE\\SOFTWARE' do
+    #       action :delete_key
+    #     end
+    #
+    # To test the content rendered by a +registry_key+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +registry_key+ resource with ChefSpec.
+    #
+    # @example Assert that a +registry_key+ was delete_keyd
+    #   expect(chef_run).to delete_key_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    # @example Assert that a +registry_key+ was delete_keyd with predicate matchers
+    #   expect(chef_run).to delete_key_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with_recursive(false)
+    #
+    # @example Assert that a +registry_key+ was delete_keyd with attributes
+    #   expect(chef_run).to delete_key_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with(recursive: false)
+    #
+    # @example Assert that a +registry_key+ was delete_keyd using a regex
+    #   expect(chef_run).to delete_key_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE').with(values: Array)
+    #
+    # @example Assert that a +registry_key+ was _not_ delete_keyd
+    #   expect(chef_run).to_not delete_key_registry_key('HKEY_LOCAL_MACHINE\\SOFTWARE')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_key_registry_key(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:registry_key, :delete_key, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/remote_directory.rb

@@ -0,0 +1,120 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module RemoteDirectoryMatchers
+    ChefSpec::Runner.define_runner_method :remote_directory
+
+    #
+    # Assert that a +remote_directory+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "/tmp" as a
+    # +remote_directory+:
+    #
+    #     remote_directory '/tmp' do
+    #       action :create
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +remote_directory+ resource with ChefSpec.
+    #
+    # @example Assert that a +remote_directory+ was createed
+    #   expect(chef_run).to create_remote_directory('/tmp')
+    #
+    # @example Assert that a +remote_directory+ was createed with predicate matchers
+    #   expect(chef_run).to create_remote_directory('/tmp').with_overwrite(true)
+    #
+    # @example Assert that a +remote_directory+ was createed with attributes
+    #   expect(chef_run).to create_remote_directory('/tmp').with(overwrite: true)
+    #
+    # @example Assert that a +remote_directory+ was createed using a regex
+    #   expect(chef_run).to create_remote_directory('/tmp').with(overwrite: Boolean)
+    #
+    # @example Assert that a +remote_directory+ was _not_ createed
+    #   expect(chef_run).to_not create_remote_directory('/tmp')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_remote_directory(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:remote_directory, :create, resource_name)
+    end
+
+    #
+    # Assert that a +remote_directory+ resource exists in the Chef run with the
+    # action +:create_if_missing+. Given a Chef Recipe that creates "/tmp/config"
+    # if missing as a +remote_directory+:
+    #
+    #     remote_directory '/tmp/config' do
+    #       action :create_if_missing
+    #     end
+    #
+    # To test the content rendered by a +remote_directory+, see
+    # {ChefSpec::API::RenderFileMatchers}.
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +remote_directory+ resource with ChefSpec.
+    #
+    # @example Assert that a +remote_directory+ was created if missing
+    #   expect(chef_run).to create_remote_directory_if_missing('/tmp/config')
+    #
+    # @example Assert that a +remote_directory+ was created if missing with predicate matchers
+    #   expect(chef_run).to create_remote_directory_if_missing('/tmp/config').with_overwrite(true)
+    #
+    # @example Assert that a +remote_directory+ was created if missing with attributes
+    #   expect(chef_run).to create_remote_directory_if_missing('/tmp/config').with(overwrite: true)
+    #
+    # @example Assert that a +remote_directory+ was created if missing using a regex
+    #   expect(chef_run).to create_remote_directory_if_missing('/tmp/config').with(overwrite: Boolean)
+    #
+    # @example Assert that a +remote_directory+ was _not_ created if missing
+    #   expect(chef_run).to_not create_remote_directory('/tmp/config')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_remote_directory_if_missing(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:remote_directory, :create_if_missing, resource_name)
+    end
+
+    #
+    # Assert that a +remote_directory+ resource exists in the Chef run with the
+    # action +:delete+. Given a Chef Recipe that deletes "/tmp" as a
+    # +remote_directory+:
+    #
+    #     remote_directory '/tmp' do
+    #       action :delete
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +remote_directory+ resource with ChefSpec.
+    #
+    # @example Assert that a +remote_directory+ was deleteed
+    #   expect(chef_run).to delete_remote_directory('/tmp')
+    #
+    # @example Assert that a +remote_directory+ was deleteed with predicate matchers
+    #   expect(chef_run).to delete_remote_directory('/tmp').with_overwrite(true)
+    #
+    # @example Assert that a +remote_directory+ was deleteed with attributes
+    #   expect(chef_run).to delete_remote_directory('/tmp').with(overwrite: true)
+    #
+    # @example Assert that a +remote_directory+ was deleteed using a regex
+    #   expect(chef_run).to delete_remote_directory('/tmp').with(overwrite: Boolean)
+    #
+    # @example Assert that a +remote_directory+ was _not_ deleteed
+    #   expect(chef_run).to_not delete_remote_directory('/tmp')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_remote_directory(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:remote_directory, :delete, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/remote_file.rb

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