chefspec 8.0.1 → 9.3.0

data/lib/chefspec/matchers/include_any_recipe_matcher.rb

@@ -0,0 +1,51 @@
+module ChefSpec::Matchers
+  class IncludeAnyRecipeMatcher
+    def matches?(runner)
+      @runner = runner
+      !(loaded_recipes - run_list_recipes).empty?
+    end
+
+    def description
+      "include any recipe"
+    end
+
+    def failure_message
+      "expected to include any recipe"
+    end
+
+    def failure_message_when_negated
+      "expected not to include any recipes"
+    end
+
+    private
+
+    #
+    # The list of run_list recipes on the Chef run (normalized)
+    #
+    # @return [Array<String>]
+    #
+    def run_list_recipes
+      @runner.run_context.node.run_list.run_list_items.map { |x| with_default(x.name) }
+    end
+
+    #
+    # Automatically appends "+::default+" to recipes that need them.
+    #
+    # @param [String] name
+    #
+    # @return [String]
+    #
+    def with_default(name)
+      name.include?("::") ? name : "#{name}::default"
+    end
+
+    #
+    # The list of loaded recipes on the Chef run (normalized)
+    #
+    # @return [Array<String>]
+    #
+    def loaded_recipes
+      @runner.run_context.loaded_recipes.map { |name| with_default(name) }
+    end
+  end
+end

data/lib/chefspec/matchers/include_recipe_matcher.rb

@@ -31,7 +31,7 @@ module ChefSpec::Matchers
     # @return [String]
     #
     def with_default(name)
-      name.include?('::') ? name : "#{name}::default"
+      name.include?("::") ? name : "#{name}::default"
     end
 
     #

data/lib/chefspec/matchers/link_to_matcher.rb

@@ -11,8 +11,8 @@ module ChefSpec::Matchers
         ChefSpec::Coverage.cover!(@link)
 
         @link.is_a?(Chef::Resource::Link) &&
-        @link.performed_action?(:create) &&
-        @path === @link.to
+          @link.performed_action?(:create) &&
+          @path === @link.to
       else
         false
       end

data/lib/chefspec/matchers/notifications_matcher.rb

@@ -14,8 +14,8 @@ module ChefSpec::Matchers
       if @resource
         block = Proc.new do |notified|
           resource_name(notified.resource).to_s == @expected_resource_type &&
-          (@expected_resource_name === notified.resource.identity.to_s || @expected_resource_name === notified.resource.name.to_s) &&
-          matches_action?(notified)
+            (@expected_resource_name === notified.resource.identity.to_s || @expected_resource_name === notified.resource.name.to_s) &&
+            matches_action?(notified)
         end
 
         if @immediately
@@ -115,6 +115,7 @@ module ChefSpec::Matchers
 
     def matches_action?(notification)
       return true if @action.nil?
+
       @action == notification.action.to_sym
     end
 
@@ -130,12 +131,12 @@ module ChefSpec::Matchers
         type = :delayed
       end
 
