chefspec 2.0.1 → 3.0.0.beta.1

data/lib/chefspec/berkshelf.rb

@@ -0,0 +1,37 @@
+begin
+  require 'berkshelf'
+rescue LoadError
+  raise RuntimeError, "Berkshelf not found! You must have the berkshelf" \
+    " installed on your system before requiring chefspec/berkshelf. Install" \
+    " berkshelf by running:\n\n  gem install berkshelf\n\nor add Berkshelf" \
+    " to your Gemfile:\n\n  gem 'berkshelf'\n\n"
+end
+
+module ChefSpec
+  class Berkshelf
+    class << self
+      extend Forwardable
+      def_delegators :instance, :setup!
+    end
+
+    include Singleton
+
+    def initialize
+      setup!
+    end
+
+    def setup!
+      tmpdir = Dir.mktmpdir
+
+      ::Berkshelf.ui.mute do
+        ::Berkshelf::Berksfile.from_file('Berksfile').install(path: tmpdir)
+      end
+
+      ::RSpec.configure do |config|
+        config.cookbook_path = tmpdir
+      end
+    end
+  end
+end
+
+ChefSpec::Berkshelf.setup!

data/lib/chefspec/deprecations.rb

@@ -0,0 +1,151 @@
+module Kernel
+  # Kernel extension to print deprecation notices.
+  #
+  # @example printing a deprecation warning
+  #   deprecated 'no longer in use' #=> "[DEPRECATION] no longer in use"
+  #
+  # @param [Array<String>] messages
+  def deprecated(*messages)
+    messages.each do |message|
+      calling_spec = caller.find { |line| line =~ /(\/spec)|(_spec\.rb)/ }
+      calling_spec = 'spec/' + calling_spec.split('/spec/').last
+      warn "[DEPRECATION] #{message} (called from #{calling_spec})"
+    end
+  end
+end
+
+module ChefSpec
+  # @deprecated {ChefSpec::ChefRunner} is deprecated. Please use
+  #   {ChefSpec::Runner} instead.
+  class ChefRunner
+    def self.new(*args, &block)
+      deprecated '`ChefSpec::ChefRunner` is deprecated. Please use' \
+        ' `ChefSpec::Runner` instead.'
+
+      ChefSpec::Runner.new(*args, &block)
+    end
+  end
+end
+
+module ChefSpec
+  class Runner
+    alias_method :existing_initialize, :initialize
+    def initialize(*args, &block)
+      if args.first.is_a?(Hash)
+        if args.first.has_key?(:evaluate_guards)
+          deprecated 'The `:evaluate_guards` option is deprecated. Guards are' \
+            ' automatically evaluated by default. Please use `stub_command` to' \
+            ' stub shell guards.'
+        end
+
+        if args.first.has_key?(:actually_run_shell_guards)
+          deprecated 'The `:actually_run_shell_guards` option is deprecated.' \
+            ' Shell commands must be stubbed using `stub_command`.'
+        end
+      end
+
+      existing_initialize(*args, &block)
+    end
+  end
+end
+
+module ChefSpec::API
+  module DeprecatedMatchers
+    def be_owned_by(user, group)
+      deprecated "The `be_owned_by` matcher is deprecated. Please use:" \
+        "\n\n" \
+        "  expect(resource.owner).to eq('#{user}')\n" \
+        "  expect(resource.group).to eq('#{group}')" \
+        "\n\n" \
+        "instead"
+      raise ChefSpec::NoConversionError.new('be_owned_by')
+    end
+
+    def create_file_with_content(path, content)
+      deprecated "The `create_file_with_content` matcher is deprecated." \
+        " Please use `render_file(#{path.inspect})" \
+        ".with_content(#{content.inspect})` instead."
+      ChefSpec::Matchers::RenderFileMatcher.new(path).with_content(content)
+    end
+
+    [:package, :yum_package, :gem_package, :chef_gem].each do |type|
+      matcher_name = "install_#{type}_at_version".to_sym
+      define_method(matcher_name) do |name, version|
+        deprecated "The `#{matcher_name}` matcher is deprecated." \
+          " Please use `install_package(#{name.inspect})" \
+          ".with(version: #{version.inspect})` instead."
+        ChefSpec::Matchers::ResourceMatcher.new(type, :install, package)
+          .with(version: version)
+      end
+    end
+
+    [:bash, :csh, :perl, :python, :ruby, :script].each do |type|
+      matcher_name = "execute_#{type}_script".to_sym
+      define_method(matcher_name) do |name|
+        deprecated "The `#{matcher_name}` matcher is deprecated." \
+          " Please use `run_#{type}(#{name.inspect})` instead."
+        ChefSpec::Matchers::ResourceMatcher.new(type, :run, name)
+      end
+    end
+
+    def log(message)
+      deprecated "The `log` matcher is deprcated. Please use" \
+        " `write_log(#{message.inspect}) instead."
+      ChefSpec::Matchers::ResourceMatcher.new(:log, :write, message)
+    end
+
+    def set_service_to_start_on_boot(service)
+      deprecated "The `set_service_to_start_on_boot` matcher is" \
+        " deprecated. Please use `enable_service(#{service.inspect})`" \
+        " instead."
+      ChefSpec::Matchers::ResourceMatcher.new(:service, :enable, service)
+    end
+
+    def set_service_to_not_start_on_boot(service)
+      deprecated "The `set_service_to_not_start_on_boot` matcher is" \
+        " deprecated. Please use `enable_service(#{service.inspect})`" \
+        " with a negating argument instead."
+      raise ChefSpec::NoConversionError.new('set_service_to_start_on_boot')
+    end
+
+    def execute_ruby_block(name)
+      deprecated "The `execute_ruby_block` matcher is deprecated. Please" \
+        " use `run_ruby_block(#{name.inspect})` instead."
+      ChefSpec::Matchers::ResourceMatcher.new(:ruby_block, :run, name)
+    end
+
+    def execute_command(command)
+      deprecated "The `execute_command` matcher is deprecated. Please" \
+        " use `run_execute(#{command.inspect})` instead."
+      ChefSpec::Matchers::ResourceMatcher.new(:execute, :run, command)
+    end
+  end
+end
+
+module ChefSpec::API
+  module NotificationsMatchers
+    alias_method :new_notify, :notify
+    def notify(resource, action = nil)
+      if action
+        deprecated "The `notify` matcher arity has changed. Please use" \
+          " `notify(#{resource.inspect}).to(#{action.to_sym.inspect})`" \
+          " instead."
+          new_notify(resource).to(action.to_sym)
+      else
+        new_notify(resource)
+      end
+    end
+  end
+end
+
+module ChefSpec
+  class NoConversionError < Error
+    def initialize(matcher)
+      message = "I cannot convert `#{matcher}` to use a new matcher format!" \
+        " Please see the ChefSpec documentation and CHANGELOG for details" \
+        " on converting this matcher. Sorry :("
+
+      super(message)
+    end
+  end
+end

data/lib/chefspec/errors.rb

@@ -0,0 +1,99 @@
+module ChefSpec
+  class Error < StandardError; end
+
+  class CommandNotStubbedError < Error
+    def initialize(command)
+      message =  "Real commands are disabled. Unregistered command: `#{command}`"
+      message << "\n\n"
+      message << "You can stub this command with:"
+      message << "\n\n"
+      message << "  #{Stubs::CommandStub.new(command).and_return(true).signature}"
+
+      unless Stubs::CommandRegistry.stubs.empty?
+        message << "\n\n"
+        message << "registered command stubs:"
+        message << "\n"
+
+        Stubs::CommandRegistry.stubs.each do |command|
+          message << "\n  #{command.signature}"
+        end
+      end
+
+      message << "\n\n"
+      message << "="*60
+      super(message)
+    end
+  end
+
+  class SearchNotStubbedError < Error
+    def initialize(type, query)
+      message =  "Real searches are disabled. Unregistered search: search(#{type.inspect}, #{query.inspect})"
+      message << "\n\n"
+      message << "You can stub this search with:"
+      message << "\n\n"
+      message << "  #{Stubs::SearchStub.new(type, query).and_return({}).signature}"
+
+      unless Stubs::SearchRegistry.stubs.empty?
+        message << "\n\n"
+        message << "registered search stubs:"
+        message << "\n"
+
+        Stubs::SearchRegistry.stubs.each do |search|
+          message << "\n  #{search.signature}"
+        end
+      end
+
+      message << "\n\n"
+      message << "="*60
+      super(message)
+    end
+  end
+
+  class DataBagNotStubbedError < Error
+    def initialize(bag)
+      message =  "Real data_bags are disabled. Unregistered data_bag: data_bag(#{bag.inspect})"
+      message << "\n\n"
+      message << "You can stub this data_bag with:"
+      message << "\n\n"
+      message << "  #{Stubs::DataBagStub.new(bag).and_return({}).signature}"
+
+      unless Stubs::DataBagRegistry.stubs.empty?
+        message << "\n\n"
+        message << "registered data_bag stubs:"
+        message << "\n"
+
+        Stubs::DataBagRegistry.stubs.each do |data_bag|
+          message << "\n  #{data_bag.signature}"
+        end
+      end
+
+      message << "\n\n"
+      message << "="*60
+      super(message)
+    end
+  end
+
+  class DataBagItemNotStubbedError < Error
+    def initialize(bag, id)
+      message =  "Real data_bag_items are disabled. Unregistered search: data_bag_item(#{bag.inspect}, #{id.inspect})"
+      message << "\n\n"
+      message << "You can stub this data_bag_item with:"
+      message << "\n\n"
+      message << "  #{Stubs::DataBagItemStub.new(bag, id).and_return({}).signature}"
+
+      unless Stubs::DataBagItemRegistry.stubs.empty?
+        message << "\n\n"
+        message << "registered data_bag_item stubs:"
+        message << "\n"
+
+        Stubs::DataBagItemRegistry.stubs.each do |data_bag_item|
+          message << "\n  #{data_bag_item.signature}"
+        end
+      end
+
+      message << "\n\n"
+      message << "="*60
+      super(message)
+    end
+  end
+end

