chefspec 3.1.4 → 3.2.0

data/lib/chefspec/matchers/resource_matcher.rb

@@ -71,9 +71,9 @@ module ChefSpec::Matchers
           " to include :#{@expected_action}"
         end
       else
-        %Q{expected "#{@resource_name}[#{@expected_identity}] with"} \
-        " action :#{@expected_action} to be in Chef run. Other" \
-        " #{@resource_name} resources:" \
+        %Q{expected "#{@resource_name}[#{@expected_identity}]"} \
+        " with action :#{@expected_action} to be in Chef run." \
+        " Other #{@resource_name} resources:" \
         "\n\n" \
         "  " + similar_resources.map(&:to_s).join("\n  ") + "\n "
       end
@@ -92,77 +92,78 @@ module ChefSpec::Matchers
     end
 
     private
-      def unmatched_parameters
-        return @_unmatched_parameters if @_unmatched_parameters
 
-        @_unmatched_parameters = {}
+    def unmatched_parameters
+      return @_unmatched_parameters if @_unmatched_parameters
 
-        params.each do |parameter, expected|
-          unless matches_parameter?(parameter, expected)
-            @_unmatched_parameters[parameter] = {
-              expected: expected,
-              actual:   safe_send(parameter),
-            }
-          end
-        end
-
-        @_unmatched_parameters
-      end
+      @_unmatched_parameters = {}
 
-      def matches_parameter?(parameter, expected)
-        # Chef 11+ stores the source parameter internally as an Array
-        if parameter == :source
-          Array(expected) == Array(safe_send(parameter))
-        else
-          expected === safe_send(parameter)
+      params.each do |parameter, expected|
+        unless matches_parameter?(parameter, expected)
+          @_unmatched_parameters[parameter] = {
+            expected: expected,
+            actual:   safe_send(parameter),
+          }
         end
       end
 
-      def correct_phase?
-        if @compile_time
-          resource.performed_action(@expected_action)[:compile_time]
-        elsif @converge_time
-          resource.performed_action(@expected_action)[:converge_time]
-        else
-          true
-        end
-      end
+      @_unmatched_parameters
+    end
 
-      def safe_send(parameter)
-        resource.send(parameter)
-      rescue NoMethodError
-        nil
+    def matches_parameter?(parameter, expected)
+      # Chef 11+ stores the source parameter internally as an Array
+      if parameter == :source
+        Array(expected) == Array(safe_send(parameter))
+      else
+        expected === safe_send(parameter)
       end
+    end
 
-      #
-      # Any other resources in the Chef run that have the same resource
-      # type. Used by {failure_message} to be ultra helpful.
-      #
-      # @return [Array<Chef::Resource>]
-      #
-      def similar_resources
-        @_similar_resources ||= @runner.find_resources(@resource_name)
+    def correct_phase?
+      if @compile_time
+        resource.performed_action(@expected_action)[:compile_time]
+      elsif @converge_time
+        resource.performed_action(@expected_action)[:converge_time]
+      else
+        true
       end
+    end
 
-      #
-      # Find the resource in the Chef run by the given class name and
-      # resource identity/name.
-      #
-      # @see ChefSpec::Runner#find_resource
-      #
-      # @return [Chef::Resource, nil]
-      #
-      def resource
-        @_resource ||= @runner.find_resource(@resource_name, @expected_identity)
-      end
+    def safe_send(parameter)
+      resource.send(parameter)
+    rescue NoMethodError
+      nil
+    end
 
-      #
-      # The list of parameters passed to the {with} matcher.
-      #
-      # @return [Hash]
-      #
-      def params
-        @_params ||= {}
-      end
+    #
+    # Any other resources in the Chef run that have the same resource
+    # type. Used by {failure_message} to be ultra helpful.
+    #
+    # @return [Array<Chef::Resource>]
+    #
+    def similar_resources
+      @_similar_resources ||= @runner.find_resources(@resource_name)
+    end
+
+    #
+    # Find the resource in the Chef run by the given class name and
+    # resource identity/name.
+    #
+    # @see ChefSpec::Runner#find_resource
+    #
+    # @return [Chef::Resource, nil]
+    #
+    def resource
+      @_resource ||= @runner.find_resource(@resource_name, @expected_identity)
+    end
+
+    #
+    # The list of parameters passed to the {with} matcher.
+    #
+    # @return [Hash]
+    #
+    def params
+      @_params ||= {}
+    end
   end
 end

