chefspec 0.6.1 → 0.7.0

data/lib/chefspec.rb

@@ -1,14 +1,17 @@
 require 'chef'
-require 'rspec'
 require 'chefspec/chef_runner'
 require 'chefspec/version'
-require 'chefspec/matchers/execute'
-require 'chefspec/matchers/file'
-require 'chefspec/matchers/link'
-require 'chefspec/matchers/log'
-require 'chefspec/matchers/package'
-require 'chefspec/matchers/service'
-require 'chefspec/matchers/shared'
-require 'chefspec/matchers/file_content'
+if defined?(RSpec)
+  require 'chefspec/matchers/cron'
+  require 'chefspec/matchers/execute'
+  require 'chefspec/matchers/file'
+  require 'chefspec/matchers/link'
+  require 'chefspec/matchers/log'
+  require 'chefspec/matchers/package'
+  require 'chefspec/matchers/service'
+  require 'chefspec/matchers/shared'
+  require 'chefspec/matchers/file_content'
+end
+require 'chefspec/minitest'
 require 'chefspec/monkey_patches/hash'
 require 'chefspec/monkey_patches/provider'

data/lib/chefspec/chef_runner.rb

@@ -14,6 +14,7 @@ module ChefSpec
     @resources = []
 
     attr_accessor :resources
+    attr_reader :run_context
     attr_reader :node
 
     # Instantiate a new runner to run examples with.
@@ -85,11 +86,11 @@ module ChefSpec
 
       @resources = []
       if @client.respond_to?(:setup_run_context) # 0.10.x
-        run_context = @client.setup_run_context
+        @run_context = @client.setup_run_context
       else
-        run_context = Chef::RunContext.new(@client.node, Chef::CookbookCollection.new(Chef::CookbookLoader.new)) # 0.9.x
+        @run_context = Chef::RunContext.new(@client.node, Chef::CookbookCollection.new(Chef::CookbookLoader.new)) # 0.9.x
       end
-      runner = Chef::Runner.new(run_context)
+      runner = Chef::Runner.new(@run_context)
       runner.converge
       self
     end
@@ -134,6 +135,14 @@ module ChefSpec
       find_resource('link', target_file)
     end
 
+    # Find a crontab entry declared with the given name
+    #
+    # @param  [String] name of a crontab
+    # @return [Chef::Resource::Cron] The matching cron resource, or Nil
+    def cron(name)
+      find_resource('cron', name)
+    end
+
     # This runner as a string.
     #
     # @return [String] Currently includes the run_list. Format of the string may change between versions of this gem.
@@ -161,7 +170,7 @@ module ChefSpec
     #
     # @return [String] The path to the cookbooks directory
     def default_cookbook_path
-      Pathname.new(File.join(caller(2).first.split(':').slice(0..-3).first, "..", "..", "..")).cleanpath
+      Pathname.new(File.join(caller(2).first.split(':').slice(0..-3).join(':'), '..', '..', '..')).cleanpath
     end
 
     # Find the resource with the declared type and name

data/lib/chefspec/matchers/cron.rb

@@ -0,0 +1,7 @@
+require 'chefspec/matchers/shared'
+
+module ChefSpec
+  module Matchers
+    define_resource_matchers([:create, :delete], [:cron], :name)
+  end
+end

data/lib/chefspec/minitest.rb

