chefspec 7.2.1 → 7.3.0

data/lib/chefspec/api/include_recipe.rb

@@ -1,23 +1,28 @@
-module ChefSpec::API
-  #
-  # Assert that a Chef run includes a certain recipe. Given a Chef Recipe
-  # that calls +include_recipe+:
-  #
-  #     include_recipe 'apache2::default'
-  #
-  # The Examples section demonstrates the different ways to test an
-  # +include_recipe+ directive with ChefSpec.
-  #
-  # @example Assert the +apache2::default+ recipe is included in the Chef run
-  #   expect(chef_run).to include_recipe('apache2::default')
-  #
-  #
-  # @param [String] recipe_name
-  #   the name of the recipe to be included
-  #
-  # @return [ChefSpec::Matchers::IncludeRecipeMatcher]
-  #
-  def include_recipe(recipe_name)
-    ChefSpec::Matchers::IncludeRecipeMatcher.new(recipe_name)
+module ChefSpec
+  module API
+    module IncludeRecipe
+      #
+      # Assert that a Chef run includes a certain recipe. Given a Chef Recipe
+      # that calls +include_recipe+:
+      #
+      #     include_recipe 'apache2::default'
+      #
+      # The Examples section demonstrates the different ways to test an
+      # +include_recipe+ directive with ChefSpec.
+      #
+      # @example Assert the +apache2::default+ recipe is included in the Chef run
+      #   expect(chef_run).to include_recipe('apache2::default')
+      #
+      #
+      # @param [String] recipe_name
+      #   the name of the recipe to be included
+      #
+      # @return [ChefSpec::Matchers::IncludeRecipeMatcher]
+      #
+      def include_recipe(recipe_name)
+        ChefSpec::Matchers::IncludeRecipeMatcher.new(recipe_name)
+      end
+
+    end
   end
 end

data/lib/chefspec/api/link.rb

@@ -1,23 +1,28 @@
-module ChefSpec::API
-  #
-  # Assert that a symlink links to a specific path. This is really
-  # syntactic sugar for the following:
-  #
-  #       expect(chef_run).to create_link('/tmp/thing').with(to: '/tmp/other_thing')
-  #
-  # @example Using +link_to+ with a String path
-  #   link = chef_run.link('/tmp/thing')
-  #   expect(link).to link_to('/tmp/other_thing')
-  #
-  # @example Using +link_to+ with a regular expression
-  #   expect(link).to link_to(/\/tmp/(.+)/)
-  #
-  # @param [String, Regex] path
-  #   the path to link to
-  #
-  # @return [ChefSpec::Matchers::LinkToMatcher]
-  #
-  def link_to(path)
-    ChefSpec::Matchers::LinkToMatcher.new(path)
+module ChefSpec
+  module API
+    module Link
+      #
+      # Assert that a symlink links to a specific path. This is really
+      # syntactic sugar for the following:
+      #
+      #       expect(chef_run).to create_link('/tmp/thing').with(to: '/tmp/other_thing')
+      #
+      # @example Using +link_to+ with a String path
+      #   link = chef_run.link('/tmp/thing')
+      #   expect(link).to link_to('/tmp/other_thing')
+      #
+      # @example Using +link_to+ with a regular expression
+      #   expect(link).to link_to(/\/tmp/(.+)/)
+      #
+      # @param [String, Regex] path
+      #   the path to link to
+      #
+      # @return [ChefSpec::Matchers::LinkToMatcher]
+      #
+      def link_to(path)
+        ChefSpec::Matchers::LinkToMatcher.new(path)
+      end
+
+    end
   end
 end

data/lib/chefspec/api/notifications.rb

@@ -1,35 +1,40 @@
-module ChefSpec::API
-  #
-  # Assert that a resource notifies another. Given a Chef Recipe that
-  # notifies a template resource to restart apache:
-  #
-  #     template '/etc/apache2/config' do
-  #       notifies :restart, 'service[apache2]'
-  #     end
-  #
-  # The Examples section demonstrates the different ways to test an
-  # notifications on a resource with ChefSpec.
-  #
-  # @example Assert the template notifies apache of something
-  #   template = chef_run.template('/etc/apache2.conf')
-  #   expect(template).to notify('service[apache2]')
-  #
-  # @example Assert the template notifies apache to restart
-  #   expect(template).to notify('service[apache2]').to(:restart)
-  #
-  # @example Assert the template notifies apache to restart immediately
-  #   expect(template).to notify('service[apache2]').to(:restart).immediately
-  #
-  # @example Assert the template notifies apache to restart delayed
-  #   expect(template).to notify('service[apache2]').to(:restart).delayed
-  #
-  #
-  # @param [String] signature
-  #   the signature of the notification to match
-  #
-  # @return [ChefSpec::Matchers::NotificationsMatcher]
-  #
-  def notify(signature)
-    ChefSpec::Matchers::NotificationsMatcher.new(signature)
+module ChefSpec
+  module API
+    module Notifications
+      #
+      # Assert that a resource notifies another. Given a Chef Recipe that
+      # notifies a template resource to restart apache:
+      #
+      #     template '/etc/apache2/config' do
+      #       notifies :restart, 'service[apache2]'
+      #     end
+      #
+      # The Examples section demonstrates the different ways to test an
+      # notifications on a resource with ChefSpec.
+      #
+      # @example Assert the template notifies apache of something
+      #   template = chef_run.template('/etc/apache2.conf')
+      #   expect(template).to notify('service[apache2]')
+      #
+      # @example Assert the template notifies apache to restart
+      #   expect(template).to notify('service[apache2]').to(:restart)
+      #
+      # @example Assert the template notifies apache to restart immediately
+      #   expect(template).to notify('service[apache2]').to(:restart).immediately
+      #
+      # @example Assert the template notifies apache to restart delayed
+      #   expect(template).to notify('service[apache2]').to(:restart).delayed
+      #
+      #
+      # @param [String] signature
+      #   the signature of the notification to match
+      #
+      # @return [ChefSpec::Matchers::NotificationsMatcher]
+      #
+      def notify(signature)
+        ChefSpec::Matchers::NotificationsMatcher.new(signature)
+      end
+
+    end
   end
 end

data/lib/chefspec/api/reboot.rb

@@ -1,9 +1,14 @@
-module ChefSpec::API
-  def now_reboot(resource_name)
-    ChefSpec::Matchers::ResourceMatcher.new(:reboot, :reboot_now, resource_name)
-  end
+module ChefSpec
+  module API
+    module Reboot
+      def now_reboot(resource_name)
+        ChefSpec::Matchers::ResourceMatcher.new(:reboot, :reboot_now, resource_name)
+      end
+
+      def request_reboot(resource_name)
+        ChefSpec::Matchers::ResourceMatcher.new(:reboot, :request_reboot, resource_name)
+      end
 
-  def request_reboot(resource_name)
-    ChefSpec::Matchers::ResourceMatcher.new(:reboot, :request_reboot, resource_name)
+    end
   end
 end

data/lib/chefspec/api/render_file.rb

@@ -1,32 +1,37 @@
-module ChefSpec::API
-  #
-  # Assert that a file is rendered by the Chef run. This matcher works for
-  # +template+, +file+, and +cookbook_file+ resources. The content from the
-  # resource must be convertable to a string; verifying the content of a
-  # binary file is not permissible at this time.
-  #
-  # @example Assert a template is rendered
-  #   expect(chef_run).to render_file('/etc/foo')
-  #
-  # @example Assert a template is rendered with certain content
-  #   expect(template).to render_file('/etc/foo').with_content('This is a file')
-  #
-  # @example Assert a template is rendered with matching content
-  #   expect(template).to render_file('/etc/foo').with_content(/^This(.+)$/)
-  #
-  # @example Assert a template is rendered with content matching any RSpec matcher
-  #   expect(template).to render_file('/etc/foo').with_content(starts_with('This'))
-  #
-  # @example Assert a partial path to a template is rendered with matching content
-  #   expect(template).to render_file(/\/etc\/foo-(\d+)$/).with_content(/^This(.+)$/)
-  #
-  #
-  # @param [String] path
-  #   the path of the file to render
-  #
-  # @return [ChefSpec::Matchers::RenderFileMatcher]
-  #
-  def render_file(path)
-    ChefSpec::Matchers::RenderFileMatcher.new(path)
+module ChefSpec
+  module API
+    module RenderFile
+      #
+      # Assert that a file is rendered by the Chef run. This matcher works for
+      # +template+, +file+, and +cookbook_file+ resources. The content from the
+      # resource must be convertable to a string; verifying the content of a
+      # binary file is not permissible at this time.
+      #
+      # @example Assert a template is rendered
+      #   expect(chef_run).to render_file('/etc/foo')
+      #
+      # @example Assert a template is rendered with certain content
+      #   expect(template).to render_file('/etc/foo').with_content('This is a file')
+      #
+      # @example Assert a template is rendered with matching content
+      #   expect(template).to render_file('/etc/foo').with_content(/^This(.+)$/)
+      #
+      # @example Assert a template is rendered with content matching any RSpec matcher
+      #   expect(template).to render_file('/etc/foo').with_content(starts_with('This'))
+      #
+      # @example Assert a partial path to a template is rendered with matching content
+      #   expect(template).to render_file(/\/etc\/foo-(\d+)$/).with_content(/^This(.+)$/)
+      #
+      #
+      # @param [String] path
+      #   the path of the file to render
+      #
+      # @return [ChefSpec::Matchers::RenderFileMatcher]
+      #
+      def render_file(path)
+        ChefSpec::Matchers::RenderFileMatcher.new(path)
+      end
+
+    end
   end
 end

