chefspec 4.0.2 → 4.1.0

data/lib/chefspec/api/service.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 0.0.1
   module ServiceMatchers
-    ChefSpec::Runner.define_runner_method :service
+    ChefSpec.define_matcher :service
 
     #
     # Assert that a +service+ resource exists in the Chef run with the

data/lib/chefspec/api/smartos_package.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 3.0.0
   module SmartosPackageMatchers
-    ChefSpec::Runner.define_runner_method :smartos_package
+    ChefSpec.define_matcher :smartos_package
 
     #
     # Assert that a +smartos_package+ resource exists in the Chef run with the

data/lib/chefspec/api/solaris_package.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 3.0.0
   module SolarisPackageMatchers
-    ChefSpec::Runner.define_runner_method :solaris_package
+    ChefSpec.define_matcher :solaris_package
 
     #
     # Assert that a +solaris_package+ resource exists in the Chef run with the

data/lib/chefspec/api/subversion.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 3.0.0
   module SubversionMatchers
-    ChefSpec::Runner.define_runner_method :subversion
+    ChefSpec.define_matcher :subversion
 
     #
     # Assert that a +subversion+ resource exists in the Chef run with the

data/lib/chefspec/api/template.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 0.0.1
   module TemplateMatchers
-    ChefSpec::Runner.define_runner_method :template
+    ChefSpec.define_matcher :template
 
     #
     # Assert that a +template+ resource exists in the Chef run with the

data/lib/chefspec/api/user.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 0.3.0
   module UserMatchers
-    ChefSpec::Runner.define_runner_method :user
+    ChefSpec.define_matcher :user
 
     #
     # Assert that a +user+ resource exists in the Chef run with the

data/lib/chefspec/api/yum_package.rb

@@ -1,7 +1,7 @@
 module ChefSpec::API
   # @since 3.0.0
   module YumPackageMatchers
-    ChefSpec::Runner.define_runner_method :yum_package
+    ChefSpec.define_matcher :yum_package
 
     #
     # Assert that a +yum_package+ resource exists in the Chef run with the

data/lib/chefspec/coverage/filters.rb

@@ -16,6 +16,7 @@ module ChefSpec
     #
     class RegexpFilter < Filter
       def matches?(resource)
+        return true if resource.source_line.nil?
         @filter =~ resource.source_line
       end
     end
@@ -39,6 +40,7 @@ module ChefSpec
     #
     class BlockFilter < Filter
       def matches?(resource)
+        return true if resource.source_line.nil?
         @filter.call(resource)
       end
     end
@@ -68,6 +70,7 @@ module ChefSpec
       end
 
       def matches?(resource)
+        return true if resource.source_line.nil?
         resource.source_line =~ /cookbooks\/(?!#{@metadatas.join('|')})/
       end
     end

data/lib/chefspec/deprecations.rb

@@ -14,141 +14,37 @@ module Kernel
   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
-  #
-  # @todo Remove in v4.0.0
-  #
-  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
+    # @deprecated {ChefSpec.define_runner_method} is deprecated. Please
+    #   use {ChefSpec.define_runner_method} instead.
+    def self.define_runner_method(resource_name)
+      deprecated "`ChefSpec.define_runner_method' is deprecated. " \
+        "Please use `ChefSpec.define_runner_method' instead."
 
-    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)
+      ChefSpec.define_matcher(resource_name)
     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
+    # @deprecated {ChefSpec::Runner.new} is deprecated. Please use
+    #   {ChefSpec::SoloRunner} or {ChefSpec::ServerRunner} instead.
+    def self.new(*args, &block)
+      deprecated "`ChefSpec::Runner' is deprecated. Please use" \
+        " `ChefSpec::SoloRunner' or `ChefSpec::ServerRunner' instead."
 
-    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)
+      ChefSpec::SoloRuner.new(*args, &block)
     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
+  class Server
+    def self.method_missing(m, *args, &block)
+      deprecated "`ChefSpec::Server.#{m}' is deprecated. There is no longer" \
+        " a global Chef Server instance. Please use a ChefSpec::ServerRunner" \
+        " instead. More documentation can be found in the ChefSpec README."
+      raise NoConversionError
     end
   end
 end
 
 module ChefSpec::Error
-  class NoConversionError < ChefSpecError
-    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
+  class NoConversionError < ChefSpecError;  end
 end

data/lib/chefspec/macros.rb

@@ -34,8 +34,8 @@ module ChefSpec
     #
     # The value of +described_recipe+ is "my_cookbook::my_recipe".
     #
-    # @example Using +described_recipe+ in the +ChefSpec::Runner+
-    #   let(:chef_run) { ChefSpec::Runner.new.converge(described_recipe) }
+    # @example Using +described_recipe+ in the +ChefSpec::SoloRunner+
+    #   let(:chef_run) { ChefSpec::SoloRunner.new.converge(described_recipe) }
     #
     #
     # @return [String]

data/lib/chefspec/matchers/render_file_matcher.rb