@@ -0,0 +1,199 @@
+module ChefSpec
+  # Supports running minitest-chef-handler examples without a real converge.
+  #
+  # This is experimental and comes with the following caveats:
+  #
+  # * This support is intended only to run existing examples at present. This
+  #   means that it has not been tested with examples that explicitly create a
+  #   new ChefRunner.
+  # * Examples that shell out or access the file system using Ruby will fail.
+  #   This support only ensures that minitest-chef-handler matchers work.
+  # * Only a subset of minitest-chef-handler matchers are currently supported
+  #   , equivalent to the built-in RSpec matchers.
+  # * It is assumed that your spec class includes the `MiniTest::Chef` modules
+  #   directly. Add this include for ChefSpec mode:
+  #
+  #       include ChefSpec::MiniTest
+  module MiniTest
+
+    # minitest-chef-handler declares methods for each resource that use
+    # `load_current_resource` to fetch the current state of the node. We override
+    # these and instantiate fresh resources.
+    def self.override_minitest_resources(run_context, within_module)
+      ::Chef::Resource.constants.each do |resource|
+        if Chef::Resource.const_get(resource).respond_to?(:ancestors) and
+          Chef::Resource.const_get(resource).ancestors.include? Chef::Resource
+            method_name = Chef::Mixin::ConvertToClassName.
+              convert_to_snake_case(resource.to_s).to_sym
+            within_module.send(:define_method, method_name) do |name|
+              Chef::Resource.const_get(resource).new(name).tap do |r|
+                r.run_context = run_context
+              end
+            end
+        end
+      end
+    end
+
+    # minitest-chef-handler patches `Chef::Resource` to handle file uid and gid
+    # conversion. In our instance these values are not populated by the
+    # provider and will instead be whatever was specified against the resource
+    # so we remove this conversion.
+    def self.remove_file_id_conversion
+      ::Chef::Resource.class_eval do
+        def resource_value(attribute)
+          send(attribute)
+        end
+      end
+    end
+
+    def self.override_minitest_assertions(chef_run)
+
+      remove_file_id_conversion
+
+      ::MiniTest::Chef::Assertions.class_eval do
+
+        def assert_includes_content(file, content)
+          assert file_includes_content?(file, content),
+            "Expected file '#{file.path}' to include the specified content"
+          file
+        end
+
+        def refute_includes_content(file, content)
+          refute file_includes_content?(file, content),
+            "Expected file '#{file.path}' not to include the specified content"
+          file
+        end
+
+        def assert_path_exists(file_or_dir)
+          paths = file_resources + resources_by_type(:directory)
+          actual_resource = paths.find{|file| file_or_dir.path == file.path and
+            ! Array(file.action).include?(:delete)}
+          assert actual_resource, "Expected path '#{file_or_dir.path}' to exist"
+          actual_resource
+        end
+
+        def refute_path_exists(file_or_dir)
+          paths = file_resources + resources_by_type(:directory)
+          actual_resource = paths.find{|file| file_or_dir.path == file.path and
+            Array(file.action).include?(:delete)}
+          assert actual_resource, "Expected path '#{file_or_dir.path}' not to exist"
+          actual_resource
+        end
+
+        private
+
+        def same_resource_type?(expected_resource, actual_resource)
+          case actual_resource.resource_name.to_s
+            when /file$/
+              expected_resource.resource_name == :file
+            else
+              expected_resource.resource_name == actual_resource.resource_name
+            end
+        end
+
+        def find_resource(expected_resource, field)
+          resources.find do |actual_resource|
+            same_resource_type?(expected_resource, actual_resource) and
+              expected_resource.send(field) == actual_resource.send(field)
+          end
+        end
+
+        def self.override_assertion(assert_name, field, wont_actions = [])
+          [:assert, :refute].each do |prefix|
+            define_method("#{prefix}_#{assert_name}") do |expected_resource|
+              actual_resource = find_resource(expected_resource, field)
+              is_wont = false
+              if actual_resource
+                is_wont = ! (Array(actual_resource.action) & wont_actions).empty?
+              end
+              # If we are refuting then the assertion is actually positive,
+              # we are for example asserting that the package has the `:remove`
+              # action.
+              if prefix == :assert || is_wont
+                assert actual_resource
+              else
+                refute actual_resource
+              end
+              actual_resource
+            end
+          end
+        end
+
+        override_assertion :installed, :package_name, [:remove, :purge]
+        override_assertion :enabled, :enabled, [:disable]
+        override_assertion :running, :running, [:stop]
+
+        def file_resources
+          resources.select{|r| r.resource_name.to_s.end_with?('file')} +
+            resources.select{|r| r.resource_name == :template}
+        end
+
+        def resources_by_type(type)
+          resources.select{|r| r.resource_name == type}
+        end
+
+        def cookbook_file_content(file_resource)
+          file = cookbook_files(file_resource.cookbook_name).find do |f|
+            Pathname.new(f).basename.to_s == file_resource.path
+          end
+          File.read(file)
+        end
+
+        def cookbook_files(cookbook)
+          run_context.cookbook_collection[cookbook].file_filenames
+        end
+
+        def file_includes_content?(file, content)
+          file_resources.any? do |f|
+            f.path == file.path &&
+              case f.resource_name
+                when :cookbook_file
+                  cookbook_file_content(f)
+                when :file
+                  f.content
+                when :template
+                  render(f, node)
+                else raise NotImplementedError,
+                  ":#{f.resource_name} not supported for comparison"
+              end.include?(content)
+          end
+        end
+
+      end
+    end
+
+    def self.share_object(spec_mod, name, obj)
+      spec_mod.send(:define_method, name) do
+        obj
+      end
+    end
+
+    def self.included(other_mod)
+      self.support_fake_converge(other_mod) if spec_module?(other_mod)
+    end
+
+    def self.support_fake_converge(spec_mod)
+      chef_run = ChefSpec::ChefRunner.new(
+        :cookbook_path => default_cookbook_path).converge recipe_for_module(spec_mod)
+      override_minitest_resources(chef_run.run_context, spec_mod)
+      override_minitest_assertions(chef_run)
+      share_object(spec_mod, :node, chef_run.node)
+      share_object(spec_mod, :resources, chef_run.resources)
+      share_object(spec_mod, :run_context, chef_run.run_context)
+    end
+
+    def self.recipe_for_module(mod)
+      mod.to_s.split('::')[-2..-1].join('::')
+    end
+
+    def self.spec_module?(mod)
+      # minitest-chef-handler module names are of the form:
+      # `recipe::example::default`
+      recipe_for_module(mod) == recipe_for_module(mod).downcase
+    end
+
+    def self.default_cookbook_path
+      Pathname.new(File.join(caller(3).first.split(':').slice(0..-3).first, "..", "..", "..")).cleanpath
+    end
+  end
+end