data/lib/chefspec/api/state_attrs.rb

@@ -1,25 +1,30 @@
-module ChefSpec::API
-  #
-  # Assert that a Chef resource has certain state attributes (since Chef
-  # 11.8.0):
-  #
-  #     state_attrs :time, :temperature
-  #
-  # @see https://github.com/opscode/chef/blob/e43d7ebda/lib/chef/resource/file.rb#L32-L37
-  #
-  # The Examples section demonstrates the different ways to test a
-  # resource's +state_attrs+ with ChefSpec.
-  #
-  # @example Assert the +lwrp+ resource has two state attributes
-  #   expect(lwrp).to have_state_attrs(:time, :temperature)
-  #
-  #
-  # @param [Array] state_attrs
-  #   the list of state attributes to assert
-  #
-  # @return [ChefSpec::Matchers::StateAttrsMatcher]
-  #
-  def have_state_attrs(*state_attrs)
-    ChefSpec::Matchers::StateAttrsMatcher.new(state_attrs)
+module ChefSpec
+  module API
+    module StateAttrs
+      #
+      # Assert that a Chef resource has certain state attributes (since Chef
+      # 11.8.0):
+      #
+      #     state_attrs :time, :temperature
+      #
+      # @see https://github.com/opscode/chef/blob/e43d7ebda/lib/chef/resource/file.rb#L32-L37
+      #
+      # The Examples section demonstrates the different ways to test a
+      # resource's +state_attrs+ with ChefSpec.
+      #
+      # @example Assert the +lwrp+ resource has two state attributes
+      #   expect(lwrp).to have_state_attrs(:time, :temperature)
+      #
+      #
+      # @param [Array] state_attrs
+      #   the list of state attributes to assert
+      #
+      # @return [ChefSpec::Matchers::StateAttrsMatcher]
+      #
+      def have_state_attrs(*state_attrs)
+        ChefSpec::Matchers::StateAttrsMatcher.new(state_attrs)
+      end
+
+    end
   end
 end

data/lib/chefspec/api/stubs.rb