@@ -80,7 +80,7 @@ module ChefSpec::Matchers
     #
     # @param [Chef::Resource] resource
     #
-    # @return [Boolean]
+    # @return [true, false]
     #
     def has_create_action?
       [:create, :create_if_missing].any? { |action| resource.performed_action?(action) }
@@ -91,7 +91,7 @@ module ChefSpec::Matchers
     #
     # @param [Chef::Resource] resource
     #
-    # @return [Boolean]
+    # @return [true, false]
     #
     def matches_content?
       return true if @expected_content.nil?

data/lib/chefspec/matchers/resource_matcher.rb

@@ -153,7 +153,7 @@ module ChefSpec::Matchers
     # Find the resource in the Chef run by the given class name and
     # resource identity/name.
     #
-    # @see ChefSpec::Runner#find_resource
+    # @see ChefSpec::SoloRunner#find_resource
     #
     # @return [Chef::Resource, nil]
     #

data/lib/chefspec/matchers/state_attrs_matcher.rb

@@ -53,7 +53,7 @@ module ChefSpec::Matchers
     # Determine if all the expected state attributes are present on the
     # given resource.
     #
-    # @return [Boolean]
+    # @return [true, false]
     #
     def matches_state_attrs?
       @expected_attrs == state_attrs

data/lib/chefspec/server.rb

