chefspec 7.0.0 → 9.3.8

data/lib/chefspec/solo_runner.rb

@@ -1,8 +1,9 @@
-require 'fauxhai'
-require 'chef/client'
-require 'chef/mash'
-require 'chef/providers'
-require 'chef/resources'
+require "fauxhai"
+require "chef/client"
+require "chef/cookbook/metadata"
+require "chef/mash"
+require "chef/providers"
+require "chef/resources"
 
 module ChefSpec
   class SoloRunner
@@ -34,7 +35,7 @@ module ChefSpec
     #   ChefSpec::SoloRunner.new
     #
     # @example Specifying the platform and version
-    #   ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '16.04')
+    #   ChefSpec::SoloRunner.new(platform: 'ubuntu', version: '18.04')
     #
     # @example Specifying the cookbook path
     #   ChefSpec::SoloRunner.new(cookbook_path: ['/cookbooks'])
@@ -63,26 +64,7 @@ module ChefSpec
     #
     def initialize(options = {})
       @options = with_default_options(options)
-
-      Chef::Log.level = @options[:log_level]
-
-      Chef::Config.reset!
-      Chef::Config.formatters.clear
-      Chef::Config.add_formatter('chefspec')
-      Chef::Config[:cache_type]      = 'Memory'
-      Chef::Config[:client_key]      = nil
-      Chef::Config[:client_name]     = nil
-      Chef::Config[:node_name]       = nil
-      Chef::Config[:file_cache_path] = @options[:file_cache_path] || file_cache_path
-      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
-      Chef::Config[:solo_legacy_mode] = true
-      Chef::Config[:use_policyfile]  = false
-      Chef::Config[:environment_path] = @options[:environment_path]
-
+      apply_chef_config!
       yield node if block_given?
     end
 
@@ -105,6 +87,10 @@ module ChefSpec
     #   A reference to the calling Runner (for chaining purposes)
     #
     def converge(*recipe_names)
+      # Re-apply the Chef config before converging in case something else
+      # called Config.reset too.
+      apply_chef_config!
+      @converging = false
       node.run_list.reset!
       recipe_names.each { |recipe_name| node.run_list.add(recipe_name) }
 
@@ -113,6 +99,14 @@ module ChefSpec
       # Expand the run_list
       expand_run_list!
 
+      # Merge in provided node attributes. Default and override use the role_
+      # levels so they win over the relevant bits from cookbooks since otherwise
+      # they would not and that would be confusing.
+      node.attributes.role_default = Chef::Mixin::DeepMerge.merge(node.attributes.role_default, options[:default_attributes]) if options[:default_attributes]
+      node.attributes.normal = Chef::Mixin::DeepMerge.merge(node.attributes.normal, options[:normal_attributes]) if options[:normal_attributes]
+      node.attributes.role_override = Chef::Mixin::DeepMerge.merge(node.attributes.role_override, options[:override_attributes]) if options[:override_attributes]
+      node.attributes.automatic = Chef::Mixin::DeepMerge.merge(node.attributes.automatic, options[:automatic_attributes]) if options[:automatic_attributes]
+
       # Setup the run_context, rescuing the exception that happens when a
       # resource is not defined on a particular platform
       begin
@@ -129,21 +123,58 @@ module ChefSpec
       if converge_val.is_a?(Exception)
         raise converge_val
       end
+
       self
     end
 
+    #
+    # Execute a block of recipe code.
+    #
+    # @param [Proc] block
+    #   A block containing Chef recipe code
+    #
+    # @return [ChefSpec::SoloRunner]
+    #
+    def converge_block(&block)
+      converge do
+        recipe = Chef::Recipe.new(cookbook_name, "_test", run_context)
+        recipe.instance_exec(&block)
+      end
+    end
+
+    #
+    # Run a static preload of the cookbook under test. This will load libraries
+    # and resources, but not attributes or recipes.
+    #
+    # @return [void]
+    #
+    def preload!
+      # Flag to disable preloading for situations where it doesn't make sense.
+      return if ENV["CHEFSPEC_NO_PRELOAD"]
+
+      begin
+        old_preload = $CHEFSPEC_PRELOAD
+        $CHEFSPEC_PRELOAD = true
+        converge("recipe[#{cookbook_name}]")
+        node.run_list.reset!
+      ensure
+        $CHEFSPEC_PRELOAD = old_preload
+      end
+    end
+
     #
     # The +Chef::Node+ corresponding to this Runner.
     #
     # @return [Chef::Node]
     #
     def node
-      return @node if @node
-
-      @node = client.build_node
-      @node.instance_variable_set(:@runner, self)
-      @node.class.send(:attr_reader, :runner)
-      @node
+      runner = self
+      @node ||= begin
+        apply_chef_config!
+        client.build_node.tap do |node|
+          node.define_singleton_method(:runner) { runner }
+        end
+      end
     end
 
     #
@@ -177,7 +208,7 @@ module ChefSpec
     #
     def find_resource(type, name, action = nil)
       resource_collection.all_resources.reverse_each.find do |resource|
-        resource.declared_type == type.to_sym && (name === resource.identity || name === resource.name) && (action.nil? || resource.performed_action?(action))
+        resource.declared_type == type.to_sym && (name === resource.name || name === resource.identity) && (action.nil? || resource.performed_action?(action))
       end
     end
 
@@ -263,7 +294,8 @@ module ChefSpec
     # Respond to custom matchers defined by the user.
     #
     def method_missing(m, *args, &block)
-      if block = ChefSpec.matchers[resource_name(m.to_sym)]
+      block = ChefSpec.matchers[resource_name(m.to_sym)]
+      if block
         instance_exec(args.first, &block)
       else
         super
@@ -306,7 +338,8 @@ module ChefSpec
       config = RSpec.configuration
 
       {
-        cookbook_path: config.cookbook_path || calling_cookbook_path(caller),
+        cookbook_root: config.cookbook_root || calling_cookbook_root(options, caller),
+        cookbook_path: config.cookbook_path || calling_cookbook_path(options, caller),
         role_path:     config.role_path || default_role_path,
         environment_path: config.environment_path || default_environment_path,
         file_cache_path: config.file_cache_path,
@@ -318,21 +351,37 @@ module ChefSpec
     end
 
     #
-    # The inferred path from the calling spec.
+    # The inferred cookbook root from the calling spec.
     #
+    # @param [Hash<Symbol, Object>] options
+    #   initial runner options
     # @param [Array<String>] kaller
     #   the calling trace
     #
     # @return [String]
     #
-    def calling_cookbook_path(kaller)
-      calling_spec = kaller.find { |line| line =~ /\/spec/ }
+    def calling_cookbook_root(options, kaller)
+      calling_spec = options[:spec_declaration_locations] || kaller.find { |line| line =~ %r{/spec} }
       raise Error::CookbookPathNotFound if calling_spec.nil?
 
       bits = calling_spec.split(/:[0-9]/, 2).first.split(File::SEPARATOR)
-      spec_dir = bits.index('spec') || 0
+      spec_dir = bits.index("spec") || 0
 
-      File.expand_path(File.join(bits.slice(0, spec_dir), '..'))
+      File.join(bits.slice(0, spec_dir))
+    end
+
+    #
+    # The inferred path from the calling spec.
+    #
+    # @param [Hash<Symbol, Object>] options
+    #   initial runner options
+    # @param [Array<String>] kaller
+    #   the calling trace
+    #
+    # @return [String]
+    #
+    def calling_cookbook_path(options, kaller)
+      File.expand_path(File.join(calling_cookbook_root(options, kaller), ".."))
     end
 
     #
@@ -342,7 +391,7 @@ module ChefSpec
     #
     def default_role_path
       Pathname.new(Dir.pwd).ascend do |path|
-        possible = File.join(path, 'roles')
+        possible = File.join(path, "roles")
         return possible if File.exist?(possible)
       end
 
@@ -356,7 +405,7 @@ module ChefSpec
     #
     def default_environment_path
       Pathname.new(Dir.pwd).ascend do |path|
-        possible = File.join(path, 'environments')
+        possible = File.join(path, "environments")
         return possible if File.exist?(possible)
       end
 
@@ -406,5 +455,62 @@ module ChefSpec
         end
       end
     end
+
+    #
+    # Try to load the cookbook metadata for the cookbook under test.
+    #
+    # @return [Chef::Cookbook::Metadata]
+    #
+    def cookbook
+      @cookbook ||= Chef::Cookbook::Metadata.new.tap { |m| m.from_file("#{options[:cookbook_root]}/metadata.rb") }
+    end
+
+    #
+    # Try to figure out the name for the cookbook under test.
+    #
+    # @return [String]
+    #
+    def cookbook_name
+      # Try to figure out the name of this cookbook, pretending this block
+      # is in the name context as the cookbook under test.
+
+      cookbook.name
+    rescue IOError
+      # Old cookbook, has no metadata, use the folder name I guess.
+      File.basename(options[:cookbook_root])
+    end
+
+    #
+    # Apply the required options to {Chef::Config}.
+    #
+    # @api private
+    # @return [void]
+    #
+    def apply_chef_config!
+      Chef::Log.level = @options[:log_level]
+
+      Chef::Config.reset!
+      Chef::Config.formatters.clear
+      Chef::Config.add_formatter("chefspec")
+      Chef::Config[:cache_type]      = "Memory"
+      Chef::Config[:client_key]      = nil
+      Chef::Config[:client_name]     = nil
+      Chef::Config[:node_name]       = nil
+      Chef::Config[:file_cache_path] = @options[:file_cache_path] || file_cache_path
+      Chef::Config[:cookbook_path]   = Array(@options[:cookbook_path])
+      # If the word cookbook is in the folder name, treat it as the path. Otherwise
+      # it's probably not a cookbook path and so we activate the gross hack mode.
+      if Chef::Config[:cookbook_path].size == 1 && Chef::Config[:cookbook_path].first !~ /cookbook/
+        Chef::Config[:chefspec_cookbook_root] = @options[:cookbook_root]
+      end
+      Chef::Config[:no_lazy_load]    = true
+      Chef::Config[:role_path]       = Array(@options[:role_path])
+      Chef::Config[:force_logger]    = true
+      Chef::Config[:solo]            = true
+      Chef::Config[:solo_legacy_mode] = true
+      Chef::Config[:use_policyfile] = false
+      Chef::Config[:environment_path] = @options[:environment_path]
+    end
+
   end
 end

data/lib/chefspec/stubs/command_registry.rb

@@ -1,4 +1,4 @@
-require_relative 'registry'
+require_relative "registry"
 
 module ChefSpec
   module Stubs

data/lib/chefspec/stubs/command_stub.rb

@@ -1,4 +1,4 @@
-require_relative 'stub'
+require_relative "stub"
 
 module ChefSpec
   module Stubs

data/lib/chefspec/stubs/data_bag_item_registry.rb

@@ -1,4 +1,4 @@
-require_relative 'registry'
+require_relative "registry"
 
 module ChefSpec
   module Stubs

data/lib/chefspec/stubs/data_bag_item_stub.rb

@@ -1,4 +1,4 @@
-require_relative 'stub'
+require_relative "stub"
 
 module ChefSpec
   module Stubs

data/lib/chefspec/stubs/data_bag_registry.rb

@@ -1,4 +1,4 @@
-require_relative 'registry'
+require_relative "registry"
 
 module ChefSpec
   module Stubs

data/lib/chefspec/stubs/data_bag_stub.rb

@@ -1,4 +1,4 @@
-require_relative 'stub'
+require_relative "stub"
 
 module ChefSpec
   module Stubs

data/lib/chefspec/stubs/registry.rb

@@ -25,7 +25,7 @@ module ChefSpec
       end
 
       def stub_for(*args)
-        raise ArgumentError, '#stub_for is an abstract function'
+        raise ArgumentError, "#stub_for is an abstract function"
       end
     end
   end

data/lib/chefspec/stubs/search_registry.rb

@@ -1,9 +1,9 @@
-require_relative 'registry'
+require_relative "registry"
 
 module ChefSpec
   module Stubs
     class SearchRegistry < Registry
-      def stub_for(type, query = '*:*')
+      def stub_for(type, query = "*:*")
         @stubs.find do |stub|
           stub.type.to_s == type.to_s && stub.query === query
         end

data/lib/chefspec/stubs/search_stub.rb

@@ -1,4 +1,4 @@
-require_relative 'stub'
+require_relative "stub"
 
 module ChefSpec
   module Stubs
@@ -7,7 +7,7 @@ module ChefSpec
       attr_reader :query
       attr_reader :type
 
-      def initialize(type, query = '*:*', &block)
+      def initialize(type, query = "*:*", &block)
         @type  = type.to_s
         @query = query
         @block = block

data/lib/chefspec/util.rb

@@ -14,10 +14,10 @@ module ChefSpec
     def underscore(string)
       string
         .to_s
-        .gsub(/::/, '/')
-        .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-        .gsub(/([a-z\d])([A-Z])/,'\1_\2')
-        .tr('-', '_')
+        .gsub(/::/, "/")
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr("-", "_")
         .downcase
     end
 
@@ -32,8 +32,8 @@ module ChefSpec
     def camelize(string)
       string
         .to_s
-        .split('_')
-        .map { |e| e.capitalize }
+        .split("_")
+        .map(&:capitalize)
         .join
     end
 
@@ -49,7 +49,7 @@ module ChefSpec
       length = options[:length] || 30
 
       if string.length > length
-        string[0..length-3] + '...'
+        string[0..length - 3] + "..."
       else
         string
       end

data/lib/chefspec/version.rb

@@ -1,3 +1,3 @@
 module ChefSpec
-  VERSION = '7.0.0'
+  VERSION = "9.3.8".freeze
 end

data/lib/chefspec/zero_server.rb

@@ -1,4 +1,4 @@
-require 'chef_zero/server'
+require "chef_zero/server"
 
 module ChefSpec
   # Rather than create a ChefZero instance per test case, simply create one
@@ -6,23 +6,16 @@ module ChefSpec
   class ZeroServer
     class << self
       extend Forwardable
-      def_delegators :instance, :setup!, :teardown!, :reset!, :upload_cookbooks!, :server, :load_data
+      def_delegators :instance, :setup!, :teardown!, :reset!, :upload_cookbooks!, :server, :load_data, :nuke!
     end
 
     include Singleton
 
+    attr_reader :server
+
     # Create the ChefZero Server
     def initialize
-      @server ||= ChefZero::Server.new(
-        # Set the log level from RSpec, defaulting to warn
-        log_level:  RSpec.configuration.log_level || :warn,
-        port: RSpec.configuration.server_runner_port,
-
-        # Set the data store
-        data_store: data_store(RSpec.configuration.server_runner_data_store),
-      )
-      @cookbooks_uploaded = false
-      @data_loaded = {}
+      nuke!
     end
 
     #
@@ -53,6 +46,22 @@ module ChefSpec
       @data_loaded = {}
     end
 
+    #
+    # Really reset everything and reload the configuration
+    #
+    def nuke!
+      @server = ChefZero::Server.new(
+        # Set the log level from RSpec, defaulting to warn
+        log_level:  RSpec.configuration.log_level || :warn,
+        port: RSpec.configuration.server_runner_port,
+
+        # Set the data store
+        data_store: data_store(RSpec.configuration.server_runner_data_store)
+      )
+      @cookbooks_uploaded = false
+      @data_loaded = {}
+    end
+
     #
     # Teardown the ChefZero Server
     #
@@ -65,19 +74,13 @@ module ChefSpec
     #
     def upload_cookbooks!
       return if @cookbooks_uploaded
+
       loader = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
       loader.load_cookbooks
       cookbook_uploader_for(loader).upload_cookbooks
       @cookbooks_uploaded = true
     end
 
-    #
-    # The URL for the ChefZero Server
-    #
-    def server
-      @server
-    end
-
     #
     # Load (and track) data sent to the server
     #
@@ -120,9 +123,8 @@ module ChefSpec
                 require "chef_zero/data_store/memory_store_v2"
                 ChefZero::DataStore::MemoryStoreV2.new
               when :on_disk
-                require "tmpdir"
+                require "tmpdir" unless defined?(Dir.mktmpdir)
                 require "chef_zero/data_store/raw_file_store"
-                tmpdir = Dir.mktmpdir
                 ChefZero::DataStore::RawFileStore.new(Dir.mktmpdir)
               else
                 raise ArgumentError, ":#{option} is not a valid server_runner_data_store option. Please use either :in_memory or :on_disk."

data/lib/chefspec.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require "rspec"
 
 module ChefSpec
   #
@@ -25,7 +25,7 @@ module ChefSpec
   # @return [Pathname]
   #
   def root
-    @root ||= Pathname.new(File.expand_path('../../', __FILE__))
+    @root ||= Pathname.new(File.expand_path("..", __dir__))
   end
   module_function :root
 
@@ -42,41 +42,34 @@ module ChefSpec
   module_function :matchers
 end
 
-require_relative 'chefspec/extensions/chef/securable'
-require_relative 'chefspec/extensions/chef/client'
-require_relative 'chefspec/extensions/chef/conditional'
-require_relative 'chefspec/extensions/chef/cookbook_uploader'
-require_relative 'chefspec/extensions/chef/data_query'
-require_relative 'chefspec/extensions/chef/lwrp_base'
-require_relative 'chefspec/extensions/chef/resource'
-require_relative 'chefspec/extensions/chef/resource/freebsd_package'
+require_relative "chefspec/extensions"
 
-require_relative 'chefspec/mixins/normalize'
+require_relative "chefspec/mixins/normalize"
 
-require_relative 'chefspec/stubs/command_registry'
-require_relative 'chefspec/stubs/command_stub'
-require_relative 'chefspec/stubs/data_bag_item_registry'
-require_relative 'chefspec/stubs/data_bag_item_stub'
-require_relative 'chefspec/stubs/data_bag_registry'
-require_relative 'chefspec/stubs/data_bag_stub'
-require_relative 'chefspec/stubs/registry'
-require_relative 'chefspec/stubs/stub'
-require_relative 'chefspec/stubs/search_registry'
-require_relative 'chefspec/stubs/search_stub'
+require_relative "chefspec/stubs/command_registry"
+require_relative "chefspec/stubs/command_stub"
+require_relative "chefspec/stubs/data_bag_item_registry"
+require_relative "chefspec/stubs/data_bag_item_stub"
+require_relative "chefspec/stubs/data_bag_registry"
+require_relative "chefspec/stubs/data_bag_stub"
+require_relative "chefspec/stubs/registry"
+require_relative "chefspec/stubs/stub"
+require_relative "chefspec/stubs/search_registry"
+require_relative "chefspec/stubs/search_stub"
 
-require_relative 'chefspec/api'
-require_relative 'chefspec/cacher'
-require_relative 'chefspec/coverage'
-require_relative 'chefspec/errors'
-require_relative 'chefspec/expect_exception'
-require_relative 'chefspec/formatter'
-require_relative 'chefspec/macros'
-require_relative 'chefspec/matchers'
-require_relative 'chefspec/renderer'
-require_relative 'chefspec/rspec'
-require_relative 'chefspec/server_runner'
-require_relative 'chefspec/solo_runner'
-require_relative 'chefspec/util'
-require_relative 'chefspec/version'
+require_relative "chefspec/api"
+require_relative "chefspec/cacher"
+require_relative "chefspec/coverage"
+require_relative "chefspec/errors"
+require_relative "chefspec/expect_exception"
+require_relative "chefspec/formatter"
+require_relative "chefspec/matchers"
+require_relative "chefspec/renderer"
+require_relative "chefspec/rspec"
+require_relative "chefspec/server_runner"
+require_relative "chefspec/solo_runner"
+require_relative "chefspec/runner"
+require_relative "chefspec/util"
+require_relative "chefspec/version"
 
-require_relative 'chefspec/deprecations'
+require_relative "chefspec/deprecations"

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
-require 'chefspec'
-require 'support/hash'
-
+require "chefspec"
+require "support/hash"
 
 ChefSpec::Coverage.start! do
-  set_template 'table.erb'
+  set_template "table.erb"
 end
 
 RSpec.configure do |config|

data/spec/support/hash.rb

@@ -5,15 +5,15 @@
 #
 class Hash
   # Like, seriously Windows?
-  undef_method(:timeout)
+  undef_method(:timeout) if method_defined?(:timeout)
 
   #
   # Monkey-patch to allow mash-style look ups for tests
   #
   def method_missing(m, *args, &block)
-    if has_key?(m.to_sym)
+    if key?(m.to_sym)
       self[m.to_sym]
-    elsif has_key?(m.to_s)
+    elsif key?(m.to_s)
       self[m.to_s]
     else
       super
@@ -26,7 +26,7 @@ class Hash
   # @see Hash#respond_to?
   #
   def respond_to?(m, include_private = false)
-    if has_key?(m.to_sym) || has_key?(m.to_s)
+    if key?(m.to_sym) || key?(m.to_s)
       true
     else
       super