-      %Q{  "#{notifying_resource.to_s}" notifies "#{resource_name(resource)}[#{resource.name}]" to :#{notification.action}, :#{type}}
+      %Q{  "#{notifying_resource}" notifies "#{resource_name(resource)}[#{resource.name}]" to :#{notification.action}, :#{type}}
     end
 
     def format_notifications
       all_notifications.map do |notification|
-        '  ' + format_notification(notification)
+        "  " + format_notification(notification)
       end.join("\n")
     end
   end

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -87,8 +87,8 @@ module ChefSpec::Matchers
 
     def resource
       @resource ||= @runner.find_resource(:cookbook_file, @path) ||
-                    @runner.find_resource(:file, @path) ||
-                    @runner.find_resource(:template, @path)
+        @runner.find_resource(:file, @path) ||
+        @runner.find_resource(:template, @path)
     end
 
     #
@@ -99,7 +99,7 @@ module ChefSpec::Matchers
     # @return [true, false]
     #
     def has_create_action?
-      [:create, :create_if_missing].any? { |action| resource.performed_action?(action) }
+      %i{create create_if_missing}.any? { |action| resource.performed_action?(action) }
     end
 
     #

data/lib/chefspec/matchers/resource_matcher.rb

@@ -1,5 +1,5 @@
-require 'rspec/matchers/expecteds_for_multiple_diffs'
-require 'rspec/expectations/fail_with'
+require "rspec/matchers/expecteds_for_multiple_diffs"
+require "rspec/expectations/fail_with"
 
 module ChefSpec::Matchers
   class ResourceMatcher
@@ -15,13 +15,15 @@ module ChefSpec::Matchers
     end
 
     def at_compile_time
-      raise ArgumentError, 'Cannot specify both .at_converge_time and .at_compile_time!' if @converge_time
+      raise ArgumentError, "Cannot specify both .at_converge_time and .at_compile_time!" if @converge_time
+
       @compile_time = true
       self
     end
 
     def at_converge_time
-      raise ArgumentError, 'Cannot specify both .at_compile_time and .at_converge_time!' if @compile_time
+      raise ArgumentError, "Cannot specify both .at_compile_time and .at_converge_time!" if @compile_time
+
       @converge_time = true
       self
     end
@@ -55,20 +57,20 @@ module ChefSpec::Matchers
       if resource
         if unmatched_parameters.empty?
           if @compile_time
-            %Q{expected "#{resource.to_s}" to be run at compile time}
+            %Q{expected "#{resource}" to be run at compile time}
           else
-            %Q{expected "#{resource.to_s}" to be run at converge time}
+            %Q{expected "#{resource}" to be run at converge time}
           end
         else
-          message = %Q{expected "#{resource.to_s}" to have parameters:} \
+          message = %Q{expected "#{resource}" to have parameters:} \
             "\n\n" \
             "  " + unmatched_parameters.collect { |parameter, h|
-            msg = "#{parameter} #{h[:expected].inspect}, was #{h[:actual].inspect}"
-            diff = ::RSpec::Matchers::ExpectedsForMultipleDiffs.from(h[:expected]) \
-              .message_with_diff(message, ::RSpec::Expectations::differ, h[:actual])
-            msg += diff if diff
-            msg
-          }.join("\n  ")
+              msg = "#{parameter} #{h[:expected].inspect}, was #{h[:actual].inspect}"
+              diff = ::RSpec::Matchers::ExpectedsForMultipleDiffs.from(h[:expected]) \
+                .message_with_diff(message, ::RSpec::Expectations.differ, h[:actual])
+              msg += diff if diff
+              msg
+            }.join("\n  ")
         end
       else
         %Q{expected "#{@resource_name}[#{@expected_identity}]"} \
@@ -81,9 +83,9 @@ module ChefSpec::Matchers
 
     def failure_message_when_negated
       if resource
-        message = %Q{expected "#{resource.to_s}" actions #{resource.performed_actions.inspect} to not exist}
+        message = %Q{expected "#{resource}" actions #{resource.performed_actions.inspect} to not exist}
       else
-        message = %Q{expected "#{resource.to_s}" to not exist}
+        message = %Q{expected "#{resource}" to not exist}
       end
 
       message << " at compile time"  if @compile_time
@@ -115,7 +117,7 @@ module ChefSpec::Matchers
       if parameter == :source
         # Chef 11+ stores the source parameter internally as an Array
         Array(expected) == Array(value)
-      elsif expected.kind_of?(Class)
+      elsif expected.is_a?(Class)
         # Ruby can't compare classes with ===
         expected == value
       else

data/lib/chefspec/mixins/normalize.rb

@@ -16,7 +16,7 @@ module ChefSpec
       else
         name = thing
       end
-      name.to_s.gsub('-', '_').to_sym
+      name.to_s.gsub("-", "_").to_sym
     end
   end
 end

data/lib/chefspec/policyfile.rb

@@ -1,8 +1,8 @@
 begin
-  require 'chef-cli/policyfile_services/export_repo'
-  require 'chef-cli/policyfile_services/install'
+  require "chef-cli/policyfile_services/export_repo"
+  require "chef-cli/policyfile_services/install"
 rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'chef-cli', name: 'ChefCLI')
+  raise ChefSpec::Error::GemLoadError.new(gem: "chef-cli", name: "ChefCLI")
 end
 
 module ChefSpec
@@ -24,7 +24,7 @@ module ChefSpec
     def setup!
       policyfile_path = RSpec.configuration.policyfile_path
       if policyfile_path.nil?
-        policyfile_path = File.join(Dir.pwd, 'Policyfile.rb')
+        policyfile_path = File.join(Dir.pwd, "Policyfile.rb")
       end
 
       installer = ChefCLI::PolicyfileServices::Install.new(
@@ -44,8 +44,8 @@ module ChefSpec
 
       ::RSpec.configure do |config|
         config.cookbook_path = [
-          File.join(@tmpdir, 'cookbooks'),
-          File.join(@tmpdir, 'cookbook_artifacts')
+          File.join(@tmpdir, "cookbooks"),
+          File.join(@tmpdir, "cookbook_artifacts"),
         ]
       end
     end

data/lib/chefspec/renderer.rb

@@ -1,6 +1,6 @@
 begin
-  require 'chef/mixin/template'
-  require 'chef/provider/template_finder'
+  require "chef/mixin/template"
+  require "chef/provider/template_finder"
 rescue LoadError
 end
 
@@ -67,8 +67,8 @@ module ChefSpec
       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),
+          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_context._extend_modules(template.helper_modules)

data/lib/chefspec/rspec.rb

@@ -1,5 +1,5 @@
 RSpec.configure do |config|
-  unless ENV['CHEFSPEC_NO_INCLUDE']
+  unless ENV["CHEFSPEC_NO_INCLUDE"]
     config.include(ChefSpec::API)
   end
 

data/lib/chefspec/runner.rb

@@ -1,4 +1,4 @@
-require "chefspec/solo_runner"
+require_relative "solo_runner"
 
 module ChefSpec
   # As we start to migrate back to only SoloRunner, include this alias for now.

data/lib/chefspec/server.rb

@@ -1,4 +1,4 @@
 # @todo Remove in v5.0.0
-require_relative 'deprecations'
+require_relative "deprecations"
 deprecated "require 'chefspec/server' is no longer required and " \
   "will be removed in the next major release."

data/lib/chefspec/server_methods.rb

@@ -88,11 +88,11 @@ module ChefSpec
       EOH
     end
 
-    entity :client,      Chef::Client, 'clients'
-    entity :data_bag,    Chef::DataBag, 'data'
-    entity :environment, Chef::Environment, 'environments'
-    entity :node,        Chef::Node, 'nodes'
-    entity :role,        Chef::Role, 'roles'
+    entity :client,      Chef::Client, "clients"
+    entity :data_bag,    Chef::DataBag, "data"
+    entity :environment, Chef::Environment, "environments"
+    entity :node,        Chef::Node, "nodes"
+    entity :role,        Chef::Role, "roles"
 
     #
     # Create a new data_bag on the Chef Server. This overrides the method
@@ -104,7 +104,7 @@ module ChefSpec
     #   the data to load into the data bag
     #
     def create_data_bag(name, data = {})
-      load_data(name, 'data', data)
+      load_data(name, "data", data)
     end
 
     #
@@ -138,7 +138,7 @@ module ChefSpec
         data = JSON.fast_generate(data)
       end
 
-      load_data(name, 'nodes', data)
+      load_data(name, "nodes", data)
     end
     alias_method :update_node, :create_node
 
@@ -161,7 +161,7 @@ module ChefSpec
     # Get the path to an item in the data store.
     #
     def get(*args)
-      args.unshift('organizations', 'chef')
+      args.unshift("organizations", "chef")
 
       if args.size == 3
         server.data_store.list(args)

data/lib/chefspec/server_runner.rb

@@ -1,10 +1,10 @@
-require 'chef/cookbook_loader'
-require 'chef/cookbook_uploader'
+require "chef/cookbook_loader"
+require "chef/cookbook_uploader"
 
-require_relative 'zero_server'
-require_relative 'file_cache_path_proxy'
-require_relative 'server_methods'
-require_relative 'solo_runner'
+require_relative "zero_server"
+require_relative "file_cache_path_proxy"
+require_relative "server_methods"
+require_relative "solo_runner"
 
 module ChefSpec
   class ServerRunner < SoloRunner
@@ -54,8 +54,8 @@ module ChefSpec
     #
     def client_key
       tmp = Dir.mktmpdir
-      path = File.join(tmp, 'client.pem')
-      File.open(path, 'wb') { |f| f.write(ChefZero::PRIVATE_KEY) }
+      path = File.join(tmp, "client.pem")
+      File.open(path, "wb") { |f| f.write(ChefZero::PRIVATE_KEY) }
       at_exit { FileUtils.rm_rf(tmp) }
       path
     end
@@ -64,8 +64,8 @@ module ChefSpec
     def apply_chef_config!
       super
       Chef::Config[:client_key]       = client_key
-      Chef::Config[:client_name]      = 'chefspec'
-      Chef::Config[:node_name]        = 'chefspec'
+      Chef::Config[:client_name]      = "chefspec"
+      Chef::Config[:node_name]        = "chefspec"
       Chef::Config[:solo]             = false
       Chef::Config[:solo_legacy_mode] = false
 

data/lib/chefspec/solo_runner.rb

@@ -1,9 +1,9 @@
-require 'fauxhai'
-require 'chef/client'
-require 'chef/cookbook/metadata'
-require 'chef/mash'
-require 'chef/providers'
-require 'chef/resources'
+require "fauxhai"
+require "chef/client"
+require "chef/cookbook/metadata"
+require "chef/mash"
+require "chef/providers"
+require "chef/resources"
 
 module ChefSpec
   class SoloRunner
@@ -123,6 +123,7 @@ module ChefSpec
       if converge_val.is_a?(Exception)
         raise converge_val
       end
+
       self
     end
 
@@ -136,7 +137,7 @@ module ChefSpec
     #
     def converge_block(&block)
       converge do
-        recipe = Chef::Recipe.new(cookbook_name, '_test', run_context)
+        recipe = Chef::Recipe.new(cookbook_name, "_test", run_context)
         recipe.instance_exec(&block)
       end
     end
@@ -149,7 +150,8 @@ module ChefSpec
     #
     def preload!
       # Flag to disable preloading for situations where it doesn't make sense.
-      return if ENV['CHEFSPEC_NO_PRELOAD']
+      return if ENV["CHEFSPEC_NO_PRELOAD"]
+
       begin
         old_preload = $CHEFSPEC_PRELOAD
         $CHEFSPEC_PRELOAD = true
@@ -292,7 +294,8 @@ module ChefSpec
     # Respond to custom matchers defined by the user.
     #
     def method_missing(m, *args, &block)
-      if block = ChefSpec.matchers[resource_name(m.to_sym)]
+      block = ChefSpec.matchers[resource_name(m.to_sym)]
+      if block
         instance_exec(args.first, &block)
       else
         super
@@ -358,11 +361,11 @@ module ChefSpec
     # @return [String]
     #
     def calling_cookbook_root(options, kaller)
-      calling_spec = options[:spec_declaration_locations] || kaller.find { |line| line =~ /\/spec/ }
+      calling_spec = options[:spec_declaration_locations] || kaller.find { |line| line =~ %r{/spec} }
       raise Error::CookbookPathNotFound if calling_spec.nil?
 
       bits = calling_spec.split(/:[0-9]/, 2).first.split(File::SEPARATOR)
-      spec_dir = bits.index('spec') || 0
+      spec_dir = bits.index("spec") || 0
 
       File.join(bits.slice(0, spec_dir))
     end
@@ -378,7 +381,7 @@ module ChefSpec
     # @return [String]
     #
     def calling_cookbook_path(options, kaller)
-      File.expand_path(File.join(calling_cookbook_root(options, kaller), '..'))
+      File.expand_path(File.join(calling_cookbook_root(options, kaller), ".."))
     end
 
     #
@@ -388,7 +391,7 @@ module ChefSpec
     #
     def default_role_path
       Pathname.new(Dir.pwd).ascend do |path|
-        possible = File.join(path, 'roles')
+        possible = File.join(path, "roles")
         return possible if File.exist?(possible)
       end
 
@@ -402,7 +405,7 @@ module ChefSpec
     #
     def default_environment_path
       Pathname.new(Dir.pwd).ascend do |path|
-        possible = File.join(path, 'environments')
+        possible = File.join(path, "environments")
         return possible if File.exist?(possible)
       end
 
@@ -459,7 +462,7 @@ module ChefSpec
     # @return [Chef::Cookbook::Metadata]
     #
     def cookbook
-      @cookbook ||= Chef::Cookbook::Metadata.new.tap {|m| m.from_file("#{options[:cookbook_root]}/metadata.rb") }
+      @cookbook ||= Chef::Cookbook::Metadata.new.tap { |m| m.from_file("#{options[:cookbook_root]}/metadata.rb") }
     end
 
     #
@@ -470,12 +473,11 @@ module ChefSpec
     def cookbook_name
       # Try to figure out the name of this cookbook, pretending this block
       # is in the name context as the cookbook under test.
-      begin
-        cookbook.name
-      rescue IOError
-        # Old cookbook, has no metadata, use the folder name I guess.
-        File.basename(options[:cookbook_root])
-      end
+
+      cookbook.name
+    rescue IOError
+      # Old cookbook, has no metadata, use the folder name I guess.
+      File.basename(options[:cookbook_root])
     end
 
     #
@@ -489,8 +491,8 @@ module ChefSpec
 
       Chef::Config.reset!
       Chef::Config.formatters.clear
-      Chef::Config.add_formatter('chefspec')
-      Chef::Config[:cache_type]      = 'Memory'
+      Chef::Config.add_formatter("chefspec")
+      Chef::Config[:cache_type]      = "Memory"
       Chef::Config[:client_key]      = nil
       Chef::Config[:client_name]     = nil
       Chef::Config[:node_name]       = nil
@@ -506,7 +508,7 @@ module ChefSpec
       Chef::Config[:force_logger]    = true
       Chef::Config[:solo]            = true
       Chef::Config[:solo_legacy_mode] = true
-      Chef::Config[:use_policyfile]  = false
+      Chef::Config[:use_policyfile] = false
       Chef::Config[:environment_path] = @options[:environment_path]
     end