data/lib/chefspec/expect_exception.rb

@@ -0,0 +1,45 @@
+class RSpec::Matchers::BuiltIn::RaiseError
+  class << self
+    attr_accessor :last_run
+  end
+
+  attr_reader :expected_error, :expected_message
+
+  alias_method :old_matches?, :matches?
+  def matches?(*args)
+    self.class.last_run = self
+    old_matches?(*args)
+  end
+end
+
+module ChefSpec
+  class ExpectException
+    def initialize(formatter_exception, formatter_message = nil)
+      @formatter_exception = formatter_exception
+      @formatter_message   = formatter_message
+      @matcher             = RSpec::Matchers::BuiltIn::RaiseError.last_run
+    end
+
+    def expected?
+      return false if @matcher.nil?
+      exception_matched? && message_matched?
+    end
+
+    private
+      def exception_matched?
+        @formatter_exception == @matcher.expected_error ||
+        @matcher.expected_error === @formatter_exception
+      end
+
+      def message_matched?
+        case @formatter_message
+        when nil
+          true
+        when Regexp
+          @matcher.expected_message =~ @formatter_message
+        else
+          @matcher.expected_message == @formatter_message
+        end
+      end
+  end
+end

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

@@ -0,0 +1,15 @@
+require 'chef/client'
+
+# @private
+class Chef::Client
+  attr_reader :events
+
+  #
+  # Don't actually run ohai (we have fake data for that)
+  #
+  # @see Chef::Client#run_ohai
+  #
+  def run_ohai
+    # noop
+  end
+end

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