data/lib/chefspec/version.rb

@@ -1,4 +1,4 @@
 module ChefSpec
   # The gem version
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,79 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: chefspec
-version: !ruby/object:Gem::Version 
-  hash: 5
+version: !ruby/object:Gem::Version
+  version: 0.7.0
   prerelease: 
-  segments: 
-  - 0
-  - 6
-  - 1
-  version: 0.6.1
 platform: ruby
-authors: 
+authors:
 - Andrew Crump
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-06-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+date: 2012-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 0
-        - 9
-        - 12
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.9.12
-  requirement: *id001
   type: :runtime
   prerelease: false
-  name: chef
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  requirement: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
   prerelease: false
-  name: erubis
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-chef-handler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 2
-        - 10
-        - 0
-        version: 2.10.0
-  requirement: *id003
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 description: Write RSpec examples for Opscode Chef recipes
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/chef/knife/cookbook_create_specs.rb
 - lib/chefspec/chef_runner.rb
+- lib/chefspec/matchers/cron.rb
 - lib/chefspec/matchers/execute.rb
 - lib/chefspec/matchers/file.rb
 - lib/chefspec/matchers/file_content.rb
@@ -82,43 +92,41 @@ files:
 - lib/chefspec/matchers/package.rb
 - lib/chefspec/matchers/service.rb
 - lib/chefspec/matchers/shared.rb
+- lib/chefspec/minitest.rb
 - lib/chefspec/monkey_patches/hash.rb
 - lib/chefspec/monkey_patches/provider.rb
 - lib/chefspec/version.rb
 - lib/chefspec.rb
 homepage: http://acrmp.github.com/chefspec
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -516424648685498603
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -516424648685498603
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: chefspec-0.6.1
+summary: chefspec-0.7.0
 test_files: []
-
 has_rdoc: