chefspec 3.4.0 → 4.0.0

data/lib/chefspec/api/powershell_script.rb

@@ -15,19 +15,19 @@ module ChefSpec::API
     # The Examples section demonstrates the different ways to test a
     # +powershell_script+ resource with ChefSpec.
     #
-    # @example Assert that a +powershell_script+ was runed
+    # @example Assert that a +powershell_script+ was run
     #   expect(chef_run).to run_powershell_script('/tmp')
     #
-    # @example Assert that a +powershell_script+ was runed with predicate matchers
+    # @example Assert that a +powershell_script+ was run with predicate matchers
     #   expect(chef_run).to run_powershell_script('/tmp').with_user('svargo')
     #
-    # @example Assert that a +powershell_script+ was runed with attributes
+    # @example Assert that a +powershell_script+ was run with attributes
     #   expect(chef_run).to run_powershell_script('/tmp').with(user: 'svargo')
     #
-    # @example Assert that a +powershell_script+ was runed using a regex
+    # @example Assert that a +powershell_script+ was run using a regex
     #   expect(chef_run).to run_powershell_script('/tmp').with(user: /sva(.+)/)
     #
-    # @example Assert that a +powershell_script+ was _not_ runed
+    # @example Assert that a +powershell_script+ was _not_ run
     #   expect(chef_run).to_not run_powershell_script('/tmp')
     #
     #

data/lib/chefspec/api/ruby_block.rb

@@ -18,10 +18,10 @@ module ChefSpec::API
     # The Examples section demonstrates the different ways to test a
     # +ruby_block+ resource with ChefSpec.
     #
-    # @example Assert that a +ruby_block+ was runed
+    # @example Assert that a +ruby_block+ was run
     #   expect(chef_run).to run_ruby_block('do_something')
     #
-    # @example Assert that a +ruby_block+ was _not_ runed
+    # @example Assert that a +ruby_block+ was _not_ run
     #   expect(chef_run).to_not run_ruby_block('do_something')
     #
     #

data/lib/chefspec/api/script.rb

@@ -1,8 +1,6 @@
 module ChefSpec::API
   # @since 1.0.0
   module ScriptMatchers
-    ChefSpec::Runner.define_runner_method :script
-
     #
     # Assert that a +bash+ resource exists in the Chef run with the
     # action +:run+. Given a Chef Recipe that runs "command" using
@@ -40,6 +38,8 @@ module ChefSpec::API
       ChefSpec::Matchers::ResourceMatcher.new(:bash, :run, resource_name)
     end
 
+    ChefSpec::Runner.define_runner_method :bash
+
     #
     # Assert that a +csh+ resource exists in the Chef run with the
     # action +:run+. Given a Chef Recipe that runs "command" using
@@ -77,6 +77,8 @@ module ChefSpec::API
       ChefSpec::Matchers::ResourceMatcher.new(:csh, :run, resource_name)
     end
 
+    ChefSpec::Runner.define_runner_method :csh
+
     #
     # Assert that a +perl+ resource exists in the Chef run with the
     # action +:run+. Given a Chef Recipe that runs "command" using
@@ -114,6 +116,8 @@ module ChefSpec::API
       ChefSpec::Matchers::ResourceMatcher.new(:perl, :run, resource_name)
     end
 
+    ChefSpec::Runner.define_runner_method :perl
+
     #
     # Assert that a +python+ resource exists in the Chef run with the
     # action +:run+. Given a Chef Recipe that runs "command" using
@@ -151,6 +155,8 @@ module ChefSpec::API
       ChefSpec::Matchers::ResourceMatcher.new(:python, :run, resource_name)
     end
 
+    ChefSpec::Runner.define_runner_method :python
+
     #
     # Assert that a +ruby+ resource exists in the Chef run with the
     # action +:run+. Given a Chef Recipe that runs "command" using
@@ -188,6 +194,8 @@ module ChefSpec::API
       ChefSpec::Matchers::ResourceMatcher.new(:ruby, :run, resource_name)
     end
 
+    ChefSpec::Runner.define_runner_method :ruby
+
     #
     # Assert that a +script+ resource exists in the Chef run with the
     # action +:run+. Given a Chef Recipe that runs "command" using
@@ -224,5 +232,8 @@ module ChefSpec::API
     def run_script(resource_name)
       ChefSpec::Matchers::ResourceMatcher.new(:script, :run, resource_name)
     end
+
+
+    ChefSpec::Runner.define_runner_method :script
   end
 end

data/lib/chefspec/cacher.rb

@@ -34,7 +34,8 @@ module ChefSpec
     FINALIZER = lambda { |id| @@cache.delete(id) }
 
     def cached(name, &block)
-      location = ancestors.first.metadata[:example_group][:location]
+      location   = ancestors.first.metadata[:location]
+      location ||= ancestors.first.metadata[:parent_example_group][:location]
 
       define_method(name) do
         key = [location, name.to_s].join('.')

data/lib/chefspec/coverage.rb

@@ -161,11 +161,19 @@ module ChefSpec
       end
 
       def source_file
-        @source_file ||= shortname(@resource.source_line.split(':').first)
+        @source_file ||= if @resource.source_line
+          shortname(@resource.source_line.split(':').first)
+        else
+          'Unknown'
+        end
       end
 
       def source_line
-        @source_line ||= @resource.source_line.split(':', 2).last.to_i
+        @source_line ||= if @resource.source_line
+          @resource.source_line.split(':', 2).last.to_i
+        else
+          'Unknown'
+        end
       end
 
       def touch!

data/lib/chefspec/expect_exception.rb

@@ -1,5 +1,3 @@
-require 'rspec/matchers/built_in/raise_error'
-
 class RSpec::Matchers::BuiltIn::RaiseError
   class << self
     attr_accessor :last_run

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

@@ -39,7 +39,11 @@ class Chef
       [self, superclass].each do |resource_holder|
         look_in_parents = false
         if resource_holder.const_defined?(class_name, look_in_parents)
-          resource_holder.send(:remove_const, class_name)
+          old_class = resource_holder.send(:remove_const, class_name)
+
+          if resource_holder.respond_to?(:resource_classes)
+            resource_holder.resource_classes.delete(old_class)
+          end
         end
       end
     end

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

@@ -0,0 +1,19 @@
+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
+  end
+end

data/lib/chefspec/librarian.rb

@@ -25,7 +25,7 @@ module ChefSpec
     #
     def setup!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      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
 
@@ -33,9 +33,12 @@ module ChefSpec
     end
 
     #
-    # Remove the temporary directory.
+    # Remove the temporary directory and restore the librarian-chef cookbook path.
     #
     def teardown!
+      env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
+      env.config_db.local['path'] = @originalpath
+      
       FileUtils.rm_rf(@tmpdir) if File.exists?(@tmpdir)
     end
   end

data/lib/chefspec/macros.rb

@@ -44,11 +44,11 @@ module ChefSpec
       scope = self.is_a?(Class) ? self : self.class
 
       metahash = scope.metadata
-      while metahash.has_key?(:example_group)
-        metahash = metahash[:example_group]
+      while metahash.has_key?(:parent_example_group)
+        metahash = metahash[:parent_example_group]
       end
 
-      metahash[:description_args].first.to_s
+      metahash[:description].to_s
     end
 
     #

data/lib/chefspec/matchers/do_nothing_matcher.rb

@@ -4,6 +4,8 @@ module ChefSpec::Matchers
       @resource = resource
 
       if @resource
+        ChefSpec::Coverage.cover!(@resource)
+
         actions = @resource.performed_actions
         actions.empty? || actions == [:nothing]
       else
@@ -15,7 +17,7 @@ module ChefSpec::Matchers
       'do nothing'
     end
 
-    def failure_message_for_should
+    def failure_message
       if @resource
         message =  %|expected #{@resource} to do nothing, but the following |
         message << %|actions were performed:|
@@ -35,7 +37,7 @@ module ChefSpec::Matchers
       end
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       if @resource
         message =  %|expected #{@resource} to do something, but no actions |
         message << %|were performed.|

data/lib/chefspec/matchers/include_recipe_matcher.rb

@@ -13,11 +13,11 @@ module ChefSpec::Matchers
       %Q{include recipe "#{@recipe_name}"}
     end
 
-    def failure_message_for_should
+    def failure_message
       %Q{expected #{loaded_recipes.inspect} to include "#{@recipe_name}"}
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       %Q{expected "#{@recipe_name}" to not be included}
     end
 

data/lib/chefspec/matchers/link_to_matcher.rb

@@ -7,16 +7,22 @@ module ChefSpec::Matchers
     def matches?(link)
       @link = link
 
-      @link.is_a?(Chef::Resource::Link) &&
-      @link.performed_action?(:create) &&
-      @path === @link.to
+      if @link
+        ChefSpec::Coverage.cover!(@link)
+
+        @link.is_a?(Chef::Resource::Link) &&
+        @link.performed_action?(:create) &&
+        @path === @link.to
+      else
+        false
+      end
     end
 
     def description
       %Q{link to "#{@path}"}
     end
 
-    def failure_message_for_should
+    def failure_message
       if @link.nil?
         %Q{expected "link[#{@path}]" with action :create to be in Chef run}
       else
@@ -24,7 +30,7 @@ module ChefSpec::Matchers
       end
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       %Q{expected "#{@link}" to not link to "#{@path}"}
     end
   end

data/lib/chefspec/matchers/notifications_matcher.rb

@@ -51,7 +51,7 @@ module ChefSpec::Matchers
       message
     end
 
-    def failure_message_for_should
+    def failure_message
       if @resource
         message = %Q{expected "#{@resource}" to notify "#{@expected_resource_type}[#{@expected_resource_name}]"}
         message << " with action :#{@action}" if @action
@@ -77,7 +77,7 @@ module ChefSpec::Matchers
       end
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       if @resource
         message = %Q{expected "#{@resource}" to not notify "#{@expected_resource_type}[#{@expected_resource_name}]"}
         message << ", but it did."

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -6,7 +6,13 @@ module ChefSpec::Matchers
 
     def matches?(runner)
       @runner = runner
-      resource && has_create_action? && matches_content?
+
+      if resource
+        ChefSpec::Coverage.cover!(resource)
+        has_create_action? && matches_content?
+      else
+        false
+      end
     end
 
     def with_content(expected_content)
@@ -26,7 +32,7 @@ module ChefSpec::Matchers
       message
     end
 
-    def failure_message_for_should
+    def failure_message
       message = %Q{expected Chef run to render "#{@path}"}
       if @expected_content
         message << " matching:"
@@ -41,7 +47,7 @@ module ChefSpec::Matchers
       message
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       message = %Q{expected file "#{@path}"}
       if @expected_content
         message << " matching:"

data/lib/chefspec/matchers/resource_matcher.rb

@@ -50,7 +50,7 @@ module ChefSpec::Matchers
       end
     end
 
-    def failure_message_for_should
+    def failure_message
       if resource
         if resource.performed_action?(@expected_action)
           if unmatched_parameters.empty?
@@ -79,7 +79,7 @@ module ChefSpec::Matchers
       end
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       if resource
         message = %Q{expected "#{resource.to_s}" actions #{resource.performed_actions.inspect} to not exist}
       else

data/lib/chefspec/matchers/state_attrs_matcher.rb

@@ -18,7 +18,7 @@ module ChefSpec::Matchers
       %Q{have state attributes #{@expected_attrs.inspect}}
     end
 
-    def failure_message_for_should
+    def failure_message
       if @resource
         "expected #{state_attrs.inspect} to equal #{@expected_attrs.inspect}"
       else
@@ -32,7 +32,7 @@ module ChefSpec::Matchers
       end
     end
 
-    def failure_message_for_should_not
+    def failure_message_when_negated
       if @resource
         "expected #{state_attrs.inspect} to not equal " \
         "#{@expected_attrs.inspect}"

data/lib/chefspec/matchers/subscribes_matcher.rb

@@ -52,12 +52,12 @@ module ChefSpec::Matchers
       @instance.description
     end
 
-    def failure_message_for_should
-      @instance.failure_message_for_should
+    def failure_message
+      @instance.failure_message
     end
 
-    def failure_message_for_should_not
-      @instance.failure_message_for_should_not
+    def failure_message_when_negated
+      @instance.failure_message_when_negated
     end
   end
 end

data/lib/chefspec/renderer.rb

@@ -108,7 +108,7 @@ module ChefSpec
     def content_from_cookbook_file(chef_run, cookbook_file)
       cookbook_name = cookbook_file.cookbook || cookbook_file.cookbook_name
       cookbook = cookbook_collection(chef_run.node)[cookbook_name]
-      File.read(cookbook.preferred_filename_on_disk_location(chef_run.node, :files, cookbook_file.source, cookbook_file.path))
+      File.read(cookbook.preferred_filename_on_disk_location(chef_run.node, :files, cookbook_file.source))
     end
 
     # The cookbook collection for the current Chef run context. Handles

data/lib/chefspec/rspec.rb

@@ -10,6 +10,7 @@ RSpec.configure do |config|
   end
 
   config.add_setting :cookbook_path
+  config.add_setting :organization, default: 'chefspec'
   config.add_setting :role_path
   config.add_setting :log_level, default: :warn
   config.add_setting :path

data/lib/chefspec/runner.rb

@@ -80,6 +80,7 @@ module ChefSpec
       Chef::Config[:cache_type]     = 'Memory'
       Chef::Config[:client_key]     = nil
       Chef::Config[:cookbook_path]  = Array(options[:cookbook_path])
+      Chef::Config[:no_lazy_load]   = true
       Chef::Config[:role_path]      = Array(options[:role_path])
       Chef::Config[:force_logger]   = true
       Chef::Config[:solo]           = true
@@ -270,7 +271,7 @@ module ChefSpec
       calling_spec = kaller.find { |line| line =~ /\/spec/ }
       raise Error::CookbookPathNotFound if calling_spec.nil?
 
-      bits = calling_spec.split(':', 2).first.split(File::SEPARATOR)
+      bits = calling_spec.split(/:[0-9]/, 2).first.split(File::SEPARATOR)
       spec_dir = bits.index('spec') || 0
 
       File.expand_path(File.join(bits.slice(0, spec_dir), '..'))

data/lib/chefspec/server.rb

@@ -61,6 +61,13 @@ module ChefSpec
       instance.send(m, *args, &block)
     end
 
+    #
+    # RSpec 3 checks +respond_to?+ for some odd reason.
+    #
+    def self.respond_to_missing?(m, include_private = false)
+      instance.respond_to?(m, include_private) || super
+    end
+
     #
     # @macro entity
     #   @method create_$1(name, data = {})
@@ -105,11 +112,11 @@ module ChefSpec
           # Convert it to JSON
           data = JSON.fast_generate(data)
 
-          @server.load_data('#{key}' => { name => data })
+          load_data(name, '#{key}', data)
         end
 
         def #{method}(name)
-          data = @server.data_store.get(['#{key}', name])
+          data = get('#{key}', name)
           json = JSON.parse(data)
 
           if #{klass}.respond_to?(:json_create)
@@ -122,37 +129,45 @@ module ChefSpec
         end
 
         def #{key}
-          @server.data_store.list(['#{key}'])
+          get('#{key}')
         end
 
         def has_#{method}?(name)
-          !@server.data_store.get(['#{key}', name]).nil?
+          !get('#{key}', name).nil?
         rescue ChefZero::DataStore::DataNotFoundError
           false
         end
       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'
+
     include Singleton
 
     attr_reader :server
 
     #
     # Create a new instance of the +ChefSpec::Server+ singleton. This method
-    # also starts the Chef Zero server in the background.
+    # also starts the Chef Zero server in the background under the organization
+    # "chefspec".
     #
     def initialize
       @server = ChefZero::Server.new(
+        # Set the log level from RSpec, defaulting to warn
         log_level:  RSpec.configuration.log_level || :warn,
+
+        # Set a random port so ChefSpec may be run in multiple jobs
+        port: port,
+
+        # Disable the "old" way - this is actually +multi_tenant: true+
+        single_org: false,
       )
     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'
-
     #
     # Create a new data_bag on the Chef Server. This overrides the method
     # created by {entity}
@@ -163,7 +178,7 @@ module ChefSpec
     #   the data to load into the data bag
     #
     def create_data_bag(name, data = {})
-      @server.load_data('data' => { name => data })
+      load_data(name, 'data', data)
     end
 
     #
@@ -197,7 +212,7 @@ module ChefSpec
         data = JSON.fast_generate(data)
       end
 
-      @server.load_data('nodes' => { name => data })
+      load_data(name, 'nodes', data)
     end
 
     #
@@ -217,6 +232,15 @@ module ChefSpec
       end
     end
 
+    #
+    # The URL where ChefZero is listening (including the organization).
+    #
+    # @return [String]
+    #
+    def chef_server_url
+      @chef_server_url ||= File.join(@server.url, 'organizations', organization)
+    end
+
     #
     # Start the Chef Zero server in the background, updating the +Chef::Config+
     # with the proper +chef_server_url+.
@@ -224,7 +248,7 @@ module ChefSpec
     def start!
       unless @server.running?
         @server.start_background
-        Chef::Config[:chef_server_url] = @server.url
+        Chef::Config[:chef_server_url] = chef_server_url
       end
     end
 
@@ -233,6 +257,7 @@ module ChefSpec
     #
     def reset!
       @server.clear_data
+      @server.data_store.create_dir(['organizations'], organization)
     end
 
     #
@@ -246,6 +271,15 @@ module ChefSpec
 
     private
 
+    #
+    # The name of the Chef organization.
+    #
+    # @return [String]
+    #
+    def organization
+      RSpec.configuration.organization
+    end
+
     #
     # The directory where any cache information (such as private keys) should
     # be stored. This cache is destroyed at the end of the run.
@@ -260,16 +294,52 @@ module ChefSpec
     #
     # Shortcut method for loading data into Chef Zero.
     #
-    # @param [String, Symbol] key
-    #   the key to load
     # @param [String] name
     #   the name or id of the item to load
+    # @param [String, Symbol] key
+    #   the key to load
     # @param [Hash] data
     #   the data for the object, which will be converted to JSON and uploaded
     #   to the server
     #
-    def load_data(key, name, data = {})
-      @server.load_data(key.to_s => { name => JSON.fast_generate(data) })
+    def load_data(name, key, data = {})
+      @server.load_data({ key => { name => data } }, organization)
+    end
+
+    #
+    # Get the path to an item in the data store.
+    #
+    def get(*args)
+      if args.size == 1
+        @server.data_store.list(with_organization(*args))
+      else
+        @server.data_store.get(with_organization(*args))
+      end
+    end
+
+    #
+    # Prefix the given args with the organization. This is used by the data
+    # store to fetch elements.
+    #
+    # @return [Array<String>]
+    #
+    def with_organization(*args)
+      ['organizations', organization, *args]
+    end
+
+    #
+    # A randomly assigned, open port for run the Chef Zero server.
+    #
+    # @return [Fixnum]
+    #
+    def port
+      return @port if @port
+
+      @server = TCPServer.new('127.0.0.1', 0)
+      @port   = @server.addr[1].to_i
+      @server.close
+
+      return @port
     end
   end
 end
@@ -277,7 +347,8 @@ end
 ChefSpec::Server.start!
 
 RSpec.configure do |config|
-  config.after(:each)   { ChefSpec::Server.reset! }
+  config.before(:each) { ChefSpec::Server.reset! }
+  config.after(:each)  { ChefSpec::Server.reset! }
 end
 
 at_exit { ChefSpec::Server.stop! }