@@ -0,0 +1,11 @@
+require 'chef/resource/conditional'
+
+class Chef::Resource::Conditional
+  # @see Chef::Resource::Conditional#evaluate_command
+  def evaluate_command
+    stub = ChefSpec::Stubs::CommandRegistry.stub_for(@command)
+    raise ChefSpec::CommandNotStubbedError.new(@command) if stub.nil?
+
+    stub.result
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'chef/dsl/data_query'
+
+module Chef::DSL::DataQuery
+  # @see Chef::DSL::DataQuery#search
+  def search(*args, &block)
+    type  = args[0]
+    query = args[1] || '*:*'
+    stub = ChefSpec::Stubs::SearchRegistry.stub_for(type, query)
+    raise ChefSpec::SearchNotStubbedError.new(type, query) if stub.nil?
+
+    stub.result
+  end
+
+  # @see Chef::DSL::DataQuery#data_bag
+  def data_bag(bag)
+    stub = ChefSpec::Stubs::DataBagRegistry.stub_for(bag)
+    raise ChefSpec::DataBagNotStubbedError.new(bag) if stub.nil?
+
+    stub.result
+  end
+
+  # @see Chef::DSL::DataQuery#data_bag_item
+  def data_bag_item(bag, id)
+    stub = ChefSpec::Stubs::DataBagItemRegistry.stub_for(bag, id)
+    raise ChefSpec::DataBagItemNotStubbedError.new(bag, id) if stub.nil?
+
+    stub.result
+  end
+end

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

@@ -0,0 +1,44 @@
+# Override Chef LWRP creation to remove existing class to avoid redefinition warnings.
+class Chef
+  class Provider
+    # Chef provider for a resource
+    class LWRPBase < Provider
+      class << self
+        alias_method :old_build_from_file, :build_from_file
+
+        #
+        # Override Opscode provider to remove any existing LWRP
+        #
+        # @param [String] cookbook_name
+        #   The name of the cookbook
+        # @param [String] filename
+        #   File to load as a LWRP
+        # @param [Chef::RunContext] run_context
+        #   Context of a Chef Run
+        #
+        # @return [Chef::Provider]
+        #
+        def build_from_file(*args)
+          cookbook_name, filename = args[0,2]
+          remove_existing_lwrp(convert_to_class_name(filename_to_qualified_string(cookbook_name, filename)))
+          old_build_from_file(*args)
+        end
+
+        #
+        # Remove any existing Chef provider or resource with the specified name.
+        #
+        # @param [String] class_name
+        #   The class name. Must be a valid constant name.
+        #
+        def remove_existing_lwrp(class_name)
+          [Chef::Resource::LWRPBase, Chef::Provider::LWRPBase, Chef::Resource, Chef::Provider].each do |resource_holder|
+            if resource_holder.const_defined? class_name, false
+              resource_holder.send(:remove_const, class_name)
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+require 'chef/resource'
+
+class Chef::Resource
+  alias :old_run_action :run_action unless method_defined?(:old_run_action)
+
+  #
+  # Pretend to run resource actions, adding them to the resource collection
+  # to prevent actually executing resources
+  #
+  # @see Chef::Resource#run_action
+  #
+  def run_action(action, notification_type = nil, notifying_resource = nil)
+    return if should_skip?(action)
+
+    if node.runner.step_into.include?(self.resource_name.to_s)
+      instance_eval { @not_if = []; @only_if = [] }
+      old_run_action(action, notification_type, notifying_resource)
+    end
+
+    Chef::Log.info("Processing #{self} action #{action} (#{defined_at})")
+
+    # Append the currently run action to the existing resource actions,
+    # making sure it's a unique array of symbols.
+    @action = [self.action, action].flatten.compact.map(&:to_sym).uniq
+    node.runner.resources[self.to_s] ||= self
+  end
+end