chefspec 7.0.0 → 9.3.8

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

@@ -1,14 +1,47 @@
-require 'chef/resource'
+require "chef/resource"
+require "chef/version"
+require_relative "../../api"
 
-class Chef::Resource
-  alias_method :old_initialize, :initialize
-  def initialize(*args)
-    @performed_actions = {}
-    old_initialize(*args)
+#
+# Three concerns:
+#   - no-op'ing so that the action does not run the provider
+#   - tracking the actions that were performed
+#   - auto registering helper methods
+#
+
+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 = :resource
+      mode = :current_value if caller.any? { |x| x.include?("`load_current_resource'") || x.include?("`load_after_resource'") }
+      ChefSpec::API::StubsFor.setup_stubs_for(self, mode)
+    end
+  end
+
+  def dup
+    return super unless $CHEFSPEC_MODE
+
+    # Also here be dragons.
+    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_value) if caller.any? { |x| x.include?("`load_current_resource'") || x.include?("`load_after_resource'") }
+    end
   end
 
-  alias_method :old_run_action, :run_action
+  # 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)
 
@@ -19,7 +52,7 @@ class Chef::Resource
     unless should_skip?(action)
       if node.runner.step_into?(self)
         instance_eval { @not_if = []; @only_if = [] }
-        old_run_action(action, notification_type, notifying_resource)
+        super
       end
 
       if node.runner.compiling?
@@ -30,20 +63,126 @@ class Chef::Resource
     end
   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: "resource", resource: self)
+    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: "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
 
   def performed_action?(action)
-    !!performed_action(action)
+    if action == :nothing
+      performed_actions.empty?
+    else
+      !!performed_action(action)
+    end
   end
 
   def performed_actions
+    @performed_actions ||= {}
     @performed_actions.keys
   end
+
+  #
+  # auto-registration
+  #
+
+  def self.prepended(base)
+    class << base
+      prepend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    # XXX: kind of a crappy way to find all the names of a resource
+    def provides_names
+      @provides_names ||= []
+    end
+
+    def resource_name(name = ::Chef::NOT_PASSED)
+      unless name == ::Chef::NOT_PASSED
+        provides_names << name unless provides_names.include?(name)
+        inject_actions(*allowed_actions)
+      end
+      super
+    end
+
+    def provides(name, **options, &block)
+      provides_names << name unless provides_names.include?(name)
+      inject_actions(*allowed_actions)
+      super
+    end
+
+    def action(sym, description: nil, &block)
+      inject_actions(sym)
+      super(sym, &block)
+    end
+
+    def allowed_actions(*actions)
+      inject_actions(*actions) unless actions.empty?
+      super
+    end
+
+    def allowed_actions=(value)
+      inject_actions(*Array(value))
+      super
+    end
+
+    private
+
+    def inject_method(method, resource_name, action)
+      unless ChefSpec::API.respond_to?(method)
+        ChefSpec::API.send(:define_method, method) do |name|
+          ChefSpec::Matchers::ResourceMatcher.new(resource_name, action, name)
+        end
+      end
+    end
+
+    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)
+          if action == :create_if_missing
+            inject_method(:"create_#{resource_name}_if_missing", resource_name, action)
+          end
+        end
+      end
+    end
+  end
 end
+
+Chef::Resource.prepend(ChefSpec::Extensions::Chef::Resource)

data/lib/chefspec/extensions/chef/run_context/cookbook_compiler.rb

