cheffish 1.4.1 → 1.4.2

data/lib/cheffish/rspec/matchers/be_idempotent.rb

@@ -1,16 +1,16 @@
-require 'rspec/matchers'
-
-RSpec::Matchers.define :be_idempotent do
-  match do |recipe|
-    @recipe = recipe
-    recipe.reset
-    recipe.converge
-    recipe.up_to_date?
-  end
-
-  failure_message {
-    "#{@recipe} is not idempotent!  Converging it a second time caused updates.\n#{@recipe.output_for_failure_message}"
-  }
-
-  supports_block_expectations
-end
+require 'rspec/matchers'
+
+RSpec::Matchers.define :be_idempotent do
+  match do |recipe|
+    @recipe = recipe
+    recipe.reset
+    recipe.converge
+    recipe.up_to_date?
+  end
+
+  failure_message {
+    "#{@recipe} is not idempotent!  Converging it a second time caused updates.\n#{@recipe.output_for_failure_message}"
+  }
+
+  supports_block_expectations
+end

data/lib/cheffish/rspec/matchers/emit_no_warnings_or_errors.rb

@@ -1,15 +1,15 @@
-require 'rspec/matchers'
-
-RSpec::Matchers.define :emit_no_warnings_or_errors do
-  match do |recipe|
-    @recipe = recipe
-    @warn_err = recipe.logs.lines.select { |l| l =~ /warn|err/i }.join("\n")
-    @warn_err.empty?
-  end
-
-  failure_message {
-    "#{@recipe} emitted warnings and errors!\n#{@warn_err}"
-  }
-
-  supports_block_expectations
-end
+require 'rspec/matchers'
+
+RSpec::Matchers.define :emit_no_warnings_or_errors do
+  match do |recipe|
+    @recipe = recipe
+    @warn_err = recipe.logs.lines.select { |l| l =~ /warn|err/i }.join("\n")
+    @warn_err.empty?
+  end
+
+  failure_message {
+    "#{@recipe} emitted warnings and errors!\n#{@warn_err}"
+  }
+
+  supports_block_expectations
+end

data/lib/cheffish/rspec/matchers/have_updated.rb

@@ -1,37 +1,37 @@
-require 'rspec/matchers'
-
-RSpec::Matchers.define :have_updated do |resource_name, *expected_actions|
-  match do |recipe|
-    @recipe = recipe
-    actual = @recipe.event_sink.events
-    actual_actions = actual.select { |event, resource, action| event == :resource_updated && resource.to_s == resource_name }.
-                               map { |event, resource, action| action }
-    expect(actual_actions).to eq(expected_actions)
-  end
-
-  failure_message do
-    actual = @recipe.event_sink.events
-    updates = actual.select { |event, resource, action| event == :resource_updated }.to_a
-    result = "expected that the chef_run would #{expected_actions.join(',')} #{resource_name}."
-    if updates.size > 0
-      result << " Actual updates were #{updates.map { |event, resource, action| "#{resource.to_s} => #{action.inspect}" }.join(', ')}"
-    else
-      result << " Nothing was updated."
-    end
-    result
-  end
-
-  failure_message_when_negated do
-    actual = @recipe.event_sink.events
-    updates = actual.select { |event, resource, action| event == :resource_updated }.to_a
-    result = "expected that the chef_run would not #{expected_actions.join(',')} #{resource_name}."
-    if updates.size > 0
-      result << " Actual updates were #{updates.map { |event, resource, action| "#{resource.to_s} => #{action.inspect}" }.join(', ')}"
-    else
-      result << " Nothing was updated."
-    end
-    result
-  end
-end
-
-RSpec::Matchers.define_negated_matcher :not_have_updated, :have_updated
+require 'rspec/matchers'
+
+RSpec::Matchers.define :have_updated do |resource_name, *expected_actions|
+  match do |recipe|
+    @recipe = recipe
+    actual = @recipe.event_sink.events
+    actual_actions = actual.select { |event, resource, action| event == :resource_updated && resource.to_s == resource_name }.
+                               map { |event, resource, action| action }
+    expect(actual_actions).to eq(expected_actions)
+  end
+
+  failure_message do
+    actual = @recipe.event_sink.events
+    updates = actual.select { |event, resource, action| event == :resource_updated }.to_a
+    result = "expected that the chef_run would #{expected_actions.join(',')} #{resource_name}."
+    if updates.size > 0
+      result << " Actual updates were #{updates.map { |event, resource, action| "#{resource.to_s} => #{action.inspect}" }.join(', ')}"
+    else
+      result << " Nothing was updated."
+    end
+    result
+  end
+
+  failure_message_when_negated do
+    actual = @recipe.event_sink.events
+    updates = actual.select { |event, resource, action| event == :resource_updated }.to_a
+    result = "expected that the chef_run would not #{expected_actions.join(',')} #{resource_name}."
+    if updates.size > 0
+      result << " Actual updates were #{updates.map { |event, resource, action| "#{resource.to_s} => #{action.inspect}" }.join(', ')}"
+    else
+      result << " Nothing was updated."
+    end
+    result
+  end
+end
+
+RSpec::Matchers.define_negated_matcher :not_have_updated, :have_updated

