chefspec 7.2.1 → 7.3.0

data/lib/chefspec/berkshelf.rb

@@ -27,7 +27,7 @@ module ChefSpec
         raise InvalidBerkshelfOptions(value: opts.inspect)
       end
 
-      berksfile = ::Berkshelf::Berksfile.from_file('Berksfile', opts)
+      berksfile = ::Berkshelf::Berksfile.from_options(opts)
 
       # Grab a handle to tmpdir, since Berkshelf 2 modifies it a bit
       tmpdir = File.join(@tmpdir, 'cookbooks')

data/lib/chefspec/deprecations.rb

@@ -19,7 +19,7 @@ module Kernel
 end
 
 module ChefSpec
-  class Runner
+  class SoloRunner
     # @deprecated {ChefSpec::Runner.define_runner_method} is deprecated. Please
     #   use {ChefSpec.define_matcher} instead.
     def self.define_runner_method(resource_name)
@@ -29,21 +29,12 @@ module ChefSpec
 
       ChefSpec.define_matcher(resource_name)
     end
-
-    # @deprecated {ChefSpec::Runner.new} is deprecated. Please use
-    #   {ChefSpec::SoloRunner} or {ChefSpec::ServerRunner} instead.
-    def self.new(*args, &block)
-      deprecated "`ChefSpec::Runner' is deprecated. Please use" \
-        " `ChefSpec::SoloRunner' or `ChefSpec::ServerRunner' instead."
-
-      ChefSpec::SoloRunner.new(*args, &block)
-    end
   end
 
   class Server
     def self.method_missing(m, *args, &block)
       deprecated "`ChefSpec::Server.#{m}' is deprecated. There is no longer" \
-        " a global Chef Server instance. Please use a ChefSpec::ServerRunner" \
+        " a global Chef Server instance. Please use a ChefSpec::SoloRunner" \
         " instead. More documentation can be found in the ChefSpec README."
       raise ChefSpec::Error::NoConversionError
     end

data/lib/chefspec/errors.rb

@@ -33,6 +33,7 @@ module ChefSpec
     class SearchNotStubbed < NotStubbed; end
     class DataBagNotStubbed < NotStubbed; end
     class DataBagItemNotStubbed < NotStubbed; end
+    class ShellOutNotStubbed < ChefSpecError; end
 
     class CookbookPathNotFound < ChefSpecError; end
     class GemLoadError < ChefSpecError; end

data/lib/chefspec/extensions.rb

@@ -6,12 +6,15 @@ 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/data_query'
 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'

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

@@ -8,15 +8,14 @@ require 'chef/providers'
 require 'chef/client'
 
 # @private
-class Chef::Client
-  attr_reader :events
-
+Chef::Client.prepend(Module.new do
   #
   # Don't actually run ohai (we have fake data for that)
   #
   # @see Chef::Client#run_ohai
   #
   def run_ohai
+    return super unless $CHEFSPEC_MODE
     # noop
   end
-end
+end)

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

@@ -1,8 +1,9 @@
 require 'chef/resource/conditional'
 
-class 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?
@@ -11,4 +12,4 @@ class Chef::Resource::Conditional
 
     stub.result
   end
-end
+end)

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

@@ -1,35 +1,32 @@
 require 'chef/cookbook/gem_installer'
 
-class Chef
-  class Cookbook
-    class GemInstaller
-      # Installs the gems into the omnibus gemset.
-      def install
-        cookbook_gems = Hash.new { |h, k| h[k] = [] }
+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|
-          cookbook_version.metadata.gems.each do |args|
-            cookbook_gems[args.first] += args[1..-1]
-          end
-        end
-
-        events.cookbook_gem_start(cookbook_gems)
-        cookbook_gems.each { |gem_name, gem_requirements| locate_gem(gem_name, gem_requirements) }
-        events.cookbook_gem_finished
+    cookbook_collection.each do |cookbook_name, cookbook_version|
+      cookbook_version.metadata.gems.each do |args|
+        cookbook_gems[args.first] += args[1..-1]
       end