data/lib/chefspec/matchers/state_attrs_matcher.rb

@@ -48,23 +48,24 @@ module ChefSpec::Matchers
     end
 
     private
-      #
-      # Determine if all the expected state attributes are present on the
-      # given resource.
-      #
-      # @return [Boolean]
-      #
-      def matches_state_attrs?
-        @expected_attrs == state_attrs
-      end
 
-      #
-      # The list of state attributes declared on the given resource.
-      #
-      # @return [Array<Symbol>]
-      #
-      def state_attrs
-        @resource.class.state_attrs.map(&:to_sym)
-      end
+    #
+    # Determine if all the expected state attributes are present on the
+    # given resource.
+    #
+    # @return [Boolean]
+    #
+    def matches_state_attrs?
+      @expected_attrs == state_attrs
+    end
+
+    #
+    # The list of state attributes declared on the given resource.
+    #
+    # @return [Array<Symbol>]
+    #
+    def state_attrs
+      @resource.class.state_attrs.map(&:to_sym)
+    end
   end
 end

data/lib/chefspec/matchers/subscribes_matcher.rb

@@ -0,0 +1,59 @@
+module ChefSpec::Matchers
+  class SubscribesMatcher
+    include ChefSpec::Normalize
+
+    def initialize(signature)
+      signature.match(/^([^\[]*)\[(.*)\]$/)
+      @expected_resource_type = $1
+      @expected_resource_name = $2
+    end
+
+    def matches?(resource)
+      @instance = ChefSpec::Matchers::NotificationsMatcher.new(resource.to_s)
+
+      if @action
+        @instance.to(@action)
+      end
+
+      if @immediately
+        @instance.immediately
+      end
+
+      if @delayed
+        @instance.delayed
+      end
+
+      if resource
+        runner   = resource.run_context.node.runner
+        expected = runner.find_resource(@expected_resource_type, @expected_resource_name)
+
+        @instance.matches?(expected)
+      else
+        @instance.matches?(nil)
+      end
+    end
+
+    def on(action)
+      @action = action
+      self
+    end
+
+    def immediately
+      @immediately = true
+      self
+    end
+
+    def delayed
+      @delayed = true
+      self
+    end
+
+    def description
+      @instance.description
+    end
+
+    def failure_message_for_should
+      @instance.failure_message_for_should
+    end
+  end
+end

data/lib/chefspec/renderer.rb

@@ -49,96 +49,97 @@ module ChefSpec
     end
 
     private
-      #
-      # Compute the contents of a template using Chef's templating logic.
-      #
-      # @param [Chef::RunContext] chef_run
-      #   the run context for the node
-      # @param [Chef::Provider::Template] template
-      #   the template resource
-      #
-      # @return [String]
-      #
-      def content_from_template(chef_run, template)
-        cookbook_name = template.cookbook || template.cookbook_name
-        template_location = cookbook_collection(chef_run.node)[cookbook_name].preferred_filename_on_disk_location(chef_run.node, :templates, template.source)
 
-        if Chef::Mixin::Template.const_defined?(:TemplateContext) # Chef 11+
-          template_context = Chef::Mixin::Template::TemplateContext.new([])
-          template_context.update({
-            :node => chef_run.node,
-            :template_finder => template_finder(chef_run, cookbook_name),
-          }.merge(template.variables))
-          if template.respond_to?(:helper_modules) # Chef 11.4+
-            template.helper_modules.each do |helper_module|
-              template_context.extend(helper_module)
-            end
-          end
-          template_context.render_template(template_location)
-        else
-          template.provider.new(template, chef_run.run_context).send(:render_with_context, template_location) do |file|
-            File.read(file.path)
+    #
+    # Compute the contents of a template using Chef's templating logic.
+    #
+    # @param [Chef::RunContext] chef_run
+    #   the run context for the node
+    # @param [Chef::Provider::Template] template
+    #   the template resource
+    #
+    # @return [String]
+    #
+    def content_from_template(chef_run, template)
+      cookbook_name = template.cookbook || template.cookbook_name
+      template_location = cookbook_collection(chef_run.node)[cookbook_name].preferred_filename_on_disk_location(chef_run.node, :templates, template.source)
+
+      if Chef::Mixin::Template.const_defined?(:TemplateContext) # Chef 11+
+        template_context = Chef::Mixin::Template::TemplateContext.new([])
+        template_context.update({
+          :node => chef_run.node,
+          :template_finder => template_finder(chef_run, cookbook_name),
+        }.merge(template.variables))
+        if template.respond_to?(:helper_modules) # Chef 11.4+
+          template.helper_modules.each do |helper_module|
+            template_context.extend(helper_module)
           end
         end
+        template_context.render_template(template_location)
+      else
+        template.provider.new(template, chef_run.run_context).send(:render_with_context, template_location) do |file|
+          File.read(file.path)
+        end
       end
+    end
 
-      #
-      # Get the contents of a file resource.
-      #
-      # @param [Chef::RunContext] chef_run
-      #   the run context for the node
-      # @param [Chef::Provider::File] file
-      #   the file resource
-      #
-      # @return [String]
-      #
-      def content_from_file(chef_run, file)
-        file.content
-      end
+    #
+    # Get the contents of a file resource.
+    #
+    # @param [Chef::RunContext] chef_run
+    #   the run context for the node
+    # @param [Chef::Provider::File] file
+    #   the file resource
+    #
+    # @return [String]
+    #
+    def content_from_file(chef_run, file)
+      file.content
+    end
 
-      #
-      # Get the contents of a cookbook file using Chef.
-      #
-      # @param [Chef::RunContext] chef_run
-      #   the run context for the node
-      # @param [Chef::Provider::CookbookFile] cookbook_file
-      #   the file resource
-      #
-      def content_from_cookbook_file(chef_run, cookbook_file)
-        cookbook_name = cookbook_file.cookbook || cookbook_file.cookbook_name
-        cookbook = cookbook_collection(chef_run.node)[cookbook_name]
-        File.read(cookbook.preferred_filename_on_disk_location(chef_run.node, :files, cookbook_file.source, cookbook_file.path))
-      end
+    #
+    # Get the contents of a cookbook file using Chef.
+    #
+    # @param [Chef::RunContext] chef_run
+    #   the run context for the node
+    # @param [Chef::Provider::CookbookFile] cookbook_file
+    #   the file resource
+    #
+    def content_from_cookbook_file(chef_run, cookbook_file)
+      cookbook_name = cookbook_file.cookbook || cookbook_file.cookbook_name
+      cookbook = cookbook_collection(chef_run.node)[cookbook_name]
+      File.read(cookbook.preferred_filename_on_disk_location(chef_run.node, :files, cookbook_file.source, cookbook_file.path))
+    end
 
-      # The cookbook collection for the current Chef run context. Handles
-      # the differing cases between Chef 10 and Chef 11.
-      #
-      # @param [Chef::Node] node
-      #   the Chef node to get the cookbook collection from
-      #
-      # @return [Array<Chef::Cookbook>]
-      def cookbook_collection(node)
-        if node.respond_to?(:run_context)
-          node.run_context.cookbook_collection # Chef 11+
-        else
-          node.cookbook_collection # Chef 10
-        end
+    # The cookbook collection for the current Chef run context. Handles
+    # the differing cases between Chef 10 and Chef 11.
+    #
+    # @param [Chef::Node] node
+    #   the Chef node to get the cookbook collection from
+    #
+    # @return [Array<Chef::Cookbook>]
+    def cookbook_collection(node)
+      if node.respond_to?(:run_context)
+        node.run_context.cookbook_collection # Chef 11+
+      else
+        node.cookbook_collection # Chef 10
       end
+    end
 
-      # Return a new instance of the TemplateFinder if we are running on Chef 11.
-      #
-      # @param [Chef::RunContext] chef_run
-      #   the run context for the noe
-      # @param [String] cookbook_name
-      #   the name of the cookbook
-      #
-      # @return [Chef::Provider::TemplateFinder, nil]
-      def template_finder(chef_run, cookbook_name)
-        if Chef::Provider.const_defined?(:TemplateFinder) # Chef 11+
-          Chef::Provider::TemplateFinder.new(chef_run.run_context, cookbook_name, chef_run.node)
-        else
-          nil
-        end
+    # Return a new instance of the TemplateFinder if we are running on Chef 11.
+    #
+    # @param [Chef::RunContext] chef_run
+    #   the run context for the noe
+    # @param [String] cookbook_name
+    #   the name of the cookbook
+    #
+    # @return [Chef::Provider::TemplateFinder, nil]
+    def template_finder(chef_run, cookbook_name)
+      if Chef::Provider.const_defined?(:TemplateFinder) # Chef 11+
+        Chef::Provider::TemplateFinder.new(chef_run.run_context, cookbook_name, chef_run.node)
+      else
+        nil
       end
+    end
   end
 end

data/lib/chefspec/runner.rb

@@ -257,66 +257,81 @@ module ChefSpec
     end
 
     private
-      #
-      # The inferred path from the calling spec.
-      #
-      # @param [Array<String>] kaller
-      #   the calling trace
-      #
-      # @return [String]
-      #
-      def calling_cookbook_path(kaller)
-        calling_spec = kaller.find { |line| line =~ /\/spec/ }
-        raise Error::CookbookPathNotFound if calling_spec.nil?
-
-        bits = calling_spec.split(':', 2).first.split(File::SEPARATOR)
-        spec_dir = bits.index('spec') || 0
-
-        File.expand_path(File.join(bits.slice(0, spec_dir), '..'))
-      end
 
-      #
-      # The inferred path to roles.
-      #
-      # @return [String, nil]
-      #
-      def default_role_path
-        Pathname.new(Dir.pwd).ascend do |path|
-          possible = File.join(path, 'roles')
-          return possible if File.exists?(possible)
-        end
+    #
+    # The inferred path from the calling spec.
+    #
+    # @param [Array<String>] kaller
+    #   the calling trace
+    #
+    # @return [String]
+    #
+    def calling_cookbook_path(kaller)
+      calling_spec = kaller.find { |line| line =~ /\/spec/ }
+      raise Error::CookbookPathNotFound if calling_spec.nil?
 
-        nil
-      end
+      bits = calling_spec.split(':', 2).first.split(File::SEPARATOR)
+      spec_dir = bits.index('spec') || 0
+
+      File.expand_path(File.join(bits.slice(0, spec_dir), '..'))
+    end
 
-      #
-      # The +Chef::Client+ for this runner.
-      #
-      # @return [Chef::Runner]
-      #
-      def client
-        return @client if @client
-
-        @client = Chef::Client.new
-        @client.ohai.data = Mash.from_hash(Fauxhai.mock(options).data)
-        @client.load_node
-        @client.build_node
-        @client.save_updated_node
-        @client
+    #
+    # The inferred path to roles.
+    #
+    # @return [String, nil]
+    #
+    def default_role_path
+      Pathname.new(Dir.pwd).ascend do |path|
+        possible = File.join(path, 'roles')
+        return possible if File.exists?(possible)
       end
 
-      #
-      # We really need a way to just expand the run_list, but that's done by
-      # +Chef::Client#build_node+. However, that same method also resets the
-      # automatic attributes, making it impossible to mock them. So we are
-      # stuck +instance_eval+ing against the client and manually expanding
-      # the mode object.
-      #
-      def expand_run_list!
+      nil
+    end
+
+    #
+    # The +Chef::Client+ for this runner.
+    #
+    # @return [Chef::Runner]
+    #
+    def client
+      return @client if @client
+
+      @client = Chef::Client.new
+      @client.ohai.data = Mash.from_hash(Fauxhai.mock(options).data)
+      @client.load_node
+      @client.build_node
+      @client.save_updated_node
+      @client
+    end
+
+    #
+    # We really need a way to just expand the run_list, but that's done by
+    # +Chef::Client#build_node+. However, that same method also resets the
+    # automatic attributes, making it impossible to mock them. So we are
+    # stuck +instance_eval+ing against the client and manually expanding
+    # the mode object.
+    #
+    # @todo Remove in Chef 13
+    #
+    def expand_run_list!
+      # Recent versions of Chef include a method to expand the +run_list+,
+      # setting the correct instance variables on the policy builder. We use
+      # that, unless the user is running an older version of Chef which
+      # doesn't include this method.
+      if client.respond_to?(:expanded_run_list)
+        client.expanded_run_list
+      else
+        # Sadly, if we got this far, it means that the current Chef version
+        # does not include the +expanded_run_list+ method, so we need to
+        # manually expand the +run_list+. The following code has been known
+        # to make kittens cry, so please read with extreme caution.
         client.instance_eval do
           @run_list_expansion = expand_run_list
           @expanded_run_list_with_versions = @run_list_expansion.recipes.with_version_constraints_strings
         end
       end
+    end
   end
 end