chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/api/easy_install_package.rb

@@ -0,0 +1,154 @@
+module ChefSpec::API
+  # @since 3.0.0
+  module EasyInstallPackageMatchers
+    ChefSpec::Runner.define_runner_method :easy_install_package
+
+    #
+    # Assert that an +easy_install_package+ resource exists in the Chef run
+    # with the action +:install+. Given a Chef Recipe that installs "pygments" as a
+    # +easy_install_package+:
+    #
+    #     easy_install_package 'pygments' do
+    #       action :install
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +easy_install_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +easy_install_package+ was installed
+    #   expect(chef_run).to install_easy_install_package('pygments')
+    #
+    # @example Assert that an +easy_install_package+ was installed with predicate matchers
+    #   expect(chef_run).to install_easy_install_package('pygments').with_version('1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was installed with attributes
+    #   expect(chef_run).to install_easy_install_package('pygments').with(version: '1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was installed using a regex
+    #   expect(chef_run).to install_easy_install_package('pygments').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +easy_install_package+ was _not_ installed
+    #   expect(chef_run).to_not install_easy_install_package('pygments')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def install_easy_install_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:easy_install_package, :install, resource_name)
+    end
+
+    #
+    # Assert that an +easy_install_package+ resource exists in the Chef run
+    # with the action +:purge+. Given a Chef Recipe that purges "pygments" as a
+    # +easy_install_package+:
+    #
+    #     easy_install_package 'pygments' do
+    #       action :purge
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +easy_install_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +easy_install_package+ was purged
+    #   expect(chef_run).to purge_easy_install_package('pygments')
+    #
+    # @example Assert that an +easy_install_package+ was purged with predicate matchers
+    #   expect(chef_run).to purge_easy_install_package('pygments').with_version('1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was purged with attributes
+    #   expect(chef_run).to purge_easy_install_package('pygments').with(version: '1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was purged using a regex
+    #   expect(chef_run).to purge_easy_install_package('pygments').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +easy_install_package+ was _not_ purged
+    #   expect(chef_run).to_not purge_easy_install_package('pygments')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def purge_easy_install_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:easy_install_package, :purge, resource_name)
+    end
+
+    #
+    # Assert that an +easy_install_package+ resource exists in the Chef run
+    # with the action +:remove+. Given a Chef Recipe that removes "pygments" as a
+    # +easy_install_package+:
+    #
+    #     easy_install_package 'pygments' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +easy_install_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +easy_install_package+ was removed
+    #   expect(chef_run).to remove_easy_install_package('pygments')
+    #
+    # @example Assert that an +easy_install_package+ was removed with predicate matchers
+    #   expect(chef_run).to remove_easy_install_package('pygments').with_version('1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was removed with attributes
+    #   expect(chef_run).to remove_easy_install_package('pygments').with(version: '1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was removed using a regex
+    #   expect(chef_run).to remove_easy_install_package('pygments').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +easy_install_package+ was _not_ removed
+    #   expect(chef_run).to_not remove_easy_install_package('pygments')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_easy_install_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:easy_install_package, :remove, resource_name)
+    end
+
+    #
+    # Assert that an +easy_install_package+ resource exists in the Chef run
+    # with the action +:upgrade+. Given a Chef Recipe that upgrades "pygments" as a
+    # +easy_install_package+:
+    #
+    #     easy_install_package 'pygments' do
+    #       action :upgrade
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +easy_install_package+ resource with ChefSpec.
+    #
+    # @example Assert that an +easy_install_package+ was upgraded
+    #   expect(chef_run).to upgrade_easy_install_package('pygments')
+    #
+    # @example Assert that an +easy_install_package+ was upgraded with predicate matchers
+    #   expect(chef_run).to upgrade_easy_install_package('pygments').with_version('1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was upgraded with attributes
+    #   expect(chef_run).to upgrade_easy_install_package('pygments').with(version: '1.2.3')
+    #
+    # @example Assert that an +easy_install_package+ was upgraded using a regex
+    #   expect(chef_run).to upgrade_easy_install_package('pygments').with(version: /(\d+\.){2}\.\d+/)
+    #
+    # @example Assert that an +easy_install_package+ was _not_ upgraded
+    #   expect(chef_run).to_not upgrade_easy_install_package('pygments')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def upgrade_easy_install_package(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:easy_install_package, :upgrade, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/env.rb

@@ -0,0 +1,117 @@
+module ChefSpec::API
+  # @since 0.9.0
+  module EnvMatchers
+    ChefSpec::Runner.define_runner_method :env
+
+    #
+    # Assert that an +env+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "HOME" as an
+    # +env+:
+    #
+    #     env 'HOME' do
+    #       action :create
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +env+ resource with ChefSpec.
+    #
+    # @example Assert that an +env+ was created
+    #   expect(chef_run).to create_env('HOME')
+    #
+    # @example Assert that an +env+ was created with predicate matchers
+    #   expect(chef_run).to create_env('HOME').with_value('/home')
+    #
+    # @example Assert that an +env+ was created with attributes
+    #   expect(chef_run).to create_env('HOME').with(value: 'home')
+    #
+    # @example Assert that an +env+ was created using a regex
+    #   expect(chef_run).to create_env('HOME').with(value: /\/ho(.+)/)
+    #
+    # @example Assert that an +env+ was _not_ created
+    #   expect(chef_run).to_not create_env('HOME')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_env(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:env, :create, resource_name)
+    end
+
+    #
+    # Assert that an +env+ resource exists in the Chef run with the
+    # action +:delete+. Given a Chef Recipe that deletes "HOME" as an
+    # +env+:
+    #
+    #     env 'HOME' do
+    #       action :delete
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +env+ resource with ChefSpec.
+    #
+    # @example Assert that an +env+ was deleted
+    #   expect(chef_run).to delete_env('HOME')
+    #
+    # @example Assert that an +env+ was deleted with predicate matchers
+    #   expect(chef_run).to delete_env('HOME').with_value('/home')
+    #
+    # @example Assert that an +env+ was deleted with attributes
+    #   expect(chef_run).to delete_env('HOME').with(value: 'home')
+    #
+    # @example Assert that an +env+ was deleted using a regex
+    #   expect(chef_run).to delete_env('HOME').with(value: /\/ho(.+)/)
+    #
+    # @example Assert that an +env+ was _not_ deleted
+    #   expect(chef_run).to_not delete_env('HOME')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def delete_env(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:env, :delete, resource_name)
+    end
+
+    #
+    # Assert that an +env+ resource exists in the Chef run with the
+    # action +:modify+. Given a Chef Recipe that modifies "HOME" as an
+    # +env+:
+    #
+    #     env 'HOME' do
+    #       action :modify
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test an
+    # +env+ resource with ChefSpec.
+    #
+    # @example Assert that an +env+ was modified
+    #   expect(chef_run).to modify_env('HOME')
+    #
+    # @example Assert that an +env+ was modified with predicate matchers
+    #   expect(chef_run).to modify_env('HOME').with_value('/home')
+    #
+    # @example Assert that an +env+ was modified with attributes
+    #   expect(chef_run).to modify_env('HOME').with(value: 'home')
+    #
+    # @example Assert that an +env+ was modified using a regex
+    #   expect(chef_run).to modify_env('HOME').with(value: /\/ho(.+)/)
+    #
+    # @example Assert that an +env+ was _not_ modified
+    #   expect(chef_run).to_not modify_env('HOME')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def modify_env(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:env, :modify, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/erl_call.rb

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

data/lib/chefspec/api/execute.rb

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

data/lib/chefspec/api/file.rb

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