+    end
+
+    events.cookbook_gem_start(cookbook_gems)
+    cookbook_gems.each { |gem_name, gem_requirements| locate_gem(gem_name, gem_requirements) }
+    events.cookbook_gem_finished
+  end
 
-      private
+  private
 
-      def locate_gem(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('\', \'')}'"
-        warn "No matching version found for '#{gem_name}' in your gem environment.\n" \
-             " - if you are using ChefDK, run the following command: \"chef #{gem_cmd}\"\n" \
-             " - if you are using bundler, append \"#{gemfile_line}\" to your Gemfile and run \"bundle install\"\n" \
-             " - otherwise run: \"#{gem_cmd}\""
-      end
-    end
+  def locate_gem(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('\', \'')}'"
+    warn "No matching version found for '#{gem_name}' in your gem environment.\n" \
+         " - if you are using ChefDK, run the following command: \"chef #{gem_cmd}\"\n" \
+         " - if you are using bundler, append \"#{gemfile_line}\" to your Gemfile and run \"bundle install\"\n" \
+         " - otherwise run: \"#{gem_cmd}\""
   end
-end
+end)

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

@@ -0,0 +1,13 @@
+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]]
+    else
+      super
+    end
+  end
+end)

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

@@ -1,11 +1,12 @@
 require 'chef/cookbook_uploader'
 
-class Chef::CookbookUploader
+Chef::CookbookUploader.prepend(Module.new do |variable|
   #
   # Don't validate uploaded cookbooks. Validating a cookbook takes *forever*
   # to complete. It's just not worth it...
   #
   def validate_cookbooks
+    return super unless $CHEFSPEC_MODE
     # noop
   end
-end
+end)

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

@@ -1,10 +1,9 @@
 require 'chef/dsl/data_query'
 
-module Chef::DSL::DataQuery
+Chef::DSL::DataQuery.prepend(Module.new do
   # @see Chef::DSL::DataQuery#search
-  alias_method :old_search, :search
   def search(*args, &block)
-    return old_search(*args, &block) unless Chef::Config[:solo]
+    return super unless Chef::Config[:solo] && $CHEFSPEC_MODE
 
     type  = args[0]
     query = args[1] || '*:*'
@@ -23,9 +22,8 @@ module Chef::DSL::DataQuery
   end
 
   # @see Chef::DSL::DataQuery#data_bag
-  alias_method :old_data_bag, :data_bag
   def data_bag(bag)
-    return old_data_bag(bag) unless Chef::Config[:solo]
+    return super unless Chef::Config[:solo] && $CHEFSPEC_MODE
 
     stub = ChefSpec::Stubs::DataBagRegistry.stub_for(bag)
 
@@ -37,9 +35,8 @@ module Chef::DSL::DataQuery
   end
 
   # @see Chef::DSL::DataQuery#data_bag_item
-  alias_method :old_data_bag_item, :data_bag_item
   def data_bag_item(bag, id, secret = nil)
-    return old_data_bag_item(bag, id, secret) unless Chef::Config[:solo]
+    return super unless Chef::Config[:solo] && $CHEFSPEC_MODE
 
     stub = ChefSpec::Stubs::DataBagItemRegistry.stub_for(bag, id)
 
@@ -49,4 +46,4 @@ module Chef::DSL::DataQuery
 
     stub.result
   end
-end
+end)

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

@@ -4,29 +4,25 @@
 # sub-resource collections.
 
 if defined?(Chef::Provider::InlineResources)
-  class Chef
-    class Provider
-      module InlineResources # ~> 12.5
-        def initialize(resource, run_context)
-          super
-          @run_context = run_context
-          @resource_collection = run_context.resource_collection
-        end
+  Chef::Provider::InlineResources.prepend(Module.new do
+    def initialize(resource, run_context)
+      super
+      @run_context = run_context
+      @resource_collection = run_context.resource_collection
+    end
+  end)
 
-        module ClassMethods
-          def action(name, &block)
-            define_method("action_#{name}", &block)
-          end
-        end
-      end
+  Chef::Provider::InlineResources::ClassMethods.prepend(Module.new do
+    def action(name, &block)
+      # Note: This does not check $CHEFSPEC_MODE.
+      define_method("action_#{name}", &block)
     end
-  end
+  end)
 else # >= 13.0
-  class Chef
-    class Provider
-      def self.action(name, &block)
-        define_method("action_#{name}", &block)
-      end
+  Chef::Provider.prepend(Module.new do
+    def compile_and_converge_action(&block)
+      return super unless $CHEFSPEC_MODE
+      instance_eval(&block)
     end
-  end
+  end)
 end

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

@@ -0,0 +1,36 @@
+require 'chef/provider'
+require 'chefspec/api'
+
+Chef::Provider.prepend(Module.new do
+  def self.name
+    "ChefSpec extensions for Chef::Provider"
+  end
+
+  def self.inspect
+    "#<Module: #{name}>"
+  end
+
+  # Hook for the stubs_for system.
+  def initialize(*args, &block)
+    super(*args, &block)
+    ChefSpec::API::StubsFor.setup_stubs_for(self, :provider) if $CHEFSPEC_MODE
+  end
+
+  # Defang shell_out and friends so it can never run.
+  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)
+    end
+
+    def shell_out_compacted!(*args)
+      return super unless $CHEFSPEC_MODE
+      shell_out_compacted(*args).tap {|c| c.error! }
+    end
+  else
+    def shell_out(*args)
+      return super unless $CHEFSPEC_MODE
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'provider', resource: new_resource)
+    end
+  end
+end)

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

@@ -1,4 +1,5 @@
 require 'chef/resource'
+require 'chef/version'
 require 'chefspec/api'
 
 #
@@ -10,8 +11,35 @@ require 'chefspec/api'
 
 module ChefSpec::Extensions::Chef::Resource
 
+  #
+  # Hooks for the stubs_for system
+  #
+  def initialize(*args, &block)
+    super(*args, &block)
+    if $CHEFSPEC_MODE
+      # Here be dragons.
+      # 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
+      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'")
+    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)
 
@@ -34,20 +62,37 @@ module ChefSpec::Extensions::Chef::Resource
   end
 
   #
-  # tracking
+  # Defang shell_out and friends so it can never run.
   #
+  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)
+    end
 
-  def initialize(*args)
-    @performed_actions = {}
-    super
+    def shell_out_compacted!(*args)
+      return super unless $CHEFSPEC_MODE
+      shell_out_compacted(*args).tap {|c| c.error! }
+    end
+  else
+    def shell_out(*args)
+      return super unless $CHEFSPEC_MODE
+      raise ChefSpec::Error::ShellOutNotStubbed.new(args: args, type: 'resource', resource: self)
+    end
   end
 
+  #
+  # tracking
+  #
+
   def perform_action(action, options = {})
+    @performed_actions ||= {}
     @performed_actions[action.to_sym] ||= {}
     @performed_actions[action.to_sym].merge!(options)
   end
 
   def performed_action(action)
+    @performed_actions ||= {}
     @performed_actions[action.to_sym]
   end
 
@@ -60,6 +105,7 @@ module ChefSpec::Extensions::Chef::Resource
   end
 
   def performed_actions
+    @performed_actions ||= {}
     @performed_actions.keys
   end
 
@@ -120,6 +166,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,19 +1,16 @@
 require 'chef/resource/freebsd_package'
 
-class Chef
-  class Resource
-    class FreebsdPackage < Chef::Resource::Package
-      #
-      # Chef decided it was a good idea to just shellout inside of a resource.
-      # Not only is that a horrible fucking idea, but I got flak when I asked
-      # to change it. So we are just going to monkey patch the fucking thing so
-      # it does not shell out.
-      #
-      # @return [false]
-      #
-      def supports_pkgng?
-        false
-      end
-    end
+Chef::Resource::FreebsdPackage.prepend(Module.new do
+  #
+  # Chef decided it was a good idea to just shellout inside of a resource.
+  # Not only is that a horrible fucking idea, but I got flak when I asked
+  # to change it. So we are just going to monkey patch the fucking thing so
+  # it does not shell out.
+  #
+  # @return [false]
+  #
+  def supports_pkgng?
+    return super unless $CHEFSPEC_MODE
+    true
   end
-end
+end)