rspec-puppet 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9af746954c13b2c0fa5039fa066faef84c28e846
-  data.tar.gz: 3616d46484994eabad338decfdb9c0b8b83cf48f
+  metadata.gz: ddac12d8bb2638b92b4d2f009511b2d5bc144305
+  data.tar.gz: 2196abf53f49f3ece60c2c615fdf00214a768948
 SHA512:
-  metadata.gz: d86702faa57cca90162ed80d8a39bc2b5bc57452b7daa6defa507c1cd51bddd8e7a44e1a1bebb718997efdb3e1059625c3d14580762d611be6fe42a3680826e2
-  data.tar.gz: 530a52d04ef1465361c34b5970d0b0da3f99742e0bd4867f9fd8ffbb7aa8d0fc4c124c890f0a384c003231c52ffaa17c17ac583aa684ea051a236571041cb73b
+  metadata.gz: 4449c6a9b781f5e8df545de27102e00c1034f7db550559b4b4fcf0aee75845de6e635f0ff87f658f713da7e1702054d69f257a941ace132011f6bd8732d11b47
+  data.tar.gz: 23bbc5facc62afbbf4f9b6c34d8ba9fe7260977790e07472bd7d338f1c3bdf282cea2b79d19a4555082b6df3c79240ac7051fc074d3ff0ede6cccfa257afd2e2

data/README.md

@@ -1,4 +1,4 @@
-# RSpec tests for your Puppet manifests & modules
+# RSpec tests for your Puppet manifests & modules [![Build Status](https://travis-ci.org/rodjek/rspec-puppet.png)](https://travis-ci.org/rodjek/rspec-puppet)
 
 ## Installation
 
@@ -172,6 +172,46 @@ least one class, the class under test. The same holds for defined types, the
 catalogue generated when testing a defined type will have at least one resource
 (the defined type itself).
 
+#### Relationship matchers
+
+The following methods will allow you to test the relationships between the resources in your catalogue, regardless of how the relationship is defined. This means that it doesn’t matter if you prefer to define your relationships with the metaparameters (**require**, **before**, **notify** and **subscribe**) or the chaining arrows (**->**, **~>**, **<-** and **<~**), they’re all tested the same.
+
+```ruby
+it { should contain_file('foo').that_requires('File[bar]') }
+it { should contain_file('foo').that_comes_before('File[bar]') }
+it { should contain_file('foo').that_notifies('File[bar]') }
+it { should contain_file('foo').that_subscribes_to('File[bar]') }
+```
+
+An array can be used to test a resource for multiple relationships
+
+```ruby
+it { should contain_file('foo').that_requires(['File[bar]', 'File[baz]']) }
+it { should contain_file('foo').that_comes_before(['File[bar]','File[baz]']) }
+it { should contain_file('foo').that_notifies(['File[bar]', 'File[baz]']) }
+it { should contain_file('foo').that_subscribes_to(['File[bar]', 'File[baz]']) }
+```
+
+You can also test the reverse direction of the relationship, so if you have the following bit of Puppet code
+
+```ruby
+notify { 'foo': }
+notify { 'bar':
+  before => Notify['foo'],
+}
+```
+
+You can test that **Notify[bar]** comes before **Notify[foo]**
+
+```ruby
+it { should contain_notify('bar').that_comes_before('Notify[foo]') }
+```
+Or, you can test that **Notify[foo]** requires **Notify[bar]**
+
+```ruby
+it { should contain_notify('foo').that_requires('Notify[bar]') }
+```
+
 ### Writing tests
 
 #### Basic test structure