@@ -0,0 +1,84 @@
+require "chef/run_context/cookbook_compiler"
+
+Chef::RunContext::CookbookCompiler.prepend(Module.new do
+  # List of compile phases as of Chef 14:
+  # compile_libraries
+  # compile_ohai_plugins
+  # compile_attributes
+  # compile_lwrps
+  # compile_resource_definitions
+  # compile_recipes
+
+  #
+  # Compile phases that should only ever run once, globally.
+  #
+
+  def load_libraries_from_cookbook(cookbook)
+    return super unless $CHEFSPEC_MODE
+
+    $CHEFSPEC_LIBRARY_PRELOAD ||= {}
+    # Already loaded this once.
+    return if $CHEFSPEC_LIBRARY_PRELOAD[cookbook]
+
+    $CHEFSPEC_LIBRARY_PRELOAD[cookbook] = true
+    super
+  end
+
+  def load_ohai_plugins_from_cookbook(cookbook)
+    return super unless $CHEFSPEC_MODE
+
+    $CHEFSPEC_OHAI_PRELOAD ||= {}
+    # Already loaded this once.
+    return if $CHEFSPEC_OHAI_PRELOAD[cookbook]
+
+    $CHEFSPEC_OHAI_PRELOAD[cookbook] = true
+    super
+  end
+
+  def load_lwrps_from_cookbook(cookbook)
+    return super unless $CHEFSPEC_MODE
+
+    $CHEFSPEC_LWRP_PRELOAD ||= {}
+    # Already loaded this once.
+    return if $CHEFSPEC_LWRP_PRELOAD[cookbook]
+
+    $CHEFSPEC_LWRP_PRELOAD[cookbook] = true
+    super
+  end
+
+  def load_resource_definitions_from_cookbook(cookbook)
+    return super unless $CHEFSPEC_MODE
+
+    $CHEFSPEC_DEFINITION_PRELOAD ||= {}
+    # Already loaded this once.
+    return if $CHEFSPEC_DEFINITION_PRELOAD[cookbook]
+
+    $CHEFSPEC_DEFINITION_PRELOAD[cookbook] = true
+    super
+  end
+
+  #
+  # Compile phases that should not run during preload
+  #
+
+  def compile_ohai_plugins
+    return super unless $CHEFSPEC_MODE
+    return if $CHEFSPEC_PRELOAD
+
+    super
+  end
+
+  def compile_attributes
+    return super unless $CHEFSPEC_MODE
+    return if $CHEFSPEC_PRELOAD
+
+    super
+  end
+
+  def compile_recipes
+    return super unless $CHEFSPEC_MODE
+    return if $CHEFSPEC_PRELOAD
+
+    super
+  end
+end)

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

@@ -1,4 +1,4 @@
-require 'chef/mixin/securable'
+require "chef/mixin/securable"
 
 class Chef
   module Mixin

data/lib/chefspec/extensions/ohai/system.rb

@@ -0,0 +1,11 @@
+require "ohai/system"
+
+Ohai::System.prepend(Module.new do
+  # If an Ohai segment exists, don't actually pull data in for ohai.
+  # (we have fake data for that)
+  # @see Ohai::System#run_additional_plugins
+  def run_additional_plugins(plugin_path)
+    return super unless $CHEFSPEC_MODE
+    # noop
+  end
+end)

data/lib/chefspec/extensions.rb

@@ -0,0 +1,21 @@
+require "rspec"
+
+module ChefSpec::Extensions
+  module Chef
+  end
+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/lwrp_base"
+require_relative "extensions/chef/resource/freebsd_package"
+require_relative "extensions/chef/run_context/cookbook_compiler"
+require_relative "extensions/chef/cookbook_loader"
+require_relative "extensions/ohai/system"

data/lib/chefspec/file_cache_path_proxy.rb

@@ -1,5 +1,5 @@
-require 'fileutils'
-require 'singleton'
+require "fileutils" unless defined?(FileUtils)
+require "singleton" unless defined?(Singleton)
 
 module ChefSpec
   class FileCachePathProxy
@@ -8,7 +8,7 @@ module ChefSpec
     attr_reader :file_cache_path
 
     def initialize
-      @file_cache_path = Dir.mktmpdir(["chefspec", "file_cache_path"])
+      @file_cache_path = Dir.mktmpdir(%w{chefspec file_cache_path})
       at_exit { FileUtils.rm_rf(@file_cache_path) }
     end
   end

data/lib/chefspec/formatter.rb

@@ -1,5 +1,5 @@
-require 'chef/formatters/base'
-require 'chef/formatters/error_mapper'
+require "chef/formatters/base"
+require "chef/formatters/error_mapper"
 
 module ChefSpec
   class ChefFormatter < Chef::Formatters::Base
@@ -133,6 +133,18 @@ module ChefSpec
     # Called when LWRPs are finished loading
     def lwrp_load_complete; end
 
+    # Called when an ohai plugin file loading starts
+    def ohai_plugin_load_start(file_count); end
+
+    # Called when an ohai plugin file has been loaded
+    def ohai_plugin_file_loaded(path); end
+
+    # Called when an ohai plugin file has an error on load.
+    def ohai_plugin_file_load_failed(path, exception); end
+
+    # Called when an ohai plugin file loading has finished
+    def ohai_plugin_load_complete; end
+
     # Called before attribute files are loaded
     def attribute_load_start(attribute_file_count); end
 
@@ -190,7 +202,7 @@ module ChefSpec
     def converge_complete; end
 
     # Called before action is executed on a resource.
-    def resource_action_start(resource, action, notification_type=nil, notifier=nil); end
+    def resource_action_start(resource, action, notification_type = nil, notifier = nil); end
 
     # Called when a resource fails, but will retry.
     def resource_failed_retriable(resource, action, retry_count, exception); end

data/lib/chefspec/librarian.rb

@@ -1,10 +1,11 @@
 begin
-  require 'librarian/chef/environment'
-  require 'librarian/action/resolve'
-  require 'librarian/action/install'
+  require "librarian/chef/environment"
+  require "librarian/action/resolve"
+  require "librarian/action/install"
 rescue LoadError
   raise ChefSpec::Error::GemLoadError.new(
-    gem: 'librarian-chef', name: 'Librarian')
+    gem: "librarian-chef", name: "Librarian"
+  )
 end
 
 module ChefSpec
@@ -25,7 +26,7 @@ module ChefSpec
     #
     def setup!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      @originalpath, env.config_db.local['path'] = 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
 
@@ -37,7 +38,7 @@ module ChefSpec
     #
     def teardown!
       env = ::Librarian::Chef::Environment.new(project_path: Dir.pwd)
-      env.config_db.local['path'] = @originalpath
+      env.config_db.local["path"] = @originalpath
 
       FileUtils.rm_rf(@tmpdir) if File.exist?(@tmpdir)
     end

data/lib/chefspec/matchers/do_nothing_matcher.rb

@@ -14,37 +14,37 @@ module ChefSpec::Matchers
     end
 
     def description
-      'do nothing'
+      "do nothing"
     end
 
     def failure_message
       if @resource
