rspec-puppet 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09f6ee077554387daa2811aecd6d308670c50693
-  data.tar.gz: c9c666f424696d2a649b0d034fcc645bb8cd1daf
+  metadata.gz: 1a4f52ea0428c49bc328570e7a71776b75b800b2
+  data.tar.gz: 461fadebe1cd4756715a99d54fefdf51c020a17b
 SHA512:
-  metadata.gz: 9ee25b36e54a9d9fda26f4b1e2d876ee87dbf783a7f216c57c7fbbeae1550a006178edc9358748c6e703b8629a2d0971217c46f6106dddd1f96ed978a3c8c2cd
-  data.tar.gz: 3083ad10c6066c73da20e5a15a6befbe7f4f54451913046be9a0791c5d52f43f2b346c2d0b52c3551f3f976bd6015149a1d6bb52ffe55a7b448e75acf6bdb59e
+  metadata.gz: 8f79f8be40bf4e2c77e11ddf68130ea0fe97b8e629cf4768c2da1a15a096ed65fad3dff160208a36b9d221f652564956fc15113b56589562a8890c01a4678098
+  data.tar.gz: bc64b10392874054ebf8cfe7712abc25874bfa3d44ebd3c6dced81d3eae7c99b359754dd3d74481dfc1851264ce347f8f76990e0022f8e653b622a77ade449d5

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.5.0]
+
+Headline features are app management, nested hashes in params, and testing for "internal" functions.
+
+Thanks to everyone who contributed: Leo Arnold, Matt Schuchard, and Si Wilkins
+
+### Changed
+
+* Updates to the README
+* Improve Gemfile to work with older rubies
+
+### Added
+
+* Add support for app management testing
+* Enable nested hashes in params
+* After refactoring the function test code, puppet 4 "internal" functions can now be tested too
+* Link functions and types on setup
+* Increased test coverage
+
 ## [2.4.0]
 
 This release now supports testing exported resources in the same way that normal resources in the catalog are tested. Access them in your examples using `exported_resources`. See "Testing Exported Resources" in the README for examples.
@@ -114,7 +133,8 @@ Thanks to Adrien Thebo, Alex Harvey, Brian, Dan Bode, Dominic Cleal, Javier Pala
 ## 1.0.1 and earlier
 For changelog of versions 1.0.1 and earlier, see http://rspec-puppet.com/changelog/
 
-[2.x]: https://github.com/rodjek/rspec-puppet/compare/v2.4.0...master
+[2.x]: https://github.com/rodjek/rspec-puppet/compare/v2.5.0...master
+[2.5.0]: https://github.com/rodjek/rspec-puppet/compare/v2.4.0...v2.5.0
 [2.4.0]: https://github.com/rodjek/rspec-puppet/compare/v2.3.2...v2.4.0
 [2.3.2]: https://github.com/rodjek/rspec-puppet/compare/v2.3.1...v2.3.2
 [2.3.1]: https://github.com/rodjek/rspec-puppet/compare/v2.3.0...v2.3.1

data/README.md

@@ -37,6 +37,10 @@ structure and naming convention.
            |     |
            |     +-- <define_name>_spec.rb
            |
+           +-- applications
+           |     |
+           |     +-- <application_name>_spec.rb
+           |
            +-- functions
            |     |
            |     +-- <function_name>_spec.rb
@@ -64,6 +68,10 @@ describe 'mydefine', :type => :define do
   ...
 end
 
+describe 'myapplication', :type => :application do
+  ...
+end
+
 describe 'myfunction', :type => :puppet_function do
   ...
 end
