rspec-puppet 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 3b7f69bbaf69b20087bd1bddd03664873dbc4c4e
-  data.tar.gz: a8cde11764645b5d98eae77faeb74eaa88473efd
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGRlMzY5NDE4OWNiN2Y2MTViMzE3YTA4N2MwMDJkN2FiNjljMjg1Mw==
+  data.tar.gz: !binary |-
+    MWExYmViYmQ5Y2RiN2E4ZjU2ZWRjODc1MTg4NmExN2VkYzI1ZmQxZg==
 SHA512:
-  metadata.gz: 1814a868083211d2c3ed2066055619f2d1d89398a28b59558eebb34005f3c82cda9fcd8601933d4b04533584ac78a6e59c165b9f4ecb268631c608269fe84c28
-  data.tar.gz: dbbb6480b731081f8776ca1da05e3ebd7a73db5ab7edf32667f3d7b18770ed910281aa934bce89d68c688df6b4d709ef516d5021a7c18011355b0b052f1ae9dc
+  metadata.gz: !binary |-
+    YzIzNjc1NzRmOTlmODU2Yjc5MGVhYTAxZTkzZjc2Mjc3Zjc5MmVhNzg2MWE1
+    ZDJkNDNiM2U3YWNjYTlmMTY4ZDZmYTc1NDE1MzNlZDVkNThiOWI4NDU3M2Q2
+    ZjJkZmMxMTJkMGU1NWYzZTUzMDRlZDY2MmFiODg0ODg2YWFiYzU=
+  data.tar.gz: !binary |-
+    MDNkNTU4MGYyNWYzZDUwYWRjM2I5MWZiMDgxYzE5NTE5YjJmYTY1NzVhYTYw
+    MzE0YmQxNDk2NzgzNDI1MGY3YmJmNWZjZmZlZmQwZTI2YjkyZWI1OGE3ZWY5
+    ZjI3Zjc3ZmQwZDI4N2Q1MDRkY2NhNDJjNmYxZmZhNzI4OGRkZjM=

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Change Log
+All notable changes to this project will be documented in this file. This
+project adheres to [Semantic Versioning](http://semver.org/).
+
+## [2.1.0] - 2015-04-21
+### Added
+- Puppet 4 support
+- Ability to set `environment` in a let block
+- Better function failure messages
+
+### Fixed
+- Filter fixtures from coverage reports
+- Fix functions accidentally modifying rspec function arguments
+- Restructured TravisCI matrix (NB: Puppet 2.6 is no longer tested)
+
+## [2.0.1] - 2015-03-12
+### Fixed
+- Allow RSpec 2 to still be used
+
+## [2.0.0] - 2014-12-02
+### Changed
+- `subject` is now a lambda to enable catching compilation failures.
+
+### Added
+- Ability to use RSpec 3
+- Hiera integration
+- Coverage reports
+- Ability to test on the future parser
+- Function tests now have a catalogue
+- Add array of references support to Relationship matchers `that_requires`,
+  `that_comes_before`, `that_notifies`, and `that_subscribes_to`
+
+### Fixed
+- Better error messaging and handling for parameters (`nil` and friends) and
+  dependency cycles
+
+## 1.0.1 and earlier
+For changelog of versions 1.0.1 and earlier, see http://rspec-puppet.com/changelog/
+
+[2.1.0]: https://github.com/rodjek/rspec-puppet/compare/v2.0.1...v2.1.0
+[2.0.1]: https://github.com/rodjek/rspec-puppet/compare/v2.0.0...v2.0.1
+[2.0.0]: https://github.com/rodjek/rspec-puppet/compare/v1.0.1...v2.0.0

data/README.md

@@ -260,6 +260,15 @@ you can specify this as follows
 let(:node) { 'testhost.example.com' }
 ```
 
+#### Specifying the environment name
+
+If the manifest you're testing expects to evaluate the environment name,
+you can specify this as follows
+
+```ruby
+let(:environment) { 'production' }
+```
+
 #### Specifying the facts that should be available to your manifest
 
 By default, the test environment contains no facts for your manifest to use.

data/lib/rspec-puppet.rb

@@ -14,6 +14,7 @@ rescue LoadError
 end
 
 RSpec.configure do |c|
+  c.add_setting :environmentpath, :default => '/etc/puppetlabs/code/environments'
   c.add_setting :module_path, :default => '/etc/puppet/modules'
   c.add_setting :manifest_dir, :default => nil
   c.add_setting :manifest, :default => nil

data/lib/rspec-puppet/coverage.rb

@@ -5,7 +5,8 @@ module RSpec::Puppet
 
     class << self
       extend Forwardable
-      def_delegators :instance, :add, :cover!, :report!, :filters
+      def_delegators(:instance, :add, :cover!, :report!,
+                     :filters, :add_filter, :add_from_catalog)
     end
 
     include Singleton
@@ -21,6 +22,41 @@ module RSpec::Puppet
       end
     end
 
+    def add_filter(type, title)
+      @filters << "#{type.capitalize}[#{title.capitalize}]"
+    end
+
+    # add all resources from catalog declared in module test_module
+    def add_from_catalog(catalog, test_module)
+      catalog.to_a.each do |resource|
+        # check filters
+        next if @filters.include?(resource.to_s)
+        if resource.type == 'Class'
+          # if the resource is a class, make sure the class belongs to
+          # module test_module
+          module_name = resource.title.split('::').first.downcase
+          next if module_name != test_module
+        elsif resource.file
+          # otherwise, the source file should be available, so make
+          # sure the manifest declaring the resource is in
+          # test_module's directory tree or the site manifest(s)
+          if Puppet.version.to_f >= 4.0
+            paths = [
+              (Pathname.new(Puppet[:environmentpath]) + 'fixtures' + test_module + 'manifests').to_s,
+              (Pathname.new(Puppet[:environmentpath]) + 'fixtures' + 'manifests' + 'site.pp').to_s
+            ]
+          else
+            paths = Puppet[:modulepath].split(File::PATH_SEPARATOR).map do |dir|
+              (Pathname.new(dir) + test_module + 'manifests').to_s
+            end
+            paths << Puppet[:manifest]
+          end
+          next unless paths.any? { |path| resource.file.include?(path) }
+        end
+        add(resource)
+      end
+    end
+
     def filtered?(resource)
       filters.include?(resource.to_s)
     end

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

@@ -11,11 +11,22 @@ module RSpec::Puppet
 
       node_name = nodename(:function)
 
+      if Puppet.version.to_f >= 4.0
+        env = Puppet::Node::Environment.create(environment, [File.join(Puppet[:environmentpath],'fixtures','modules')], File.join(Puppet[:environmentpath],'fixtures','manifests'))
+        loader = Puppet::Pops::Loaders.new(env)
+        func = loader.private_environment_loader.load(:function,function_name)
+        return func if func
+      end
+
       function_scope = scope(compiler, node_name)
 
       # Return the method instance for the function.  This can be used with
       # method.call
-      return nil unless Puppet::Parser::Functions.function(function_name)
+      if env
+        return nil unless Puppet::Parser::Functions.function(function_name,env)
+      else
+        return nil unless Puppet::Parser::Functions.function(function_name)
+      end
       FileUtils.rm_rf(vardir) if File.directory?(vardir)
       function_scope.method("function_#{function_name}".intern)
     end

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

@@ -92,7 +92,7 @@ module RSpec::Puppet
         end
 
         expected.keys.all? do |key|
-          check(expected[key], actual[key.to_s])
+          check(expected[key], actual[key])
         end
       end
 

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

@@ -4,9 +4,17 @@ module RSpec::Puppet
       def matches?(func_obj)
         @func_obj = func_obj
         if @params
-          @func = lambda { func_obj.call(@params) }
+          if Puppet.version.to_f >= 4.0 and ! @func_obj.respond_to?(:receiver)
+            @func = lambda { func_obj.call({}, *@params) }
+          else
+            @func = lambda { func_obj.call(@params) }
+          end
         else
-          @func = lambda { func_obj.call }
+          if Puppet.version.to_f >= 4.0 and ! @func_obj.respond_to?(:receiver)
+            @func = lambda { func_obj.call({}) }
+          else
+            @func = lambda { func_obj.call }
+          end
         end
 
         unless @expected_error.nil?
@@ -15,6 +23,7 @@ module RSpec::Puppet
             @func.call
           rescue Exception => e
             @actual_error = e.class
+            @actual_error_message = e.to_s
             if e.is_a?(@expected_error)
               case @expected_error_message
               when nil
@@ -49,6 +58,9 @@ module RSpec::Puppet
 
       def with_params(*params)
         @params = params
+        # stringify immediately to protect us from the params being changed by
+        # the subject, e.g. with params.shift
+        @func_args = @params.inspect[1..-2]
         self
       end
 
@@ -95,11 +107,15 @@ module RSpec::Puppet
 
       private
       def func_name
-        @func_name ||= @func_obj.name.to_s.gsub(/^function_/, '')
+        if Puppet.version.to_f >= 4.0 and ! @func_ob and ! @func_obj.respond_to?(:receiver)
+          @func_name ||= @func_obj.class.name
+        else
+          @func_name ||= @func_obj.name.to_s.gsub(/^function_/, '')
+        end
       end
 
       def func_params
-        @func_args ||= @params.inspect[1..-2]
+        @func_args
       end
 
       def failure_message_generic(type, func_obj)
@@ -113,6 +129,19 @@ module RSpec::Puppet
           end
         elsif @expected_error
           message << "have raised #{@expected_error.inspect}"
+          if @expected_error_message
+            message << " matching #{@expected_error_message.inspect}"
+          end
+          if type == :should
+            if @actual_error
+              message << " instead of raising #{@actual_error.inspect}"
+              if @expected_error_message
+                message << "(#{@actual_error_message})"
+              end
+            elsif @actual_return
+              message << " instead of returning #{@actual_return.inspect}"
+            end
+          end
         else
           message << "have run successfully"
         end

data/lib/rspec-puppet/setup.rb

@@ -1,4 +1,7 @@
 require 'puppet'
+if Puppet.version.to_f >= 4.0
+  require 'puppet/pops'
+end
 require 'fileutils'
 
 module RSpec::Puppet

data/lib/rspec-puppet/support.rb

@@ -7,37 +7,37 @@ module RSpec::Puppet
       lambda { catalogue }
     end
 
+    def environment
+      'rp_env'
+    end
+
     def load_catalogue(type)
       vardir = setup_puppet
 
-      if Puppet[:parser] == 'future'
-        code = [pre_cond, test_manifest(type)].join("\n")
+      if Puppet.version.to_f >= 4.0 or Puppet[:parser] == 'future'
+        code = [pre_cond, test_manifest(type)].compact.join("\n")
       else
-        code = [import_str, pre_cond, test_manifest(type)].join("\n")
+        code = [import_str, pre_cond, test_manifest(type)].compact.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
+      test_module = class_name.split('::').first
+      RSpec::Puppet::Coverage.add_filter(type.to_s, self.class.description)
+      RSpec::Puppet::Coverage.add_from_catalog(catalogue, test_module)
 
       FileUtils.rm_rf(vardir) if File.directory?(vardir)
       catalogue
     end
 
     def import_str
-      klass_name = self.class.top_level_description.downcase
-
       if File.exists?(File.join(Puppet[:modulepath], 'manifests', 'init.pp'))
         path_to_manifest = File.join([
           Puppet[:modulepath],
           'manifests',
-          klass_name.split('::')[1..-1]
+          class_name.split('::')[1..-1]
         ].flatten)
         import_str = [
           "import '#{Puppet[:modulepath]}/manifests/init.pp'",
@@ -54,22 +54,20 @@ module RSpec::Puppet
     end
 
     def test_manifest(type)
-      klass_name = self.class.top_level_description.downcase
-
       if type == :class
         if !self.respond_to?(:params) || params == {}
-          "include #{klass_name}"
+          "include #{class_name}"
         else
-          "class { '#{klass_name}': #{param_str} }"
+          "class { '#{class_name}': #{param_str} }"
         end
       elsif type == :define
         if self.respond_to? :params
-          "#{klass_name} { '#{title}': #{param_str} }"
+          "#{class_name} { '#{title}': #{param_str} }"
         else
-          "#{klass_name} { '#{title}': }"
+          "#{class_name} { '#{title}': }"
         end
       elsif type == :host
-        ""
+        nil
       end
     end
 
@@ -78,27 +76,30 @@ module RSpec::Puppet
       if [:class, :define, :function].include? type
         Puppet[:certname]
       else
-        self.class.top_level_description.downcase
+        class_name
       end
     end
 
+    def class_name
+      self.class.top_level_description.downcase
+    end
 
     def pre_cond
       if self.respond_to?(:pre_condition) && !pre_condition.nil?
         if pre_condition.is_a? Array
-          pre_condition.join("\n")
+          pre_condition.compact.join("\n")
         else
           pre_condition
         end
       else
-        ''
+        nil
       end
     end
 
     def facts_hash(node)
       facts_val = {
         'clientversion' => Puppet::PUPPETVERSION,
-        'environment'   => 'production',
+        'environment'   => environment,
         'hostname'      => node.split('.').first,
         'fqdn'          => node,
         'domain'        => node.split('.', 2).last,
@@ -124,16 +125,26 @@ module RSpec::Puppet
       vardir = Dir.mktmpdir
       Puppet[:vardir] = vardir
 
-      [
-        [:modulepath, :module_path],
-        [:manifestdir, :manifest_dir],
-        [:manifest, :manifest],
-        [:templatedir, :template_dir],
-        [:config, :config],
-        [:confdir, :confdir],
-        [:hiera_config, :hiera_config],
-        [:parser, :parser],
-      ].each do |a, b|
+      if Puppet.version.to_f >= 4.0
+        settings = [
+          [:environmentpath, :environmentpath],
+          [:config, :config],
+          [:confdir, :confdir],
+          [:hiera_config, :hiera_config],
+        ]
+      else
+        settings = [
+          [:modulepath, :module_path],
+          [:manifestdir, :manifest_dir],
+          [:manifest, :manifest],
+          [:templatedir, :template_dir],
+          [:config, :config],
+          [:confdir, :confdir],
+          [:hiera_config, :hiera_config],
+          [:parser, :parser],
+        ]
+      end
+      settings.each do |a,b|
         value = self.respond_to?(b) ? self.send(b) : RSpec.configuration.send(b)
         begin
           Puppet[a] = value
@@ -142,6 +153,7 @@ module RSpec::Puppet
         end
       end
 
+      # This line is wrong. libdir should never be more than a single path
       Puppet[:libdir] = Dir["#{Puppet[:modulepath]}/*/lib"].entries.join(File::PATH_SEPARATOR)
       vardir
     end
@@ -158,6 +170,16 @@ module RSpec::Puppet
       # trying to be compatible with 2.7 as well as 2.6
       if Puppet::Resource::Catalog.respond_to? :find
         Puppet::Resource::Catalog.find(node_obj.name, :use_node => node_obj)
+      elsif Puppet.version.to_f >= 4.0
+        env = Puppet::Node::Environment.create(
+          environment,
+          [File.join(Puppet[:environmentpath],'fixtures','modules')],
+          File.join(Puppet[:environmentpath],'fixtures','manifests'))
+        loader = Puppet::Environments::Static.new(env)
+        Puppet.override({:environments => loader}, 'fixtures') do
+          node_obj.environment = env
+          Puppet::Resource::Catalog.indirection.find(node_obj.name, :use_node => node_obj)
+        end
       else
         Puppet::Resource::Catalog.indirection.find(node_obj.name, :use_node => node_obj)
       end
@@ -199,7 +221,14 @@ module RSpec::Puppet
     end
 
     def build_node(name, opts = {})
-      node_environment = Puppet::Node::Environment.new('test')
+      if Puppet.version.to_f >= 4.0
+        node_environment = Puppet::Node::Environment.create(
+          environment,
+          [File.join(Puppet[:environmentpath],'fixtures','modules')],
+          File.join(Puppet[:environmentpath],'fixtures','manifests'))
+      else
+        node_environment = Puppet::Node::Environment.new(environment)
+      end
       opts.merge!({:environment => node_environment})
       Puppet::Node.new(name, opts)
     end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-13 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: RSpec tests for your Puppet manifests
@@ -31,6 +31,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - README.md
 - bin/rspec-puppet-init
 - lib/rspec-puppet.rb
@@ -61,18 +62,19 @@ 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.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: RSpec tests for your Puppet manifests
 test_files: []
+has_rdoc: