chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/api/template.rb

@@ -0,0 +1,166 @@
+module ChefSpec::API
+  # @since 0.0.1
+  module TemplateMatchers
+    ChefSpec::Runner.define_runner_method :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/user.rb

@@ -0,0 +1,228 @@
+module ChefSpec::API
+  # @since 0.3.0
+  module UserMatchers
+    ChefSpec::Runner.define_runner_method :user
+
+    #
+    # Assert that a +user+ resource exists in the Chef run with the
+    # action +:create+. Given a Chef Recipe that creates "apache2" as a
+    # +user+:
+    #
+    #     user 'apache2' do
+    #       action :create
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +user+ resource with ChefSpec.
+    #
+    # @example Assert that a +user+ was createed
+    #   expect(chef_run).to create_user('apache2')
+    #
+    # @example Assert that a +user+ was createed with predicate matchers
+    #   expect(chef_run).to create_user('apache2').with_uid(1234)
+    #
+    # @example Assert that a +user+ was createed with attributes
+    #   expect(chef_run).to create_user('apache2').with(uid: 1234)
+    #
+    # @example Assert that a +user+ was createed using a regex
+    #   expect(chef_run).to create_user('apache2').with(uid: /\d+/)
+    #
+    # @example Assert that a +user+ was _not_ createed
+    #   expect(chef_run).to_not create_user('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def create_user(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:user, :create, resource_name)
+    end
+
+    #
+    # Assert that a +user+ resource exists in the Chef run with the
+    # action +:remove+. Given a Chef Recipe that removes "apache2" as a
+    # +user+:
+    #
+    #     user 'apache2' do
+    #       action :remove
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +user+ resource with ChefSpec.
+    #
+    # @example Assert that a +user+ was remove
+    #   expect(chef_run).to remove_user('apache2')
+    #
+    # @example Assert that a +user+ was remove with predicate matchers
+    #   expect(chef_run).to remove_user('apache2').with_uid(1234)
+    #
+    # @example Assert that a +user+ was remove with attributes
+    #   expect(chef_run).to remove_user('apache2').with(uid: 1234)
+    #
+    # @example Assert that a +user+ was remove using a regex
+    #   expect(chef_run).to remove_user('apache2').with(uid: /\d+/)
+    #
+    # @example Assert that a +user+ was _not_ remove
+    #   expect(chef_run).to_not remove_user('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def remove_user(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:user, :remove, resource_name)
+    end
+
+    #
+    # Assert that a +user+ resource exists in the Chef run with the
+    # action +:modify+. Given a Chef Recipe that modifies "apache2" as a
+    # +user+:
+    #
+    #     user 'apache2' do
+    #       action :modify
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +user+ resource with ChefSpec.
+    #
+    # @example Assert that a +user+ was modified
+    #   expect(chef_run).to modify_user('apache2')
+    #
+    # @example Assert that a +user+ was modified with predicate matchers
+    #   expect(chef_run).to modify_user('apache2').with_uid(1234)
+    #
+    # @example Assert that a +user+ was modified with attributes
+    #   expect(chef_run).to modify_user('apache2').with(uid: 1234)
+    #
+    # @example Assert that a +user+ was modified using a regex
+    #   expect(chef_run).to modify_user('apache2').with(uid: /\d+/)
+    #
+    # @example Assert that a +user+ was _not_ modified
+    #   expect(chef_run).to_not modify_user('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def modify_user(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:user, :modify, resource_name)
+    end
+
+    #
+    # Assert that a +user+ resource exists in the Chef run with the
+    # action +:manage+. Given a Chef Recipe that manages "apache2" as a
+    # +user+:
+    #
+    #     user 'apache2' do
+    #       action :manage
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +user+ resource with ChefSpec.
+    #
+    # @example Assert that a +user+ was managed
+    #   expect(chef_run).to manage_user('apache2')
+    #
+    # @example Assert that a +user+ was managed with predicate matchers
+    #   expect(chef_run).to manage_user('apache2').with_uid(1234)
+    #
+    # @example Assert that a +user+ was managed with attributes
+    #   expect(chef_run).to manage_user('apache2').with(uid: 1234)
+    #
+    # @example Assert that a +user+ was managed using a regex
+    #   expect(chef_run).to manage_user('apache2').with(uid: /\d+/)
+    #
+    # @example Assert that a +user+ was _not_ managed
+    #   expect(chef_run).to_not manage_user('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def manage_user(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:user, :manage, resource_name)
+    end
+
+    #
+    # Assert that a +user+ resource exists in the Chef run with the
+    # action +:lock+. Given a Chef Recipe that locks "apache2" as a
+    # +user+:
+    #
+    #     user 'apache2' do
+    #       action :lock
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +user+ resource with ChefSpec.
+    #
+    # @example Assert that a +user+ was locked
+    #   expect(chef_run).to lock_user('apache2')
+    #
+    # @example Assert that a +user+ was locked with predicate matchers
+    #   expect(chef_run).to lock_user('apache2').with_uid(1234)
+    #
+    # @example Assert that a +user+ was locked with attributes
+    #   expect(chef_run).to lock_user('apache2').with(uid: 1234)
+    #
+    # @example Assert that a +user+ was locked using a regex
+    #   expect(chef_run).to lock_user('apache2').with(uid: /\d+/)
+    #
+    # @example Assert that a +user+ was _not_ locked
+    #   expect(chef_run).to_not lock_user('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def lock_user(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:user, :lock, resource_name)
+    end
+
+    #
+    # Assert that a +user+ resource exists in the Chef run with the
+    # action +:unlock+. Given a Chef Recipe that unlocks "apache2" as a
+    # +user+:
+    #
+    #     user 'apache2' do
+    #       action :unlock
+    #     end
+    #
+    # The Examples section demonstrates the different ways to test a
+    # +user+ resource with ChefSpec.
+    #
+    # @example Assert that a +user+ was unlocked
+    #   expect(chef_run).to unlock_user('apache2')
+    #
+    # @example Assert that a +user+ was unlocked with predicate matchers
+    #   expect(chef_run).to unlock_user('apache2').with_uid(1234)
+    #
+    # @example Assert that a +user+ was unlocked with attributes
+    #   expect(chef_run).to unlock_user('apache2').with(uid: 1234)
+    #
+    # @example Assert that a +user+ was unlocked using a regex
+    #   expect(chef_run).to unlock_user('apache2').with(uid: /\d+/)
+    #
+    # @example Assert that a +user+ was _not_ unlocked
+    #   expect(chef_run).to_not unlock_user('apache2')
+    #
+    #
+    # @param [String, Regex] resource_name
+    #   the name of the resource to match
+    #
+    # @return [ChefSpec::Matchers::ResourceMatcher]
+    #
+    def unlock_user(resource_name)
+      ChefSpec::Matchers::ResourceMatcher.new(:user, :unlock, resource_name)
+    end
+  end
+end

data/lib/chefspec/api/yum_package.rb

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