@@ -77,7 +85,7 @@ describe 'myhost.example.com', :type => :host do
 end
 ```
 
-## Defined Types & Classes
+## Defined Types, Classes & Applications
 
 ### Matchers
 
@@ -354,16 +362,45 @@ let(:title) { 'foo' }
 
 #### Specifying the parameters to pass to a resources or parameterised class
 
+Parameters of a defined type, class or application can be passed defining `:params` in a let,
+and passing it a hash as seen below.
+
 ```ruby
 let(:params) { {:ensure => 'present', ...} }
 ```
 
-##### Passing Puppet's `undef` as a parameter value
+For passing Puppet's `undef` as a paremeter value, you can simply use `:undef` and it will
+be translated to `undef` when compiling. For example:
 
 ```ruby
 let(:params) { {:user => :undef, ...} }
 ```
 
+For references to nodes or resources as seen when using `require` or `before` properties,
+or an `application` resource you can pass the string as an argument to the `ref` helper:
+
+```ruby
+let(:params) { :require => ref('Package', 'sudoku') }
+```
+
+Which translates to:
+
+```puppet
+mydefine { 'mytitle': require => Package['sudoku'] }
+```
+
+Another example, for an application setup (when using `app_management`):
+
+```ruby
+let(:params) { { :nodes => { ref('Node', 'dbnode') => ref('Myapp::Mycomponent', 'myapp') } } }
+```
+
+Will translate to:
+
+```puppet
+site { myapp { 'myimpl': nodes => { Node['dbnode'] => Myapp::Mycomponent['myimpl'] } } }
+```
+
 #### Specifying the FQDN of the test node
 
 If the manifest you're testing expects to run on host with a particular name,
@@ -450,6 +487,46 @@ You can also use `exported_resources` directly in a test:
 it { expect(exported_resources).to contain_file('foo') }
 ```
 
+#### Testing applications
+
+Applications in some ways behave as defined resources, but are more complex so
+require a number of elements already documented above to be combined for testing.
+
+A full example of the simplest rspec test for a single component application:
+
+```ruby
+require 'spec_helper'
+
+describe 'orch_app' do
+  let(:node) { 'my_node' }
+  let(:title) { 'my_awesome_app' }
+  let(:params) do
+    {
+      :nodes => {
+        ref('Node', node) => ref('Orch_app::Db', title),
+      }
+    }
+  end
+
+  it { should compile }
+  it { should contain_orch_app(title) }
+end
+```
+
+Each piece is required:
+
+* You must turn on app_management during testing for the handling to work
+* The `:node` definition is required to be set so later on you can reference it in the `:nodes` argument within `:params`
+* Applications act like defined resources, and each require a `:title` to be defined
+* The `:nodes` key in `:params` requires the use of node reference mappings to resource
+  mappings. The `ref` keyword allows you to provide these (a normal string will not work).
+
+Beyond these requirements, the very basic `should compile` test and other matchers
+as you would expect will work the same as classes and defined resources.
+
+**Note:** for the moment, cross-node support is not available and will return an error.
+Ensure you model your tests to be single-node for the time being.
+
 ## Functions
 
 ### Matchers
@@ -554,6 +631,20 @@ before(:each) { scope.expects(:lookupvar).with('some_variable').returns('some_va
 it { is_expected.to run.with_params('...').and_return('...') }
 ```
 
+Note that this does not work when testing manifests which use custom functions. Instead,
+you'll need to create a replacement function directly.
+
+```ruby
+before(:each) do
+    Puppet::Parser::Functions.newfunction(:custom_function, :type => :rvalue) { |args|
+        raise ArgumentError, 'expected foobar' unless args[0] == 'foobar'
+        'expected value'
+    }
+end
+
+```
+
+
 ## Hiera integration
 
 ### Configuration

data/lib/rspec-puppet/example.rb

@@ -5,6 +5,7 @@ require 'rspec-puppet/example/function_example_group'
 require 'rspec-puppet/example/host_example_group'
 require 'rspec-puppet/example/type_example_group'
 require 'rspec-puppet/example/provider_example_group'
+require 'rspec-puppet/example/application_example_group'
 
 RSpec::configure do |c|
 
@@ -31,6 +32,9 @@ RSpec::configure do |c|
     c.include RSpec::Puppet::ProviderExampleGroup, :type => :provider, :example_group => {
       :file_path => c.escaped_path(%w[spec providers])
     }
+    c.include RSpec::Puppet::ApplicationExampleGroup, :type => :application, :example_group => {
+      :file_path => c.escaped_path(%w[spec applications])
+    }
   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])
@@ -38,6 +42,7 @@ RSpec::configure do |c|
     c.include RSpec::Puppet::HostExampleGroup, :type => :host, :file_path => c.escaped_path(%w[spec hosts])
     c.include RSpec::Puppet::TypeExampleGroup, :type => :type, :file_path => c.escaped_path(%w[spec types])
     c.include RSpec::Puppet::ProviderExampleGroup, :type => :provider, :file_path => c.escaped_path(%w[spec providers])
+    c.include RSpec::Puppet::ApplicationExampleGroup, :type => :application, :file_path => c.escaped_path(%w[spec applications])
   end
 
   # Hook for each example group type to remove any caches or instance variables, since they will remain

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

@@ -0,0 +1,19 @@
+module RSpec::Puppet
+  # This module provides support for the application type
+  module ApplicationExampleGroup
+    include RSpec::Puppet::ManifestMatchers
+    include RSpec::Puppet::Support
+
+    def catalogue
+      @catalogue ||= load_catalogue(:application)
+    end
+
+    def exported_resources
+      lambda { load_catalogue(:application, true) }
+    end
+
+    def rspec_puppet_cleanup
+      @catalogue = nil
+    end
+  end
+end

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

@@ -4,27 +4,87 @@ module RSpec::Puppet
     include RSpec::Puppet::ManifestMatchers
     include RSpec::Puppet::Support
 
+    class V4FunctionWrapper
+      attr_reader :func, :func_name
+
+      def initialize(name, func, overrides)
+        @func_name = name
+        @func = func
+        @overrides = overrides
+      end
+
+      # This method is used by the `run` matcher to trigger the function execution, and provides a uniform interface across all puppet versions.
+      def execute(*args)
+        Puppet.override(@overrides, "rspec-test scope") do
+          @func.call(@overrides[:global_scope], *args)
+        end
+      end
+
+      # compatibility alias for existing tests
+      def call(scope, *args)
+        RSpec.deprecate("subject.call", :replacement => "is_expected.to run.with().and_raise_error(), or execute()")
+        execute(*args)
+      end
+    end
+
+    class V3FunctionWrapper
+      attr_accessor :func_name
+
+      def initialize(name, func)
+        @func_name = name
+        @func = func
+      end
+
+      # This method is used by the `run` matcher to trigger the function execution, and provides a uniform interface across all puppet versions.
+      def execute(*args)
+        if args.nil?
+          @func.call
+        else
+          @func.call(args)
+        end
+      end
+
+      # This method was formerly used by the `run` matcher to trigger the function execution, and provides puppet versions dependant interface.
+      def call(*args)
+        RSpec.deprecate("subject.call", :replacement => "is_expected.to run.with().and_raise_error(), or execute()")
+        if args.nil?
+          @func.call
+        else
+          @func.call(*args)
+        end
+      end
+    end
+
+    # (at least) rspec 3.5 doesn't seem to memoize `subject` when called from
+    # a before(:each) hook, so we need to memoize it ourselves.
     def subject
-      function_name = self.class.top_level_description.downcase
+      @subject ||= find_function
+    end
 
-      vardir = setup_puppet
+    def find_function
+      function_name = self.class.top_level_description.downcase
 
-      if Puppet.version.to_f >= 4.0
+      with_vardir do
         env = adapter.current_environment
-        loader = Puppet::Pops::Loaders.new(env)
-        func = loader.private_environment_loader.load(:function,function_name)
-        return func if func
-      end
 
-      # Return the method instance for the function.  This can be used with
-      # method.call
-      if env
-        return nil unless Puppet::Parser::Functions.function(function_name,env)
-      else
-        return nil unless Puppet::Parser::Functions.function(function_name)
+        if Puppet.version.to_f >= 4.0
+          context_overrides = compiler.context_overrides
+          func = nil
+          Puppet.override(context_overrides, "rspec-test scope") do
+            loader = Puppet::Pops::Loaders.new(env)
+            func = V4FunctionWrapper.new(function_name, loader.private_environment_loader.load(:function, function_name), context_overrides)
+            @scope = context_overrides[:global_scope]
+          end
+
+          return func if func.func
+        end
+
+        if Puppet::Parser::Functions.function(function_name)
+          V3FunctionWrapper.new(function_name, scope.method("function_#{function_name}".intern))
+        else
+          nil
+        end
       end
-      FileUtils.rm_rf(vardir) if File.directory?(vardir)
-      scope.method("function_#{function_name}".intern)
     end
 
     def scope
@@ -36,6 +96,7 @@ module RSpec::Puppet
     end
 
     def rspec_puppet_cleanup
+      @subject = nil
       @catalogue = nil
       @compiler = nil
       @scope = nil
@@ -71,7 +132,9 @@ module RSpec::Puppet
     end
 
     def build_scope(compiler, node_name)
-      if Puppet.version =~ /^2\.[67]/
+      if Puppet.version.to_f >= 4.0
+        return compiler.context_overrides[:global_scope]
+      elsif Puppet.version =~ /^2\.[67]/
         # loadall should only be necessary prior to 3.x
         # Please note, loadall needs to happen first when creating a scope, otherwise
         # you might receive undefined method `function_*' errors

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

@@ -3,23 +3,11 @@ module RSpec::Puppet
     class Run
       def matches?(func_obj)
         @func_obj = func_obj
-        if @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
-          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
 
         @has_returned = false
         begin
-          @actual_return = @func.call
+          # `*nil` does not evaluate to "no params" on ruby 1.8 :-(
+          @actual_return = @params.nil? ? @func_obj.execute : @func_obj.execute(*@params)
           @has_returned = true
         rescue Exception => e
           @actual_error = e
@@ -113,11 +101,7 @@ module RSpec::Puppet
 
       private
       def func_name
-        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
+        @func_obj.func_name
       end
 
       def func_params
@@ -129,9 +113,9 @@ module RSpec::Puppet
           ''
         elsif @actual_error
           if @has_expected_return
-            " instead of raising #{@actual_error.class.inspect}(#{@actual_error})"
+            " instead of raising #{@actual_error.class.inspect}(#{@actual_error})\n#{@actual_error.backtrace.join("\n")}"
           else
-            " instead of #{@actual_error.class.inspect}(#{@actual_error})"
+            " instead of #{@actual_error.class.inspect}(#{@actual_error})\n#{@actual_error.backtrace.join("\n")}"
           end
         else # function has returned
           if @has_expected_error

data/lib/rspec-puppet/raw_string.rb

@@ -0,0 +1,16 @@
+module RSpec::Puppet
+  # A raw string object, that is used by helpers to allow consumers to return non-quoted strings
+  # as part of their params section.
+  class RawString
+    # Create a new RawString object
+    # @param [String] value string to wrap
+    def initialize(value)
+      @value = value
+    end
+
+    # @return [String] raw string
+    def inspect
+      @value
+    end
+  end
+end

data/lib/rspec-puppet/setup.rb

@@ -34,7 +34,7 @@ module RSpec::Puppet
 
       safe_touch('spec/fixtures/manifests/site.pp')
 
-      %w(data manifests lib files templates).each do |dir|
+      %w(data manifests lib files templates functions types).each do |dir|
         if File.exist? dir
           safe_make_symlink("../../../../#{dir}", "spec/fixtures/modules/#{module_name}/#{dir}")
         end

data/lib/rspec-puppet/support.rb

@@ -1,5 +1,6 @@
 require 'rspec-puppet/cache'
 require 'rspec-puppet/adapters'
+require 'rspec-puppet/raw_string'
 
 module RSpec::Puppet
   module Support
@@ -15,26 +16,25 @@ module RSpec::Puppet
     end
 
     def load_catalogue(type, exported = false)
-      vardir = setup_puppet
-
-      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)].compact.join("\n")
-      end
+      with_vardir do
+        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)].compact.join("\n")
+        end
 
-      node_name = nodename(type)
+        node_name = nodename(type)
 
-      hiera_config_value = self.respond_to?(:hiera_config) ? hiera_config : nil
+        hiera_config_value = self.respond_to?(:hiera_config) ? hiera_config : nil
 
-      catalogue = build_catalog(node_name, facts_hash(node_name), hiera_config_value, code, exported)
+        catalogue = build_catalog(node_name, facts_hash(node_name), hiera_config_value, code, exported)
 
-      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)
+        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
+        catalogue
+      end
     end
 
     def import_str
@@ -68,6 +68,12 @@ module RSpec::Puppet
         else
           "class { '#{class_name}': #{param_str} }"
         end
+      elsif type == :application
+        if self.respond_to? :params
+          "site { #{class_name} { '#{title}': #{param_str} } }"
+        else
+          raise ArgumentException, "You need to provide params for an application"
+        end
       elsif type == :define
         if self.respond_to? :params
           "#{class_name} { '#{title}': #{param_str} }"
@@ -81,7 +87,7 @@ module RSpec::Puppet
 
     def nodename(type)
       return node if self.respond_to?(:node)
-      if [:class, :define, :function].include? type
+      if [:class, :define, :function, :application].include? type
         Puppet[:certname]
       else
         class_name
@@ -123,14 +129,28 @@ module RSpec::Puppet
     end
 
     def param_str
-      params.keys.map do |r|
-        param_val = params[r]
-        param_val_str = if param_val == :undef
-                          'undef'  # verbatim undef keyword
-                        else
-                          escape_special_chars(param_val.inspect)
-                        end
-        "#{r.to_s} => #{param_val_str}"
+      param_str_from_hash(params)
+    end
+
+    def str_from_value(value)
+      case value
+      when Hash
+        kvs = value.collect do |k,v|
+          "#{str_from_value(k)} => #{str_from_value(v)}"
+        end.join(", ")
+        "{ #{kvs} }"
+      when :undef
+        'undef'  # verbatim undef keyword
+      else
+        escape_special_chars(value.inspect)
+      end
+    end
+
+    def param_str_from_hash(params_hash)
+      # the param_str has special quoting rules, because the top-level keys are the Puppet
+      # params, which may not be quoted
+      params_hash.collect do |k,v|
+        "#{k.to_s} => #{str_from_value(v)}"
       end.join(', ')
     end
 
@@ -138,6 +158,11 @@ module RSpec::Puppet
       vardir = Dir.mktmpdir
       Puppet[:vardir] = vardir
 
+      # Enable app_management by default for Puppet versions that support it
+      if Puppet.version.to_f >= 4.3
+        Puppet[:app_management] = true
+      end
+
       adapter.modulepath.map do |d|
         Dir["#{d}/*/lib"].entries
       end.flatten.each do |lib|
@@ -147,6 +172,15 @@ module RSpec::Puppet
       vardir
     end
 
+    def with_vardir
+      begin
+        vardir = setup_puppet
+        return yield(vardir) if block_given?
+      ensure
+        FileUtils.rm_rf(vardir) if File.directory?(vardir)
+      end
+    end
+
     def build_catalog_without_cache(nodename, facts_val, hiera_config_val, code, exported)
 
       # If we're going to rebuild the catalog, we should clear the cached instance
@@ -206,6 +240,16 @@ module RSpec::Puppet
       end
     end
 
+    # Helper to return a resource/node reference, so it gets translated in params to a raw string
+    # without quotes.
+    #
+    # @param [String] type reference type
+    # @param [String] title reference title
+    # @return [RSpec::Puppet::RawString] return a new RawString with the type/title populated correctly
+    def ref(type, title)
+      return RSpec::Puppet::RawString.new("#{type}['#{title}']")
+    end
+
     # @!attribute [r] adapter
     #   @api private
     #   @return [Class < RSpec::Puppet::Adapters::Base]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -40,6 +40,7 @@ files:
 - lib/rspec-puppet/coverage.rb
 - lib/rspec-puppet/errors.rb
 - lib/rspec-puppet/example.rb
+- lib/rspec-puppet/example/application_example_group.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
@@ -56,6 +57,7 @@ files:
 - lib/rspec-puppet/matchers/run.rb
 - lib/rspec-puppet/matchers/type_matchers.rb
 - lib/rspec-puppet/rake_task.rb
+- lib/rspec-puppet/raw_string.rb
 - lib/rspec-puppet/setup.rb
 - lib/rspec-puppet/spec_helper.rb
 - lib/rspec-puppet/support.rb