chefspec 7.0.0 → 9.3.8

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -3,6 +3,7 @@ module ChefSpec::Matchers
     attr_reader :expected_content
     def initialize(path)
       @path = path
+      @expected_content = []
     end
 
     def matches?(runner)
@@ -20,9 +21,9 @@ module ChefSpec::Matchers
       if expected_content && block
         raise ArgumentError, "Cannot specify expected content and a block!"
       elsif expected_content
-        @expected_content = expected_content
+        @expected_content << expected_content
       elsif block_given?
-        @expected_content = block
+        @expected_content << block
       else
         raise ArgumentError, "Must specify expected content or a block!"
       end
@@ -32,11 +33,11 @@ module ChefSpec::Matchers
 
     def description
       message = %Q{render file "#{@path}"}
-      if @expected_content
-        if @expected_content.to_s.include?("\n")
+      @expected_content.each do |expected|
+        if expected.to_s.include?("\n")
           message << " with content <suppressed>"
         else
-          message << " with content #{@expected_content.inspect}"
+          message << " with content #{expected.inspect}"
         end
       end
       message
@@ -44,7 +45,7 @@ module ChefSpec::Matchers
 
     def failure_message
       message = %Q{expected Chef run to render "#{@path}"}
-      if @expected_content
+      unless @expected_content.empty?
         message << " matching:"
         message << "\n\n"
         message << expected_content_message
@@ -59,7 +60,7 @@ module ChefSpec::Matchers
 
     def failure_message_when_negated
       message = %Q{expected file "#{@path}"}
-      if @expected_content
+      unless @expected_content.empty?
         message << " matching:"
         message << "\n\n"
         message << expected_content_message
@@ -72,19 +73,22 @@ module ChefSpec::Matchers
     private
 
     def expected_content_message
-      if RSpec::Matchers.is_a_matcher?(@expected_content) && @expected_content.respond_to?(:description)
-        @expected_content.description
-      elsif @expected_content.is_a?(Proc)
-        "(the result of a proc)"
-      else
-        @expected_content.to_s
+      messages = @expected_content.collect do |expected|
+        if RSpec::Matchers.is_a_matcher?(expected) && expected.respond_to?(:description)
+          expected.description
+        elsif expected.is_a?(Proc)
+          "(the result of a proc)"
+        else
+          expected.to_s
+        end
       end
+      messages.join("\n\n")
     end
 
     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
 
     #
@@ -95,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
 
     #
@@ -106,25 +110,31 @@ module ChefSpec::Matchers
     # @return [true, false]
     #
     def matches_content?
-      return true if @expected_content.nil?
+      return true if @expected_content.empty?
 
       @actual_content = ChefSpec::Renderer.new(@runner, resource).content
 
       return false if @actual_content.nil?
 
-      if @expected_content.is_a?(Regexp)
-        @actual_content =~ @expected_content
-      elsif RSpec::Matchers.is_a_matcher?(@expected_content)
-        @expected_content.matches?(@actual_content)
-      elsif @expected_content.is_a?(Proc)
-        @expected_content.call(@actual_content)
-        # Weird RSpecish, but that block will return false for a negated check,
-        # so we always return true. The block will raise an exception if the
-        # assertion fails.
-        true
-      else
-        @actual_content.include?(@expected_content)
+      # Knock out matches that pass. When we're done, we pass if the list is
+      # empty. Otherwise, @expected_content is the list of matchers that
+      # failed
+      @expected_content.delete_if do |expected|
+        if expected.is_a?(Regexp)
+          @actual_content =~ expected
+        elsif RSpec::Matchers.is_a_matcher?(expected)
+          expected.matches?(@actual_content)
+        elsif expected.is_a?(Proc)
+          expected.call(@actual_content)
+          # Weird RSpecish, but that block will return false for a negated check,
+          # so we always return true. The block will raise an exception if the
+          # assertion fails.
+          true
+        else
+          @actual_content.include?(expected)
+        end
       end
+      @expected_content.empty?
     end
   end
 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
@@ -39,7 +41,7 @@ module ChefSpec::Matchers
     end
 
     def description
-      %Q{#{@expected_actioe} #{@resource_name} "#{@expected_identity}"}
+      %Q{#{@expected_action} #{@resource_name} "#{@expected_identity}"}
     end
 
     def matches?(runner)
@@ -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/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/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,9 @@
 begin
-  require 'chef-dk/policyfile_services/export_repo'
-  require 'chef-dk/policyfile_services/install'
+  require "chef-cli/policyfile_services/export_repo"
+  require "chef-cli/policyfile_services/install"
+  require "chef/workstation_config_loader"
 rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'chef-dk', name: 'ChefDK')
+  raise ChefSpec::Error::GemLoadError.new(gem: "chef-cli", name: "ChefCLI")
 end
 
 module ChefSpec
@@ -22,16 +23,22 @@ module ChefSpec
     # Setup and install the necessary  dependencies in the temporary directory
     #
     def setup!
-      policyfile_path = File.join(Dir.pwd, 'Policyfile.rb')
+      policyfile_path = RSpec.configuration.policyfile_path
+      if policyfile_path.nil?
+        policyfile_path = File.join(Dir.pwd, "Policyfile.rb")
+      end
+
+      Chef::WorkstationConfigLoader.new(nil).load
 
-      installer = ChefDK::PolicyfileServices::Install.new(
+      installer = ChefCLI::PolicyfileServices::Install.new(
         policyfile: policyfile_path,
-        ui: ChefDK::UI.null
+        ui: ChefCLI::UI.null,
+        config: Chef::Config
       )
 
       installer.run
 
-      exporter = ChefDK::PolicyfileServices::ExportRepo.new(
+      exporter = ChefCLI::PolicyfileServices::ExportRepo.new(
         policyfile: policyfile_path,
         export_dir: @tmpdir
       )
@@ -41,8 +48,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,16 +1,12 @@
 RSpec.configure do |config|
-  config.include(ChefSpec::API)
-  config.include(ChefSpec::Macros)
-
-  config.after(:each) do
-    ChefSpec::Stubs::CommandRegistry.reset!
-    ChefSpec::Stubs::DataBagRegistry.reset!
-    ChefSpec::Stubs::DataBagItemRegistry.reset!
-    ChefSpec::Stubs::SearchRegistry.reset!
+  unless ENV["CHEFSPEC_NO_INCLUDE"]
+    config.include(ChefSpec::API)
   end
 
   config.add_setting :berkshelf_options, default: {}
+  config.add_setting :policyfile_path
   config.add_setting :file_cache_path
+  config.add_setting :cookbook_root
   config.add_setting :cookbook_path
   config.add_setting :role_path
   config.add_setting :environment_path

data/lib/chefspec/runner.rb

@@ -0,0 +1,8 @@
+require_relative "solo_runner"
+
+module ChefSpec
+  # As we start to migrate back to only SoloRunner, include this alias for now.
+  #
+  # @since 7.3
+  Runner = SoloRunner
+end

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
 
     #
@@ -118,7 +118,7 @@ module ChefSpec
     #
     # @example Create a node from a +Chef::Node+ object
     #
-    #   node = stub_node('bacon', platform: 'ubuntu', version: '16.04')
+    #   node = stub_node('bacon', platform: 'ubuntu', version: '18.04')
     #   create_node(node)
     #
     # @param [String, Chef::Node] object
@@ -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
@@ -23,15 +23,6 @@ module ChefSpec
       # our yielding.
       super(options, &nil)
 
-      Chef::Config[:client_key]      = client_key
-      Chef::Config[:client_name]     = 'chefspec'
-      Chef::Config[:node_name]       = 'chefspec'
-      Chef::Config[:solo]            = false
-      Chef::Config[:solo_legacy_mode] = false
-
-      Chef::Config[:chef_server_url]  = server.url
-      Chef::Config[:http_retry_count] = 0
-
       # Unlike the SoloRunner, the node AND server object are yielded for
       # customization
       yield node, self if block_given?
@@ -63,10 +54,23 @@ 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
+
+    # (see SoloRunner#apply_chef_config!)
+    def apply_chef_config!
+      super
+      Chef::Config[:client_key]       = client_key
+      Chef::Config[:client_name]      = "chefspec"
+      Chef::Config[:node_name]        = "chefspec"
+      Chef::Config[:solo]             = false
+      Chef::Config[:solo_legacy_mode] = false
+
+      Chef::Config[:chef_server_url]  = server.url
+      Chef::Config[:http_retry_count] = 0
+    end
   end
 end