chefspec 9.1.0 → 9.3.1

data/lib/chefspec/extensions/chef/run_context/cookbook_compiler.rb

@@ -1,4 +1,4 @@
-require 'chef/run_context/cookbook_compiler'
+require "chef/run_context/cookbook_compiler"
 
 Chef::RunContext::CookbookCompiler.prepend(Module.new do
   # List of compile phases as of Chef 14:
@@ -15,27 +15,44 @@ Chef::RunContext::CookbookCompiler.prepend(Module.new do
 
   def load_libraries_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_LIBRARY_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_LIBRARY_PRELOAD[cookbook]
+
     $CHEFSPEC_LIBRARY_PRELOAD[cookbook] = true
     super
   end
 
+  def load_ohai_plugins_from_cookbook(cookbook)
+    return super unless $CHEFSPEC_MODE
+
+    $CHEFSPEC_OHAI_PRELOAD ||= {}
+    # Already loaded this once.
+    return if $CHEFSPEC_OHAI_PRELOAD[cookbook]
+
+    $CHEFSPEC_OHAI_PRELOAD[cookbook] = true
+    super
+  end
+
   def load_lwrps_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_LWRP_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_LWRP_PRELOAD[cookbook]
+
     $CHEFSPEC_LWRP_PRELOAD[cookbook] = true
     super
   end
 
   def load_resource_definitions_from_cookbook(cookbook)
     return super unless $CHEFSPEC_MODE
+
     $CHEFSPEC_DEFINITION_PRELOAD ||= {}
     # Already loaded this once.
     return if $CHEFSPEC_DEFINITION_PRELOAD[cookbook]
+
     $CHEFSPEC_DEFINITION_PRELOAD[cookbook] = true
     super
   end
@@ -47,18 +64,21 @@ Chef::RunContext::CookbookCompiler.prepend(Module.new do
   def compile_ohai_plugins
     return super unless $CHEFSPEC_MODE
     return if $CHEFSPEC_PRELOAD
+
     super
   end
 
   def compile_attributes
     return super unless $CHEFSPEC_MODE
     return if $CHEFSPEC_PRELOAD
+
     super
   end
 
   def compile_recipes
     return super unless $CHEFSPEC_MODE
     return if $CHEFSPEC_PRELOAD
+
     super
   end
 end)

data/lib/chefspec/extensions/chef/securable.rb

@@ -1,4 +1,4 @@
-require 'chef/mixin/securable'
+require "chef/mixin/securable"
 
 class Chef
   module Mixin

data/lib/chefspec/extensions/ohai/system.rb

@@ -0,0 +1,11 @@
+require "ohai/system"
+
+Ohai::System.prepend(Module.new do
+  # If an Ohai segment exists, don't actually pull data in for ohai.
+  # (we have fake data for that)
+  # @see Ohai::System#run_additional_plugins
+  def run_additional_plugins(plugin_path)
+    return super unless $CHEFSPEC_MODE
+    # noop
+  end
+end)

data/lib/chefspec/extensions.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require "rspec"
 
 module ChefSpec::Extensions
   module Chef
@@ -6,15 +6,16 @@ module ChefSpec::Extensions
 end
 
 # STOP! DO NOT ALPHABETIZE!
-require_relative 'extensions/chef/data_query' # must be before Chef::Resource loads
-require_relative 'extensions/chef/resource'  # must come before client extensions or anything that winds up loading resources
-require_relative 'extensions/chef/provider'
-require_relative 'extensions/chef/securable'
-require_relative 'extensions/chef/client'
-require_relative 'extensions/chef/conditional'
-require_relative 'extensions/chef/cookbook_uploader'
-require_relative 'extensions/chef/cookbook/gem_installer'
-require_relative 'extensions/chef/lwrp_base'
-require_relative 'extensions/chef/resource/freebsd_package'
-require_relative 'extensions/chef/run_context/cookbook_compiler'
-require_relative 'extensions/chef/cookbook_loader'
+require_relative "extensions/chef/data_query" # must be before Chef::Resource loads
+require_relative "extensions/chef/resource"  # must come before client extensions or anything that winds up loading resources
+require_relative "extensions/chef/provider"
+require_relative "extensions/chef/securable"
+require_relative "extensions/chef/client"
+require_relative "extensions/chef/conditional"
+require_relative "extensions/chef/cookbook_uploader"
+require_relative "extensions/chef/cookbook/gem_installer"
+require_relative "extensions/chef/lwrp_base"
+require_relative "extensions/chef/resource/freebsd_package"
+require_relative "extensions/chef/run_context/cookbook_compiler"
+require_relative "extensions/chef/cookbook_loader"
+require_relative "extensions/ohai/system"

data/lib/chefspec/file_cache_path_proxy.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'singleton'
+require "fileutils" unless defined?(FileUtils)
+require "singleton" unless defined?(Singleton)
 
 module ChefSpec
   class FileCachePathProxy
@@ -8,7 +8,7 @@ module ChefSpec
     attr_reader :file_cache_path
 
     def initialize
-      @file_cache_path = Dir.mktmpdir(["chefspec", "file_cache_path"])
+      @file_cache_path = Dir.mktmpdir(%w{chefspec file_cache_path})
       at_exit { FileUtils.rm_rf(@file_cache_path) }
     end
   end

data/lib/chefspec/formatter.rb

@@ -1,5 +1,5 @@
-require 'chef/formatters/base'
-require 'chef/formatters/error_mapper'
+require "chef/formatters/base"
+require "chef/formatters/error_mapper"
 
 module ChefSpec
   class ChefFormatter < Chef::Formatters::Base
@@ -133,6 +133,18 @@ module ChefSpec
     # Called when LWRPs are finished loading
     def lwrp_load_complete; end
 
+    # Called when an ohai plugin file loading starts
+    def ohai_plugin_load_start(file_count); end
+
+    # Called when an ohai plugin file has been loaded
+    def ohai_plugin_file_loaded(path); end
+
+    # Called when an ohai plugin file has an error on load.
+    def ohai_plugin_file_load_failed(path, exception); end
+
+    # Called when an ohai plugin file loading has finished
+    def ohai_plugin_load_complete; end
+
     # Called before attribute files are loaded
     def attribute_load_start(attribute_file_count); end
 
@@ -190,7 +202,7 @@ module ChefSpec
     def converge_complete; end
 
     # Called before action is executed on a resource.
-    def resource_action_start(resource, action, notification_type=nil, notifier=nil); end
+    def resource_action_start(resource, action, notification_type = nil, notifier = nil); end
 
     # Called when a resource fails, but will retry.
     def resource_failed_retriable(resource, action, retry_count, exception); end

data/lib/chefspec/librarian.rb

@@ -1,10 +1,11 @@
 begin
-  require 'librarian/chef/environment'
-  require 'librarian/action/resolve'
-  require 'librarian/action/install'
+  require "librarian/chef/environment"
+  require "librarian/action/resolve"
+  require "librarian/action/install"
 rescue LoadError
   raise ChefSpec::Error::GemLoadError.new(
-    gem: 'librarian-chef', name: 'Librarian')
+    gem: "librarian-chef", name: "Librarian"
+  )
 end
 
 module ChefSpec
@@ -25,7 +26,7 @@ module ChefSpec
     #
     def setup!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      @originalpath, env.config_db.local['path'] = env.config_db.local['path'], @tmpdir
+      @originalpath, env.config_db.local["path"] = env.config_db.local["path"], @tmpdir
       ::Librarian::Action::Resolve.new(env).run
       ::Librarian::Action::Install.new(env).run
 
@@ -37,7 +38,7 @@ module ChefSpec
     #
     def teardown!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      env.config_db.local['path'] = @originalpath
+      env.config_db.local["path"] = @originalpath
 
       FileUtils.rm_rf(@tmpdir) if File.exist?(@tmpdir)
     end

data/lib/chefspec/matchers/do_nothing_matcher.rb

@@ -14,37 +14,37 @@ module ChefSpec::Matchers
     end
 
     def description
-      'do nothing'
+      "do nothing"
     end
 
     def failure_message
       if @resource
-        message =  %|expected #{@resource} to do nothing, but the following |
-        message << %|actions were performed:|
-        message << %|\n\n|
+        message =  %{expected #{@resource} to do nothing, but the following }
+        message << %{actions were performed:}
+        message << %{\n\n}
         @resource.performed_actions.each do |action|
-          message << %|  :#{action}|
+          message << %{  :#{action}}
         end
         message
       else
-        message =  %|expected _something_ to do nothing, but the _something_ |
-        message << %|you gave me was nil! If you are running a test like:|
-        message << %|\n\n|
-        message << %|  expect(_something_).to do_nothing|
-        message << %|\n\n|
-        message << %|make sure that `_something_` exists, because I got nil!|
+        message =  %{expected _something_ to do nothing, but the _something_ }
+        message << %{you gave me was nil! If you are running a test like:}
+        message << %{\n\n}
+        message << %{  expect(_something_).to do_nothing}
+        message << %{\n\n}
+        message << %{make sure that `_something_` exists, because I got nil!}
         message
       end
     end
 
     def failure_message_when_negated
       if @resource
-        message =  %|expected #{@resource} to do something, but no actions |
-        message << %|were performed.|
+        message =  %{expected #{@resource} to do something, but no actions }
+        message << %{were performed.}
         message
       else
-        message =  %|expected _something_ to do something, but no actions |
-        message << %|were performed.|
+        message =  %{expected _something_ to do something, but no actions }
+        message << %{were performed.}
         message
       end
     end

data/lib/chefspec/matchers/include_any_recipe_matcher.rb

@@ -6,15 +6,15 @@ module ChefSpec::Matchers
     end
 
     def description
-      'include any recipe'
+      "include any recipe"
     end
 
     def failure_message
-      'expected to include any recipe'
+      "expected to include any recipe"
     end
 
     def failure_message_when_negated
-      'expected not to include any recipes'
+      "expected not to include any recipes"
     end
 
     private
@@ -36,7 +36,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/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