data/lib/cheffish/rspec/matchers/partially_match.rb

@@ -1,63 +1,63 @@
-module Cheffish
-  module RSpec
-    module Matchers
-      class PartiallyMatch
-        include ::RSpec::Matchers::Composable
-
-        def initialize(example, expected)
-          @example = example
-          @expected = expected
-        end
-
-        def matches?(actual)
-          @actual = actual
-          partially_matches_values(@expected, actual)
-        end
-
-        def failure_message
-          "expected #{@actual} to match #{@expected}"
-        end
-
-        def failure_message_when_negated
-          "expected #{@actual} not to match #{@expected}"
-        end
-
-        protected
-
-        def partially_matches_values(expected, actual)
-          if Hash === actual
-            return partially_matches_hashes(expected, actual) if Hash === expected || Array === expected
-          elsif Array === expected && Enumerable === actual && !(Struct === actual)
-            return partially_matches_arrays(expected, actual)
-          end
-
-          return true if actual == expected
-
-          begin
-            expected === actual
-          rescue ArgumentError
-            # Some objects, like 0-arg lambdas on 1.9+, raise
-            # ArgumentError for `expected === actual`.
-            false
-          end
-        end
-
-        def partially_matches_hashes(expected, actual)
-          expected.all? { |key, value| partially_matches_values(value, actual[key]) }
-        end
-
-        def partially_matches_arrays(expected, actual)
-          expected.all? { |e| actual.any? { |a| partially_matches_values(e, a) } }
-        end
-      end
-    end
-  end
-end
-
-module RSpec
-  module Matchers
-    def partially_match(expected)
-      Cheffish::RSpec::Matchers::PartiallyMatch.new(self, expected)
-    end
-  end
-end
+module Cheffish
+  module RSpec
+    module Matchers
+      class PartiallyMatch
+        include ::RSpec::Matchers::Composable
+
+        def initialize(example, expected)
+          @example = example
+          @expected = expected
+        end
+
+        def matches?(actual)
+          @actual = actual
+          partially_matches_values(@expected, actual)
+        end
+
+        def failure_message
+          "expected #{@actual} to match #{@expected}"
+        end
+
+        def failure_message_when_negated
+          "expected #{@actual} not to match #{@expected}"
+        end
+
+        protected
+
+        def partially_matches_values(expected, actual)
+          if Hash === actual
+            return partially_matches_hashes(expected, actual) if Hash === expected || Array === expected
+          elsif Array === expected && Enumerable === actual && !(Struct === actual)
+            return partially_matches_arrays(expected, actual)
+          end
+
+          return true if actual == expected
+
+          begin
+            expected === actual
+          rescue ArgumentError
+            # Some objects, like 0-arg lambdas on 1.9+, raise
+            # ArgumentError for `expected === actual`.
+            false
+          end
+        end
+
+        def partially_matches_hashes(expected, actual)
+          expected.all? { |key, value| partially_matches_values(value, actual[key]) }
+        end
+
+        def partially_matches_arrays(expected, actual)
+          expected.all? { |e| actual.any? { |a| partially_matches_values(e, a) } }
+        end
+      end
+    end
+  end
+end
+
+module RSpec
+  module Matchers
+    def partially_match(expected)
+      Cheffish::RSpec::Matchers::PartiallyMatch.new(self, expected)
+    end
+  end
+end

data/lib/cheffish/rspec/matchers.rb

@@ -1,4 +1,4 @@
-require 'cheffish/rspec/matchers/have_updated'
-require 'cheffish/rspec/matchers/be_idempotent'
-require 'cheffish/rspec/matchers/partially_match'
-require 'cheffish/rspec/matchers/emit_no_warnings_or_errors'
+require 'cheffish/rspec/matchers/have_updated'
+require 'cheffish/rspec/matchers/be_idempotent'
+require 'cheffish/rspec/matchers/partially_match'
+require 'cheffish/rspec/matchers/emit_no_warnings_or_errors'

data/lib/cheffish/rspec/recipe_run_wrapper.rb

@@ -1,59 +1,78 @@
-require 'cheffish/chef_run'
-
-module Cheffish
-  module RSpec
-    class RecipeRunWrapper < ChefRun
-      def initialize(chef_config, example: nil, &recipe)
-        super(chef_config)
-        @recipe = recipe
-        @example = example || recipe.binding.eval('self')
-      end
-
-      attr_reader :recipe
-      attr_reader :example
-
-      def client
-        if !@client
-          super
-          example = self.example
-
-          # Call into the rspec example's let variables and other methods
-          @client.define_singleton_method(:method_missing) do |name, *args, &block|
-            # the elimination of a bunch of metaprogramming in 12.4 changed how Chef DSL is defined in code,
-            # requiring a slight contortion for earlier versions.
-            if Gem::Version.new(Chef::VERSION) >= Gem::Version.new('12.4')    # incompatibility introduced at 2b364df
-              if example.respond_to?(name)
-                example.public_send(name, *args, &block)
-              end
-            else
-              begin
-                super(name, *args, &block)
-              rescue NameError
-                if example.respond_to?(name)
-                  example.public_send(name, *args, &block)
-                else
-                  raise
-                end
-              end
-            end
-          end
-          # This is called by respond_to?, and is required to make sure the
-          # resource knows that we will in fact call the given method.
-          @client.define_singleton_method(:respond_to_missing?) do |name, include_private = false|
-            example.respond_to?(name) || super(name, include_private)
-          end
-          # Respond true to is_a?(Chef::Provider) so that Chef::Recipe::DSL.build_resource
-          # will hook resources up to the example let variables as well (via
-          # enclosing_provider).
-          # Please don't hurt me
-          @client.define_singleton_method(:is_a?) do |klass|
-            klass == Chef::Provider || super(klass)
-          end
-
-          @client.load_block(&recipe)
-        end
-        @client
-      end
-    end
-  end
-end
+require 'cheffish/chef_run'
+require 'forwardable'
+
+module Cheffish
+  module RSpec
+    class RecipeRunWrapper < ChefRun
+      def initialize(chef_config, example: nil, &recipe)
+        super(chef_config)
+        @recipe = recipe
+        @example = example || recipe.binding.eval('self')
+      end
+
+      attr_reader :recipe
+      attr_reader :example
+
+      def client
+        if !@client
+          super
+          example = self.example
+
+          #
+          # Support for both resources and rspec example's let variables:
+          #
+          # In 12.4, the elimination of a bunch of metaprogramming in 12.4
+          # changed how Chef DSL is defined in code: resource methods are now
+          # explicitly defined in `Chef::DSL::Recipe`. In 12.3, no actual
+          # methods were defined and `respond_to?(:file)` would return false.
+          # If we reach `method_missing` here, it means that we either have a
+          # 12.3-ish resource or we want to call a `let` variable.
+          #
+          @client.instance_eval { @rspec_example = example }
+          def @client.method_missing(name, *args, &block)
+            # If there is a let variable, call it. This is because in 12.4,
+            # the parent class is going to call respond_to?(name) to find out
+            # if someone was doing weird things, and then call send(). This
+            # would result in an infinite loop, coming right. Back. Here.
+            # A fix to chef is incoming, but we still need this if we want to
+            # work with Chef 12.4.
+            if Gem::Version.new(Chef::VERSION) >= Gem::Version.new('12.4')
+              if @rspec_example.respond_to?(name)
+                return @rspec_example.public_send(name, *args, &block)
+              end
+            end
+
+            # In 12.3 or below, method_missing was the only way to call
+            # resources. If we are in 12.4, we still need to call the crazy
+            # method_missing metaprogramming because backcompat.
+            begin
+              super
+            rescue NameError
+              if @rspec_example.respond_to?(name)
+                @rspec_example.public_send(name, *args, &block)
+              else
+                raise
+              end
+            end
+          end
+          # This is called by respond_to?, and is required to make sure the
+          # resource knows that we will in fact call the given method.
+          def @client.respond_to_missing?(name, include_private = false)
+            @rspec_example.respond_to?(name, include_private) || super
+          end
+
+          # Respond true to is_a?(Chef::Provider) so that Chef::Recipe::DSL.build_resource
+          # will hook resources up to the example let variables as well (via
+          # enclosing_provider).
+          # Please don't hurt me
+          def @client.is_a?(klass)
+            klass == Chef::Provider || super(klass)
+          end
+
+          @client.load_block(&recipe)
+        end
+        @client
+      end
+    end
+  end
+end