@@ -0,0 +1,183 @@
+module ChefSpec
+  module API
+    module Stubs
+      #
+      # Stub a shell command to return a particular value without
+      # shelling out to the system.
+      #
+      # @example stubbing a command to return true
+      #   stub_command('test -f /tmp/bacon').and_return(true)
+      #
+      # @example stubbing a block that is evaluated at runtime
+      #   stub_command('test -f /tmp/bacon') { MyClass.check? }
+      #
+      # @example stubbing a command that matches a pattern
+      #   stub_command(/test \-f/).and_return(true)
+      #
+      # @example stubbing a command that raises an exception
+      #   stub_command('test -f /tmp/bacon').and_raise(SomeException)
+      #
+      #
+      # @param [String, Regexp] command
+      #   the command to stub
+      #
+      # @return [ChefSpec::CommandStub]
+      #
+      def stub_command(command, &block)
+        ChefSpec::Stubs::CommandRegistry.register(ChefSpec::Stubs::CommandStub.new(command, &block))
+      end
+
+      #
+      # Stub a Chef call to load a data_bag.
+      #
+      # @example stubbing a data_bag to return an empty Array
+      #   stub_data_bag('users').and_return([])
+      #
+      # @example stubbing a data_bag with a block that is evaluated at runtime
+      #   stub_data_bag('users') { JSON.parse(File.read('fixtures/data_bag.json')) }
+      #
+      # @example stubbing a data_bag to return an Array of Hashes
+      #   stub_data_bag('users').and_return([
+      #     { id: 'bacon', comment: 'delicious' },
+      #     { id: 'ham', comment: 'also good' }
+      #   ])
+      #
+      # @example stubbing a data_bag to raise an exception
+      #   stub_data_bag('users').and_raise(Chef::Exceptions::PrivateKeyMissing)
+      #
+      #
+      # @param [String, Symbol] bag
+      #   the name of the data bag to stub
+      #
+      # @return [ChefSpec::DataBagStub]
+      #
+      def stub_data_bag(bag, &block)
+        ChefSpec::Stubs::DataBagRegistry.register(ChefSpec::Stubs::DataBagStub.new(bag, &block))
+      end
+
+      #
+      # Stub a Chef data_bag call.
+      #
+      # @example stubbing a data_bag_item to return a Hash of data
+      #   stub_data_bag_item('users', 'svargo').and_return({
+      #     id: 'svargo',
+      #     name: 'Seth Vargo'
+      #   })
+      #
+      # @example stubbing a data_bag_item with a block that is evaluated at runtime
+      #   stub_data_bag_item('users', 'svargo') { JSON.parse(File.read('fixtures/data_bag_item.json')) }
+      #
+      # @example stubbing a data_bag_item to raise an exception
+      #   stub_data_bag('users', 'svargo').and_raise(Chef::Exceptions::PrivateKeyMissing)
+      #
+      #
+      # @param [String, Symbol] bag
+      #   the name of the data bag to find the item in
+      # @param [String] id
+      #   the id of the data bag item to stub
+      #
+      # @return [ChefSpec::DataBagItemStub]
+      #
+      def stub_data_bag_item(bag, id, &block)
+        ChefSpec::Stubs::DataBagItemRegistry.register(ChefSpec::Stubs::DataBagItemStub.new(bag, id, &block))
+      end
+
+      #
+      # Creates a fake Chef::Node for use in testing.
+      #
+      # @example mocking a simple node
+      #   stub_node('mynode.example')
+      #
+      # @example mocking a specific platform and version
+      #   stub_node('mynode.example', platform: 'ubuntu', version: '18.04')
+      #
+      # @example overriding a specific ohai attribute
+      #   stub_node('mynode.example', ohai: { ipaddress: '1.2.3.4' })
+      #
+      # @example stubbing a node based on a JSON fixture
+      #   stub_node('mynode.example', path: File.join('fixtures', 'nodes', 'default.json'))
+      #
+      # @example setting specific attributes
+      #   stub_node('mynode.example') do |node|
+      #     node.default['attribute']['thing'] = 'value'
+      #   end
+      #
+      #
+      # @param [String] name
+      #   the name of the node
+      # @param [Hash] options
+      #   the list of options for the node
+      #
+      # @option options [Symbol] :platform
+      #   the platform to mock
+      # @option options [Symbol] :version
+      #   the version of the platform to mock
+      # @option options [Symbol] :path
+      #   filepath to a JSON file to pull a node from
+      # @option options [Hash] :ohai
+      #   a Hash of Ohai attributes to mock on the node
+      #
+      # @return [Chef::Node]
+      #
+      def stub_node(*args, &block)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        name    = args.first || 'node.example'
+
+        fauxhai = Fauxhai.mock(options).data
+        fauxhai = fauxhai.merge(options[:ohai] || {})
+        fauxhai = Mash.new(fauxhai)
+
+        node = Chef::Node.new
+        node.name(name)
+        node.automatic_attrs = fauxhai
+        node.instance_eval(&block) if block_given?
+        node
+      end
+
+      #
+      # Stub a Chef search to return pre-defined data. When providing a value,
+      # the value is automatically mashified (to the best of ChefSpec's abilities)
+      # to ease in use.
+      #
+      # @example stubbing a search to return nothing
+      #   stub_search(:node)
+      #
+      # @example stubbing a search with a query
+      #   stub_search(:node, 'name:*')
+      #
+      # @example stubbing a search with a query as a regex
+      #   stub_search(:node, /name:(.+)/)
+      #
+      # @example stubbing a search with a block that is evaluated at runtime
+      #   stub_search(:node) { JSON.parse(File.read('fixtures/nodes.json')) }
+      #
+      # @example stubbing a search to return a fixed value
+      #   stub_search(:node).and_return([ { a: 'b' } ])
+      #
+      # @example stubbing a search to raise an exception
+      #   stub_search(:node).and_raise(Chef::Exceptions::PrivateKeyMissing)
+      #
+      #
+      # @param [String, Symbol] type
+      #   the type to search to stub
+      # @param [String, Symbol, nil] query
+      #   the query to stub
+      #
+      # @return [ChefSpec::SearchStub]
+      #
+      def stub_search(type, query = '*:*', &block)
+        ChefSpec::Stubs::SearchRegistry.register(ChefSpec::Stubs::SearchStub.new(type, query, &block))
+      end
+
+      # Automatically clear all stubs after each test.
+      extend RSpec::SharedContext
+      after(:each) do
+        ChefSpec::Stubs::CommandRegistry.reset!
+        ChefSpec::Stubs::DataBagRegistry.reset!
+        ChefSpec::Stubs::DataBagItemRegistry.reset!
+        ChefSpec::Stubs::SearchRegistry.reset!
+      end
+
+    end
+  end
+end