chefspec 8.0.1 → 9.3.0

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

@@ -1,11 +1,11 @@
 # Force loading Chef Config to fix a bad dependency tree. See
 # https://github.com/opscode/chef/issues/2703 for more information.
-require 'chef/config'
+require "chef/config"
 
 # Providers has to be included before client... probably a weird
 # include missing in Chef-land, but we can make sure we get it right anyway.
-require 'chef/providers'
-require 'chef/client'
+require "chef/providers"
+require "chef/client"
 
 # @private
 Chef::Client.prepend(Module.new do

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

@@ -1,9 +1,10 @@
-require 'chef/resource/conditional'
+require "chef/resource/conditional"
 
 Chef::Resource::Conditional.prepend(Module.new do
   # @see Chef::Resource::Conditional#evaluate_command
   def evaluate_command
     return super unless $CHEFSPEC_MODE
+
     stub = ChefSpec::Stubs::CommandRegistry.stub_for(@command)
 
     if stub.nil?

data/lib/chefspec/extensions/chef/cookbook/gem_installer.rb

@@ -1,9 +1,10 @@
-require 'chef/cookbook/gem_installer'
+require "chef/cookbook/gem_installer"
 
 Chef::Cookbook::GemInstaller.prepend(Module.new do
   # Installs the gems into the omnibus gemset.
   def install
     return super unless $CHEFSPEC_MODE
+
     cookbook_gems = Hash.new { |h, k| h[k] = [] }
 
     cookbook_collection.each do |cookbook_name, cookbook_version|
@@ -20,10 +21,10 @@ Chef::Cookbook::GemInstaller.prepend(Module.new do
   private
 
   def locate_gem(gem_name, gem_requirements)
-    ::Gem::Specification::find_by_name(gem_name, gem_requirements)
+    ::Gem::Specification.find_by_name(gem_name, gem_requirements)
   rescue ::Gem::MissingSpecError
-    gem_cmd = "gem install #{gem_name} --version '#{gem_requirements.join(', ')}'"
-    gemfile_line = "gem '#{[gem_name, *gem_requirements].join('\', \'')}'"
+    gem_cmd = "gem install #{gem_name} --version '#{gem_requirements.join(", ")}'"
+    gemfile_line = "gem '#{[gem_name, *gem_requirements].join("', '")}'"
     warn "No matching version found for '#{gem_name}' in your gem environment.\n" \
          " - if you are using Chef Workstation, run the following command: \"chef #{gem_cmd}\"\n" \
          " - if you are using bundler, append \"#{gemfile_line}\" to your Gemfile and run \"bundle install\"\n" \

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

@@ -3,6 +3,7 @@ require "chef/cookbook_loader"
 Chef::CookbookLoader.prepend(Module.new do
   def all_directories_in_repo_paths
     return super unless $CHEFSPEC_MODE
+
     if Chef::Config[:chefspec_cookbook_root]
       # Hax.
       [Chef::Config[:chefspec_cookbook_root]]

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

@@ -1,4 +1,4 @@
-require 'chef/cookbook_uploader'
+require "chef/cookbook_uploader"
 
 Chef::CookbookUploader.prepend(Module.new do |variable|
   #

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

@@ -1,4 +1,4 @@
-require 'chef/dsl/data_query'
+require "chef/dsl/data_query"
 
 Chef::DSL::DataQuery.prepend(Module.new do
   # @see Chef::DSL::DataQuery#search
@@ -6,7 +6,7 @@ Chef::DSL::DataQuery.prepend(Module.new do
     return super unless Chef::Config[:solo] && $CHEFSPEC_MODE
 
     type  = args[0]
-    query = args[1] || '*:*'
+    query = args[1] || "*:*"
     stub = ChefSpec::Stubs::SearchRegistry.stub_for(type, query)
 
     if stub.nil?
@@ -14,7 +14,7 @@ Chef::DSL::DataQuery.prepend(Module.new do
     end
 
     if block
-      Array(stub.result).each {|r| block.call(r) }
+      Array(stub.result).each { |r| block.call(r) }
       true
     else
       stub.result

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

@@ -22,6 +22,7 @@ else # >= 13.0
   Chef::Provider.prepend(Module.new do
     def compile_and_converge_action(&block)
       return super unless $CHEFSPEC_MODE
+
       instance_eval(&block)
     end
   end)

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

@@ -1,5 +1,5 @@
-require 'chef/provider'
-require 'chefspec/api'
+require "chef/provider"
+require_relative "../../api"
 
 Chef::Provider.prepend(Module.new do
   def self.name
@@ -20,17 +20,20 @@ Chef::Provider.prepend(Module.new do
   if ChefSpec::API::StubsFor::HAS_SHELLOUT_COMPACTED.satisfied_by?(Gem::Version.create(Chef::VERSION))
     def shell_out_compacted(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'provider', resource: new_resource)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "provider", resource: new_resource)
     end
 
     def shell_out_compacted!(*args)
       return super unless $CHEFSPEC_MODE
-      shell_out_compacted(*args).tap {|c| c.error! }
+
+      shell_out_compacted(*args).tap(&:error!)
     end
   else
     def shell_out(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'provider', resource: new_resource)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "provider", resource: new_resource)
     end
   end
 end)

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

@@ -1,6 +1,6 @@
-require 'chef/resource'
-require 'chef/version'
-require 'chefspec/api'
+require "chef/resource"
+require "chef/version"
+require_relative "../../api"
 
 #
 # Three concerns:
@@ -21,25 +21,27 @@ module ChefSpec::Extensions::Chef::Resource
       # If we're directly inside a `load_current_resource`, this is probably
       # something like `new_resource.class.new` so we want to call this a current_resource,
       # Otherwise it's probably a normal resource instantiation.
-      mode = caller[1].include?("`load_current_resource'") ? :current_resource : :resource
+      mode = :resource
+      mode = :current_value if caller.any? { |x| x.include?("`load_current_resource'") || x.include?("`load_after_resource'") }
       ChefSpec::API::StubsFor.setup_stubs_for(self, mode)
     end
   end
 
   def dup
     return super unless $CHEFSPEC_MODE
+
     # Also here be dragons.
-    stack = caller
     super.tap do |dup_resource|
       # We're directly inside a load_current_resource, which is probably via
       # the load_current_value DSL system, so call this a current resource.
-      ChefSpec::API::StubsFor.setup_stubs_for(dup_resource, :current_resource) if stack.first.include?("`load_current_resource'")
+      ChefSpec::API::StubsFor.setup_stubs_for(dup_resource, :current_value) if caller.any? { |x| x.include?("`load_current_resource'") || x.include?("`load_after_resource'") }
     end
   end
 
   # mix of no-op and tracking concerns
   def run_action(action, notification_type = nil, notifying_resource = nil)
     return super unless $CHEFSPEC_MODE
+
     resolve_notification_references
     validate_action(action)
 
@@ -67,17 +69,20 @@ module ChefSpec::Extensions::Chef::Resource
   if ChefSpec::API::StubsFor::HAS_SHELLOUT_COMPACTED.satisfied_by?(Gem::Version.create(Chef::VERSION))
     def shell_out_compacted(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'resource', resource: self)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "resource", resource: self)
     end
 
     def shell_out_compacted!(*args)
       return super unless $CHEFSPEC_MODE
-      shell_out_compacted(*args).tap {|c| c.error! }
+
+      shell_out_compacted(*args).tap(&:error!)
     end
   else
     def shell_out(*args)
       return super unless $CHEFSPEC_MODE
-      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'resource', resource: self)
+
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: "resource", resource: self)
     end
   end
 
@@ -133,15 +138,15 @@ module ChefSpec::Extensions::Chef::Resource
       super
     end
 
-    def provides(name, *args, &block)
+    def provides(name, **options, &block)
       provides_names << name unless provides_names.include?(name)
       inject_actions(*allowed_actions)
       super
     end
 
-    def action(sym, &block)
+    def action(sym, description: nil, &block)
       inject_actions(sym)
-      super
+      super(sym, &block)
     end
 
     def allowed_actions(*actions)
@@ -167,6 +172,7 @@ module ChefSpec::Extensions::Chef::Resource
     def inject_actions(*actions)
       provides_names.each do |resource_name|
         next unless resource_name
+
         ChefSpec.define_matcher(resource_name)
         actions.each do |action|
           inject_method(:"#{action}_#{resource_name}", resource_name, action)

data/lib/chefspec/extensions/chef/resource/freebsd_package.rb

@@ -1,4 +1,4 @@
-require 'chef/resource/freebsd_package'
+require "chef/resource/freebsd_package"
 
 Chef::Resource::FreebsdPackage.prepend(Module.new do
   #
@@ -11,6 +11,7 @@ Chef::Resource::FreebsdPackage.prepend(Module.new do
   #
   def supports_pkgng?
     return super unless $CHEFSPEC_MODE
+
     true
   end
 end)

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/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.rb

@@ -1,12 +1,13 @@
 module ChefSpec
   module Matchers
-    require_relative 'matchers/do_nothing_matcher'
-    require_relative 'matchers/include_recipe_matcher'
-    require_relative 'matchers/link_to_matcher'
-    require_relative 'matchers/notifications_matcher'
-    require_relative 'matchers/render_file_matcher'
-    require_relative 'matchers/resource_matcher'
-    require_relative 'matchers/state_attrs_matcher'
-    require_relative 'matchers/subscribes_matcher'
+    require_relative "matchers/do_nothing_matcher"
+    require_relative "matchers/include_any_recipe_matcher"
+    require_relative "matchers/include_recipe_matcher"
+    require_relative "matchers/link_to_matcher"
+    require_relative "matchers/notifications_matcher"
+    require_relative "matchers/render_file_matcher"
+    require_relative "matchers/resource_matcher"
+    require_relative "matchers/state_attrs_matcher"
+    require_relative "matchers/subscribes_matcher"
   end
 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