data/lib/cheffish/rspec/repository_support.rb

@@ -1,108 +1,108 @@
-module Cheffish
-  module RSpec
-    module RepositorySupport
-      def when_the_repository(desc, *tags, &block)
-        context("when the chef repo #{desc}", *tags) do
-          include_context "with a chef repo"
-          extend WhenTheRepositoryClassMethods
-          module_eval(&block)
-        end
-      end
-
-      ::RSpec.shared_context "with a chef repo" do
-        before :each do
-          raise "Can only create one directory per test" if @repository_dir
-          @repository_dir = Dir.mktmpdir('chef_repo')
-          Chef::Config.chef_repo_path = @repository_dir
-          %w(client cookbook data_bag environment node role user).each do |object_name|
-            Chef::Config.delete("#{object_name}_path".to_sym)
-          end
-        end
-
-        after :each do
-          if @repository_dir
-            begin
-              %w(client cookbook data_bag environment node role user).each do |object_name|
-                Chef::Config.delete("#{object_name}_path".to_sym)
-              end
-              Chef::Config.delete(:chef_repo_path)
-              FileUtils.remove_entry_secure(@repository_dir)
-            ensure
-              @repository_dir = nil
-            end
-          end
-          Dir.chdir(@old_cwd) if @old_cwd
-        end
-
-        def directory(relative_path, &block)
-          old_parent_path = @parent_path
-          @parent_path = path_to(relative_path)
-          FileUtils.mkdir_p(@parent_path)
-          instance_eval(&block) if block
-          @parent_path = old_parent_path
-        end
-
-        def file(relative_path, contents)
-          filename = path_to(relative_path)
-          dir = File.dirname(filename)
-          FileUtils.mkdir_p(dir) unless dir == '.'
-          File.open(filename, 'w') do |file|
-            raw = case contents
-                  when Hash
-                    JSON.pretty_generate(contents)
-                  when Array
-                    contents.join("\n")
-                  else
-                    contents
-                  end
-            file.write(raw)
-          end
-        end
-
-        def symlink(relative_path, relative_dest)
-          filename = path_to(relative_path)
-          dir = File.dirname(filename)
-          FileUtils.mkdir_p(dir) unless dir == '.'
-          dest_filename = path_to(relative_dest)
-          File.symlink(dest_filename, filename)
-        end
-
-        def path_to(relative_path)
-          File.expand_path(relative_path, (@parent_path || @repository_dir))
-        end
-
-        def cwd(relative_path)
-          @old_cwd = Dir.pwd
-          Dir.chdir(path_to(relative_path))
-        end
-
-        module WhenTheRepositoryClassMethods
-          def directory(*args, &block)
-            before :each do
-              directory(*args, &block)
-            end
-          end
-
-          def file(*args, &block)
-            before :each do
-              file(*args, &block)
-            end
-          end
-
-          def symlink(*args, &block)
-            before :each do
-              symlink(*args, &block)
-            end
-          end
-
-          def path_to(*args, &block)
-            before :each do
-              file(*args, &block)
-            end
-          end
-        end
-      end
-    end
-
-  end
-end
+module Cheffish
+  module RSpec
+    module RepositorySupport
+      def when_the_repository(desc, *tags, &block)
+        context("when the chef repo #{desc}", *tags) do
+          include_context "with a chef repo"
+          extend WhenTheRepositoryClassMethods
+          module_eval(&block)
+        end
+      end
+
+      ::RSpec.shared_context "with a chef repo" do
+        before :each do
+          raise "Can only create one directory per test" if @repository_dir
+          @repository_dir = Dir.mktmpdir('chef_repo')
+          Chef::Config.chef_repo_path = @repository_dir
+          %w(client cookbook data_bag environment node role user).each do |object_name|
+            Chef::Config.delete("#{object_name}_path".to_sym)
+          end
+        end
+
+        after :each do
+          if @repository_dir
+            begin
+              %w(client cookbook data_bag environment node role user).each do |object_name|
+                Chef::Config.delete("#{object_name}_path".to_sym)
+              end
+              Chef::Config.delete(:chef_repo_path)
+              FileUtils.remove_entry_secure(@repository_dir)
+            ensure
+              @repository_dir = nil
+            end
+          end
+          Dir.chdir(@old_cwd) if @old_cwd
+        end
+
+        def directory(relative_path, &block)
+          old_parent_path = @parent_path
+          @parent_path = path_to(relative_path)
+          FileUtils.mkdir_p(@parent_path)
+          instance_eval(&block) if block
+          @parent_path = old_parent_path
+        end
+
+        def file(relative_path, contents)
+          filename = path_to(relative_path)
+          dir = File.dirname(filename)
+          FileUtils.mkdir_p(dir) unless dir == '.'
+          File.open(filename, 'w') do |file|
+            raw = case contents
+                  when Hash
+                    JSON.pretty_generate(contents)
+                  when Array
+                    contents.join("\n")
+                  else
+                    contents
+                  end
+            file.write(raw)
+          end
+        end
+
+        def symlink(relative_path, relative_dest)
+          filename = path_to(relative_path)
+          dir = File.dirname(filename)
+          FileUtils.mkdir_p(dir) unless dir == '.'
+          dest_filename = path_to(relative_dest)
+          File.symlink(dest_filename, filename)
+        end
+
+        def path_to(relative_path)
+          File.expand_path(relative_path, (@parent_path || @repository_dir))
+        end
+
+        def cwd(relative_path)
+          @old_cwd = Dir.pwd
+          Dir.chdir(path_to(relative_path))
+        end
+
+        module WhenTheRepositoryClassMethods
+          def directory(*args, &block)
+            before :each do
+              directory(*args, &block)
+            end
+          end
+
+          def file(*args, &block)
+            before :each do
+              file(*args, &block)
+            end
+          end
+
+          def symlink(*args, &block)
+            before :each do
+              symlink(*args, &block)
+            end
+          end
+
+          def path_to(*args, &block)
+            before :each do
+              file(*args, &block)
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/cheffish/rspec.rb

@@ -1,8 +1,8 @@
-require 'cheffish/rspec/chef_run_support'
-require 'cheffish/rspec/repository_support'
-require 'cheffish/rspec/matchers'
-
-module Cheffish
-  module RSpec
-  end
-end
+require 'cheffish/rspec/chef_run_support'
+require 'cheffish/rspec/repository_support'
+require 'cheffish/rspec/matchers'
+
+module Cheffish
+  module RSpec
+  end
+end