@@ -1,361 +1,4 @@
-begin
-  require 'chef_zero/server'
-rescue LoadError
-  raise ChefSpec::Error::GemLoadError.new(gem: 'chef-zero', name: 'Chef Zero')
-end
-
-require 'chef/cookbook_loader'
-require 'chef/cookbook_uploader'
-
-class Chef::CookbookUploader
-  #
-  # Don't validate uploaded cookbooks. Validating a cookbook takes *forever*
-  # to complete. It's just not worth it...
-  #
-  def validate_cookbooks
-    # noop
-  end
-end
-
-class ChefSpec::Runner
-  alias_method :old_initialize, :initialize
-
-  #
-  # Override the existing initialize method, setting the appropriate
-  # configuration to use a real Chef Server instead.
-  #
-  # @see ChefSpec::Runner#initialize
-  #
-  def initialize(options = {}, &block)
-    old_initialize(options, &block)
-
-    Chef::Config[:client_key]      = ChefSpec::Server.client_key
-    Chef::Config[:client_name]     = 'chefspec'
-    Chef::Config[:node_name]       = 'chefspec'
-    Chef::Config[:file_cache_path] = Dir.mktmpdir
-    Chef::Config[:solo]            = false
-
-    upload_cookbooks!
-  end
-
-  private
-
-  #
-  # Upload the cookbooks to the Chef Server.
-  #
-  def upload_cookbooks!
-    loader = Chef::CookbookLoader.new(Chef::Config[:cookbook_path])
-    loader.load_cookbooks
-
-    uploader = Chef::CookbookUploader.new(loader.cookbooks, loader.cookbook_paths)
-    uploader.upload_cookbooks
-  end
-end
-
-module ChefSpec
-  class Server
-    #
-    # Delegate all methods to the singleton instance.
-    #
-    def self.method_missing(m, *args, &block)
-      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 = {})
-    #     Create a new $1 on the Chef Server
-    #
-    #     @param [String] name
-    #       the name of the $1
-    #     @param [Hash] data
-    #       the list of data to load
-    #
-    #
-    #   @method $1(name)
-    #     Find a $1 at the given name
-    #
-    #     @param [String] name
-    #       the name of the $1
-    #
-    #     @return [$2, nil]
-    #
-    #
-    #   @method $3
-    #     The list of $1 on the Chef Server
-    #
-    #     @return [Array<Hash>]
-    #       all the $1 on the Chef Server
-    #
-    #
-    #   @method has_$1?(name)
-    #     Determine if the Chef Server has the given $1
-    #
-    #     @param [String] name
-    #       the name of the $1 to find
-    #
-    #     @return [Boolean]
-    #
-    def self.entity(method, klass, key)
-      class_eval <<-EOH, __FILE__, __LINE__ + 1
-        def create_#{method}(name, data = {})
-          # Automatically set the "name" if no explicit one was given
-          data[:name] ||= name
-
-          # Convert it to JSON
-          data = JSON.fast_generate(data)
-
-          load_data(name, '#{key}', data)
-        end
-
-        def #{method}(name)
-          data = get('#{key}', name)
-          json = JSON.parse(data)
-
-          if #{klass}.respond_to?(:json_create)
-            #{klass}.json_create(json)
-          else
-            #{klass}.new(json)
-          end
-        rescue ChefZero::DataStore::DataNotFoundError
-          nil
-        end
-
-        def #{key}
-          get('#{key}')
-        end
-
-        def has_#{method}?(name)
-          !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.
-    #
-    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,
-      )
-    end
-
-    #
-    # Create a new data_bag on the Chef Server. This overrides the method
-    # created by {entity}
-    #
-    # @param [String] name
-    #   the name of the data bag
-    # @param [Hash] data
-    #   the data to load into the data bag
-    #
-    def create_data_bag(name, data = {})
-      load_data(name, 'data', data)
-    end
-
-    #
-    # Create a new node on the Chef Server. This overrides the method created
-    # by {entity}, permitting users to pass a raw +Chef::Node+ object in
-    # addition to a hash.
-    #
-    # @example Create a node from a hash
-    #
-    #   create_node('bacon', attribute: 'value')
-    #
-    # @example Create a node from a +Chef::Node+ object
-    #
-    #   node = stub_node('bacon', platform: 'ubuntu', version: '12.04')
-    #   create_node(node)
-    #
-    # @param [String, Chef::Node] object
-    #   the object to create; this can be the name of the node, or an actual
-    #   +Chef::Node+ object
-    # @param [Hash] data
-    #   the list of data to populate the node with; this is ignored if an
-    #   actual node object is given
-    #
-    def create_node(object, data = {})
-      if object.is_a?(Chef::Node)
-        name = object.name
-        data = object.to_json
-      else
-        name = object.to_s
-        data[:name] ||= name
-        data = JSON.fast_generate(data)
-      end
-
-      load_data(name, 'nodes', data)
-    end
-
-    #
-    # The path to the insecure Chef Zero private key on disk. Because Chef
-    # requires the path to a file instead of the contents of the key (why),
-    # this method dynamically writes the +ChefZero::PRIVATE_KEY+ to disk and
-    # then returns that path.
-    #
-    # @return [String]
-    #   the path to the client key on disk
-    #
-    def client_key
-      @client_key ||= begin
-        path = File.join(cache_dir, 'client.pem')
-        File.open(path, 'w') { |f| f.write(ChefZero::PRIVATE_KEY) }
-        path
-      end
-    end
-
-    #
-    # The URL where ChefZero is listening.
-    #
-    # @return [String]
-    #
-    def chef_server_url
-      @chef_server_url ||= File.join(@server.url)
-    end
-
-    #
-    # Start the Chef Zero server in the background, updating the +Chef::Config+
-    # with the proper +chef_server_url+.
-    #
-    def start!
-      unless @server.running?
-        @server.start_background
-        Chef::Config[:chef_server_url] = chef_server_url
-      end
-    end
-
-    #
-    # Clear the contents of the server (used between examples)
-    #
-    def reset!
-      @server.clear_data
-    end
-
-    #
-    # Stop the Chef Zero server, if it is running. This method also runs any
-    # cleanup hooks, such as clearing the cache directories.
-    #
-    def stop!
-      @server.stop if @server.running?
-      FileUtils.rm_rf(cache_dir)
-    end
-
-    private
-
-    #
-    # The directory where any cache information (such as private keys) should
-    # be stored. This cache is destroyed at the end of the run.
-    #
-    # @return [String]
-    #   the path to the cache directory on disk
-    #
-    def cache_dir
-      @cache_dir ||= Dir.mktmpdir(['chefspec', 'cache'])
-    end
-
-    #
-    # Shortcut method for loading data into Chef Zero.
-    #
-    # @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(name, key, data = {})
-      @server.load_data({ key => { name => data } })
-    end
-
-    #
-    # Get the path to an item in the data store.
-    #
-    def get(*args)
-      # This is a real-life "what in the actual fuck!?". Since some engineers
-      # cannot seem to understand the importance of an unchanging public API,
-      # we have to implement crazy, outlandish checks like this.
-      #
-      # In the 2.0 series of Chef Zero, the DataStore did not prefix values.
-      # In the 2.1+ series, DataStore values are nested under
-      # +organizations/chef+, for some ridiciously reason.
-      #
-      # Oh, and for the record, there was no CHANGELOG entry or anything. They
-      # just decided it would be a good idea to change one of the main APIs in
-      # the system.
-      if ChefZero::VERSION.to_f == 2.0
-        get_without_prefix(*args)
-      else
-        get_with_prefix(*args)
-      end
-    end
-
-    # @see {get}
-    def get_without_prefix(*args)
-      if args.size == 1
-        @server.data_store.list(args)
-      else
-        @server.data_store.get(args)
-      end
-    end
-
-    # @see {get}
-    def get_with_prefix(*args)
-      args.unshift('organizations', 'chef')
-
-      if args.size == 3
-        @server.data_store.list(args)
-      else
-        @server.data_store.get(args)
-      end
-    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
-
-ChefSpec::Server.start!
-
-RSpec.configure do |config|
-  config.before(:each) { ChefSpec::Server.reset! }
-  config.after(:each)  { ChefSpec::Server.reset! }
-end
-
-at_exit { ChefSpec::Server.stop! }
+# @todo Remove in v5.0.0
+require_relative 'deprecations'
+deprecated "require 'chefspec/server' is no longer required and " \
+  "will be removed in the next major release."