@@ -352,3 +392,69 @@ it 'something' do
   expect { subject.call(['a']) }.should_not raise_error(Puppet::ParseError)
 end
 ```
+
+## Hiera integration
+
+### Configuration
+
+Set the hiera config symbol properly in your spec files:
+
+```ruby
+let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
+hiera = Hiera.new(:config => 'spec/fixtures/hiera/hiera.yaml')
+```
+
+Create your spec hiera files
+
+spec/fixtures/hiera/hiera.yaml
+```ruby
+---
+:backends:
+  - yaml
+:hierarchy:
+  - test
+:yaml:
+  :datadir: 'spec/fixtures/hiera'
+```
+
+spec/fixtures/hiera/test.yaml
+```ruby
+---
+ntpserver: ['ntp1.domain.com','ntpXX.domain.com']
+user:
+  oneuser:
+    shell: '/bin/bash'
+  twouser:
+    shell: '/sbin/nologin'
+```
+
+### Use hiera in your tests
+
+```ruby
+  ntpserver = hiera.lookup('ntpserver', nil, nil)
+  let(:params) { :ntpserver => ntpserver }
+```
+
+### Enabling hiera lookups
+If you just want to fetch values from hiera (e.g. because
+you're testing code that uses explicit hiera lookups) just specify
+the path to the hiera config in your `spec_helper.rb`
+
+```ruby
+RSpec.configure do |c|
+  c.hiera_config = 'spec/fixtures/hiera/hiera.yaml'
+end
+```
+
+## Producing coverage reports
+
+You can output a basic resource coverage report with the following in
+you spec file.
+
+```ruby
+at_exit { RSpec::Puppet::Coverage.report! }
+```
+
+This checks which Puppet resources have been explicitly checked as part
+of the current test run and outputs both a coverage percentage and a
+list of untouched resources.

data/lib/rspec-puppet.rb

@@ -6,6 +6,7 @@ require 'rspec-puppet/errors'
 require 'rspec-puppet/matchers'
 require 'rspec-puppet/example'
 require 'rspec-puppet/setup'
+require 'rspec-puppet/coverage'
 
 begin
   require 'puppet/test/test_helper'
@@ -21,6 +22,7 @@ RSpec.configure do |c|
   c.add_setting :confdir, :default => '/etc/puppet'
   c.add_setting :default_facts, :default => {}
   c.add_setting :hiera_config, :default => '/dev/null'
+  c.add_setting :parser, :default => 'current'
 
   if defined?(Puppet::Test::TestHelper)
     begin

data/lib/rspec-puppet/coverage.rb

@@ -0,0 +1,107 @@
+module RSpec::Puppet
+  class Coverage
+
+    attr_accessor :filters
+
+    class << self
+      extend Forwardable
+      def_delegators :instance, :add, :cover!, :report!, :filters
+    end
+
+    include Singleton
+
+    def initialize
+      @collection = {}
+      @filters = ['Stage[main]', 'Class[Settings]', 'Class[main]']
+    end
+
+    def add(resource)
+      if !exists?(resource) && !filtered?(resource)
+        @collection[resource.to_s] = ResourceWrapper.new(resource)
+      end
+    end
+
+    def filtered?(resource)
+      filters.include?(resource.to_s)
+    end
+
+    def cover!(resource)
+      if !filtered?(resource) && (wrapper = find(resource))
+        wrapper.touch!
+      end
+    end
+
+    def report!
+      report = {}
+
+      report[:total] = @collection.size
+      report[:touched] = @collection.count { |_, resource| resource.touched? }
+      report[:untouched] = report[:total] - report[:touched]
+      report[:coverage] = sprintf("%5.2f", ((report[:touched].to_f/report[:total].to_f)*100))
+
+      report[:detailed] = Hash[*@collection.map do |name, wrapper|
+        [name, wrapper.to_hash]
+      end.flatten]
+
+      puts <<-EOH.gsub(/^ {8}/, '')
+
+        Total resources:   #{report[:total]}
+        Touched resources: #{report[:touched]}
+        Resource coverage: #{report[:coverage]}%
+      EOH
+
+      if report[:coverage] != "100.00"
+        puts <<-EOH.gsub(/^ {10}/, '')
+          Untouched resources:
+
+          #{
+            untouched_resources = report[:detailed].reject do |_,rsrc|
+              rsrc["touched"]
+            end
+            untouched_resources.inject([]) do |memo, (name,_)|
+              memo << "  #{name}"
+            end.sort.join("\n")
+          }
+        EOH
+      end
+
+    end
+
+    private
+
+      def find(resource)
+        @collection[resource.to_s]
+      end
+
+      def exists?(resource)
+        !find(resource).nil?
+      end
+
+      class ResourceWrapper
+        attr_reader :resource
+
+        def initialize(resource = nil)
+          @resource = resource
+        end
+
+        def to_s
+          @resource.to_s
+        end
+
+        def to_hash
+          {
+            'touched' => touched?,
+          }
+        end
+
+        def touch!
+          @touched = true
+        end
+
+        def touched?
+          !!@touched
+        end
+      end
+
+  end
+end

data/lib/rspec-puppet/errors.rb

@@ -5,16 +5,16 @@ module RSpec::Puppet
 
       def initialize(param, expected, actual, negative)
         @param = param
-        @expected = expected.inspect
-        @actual = actual.inspect
+        @expected = expected
+        @actual = actual
         @negative = negative
       end
 
       def message
         if negative == true
-          "#{param} not set to #{expected} but it is set to #{actual}"
+          "#{param} not set to #{expected.inspect} but it is set to #{actual.inspect}"
         else
-          "#{param} set to #{expected} but it is set to #{actual}"
+          "#{param} set to #{expected.inspect} but it is set to #{actual.inspect}"
         end
       end
 
@@ -26,9 +26,9 @@ module RSpec::Puppet
     class RegexpMatchError < MatchError
       def message
         if negative == true
-          "#{param} not matching #{expected} but its value of #{actual} does"
+          "#{param} not matching #{expected.inspect} but its value of #{actual.inspect} does"
         else
-          "#{param} matching #{expected} but its value of #{actual} does not"
+          "#{param} matching #{expected.inspect} but its value of #{actual.inspect} does not"
         end
       end
     end
@@ -36,9 +36,9 @@ module RSpec::Puppet
     class ProcMatchError < MatchError
       def message
         if negative == true
-          "#{param} passed to the block would not return `#{expected}` but it did"
+          "#{param} passed to the block would not return `#{expected.inspect}` but it did"
         else
-          "#{param} passed to the block would return `#{expected}` but it is `#{actual}`"
+          "#{param} passed to the block would return `#{expected.inspect}` but it is `#{actual.inspect}`"
         end
       end
     end
@@ -58,25 +58,25 @@ module RSpec::Puppet
 
     class BeforeRelationshipError < RelationshipError
       def message
-        "#{from} to come before #{to} in the graph"
+        "that comes before #{to}"
       end
     end
 
     class RequireRelationshipError < RelationshipError
       def message
-        "#{from} to require #{to} in the graph"
+        "that requires #{to}"
       end
     end
 
     class NotifyRelationshipError < RelationshipError
       def message
-        "#{from} to notify #{to}"
+        "that notifies #{to}"
       end
     end
 
     class SubscribeRelationshipError < RelationshipError
       def message
-        "#{from} to be subscribed to #{to}"
+        "that is subscribed to #{to}"
       end
     end
   end

data/lib/rspec-puppet/example.rb

@@ -9,19 +9,23 @@ RSpec::configure do |c|
     Regexp.compile(parts.join('[\\\/]'))
   end
 
-  c.include RSpec::Puppet::DefineExampleGroup, :type => :define, :example_group => {
-    :file_path => c.escaped_path(%w[spec defines])
-  }
-
-  c.include RSpec::Puppet::ClassExampleGroup, :type => :class, :example_group => {
-    :file_path => c.escaped_path(%w[spec classes])
-  }
-
-  c.include RSpec::Puppet::FunctionExampleGroup, :type => :puppet_function, :example_group => {
-    :file_path => c.escaped_path(%w[spec functions])
-  }
-
-  c.include RSpec::Puppet::HostExampleGroup, :type => :host, :example_group => {
-    :file_path => c.escaped_path(%w[spec hosts])
-  }
+  if RSpec::Version::STRING < '3'
+    c.include RSpec::Puppet::DefineExampleGroup, :type => :define, :example_group => {
+      :file_path => c.escaped_path(%w[spec defines])
+    }
+    c.include RSpec::Puppet::ClassExampleGroup, :type => :class, :example_group => {
+      :file_path => c.escaped_path(%w[spec classes])
+    }
+    c.include RSpec::Puppet::FunctionExampleGroup, :type => :puppet_function, :example_group => {
+      :file_path => c.escaped_path(%w[spec functions])
+    }
+    c.include RSpec::Puppet::HostExampleGroup, :type => :host, :example_group => {
+      :file_path => c.escaped_path(%w[spec hosts])
+   }
+  else
+    c.include RSpec::Puppet::DefineExampleGroup, :type => :define, :file_path => c.escaped_path(%w[spec defines])
+    c.include RSpec::Puppet::ClassExampleGroup, :type => :class, :file_path => c.escaped_path(%w[spec classes])
+    c.include RSpec::Puppet::FunctionExampleGroup, :type => :puppet_function, :file_path => c.escaped_path(%w[spec functions])
+    c.include RSpec::Puppet::HostExampleGroup, :type => :host, :file_path => c.escaped_path(%w[spec hosts])
+  end
 end

data/lib/rspec-puppet/example/class_example_group.rb

@@ -3,8 +3,8 @@ module RSpec::Puppet
     include RSpec::Puppet::ManifestMatchers
     include RSpec::Puppet::Support
 
-    def subject
-      @catalogue ||= catalogue(:class)
+    def catalogue
+      @catalogue ||= load_catalogue(:class)
     end
   end
 end

data/lib/rspec-puppet/example/define_example_group.rb

@@ -3,8 +3,8 @@ module RSpec::Puppet
     include RSpec::Puppet::ManifestMatchers
     include RSpec::Puppet::Support
 
-    def subject
-      @catalogue ||= catalogue(:define)
+    def catalogue
+      @catalogue ||= load_catalogue(:define)
     end
   end
 end

data/lib/rspec-puppet/example/function_example_group.rb

@@ -11,14 +11,6 @@ module RSpec::Puppet
 
       node_name = nodename(:function)
 
-      facts_val = facts_hash(node_name)
-
-      # if we specify a pre_condition, we should ensure that we compile that code
-      # into a catalog that is accessible from the scope where the function is called
-      Puppet[:code] = pre_cond
-
-      compiler = build_compiler(node_name, facts_val)
-
       function_scope = scope(compiler, node_name)
 
       # Return the method instance for the function.  This can be used with
@@ -28,8 +20,26 @@ module RSpec::Puppet
       function_scope.method("function_#{function_name}".intern)
     end
 
+    def catalogue
+      @catalogue ||= compiler.catalog
+    end
+
+    private
+
+    def compiler
+      @compiler ||= build_compiler
+    end
+
     # get a compiler with an attached compiled catalog
-    def build_compiler(node_name, fact_values)
+    def build_compiler
+      node_name   = nodename(:function)
+      fact_values = facts_hash(node_name)
+
+      # if we specify a pre_condition, we should ensure that we compile that
+      # code into a catalog that is accessible from the scope where the
+      # function is called
+      Puppet[:code] = pre_cond
+
       node_options = {
         :parameters => fact_values,
       }

data/lib/rspec-puppet/example/host_example_group.rb

@@ -3,8 +3,8 @@ module RSpec::Puppet
     include RSpec::Puppet::ManifestMatchers
     include RSpec::Puppet::Support
 
-    def subject
-      @catalogue ||= catalogue(:host)
+    def catalogue
+      @catalogue ||= load_catalogue(:host)
     end
   end
 end

data/lib/rspec-puppet/matchers/compile.rb

@@ -5,6 +5,7 @@ module RSpec::Puppet
         @failed_resource = ""
         @check_deps = false
         @cycles = []
+        @error_msg = ""
       end
 
       def with_all_deps
@@ -12,30 +13,57 @@ module RSpec::Puppet
         self
       end
 
+      def and_raise_error(error)
+        @expected_error = error
+        self
+      end
+
       def matches?(catalogue)
-        @catalogue = catalogue
-        if cycles_found?
-          false
-        elsif @check_deps == true && missing_dependencies?
-          false
-        else
-          true
+        begin
+          @catalogue = catalogue.call
+
+          if cycles_found?
+            false
+          elsif @check_deps == true && missing_dependencies?
+            false
+          else
+            true
+          end
+        rescue Puppet::Error => e
+          @error_msg = e.message
+          if @expected_error.nil?
+            false
+          else
+            method = @expected_error.is_a?(Regexp) ? :=~ : :==
+            e.message.send(method, @expected_error)
+          end
         end
       end
 
       def description
-        "compile the catalogue without cycles"
+        case @expected_error
+        when nil
+          "compile into a catalogue without dependency cycles"
+        when Regexp
+          "fail to compile and raise an error matching #{@expected_error.inspect}"
+        else
+          "fail to compile and raise the error #{@expected_error.inspect}"
+        end
       end
 
-      def failure_message_for_should
+      def failure_message
         unless @cycles.empty?
           "dependency cycles found: #{@cycles.join('; ')}"
         else
-          "expected that the catalogue would include #{@failed_resource}"
+          unless @error_msg.empty?
+            "error during compilation: #{@error_msg}"
+          else
+            "expected that the catalogue would include #{@failed_resource}"
+          end
         end
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         "expected that the catalogue would not compile but it does"
       end
 
@@ -95,20 +123,14 @@ module RSpec::Puppet
       end
 
       def cycles_found?
-        retval = false
-        begin
-          cat = @catalogue.to_ral.relationship_graph
-          cat.write_graph(:resources)
-          if cat.respond_to? :find_cycles_in_graph
-            find_cycles(cat)
-          else
-            find_cycles_legacy(cat)
-          end
-          retval = true unless @cycles.empty?
-        rescue Puppet::Error
-          retval = true
+        cat = @catalogue.to_ral.relationship_graph
+        cat.write_graph(:resources)
+        if cat.respond_to? :find_cycles_in_graph
+          find_cycles(cat)
+        else
+          find_cycles_legacy(cat)
         end
-        retval
+        !@cycles.empty?
       end
 
       def find_cycles(catalogue)

data/lib/rspec-puppet/matchers/count_generic.rb

@@ -12,15 +12,17 @@ module RSpec::Puppet
       end
 
       def matches?(catalogue)
+        @catalogue = catalogue.call
+
         if @type == "resource"
-          @actual_number = catalogue.resources.count do |res|
+          @actual_number = @catalogue.resources.count do |res|
             !(['Class', 'Node'].include? res.type)
           end
 
           # Puppet automatically adds Stage[main]
           @actual_number = @actual_number - 1
         else
-          @actual_number = catalogue.resources.count do |res|
+          @actual_number = @catalogue.resources.count do |res|
             res.type == @referenced_type
           end
 
@@ -47,11 +49,11 @@ module RSpec::Puppet
         desc.join(" ")
       end
 
-      def failure_message_for_should
+      def failure_message
         "expected that the catalogue would " + description + " but it contains #{@actual_number}"
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         "expected that the catalogue would not " + description + " but it does"
       end
 

data/lib/rspec-puppet/matchers/create_generic.rb

@@ -39,22 +39,22 @@ module RSpec::Puppet
       end
 
       def that_notifies(resource)
-        @notifies << resource
+        @notifies.concat(Array(resource))
         self
       end
 
       def that_subscribes_to(resource)
-        @subscribes << resource
+        @subscribes.concat(Array(resource))
         self
       end
 
       def that_requires(resource)
-        @requires << resource
+        @requires.concat(Array(resource))
         self
       end
 
       def that_comes_before(resource)
-        @befores << resource
+        @befores.concat(Array(resource))
         self
       end
 
@@ -79,11 +79,13 @@ module RSpec::Puppet
 
       def matches?(catalogue)
         ret = true
-        resource = catalogue.resource(@referenced_type, @title)
+        @catalogue = catalogue.call
+        resource = @catalogue.resource(@referenced_type, @title)
 
         if resource.nil?
           false
         else
+          RSpec::Puppet::Coverage.cover!(resource)
           rsrc_hsh = resource.to_hash
           if @expected_params_count
             unless rsrc_hsh.size == @expected_params_count
@@ -94,25 +96,26 @@ module RSpec::Puppet
 
           check_params(rsrc_hsh, @expected_params, :should) if @expected_params.any?
           check_params(rsrc_hsh, @expected_undef_params, :not) if @expected_undef_params.any?
-          check_befores(catalogue, resource) if @befores.any?
-          check_requires(catalogue, resource) if @requires.any?
-          check_notifies(catalogue, resource) if @notifies.any?
-          check_subscribes(catalogue, resource) if @subscribes.any?
+          check_befores(@catalogue, resource) if @befores.any?
+          check_requires(@catalogue, resource) if @requires.any?
+          check_notifies(@catalogue, resource) if @notifies.any?
+          check_subscribes(@catalogue, resource) if @subscribes.any?
 
           @errors.empty?
         end
       end
 
-      def failure_message_for_should
+      def failure_message
         "expected that the catalogue would contain #{@referenced_type}[#{@title}]#{errors}"
       end
 
-      def failure_message_for_should_not
+      def failure_message_when_negated
         "expected that the catalogue would not contain #{@referenced_type}[#{@title}]#{errors}"
       end
 
       def description
         values = []
+        value_str_prefix = "with"
 
         if @expected_params_count
           values << "exactly #{@expected_params_count} parameters"
@@ -126,17 +129,49 @@ module RSpec::Puppet
           values.concat(generate_param_list(@expected_undef_params, :not))
         end
 
+        if @notifies.any?
+          value_str_prefix = "that notifies"
+          values = @notifies
+        end
+
+        if @subscribes.any?
+          value_str_prefix = "that subscribes to"
+          values = @subscribes
+        end
+
+        if @requires.any?
+          value_str_prefix = "that requires"
+          values = @requires
+        end
+
+        if @befores.any?
+          value_str_prefix = "that comes before"
+          values = @befores
+        end
+
         unless values.empty?
           if values.length == 1
-            value_str = " with #{values.first}"
+            value_str = " #{value_str_prefix} #{values.first}"
           else
-            value_str = " with #{values[0..-2].join(", ")} and #{values[-1]}"
+            value_str = " #{value_str_prefix} #{values[0..-2].join(", ")} and #{values[-1]}"
           end
         end
 
         "contain #{@referenced_type}[#{@title}]#{value_str}"
       end
 
+      def diffable?
+        true
+      end
+
+      def expected
+        @errors.map {|e| e.expected if e.respond_to?(:expected)}.compact.join("\n\n")
+      end
+
+      def actual
+        @errors.map {|e| e.actual if e.respond_to?(:actual)}.compact.join("\n\n")
+      end
+
       private
       def referenced_type(type)
         type.split('__').map { |r| r.capitalize }.join('::')
@@ -199,17 +234,25 @@ module RSpec::Puppet
       end
 
       def precedes?(first, second)
-        before_refs = relationship_refs(first[:before])
-        require_refs = relationship_refs(second[:require])
+        if first.nil? || second.nil?
+          false
+        else
+          before_refs = relationship_refs(first[:before])
+          require_refs = relationship_refs(second[:require])
 
-        before_refs.include?(second.to_ref) || require_refs.include?(first.to_ref)
+          before_refs.include?(second.to_ref) || require_refs.include?(first.to_ref)
+        end
       end
 
       def notifies?(first, second)
-        notify_refs = relationship_refs(first[:notify])
-        subscribe_refs = relationship_refs(second[:subscribe])
+        if first.nil? || second.nil?
+          false
+        else
+          notify_refs = relationship_refs(first[:notify])
+          subscribe_refs = relationship_refs(second[:subscribe])
 
-        notify_refs.include?(second.to_ref) || subscribe_refs.include?(first.to_ref)
+          notify_refs.include?(second.to_ref) || subscribe_refs.include?(first.to_ref)
+        end
       end
 
       # @param resource [Hash<Symbol, Object>] The resource in the catalog

data/lib/rspec-puppet/matchers/include_class.rb

@@ -5,16 +5,24 @@ module RSpec::Puppet
     matcher :include_class do |expected_class|
       match do |catalogue|
         RSpec.deprecate(:include_class, :contain_class)
-        catalogue.classes.include?(expected_class)
+        catalogue.call.classes.include?(expected_class)
       end
 
       description do
         "include Class[#{expected_class}]"
       end
 
-      failure_message_for_should do |actual|
-        "expected that the catalogue would include Class[#{expected_class}]"
+      if RSpec::Version::STRING < '3'
+        failure_message_for_should do |actual|
+          "expected that the catalogue would include Class[#{expected_class}]"
+        end
+      else
+        failure_message do |actual|
+          "expected that the catalogue would include Class[#{expected_class}]"
+        end
       end
+
     end
+
   end
 end

data/lib/rspec-puppet/matchers/parameter_matcher.rb

@@ -30,9 +30,7 @@ module RSpec::Puppet
         # Puppet flattens an array with a single value into just the value and
         # this can cause confusion when testing as people expect when you put
         # an array in, you'll get an array out.
-        if expected.is_a?(Array) && expected.length == 1
-          actual = Array[actual] unless actual.is_a?(Array)
-        end
+        actual = [*actual] if expected.is_a?(Array)
 
         retval = check(expected, actual)
 
@@ -57,6 +55,7 @@ module RSpec::Puppet
       #
       # @return [true, false] If the resource matched
       def check(expected, actual)
+        return false if actual.nil? && !expected.nil?
         case expected
         when Proc
           check_proc(expected, actual)

data/lib/rspec-puppet/matchers/run.rb

@@ -2,6 +2,7 @@ module RSpec::Puppet
   module FunctionMatchers
     class Run
       def matches?(func_obj)
+        @func_obj = func_obj
         if @params
           @func = lambda { func_obj.call(@params) }
         else
@@ -29,7 +30,12 @@ module RSpec::Puppet
         else
           unless @expected_return.nil?
             @actual_return = @func.call
-            @actual_return == @expected_return
+            case @expected_return
+            when Regexp
+              @actual_return =~ @expected_return
+            else
+              @actual_return == @expected_return
+            end
           else
             begin
               @func.call
@@ -48,6 +54,11 @@ module RSpec::Puppet
 
       def and_return(value)
         @expected_return = value
+        if value.is_a? Regexp
+          @desc = "match #{value.inspect}"
+        else
+          @desc = "return #{value.inspect}"
+        end
         self
       end
 
@@ -58,22 +69,40 @@ module RSpec::Puppet
         else
           @expected_error, @expected_error_message = error_or_message, message
         end
+
+        if @expected_error_message.is_a? Regexp
+          @desc = "raise an #{@expected_error} with the message matching #{@expected_error_message.inspect}"
+        else
+          @desc = "raise an #{@expected_error}"
+          unless @expected_error_message.nil?
+            @desc += "with the message #{@expected_error_message.inspect}"
+          end
+        end
         self
       end
 
-      def failure_message_for_should(func_obj)
-        failure_message_generic(:should, func_obj)
+      def failure_message
+        failure_message_generic(:should, @func_obj)
       end
 
-      def failure_message_for_should_not(func_obj)
-        failure_message_generic(:should_not, func_obj)
+      def failure_message_when_negated
+        failure_message_generic(:should_not, @func_obj)
+      end
+
+      def description
+        "run #{func_name}(#{func_params}) and #{@desc}"
       end
 
       private
-      def failure_message_generic(type, func_obj)
-        func_name = func_obj.name.gsub(/^function_/, '')
-        func_params = @params.inspect[1..-2]
+      def func_name
+        @func_name ||= @func_obj.name.to_s.gsub(/^function_/, '')
+      end
 
+      def func_params
+        @func_args ||= @params.inspect[1..-2]
+      end
+
+      def failure_message_generic(type, func_obj)
         message = "expected #{func_name}(#{func_params}) to "
         message << "not " if type == :should_not
 

data/lib/rspec-puppet/setup.rb

@@ -31,7 +31,7 @@ module RSpec::Puppet
 
       safe_touch('spec/fixtures/manifests/site.pp')
 
-      ['manifests','lib','files','templates'].each do |dir|
+      %w(data manifests lib files templates).each do |dir|
         if File.exist? dir
           safe_make_symlink("../../../../#{dir}", "spec/fixtures/modules/#{module_name}/#{dir}")
         end
@@ -122,7 +122,7 @@ EOF
     def self.safe_make_symlink(source, target)
       if File.exists? target
         unless File.symlink? target
-          $stderr.puts "!! #{file} already exists and is not a symlink"
+          $stderr.puts "!! #{target} already exists and is not a symlink"
         end
       else
         FileUtils.ln_s(source, target)

data/lib/rspec-puppet/support.rb

@@ -3,13 +3,29 @@ module RSpec::Puppet
 
     @@cache = {}
 
-    def catalogue(type)
+    def subject
+      lambda { catalogue }
+    end
+
+    def load_catalogue(type)
       vardir = setup_puppet
 
-      code = [import_str, pre_cond, test_manifest(type)].join("\n")
+      if Puppet[:parser] == 'future'
+        code = [pre_cond, test_manifest(type)].join("\n")
+      else
+        code = [import_str, pre_cond, test_manifest(type)].join("\n")
+      end
+
       node_name = nodename(type)
 
       catalogue = build_catalog(node_name, facts_hash(node_name), code)
+
+      RSpec::Puppet::Coverage.filters << "#{type.to_s.capitalize}[#{self.class.description.capitalize}]"
+
+      catalogue.to_a.each do |resource|
+        RSpec::Puppet::Coverage.add(resource)
+      end
+
       FileUtils.rm_rf(vardir) if File.directory?(vardir)
       catalogue
     end
@@ -58,8 +74,9 @@ module RSpec::Puppet
     end
 
     def nodename(type)
+      return node if self.respond_to?(:node)
       if [:class, :define, :function].include? type
-        self.respond_to?(:node) ? node : Puppet[:certname]
+        Puppet[:certname]
       else
         self.class.top_level_description.downcase
       end
@@ -80,9 +97,12 @@ module RSpec::Puppet
 
     def facts_hash(node)
       facts_val = {
-        'hostname' => node.split('.').first,
-        'fqdn'     => node,
-        'domain'   => node.split('.', 2).last,
+        'clientversion' => Puppet::PUPPETVERSION,
+        'environment'   => 'production',
+        'hostname'      => node.split('.').first,
+        'fqdn'          => node,
+        'domain'        => node.split('.', 2).last,
+        'clientcert'    => node
       }
 
       if RSpec.configuration.default_facts.any?
@@ -112,6 +132,7 @@ module RSpec::Puppet
         [:config, :config],
         [:confdir, :confdir],
         [:hiera_config, :hiera_config],
+        [:parser, :parser],
       ].each do |a, b|
         value = self.respond_to?(b) ? self.send(b) : RSpec.configuration.send(b)
         begin
@@ -182,5 +203,13 @@ module RSpec::Puppet
       opts.merge!({:environment => node_environment})
       Puppet::Node.new(name, opts)
     end
+
+    def rspec_compatibility
+      if RSpec::Version::STRING < '3'
+        # RSpec 2 compatibility:
+        alias_method :failure_message_for_should, :failure_message
+        alias_method :failure_message_for_should_not, :failure_message_when_negated
+      end
+    end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 description: RSpec tests for your Puppet manifests
 email: tim@sharpe.id.au
 executables:
@@ -32,12 +32,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/rspec-puppet-init
+- lib/rspec-puppet.rb
+- lib/rspec-puppet/coverage.rb
 - lib/rspec-puppet/errors.rb
+- lib/rspec-puppet/example.rb
 - lib/rspec-puppet/example/class_example_group.rb
 - lib/rspec-puppet/example/define_example_group.rb
 - lib/rspec-puppet/example/function_example_group.rb
 - lib/rspec-puppet/example/host_example_group.rb
-- lib/rspec-puppet/example.rb
+- lib/rspec-puppet/matchers.rb
 - lib/rspec-puppet/matchers/compile.rb
 - lib/rspec-puppet/matchers/count_generic.rb
 - lib/rspec-puppet/matchers/create_generic.rb
@@ -45,11 +49,8 @@ files:
 - lib/rspec-puppet/matchers/include_class.rb
 - lib/rspec-puppet/matchers/parameter_matcher.rb
 - lib/rspec-puppet/matchers/run.rb
-- lib/rspec-puppet/matchers.rb
 - lib/rspec-puppet/setup.rb
 - lib/rspec-puppet/support.rb
-- lib/rspec-puppet.rb
-- bin/rspec-puppet-init
 homepage: https://github.com/rodjek/rspec-puppet/
 licenses:
 - MIT
@@ -60,17 +61,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: RSpec tests for your Puppet manifests