chefspec 7.0.0 → 9.3.8

data/lib/chefspec/berkshelf.rb

@@ -1,7 +1,7 @@
 begin
-  require 'berkshelf'
+  require "berkshelf"
 rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'berkshelf', name: 'Berkshelf')
+  raise ChefSpec::Error::GemLoadError.new(gem: "berkshelf", name: "Berkshelf")
 end
 
 module ChefSpec
@@ -23,14 +23,14 @@ module ChefSpec
     def setup!
       # Get the list of Berkshelf options
       opts = RSpec.configuration.berkshelf_options
-      if !opts.is_a?(Hash)
+      unless opts.is_a?(Hash)
         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')
+      tmpdir = File.join(@tmpdir, "cookbooks")
 
       ::Berkshelf.ui.mute do
         if ::Berkshelf::Berksfile.method_defined?(:vendor)

data/lib/chefspec/cacher.rb

@@ -42,8 +42,8 @@ module ChefSpec
       location ||= ancestors.first.metadata[:parent_example_group][:location]
 
       define_method(name) do
-        key = [location, name.to_s].join('.')
-        unless @@cache.has_key?(Thread.current.object_id)
+        key = [location, name.to_s].join(".")
+        unless @@cache.key?(Thread.current.object_id)
           ObjectSpace.define_finalizer(Thread.current, FINALIZER)
         end
         @@cache[Thread.current.object_id] ||= {}

data/lib/chefspec/coverage/filters.rb

@@ -6,7 +6,7 @@ module ChefSpec
       end
 
       def matches?
-        raise RuntimeError, "Must override Filter#matches?"
+        raise "Must override Filter#matches?"
       end
     end
 
@@ -17,6 +17,7 @@ module ChefSpec
     class RegexpFilter < Filter
       def matches?(resource)
         return true if resource.source_line.nil?
+
         @filter =~ resource.source_line
       end
     end
@@ -41,6 +42,7 @@ module ChefSpec
     class BlockFilter < Filter
       def matches?(resource)
         return true if resource.source_line.nil?
+
         @filter.call(resource)
       end
     end
@@ -54,25 +56,26 @@ module ChefSpec
         @berksfile = berksfile
 
         @metadatas = if berksfile.respond_to?(:dependencies)
-          berksfile.dependencies
-            .select(&:metadata?)
-            .map(&:name)
-        else
-          berksfile.sources.collect do |source|
-            location = source.location
-            if location.respond_to?(:metadata?) && location.metadata?
-              source
-            else
-              nil
-            end
-          end.compact.map(&:name)
-        end
+                       berksfile.dependencies
+                         .select(&:metadata?)
+                         .map(&:name)
+                     else
+                       berksfile.sources.collect do |source|
+                         location = source.location
+                         if location.respond_to?(:metadata?) && location.metadata?
+                           source
+                         else
+                           nil
+                         end
+                       end.compact.map(&:name)
+                     end
       end
 
       def matches?(resource)
         return true if resource.source_line.nil?
+
         normalized_source_line = resource.source_line.gsub("\\", "/")
-        normalized_source_line=~ /cookbooks\/(?!#{@metadatas.join('|')})/
+        normalized_source_line =~ %r{cookbooks/(?!#{@metadatas.join('|')})}
       end
     end
   end

data/lib/chefspec/coverage.rb

@@ -1,4 +1,4 @@
-require_relative 'coverage/filters'
+require_relative "coverage/filters"
 
 module ChefSpec
   class Coverage
@@ -30,14 +30,14 @@ module ChefSpec
       @filters    = {}
       @outputs    = []
       add_output do |report|
-        begin
-          erb = Erubis::Eruby.new(File.read(@template))
-          puts erb.evaluate(report)
-        rescue NameError => e
-          raise Error::ErbTemplateParseError.new(original_error: e.message)
-        end
+
+        erb = Erubis::Eruby.new(File.read(@template))
+        puts erb.evaluate(report)
+      rescue NameError => e
+        raise Error::ErbTemplateParseError.new(original_error: e.message)
+
       end
-      @template = ChefSpec.root.join('templates', 'coverage', 'human.erb')
+      @template = ChefSpec.root.join("templates", "coverage", "human.erb")
     end
 
     #
@@ -45,6 +45,7 @@ module ChefSpec
     # +at_exit+ handler for printing the coverage report.
     #
     def start!(&block)
+      warn("ChefSpec's coverage reporting is deprecated and will be removed in a future version")
       instance_eval(&block) if block
       at_exit { ChefSpec::Coverage.report! }
     end
@@ -62,17 +63,17 @@ module ChefSpec
     def add_filter(filter = nil, &block)
       id = "#{filter.inspect}/#{block.inspect}".hash
 
-      @filters[id] = if filter.kind_of?(Filter)
+      @filters[id] = if filter.is_a?(Filter)
                        filter
-                     elsif filter.kind_of?(String)
+                     elsif filter.is_a?(String)
                        StringFilter.new(filter)
-                     elsif filter.kind_of?(Regexp)
+                     elsif filter.is_a?(Regexp)
                        RegexpFilter.new(filter)
                      elsif block
                        BlockFilter.new(block)
                      else
-                       raise ArgumentError, 'Please specify either a string, ' \
-                         'filter, or block to filter source files with!'
+                       raise ArgumentError, "Please specify either a string, " \
+                         "filter, or block to filter source files with!"
                      end
 
       true
@@ -97,18 +98,14 @@ module ChefSpec
     #
     # @return [true]
     #
-    def set_template(file = 'human.erb')
-      [
-        ChefSpec.root.join('templates', 'coverage', file),
-        File.expand_path(file, Dir.pwd)
-      ].each do |temp|
-        if File.exist?(temp)
-          @template = temp
-          return
-        end
-      end
-      raise Error::TemplateNotFound.new(path: file)
+    def set_template(file = "human.erb")
+      @template = [
+        ChefSpec.root.join("templates", "coverage", file),
+        File.expand_path(file, Dir.pwd),
+      ].find { |f| File.exist?(f) }
+      raise Error::TemplateNotFound.new(path: file) unless @template
     end
+
     #
     # Add a resource to the resource collection. Only new resources are added
     # and only resources that match the given filter are covered (which is *
@@ -128,9 +125,8 @@ module ChefSpec
     # @param [Chef::Resource] resource
     #
     def cover!(resource)
-      if wrapper = find(resource)
-        wrapper.touch!
-      end
+      wrapper = find(resource)
+      wrapper.touch! if wrapper
     end
 
     #
@@ -165,7 +161,7 @@ module ChefSpec
       report = {}.tap do |h|
         h[:total]     = @collection.size
         h[:touched]   = @collection.count { |_, resource| resource.touched? }
-        h[:coverage]  = ((h[:touched]/h[:total].to_f)*100).round(2)
+        h[:coverage]  = ((h[:touched] / h[:total].to_f) * 100).round(2)
       end
 
       report[:untouched_resources] = @collection.collect do |_, resource|
@@ -174,7 +170,7 @@ module ChefSpec
       report[:all_resources] = @collection.values
 
       @outputs.each do |block|
-        self.instance_exec(report, &block)
+        instance_exec(report, &block)
       end
 
       # Ensure we exit correctly (#351)
@@ -207,24 +203,24 @@ module ChefSpec
           "source_file" => source_file,
           "source_line" => source_line,
           "touched" => touched?,
-          "resource" => to_s
+          "resource" => to_s,
         }.to_json
       end
 
       def source_file
         @source_file ||= if @resource.source_line
-          shortname(@resource.source_line.split(':').first)
-        else
-          'Unknown'
-        end
+                           shortname(@resource.source_line.split(":").first)
+                         else
+                           "Unknown"
+                         end
       end
 
       def source_line
         @source_line ||= if @resource.source_line
-          @resource.source_line.split(':', 2).last.to_i
-        else
-          'Unknown'
-        end
+                           @resource.source_line.split(":", 2).last.to_i
+                         else
+                           "Unknown"
+                         end
       end
 
       def touch!
@@ -240,8 +236,8 @@ module ChefSpec
       def shortname(file)
         if file.include?(Dir.pwd)
           file.split(Dir.pwd, 2).last
-        elsif file.include?('cookbooks')
-          file.split('cookbooks/', 2).last
+        elsif file.include?("cookbooks")
+          file.split("cookbooks/", 2).last
         else
           file
         end

data/lib/chefspec/deprecations.rb

@@ -7,9 +7,9 @@ module Kernel
   # @param [Array<String>] messages
   def deprecated(*messages)
     messages.each do |message|
-      calling_spec = caller.find { |line| line =~ /(\/spec)|(_spec\.rb)/ }
+      calling_spec = caller.find { |line| line =~ %r{(/spec)|(_spec\.rb)} }
       if calling_spec
-        calling_spec = 'spec/' + calling_spec.split('/spec/').last
+        calling_spec = "spec/" + calling_spec.split("/spec/").last
         warn "[DEPRECATION] #{message} (called from #{calling_spec})"
       else
         warn "[DEPRECATION] #{message}"
@@ -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
@@ -51,5 +42,5 @@ module ChefSpec
 end
 
 module ChefSpec::Error
-  class NoConversionError < ChefSpecError;  end
+  class NoConversionError < ChefSpecError; end
 end

data/lib/chefspec/errors.rb

@@ -2,9 +2,9 @@ module ChefSpec
   module Error
     class ChefSpecError < StandardError
       def initialize(options = {})
-        class_name = self.class.to_s.split('::').last
+        class_name = self.class.to_s.split("::").last
         filename   = options.delete(:_template) || Util.underscore(class_name)
-        template   = ChefSpec.root.join('templates', 'errors', "#{filename}.erb")
+        template   = ChefSpec.root.join("templates", "errors", "#{filename}.erb")
 
         erb = Erubis::Eruby.new(File.read(template))
         super erb.evaluate(options)
@@ -13,12 +13,12 @@ module ChefSpec
 
     class NotStubbed < ChefSpecError
       def initialize(options = {})
-        name  = self.class.name.to_s.split('::').last
-        type  = Util.underscore(name).gsub('_not_stubbed', '')
-        klass = Stubs.const_get(name.gsub('NotStubbed', '') + 'Stub')
-        stub  = klass.new(*options[:args]).and_return('...').signature
+        name  = self.class.name.to_s.split("::").last
+        type  = Util.underscore(name).gsub("_not_stubbed", "")
+        klass = Stubs.const_get(name.gsub("NotStubbed", "") + "Stub")
+        stub  = klass.new(*options[:args]).and_return("...").signature
 
-        signature = "#{type}(#{options[:args].map(&:inspect).join(', ')})"
+        signature = "#{type}(#{options[:args].map(&:inspect).join(", ")})"
 
         super({
           type:      type,
@@ -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/expect_exception.rb

@@ -26,6 +26,7 @@ module ChefSpec
 
     def expected?
       return false if @matcher.nil?
+
       exception_matched? && message_matched?
     end
 
@@ -33,7 +34,7 @@ module ChefSpec
 
     def exception_matched?
       @formatter_exception == @matcher.last_error_for_chefspec ||
-      @matcher.last_error_for_chefspec === @formatter_exception
+        @matcher.last_error_for_chefspec === @formatter_exception
     end
 
     def message_matched?

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

@@ -1,22 +1,21 @@
 # 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
-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,10 @@
-require 'chef/resource/conditional'
+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 +13,4 @@ class Chef::Resource::Conditional
 
     stub.result
   end
-end
+end)

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

@@ -0,0 +1,33 @@
+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|
+      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
+
+  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 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" \
+         " - otherwise run: \"#{gem_cmd}\""
+  end
+end)

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

@@ -0,0 +1,14 @@
+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'
+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,13 +1,12 @@
-require 'chef/dsl/data_query'
+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] || '*:*'
+    query = args[1] || "*:*"
     stub = ChefSpec::Stubs::SearchRegistry.stub_for(type, query)
 
     if stub.nil?
@@ -15,7 +14,7 @@ module Chef::DSL::DataQuery
     end
 
     if block
-      Array(stub.result).each {|r| block.call(r) }
+      Array(stub.result).each { |r| block.call(r) }
       true
     else
       stub.result
@@ -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,26 @@
 # 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,39 @@
+require "chef/provider"
+require_relative "../../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(&: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/freebsd_package.rb

@@ -1,19 +1,17 @@
-require 'chef/resource/freebsd_package'
+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)