-        message =  %|expected #{@resource} to do nothing, but the following |
-        message << %|actions were performed:|
-        message << %|\n\n|
+        message =  %{expected #{@resource} to do nothing, but the following }
+        message << %{actions were performed:}
+        message << %{\n\n}
         @resource.performed_actions.each do |action|
-          message << %|  :#{action}|
+          message << %{  :#{action}}
         end
         message
       else
-        message =  %|expected _something_ to do nothing, but the _something_ |
-        message << %|you gave me was nil! If you are running a test like:|
-        message << %|\n\n|
-        message << %|  expect(_something_).to do_nothing|
-        message << %|\n\n|
-        message << %|make sure that `_something_` exists, because I got nil!|
+        message =  %{expected _something_ to do nothing, but the _something_ }
+        message << %{you gave me was nil! If you are running a test like:}
+        message << %{\n\n}
+        message << %{  expect(_something_).to do_nothing}
+        message << %{\n\n}
+        message << %{make sure that `_something_` exists, because I got nil!}
         message
       end
     end
 
     def failure_message_when_negated
       if @resource
-        message =  %|expected #{@resource} to do something, but no actions |
-        message << %|were performed.|
+        message =  %{expected #{@resource} to do something, but no actions }
+        message << %{were performed.}
         message
       else
-        message =  %|expected _something_ to do something, but no actions |
-        message << %|were performed.|
+        message =  %{expected _something_ to do something, but no actions }
+        message << %{were performed.}
         message
       end
     end

data/lib/chefspec/matchers/include_any_recipe_matcher.rb

@@ -0,0 +1,51 @@
+module ChefSpec::Matchers
+  class IncludeAnyRecipeMatcher
+    def matches?(runner)
+      @runner = runner
+      !(loaded_recipes - run_list_recipes).empty?
+    end
+
+    def description
+      "include any recipe"
+    end
+
+    def failure_message
+      "expected to include any recipe"
+    end
+
+    def failure_message_when_negated
+      "expected not to include any recipes"
+    end
+
+    private
+
+    #
+    # The list of run_list recipes on the Chef run (normalized)
+    #
+    # @return [Array<String>]
+    #
+    def run_list_recipes
+      @runner.run_context.node.run_list.run_list_items.map { |x| with_default(x.name) }
+    end
+
+    #
+    # Automatically appends "+::default+" to recipes that need them.
+    #
+    # @param [String] name
+    #
+    # @return [String]
+    #
+    def with_default(name)
+      name.include?("::") ? name : "#{name}::default"
+    end
+
+    #
+    # The list of loaded recipes on the Chef run (normalized)
+    #
+    # @return [Array<String>]
+    #
+    def loaded_recipes
+      @runner.run_context.loaded_recipes.map { |name| with_default(name) }
+    end
+  end
+end

data/lib/chefspec/matchers/include_recipe_matcher.rb

@@ -31,7 +31,7 @@ module ChefSpec::Matchers
     # @return [String]
     #
     def with_default(name)
-      name.include?('::') ? name : "#{name}::default"
+      name.include?("::") ? name : "#{name}::default"
     end
 
     #

data/lib/chefspec/matchers/link_to_matcher.rb

@@ -11,8 +11,8 @@ module ChefSpec::Matchers
         ChefSpec::Coverage.cover!(@link)
 
         @link.is_a?(Chef::Resource::Link) &&
-        @link.performed_action?(:create) &&
-        @path === @link.to
+          @link.performed_action?(:create) &&
+          @path === @link.to
       else
         false
       end

data/lib/chefspec/matchers/notifications_matcher.rb

@@ -14,8 +14,8 @@ module ChefSpec::Matchers
       if @resource
         block = Proc.new do |notified|
           resource_name(notified.resource).to_s == @expected_resource_type &&
-          (@expected_resource_name === notified.resource.identity.to_s || @expected_resource_name === notified.resource.name.to_s) &&
-          matches_action?(notified)
+            (@expected_resource_name === notified.resource.identity.to_s || @expected_resource_name === notified.resource.name.to_s) &&
+            matches_action?(notified)
         end
 
         if @immediately
@@ -115,6 +115,7 @@ module ChefSpec::Matchers
 
     def matches_action?(notification)
       return true if @action.nil?
+
       @action == notification.action.to_sym
     end
 
@@ -130,12 +131,12 @@ module ChefSpec::Matchers
         type = :delayed
       end
 
-      %Q{  "#{notifying_resource.to_s}" notifies "#{resource_name(resource)}[#{resource.name}]" to :#{notification.action}, :#{type}}
+      %Q{  "#{notifying_resource}" notifies "#{resource_name(resource)}[#{resource.name}]" to :#{notification.action}, :#{type}}
     end
 
     def format_notifications
       all_notifications.map do |notification|
-        '  ' + format_notification(notification)
+        "  " + format_notification(notification)
       end.join("\n")
     end
   end