rspec-puppet 2.5.0 → 2.6.0

data/lib/rspec-puppet/setup.rb

@@ -12,6 +12,14 @@ module RSpec::Puppet
         return false
       end
 
+      safe_setup_directories(module_name)
+      safe_touch(File.join('spec', 'fixtures', 'manifests', 'site.pp'))
+
+      safe_create_spec_helper
+      safe_create_rakefile
+    end
+
+    def self.safe_setup_directories(module_name=nil, verbose=true)
       if module_name.nil?
         module_name = get_module_name
         if module_name.nil?
@@ -22,28 +30,33 @@ module RSpec::Puppet
 
       [
         'spec',
-        'spec/classes',
-        'spec/defines',
-        'spec/functions',
-        'spec/hosts',
-        'spec/fixtures',
-        'spec/fixtures/manifests',
-        'spec/fixtures/modules',
-        "spec/fixtures/modules/#{module_name}",
-      ].each { |dir| safe_mkdir(dir) }
-
-      safe_touch('spec/fixtures/manifests/site.pp')
-
-      %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}")
+        File.join('spec', 'classes'),
+        File.join('spec', 'defines'),
+        File.join('spec', 'functions'),
+        File.join('spec', 'hosts'),
+        File.join('spec', 'fixtures'),
+        File.join('spec', 'fixtures', 'manifests'),
+        File.join('spec', 'fixtures', 'modules'),
+      ].each { |dir| safe_mkdir(dir, verbose) }
+
+      target = File.join('spec', 'fixtures', 'modules', module_name)
+      safe_make_link('.', target, verbose)
+    end
+
+    def self.safe_teardown_links(module_name=nil)
+      if module_name.nil?
+        module_name = get_module_name
+        if module_name.nil?
+          $stderr.puts "Unable to determine module name.  Aborting"
+          return false
         end
       end
 
-      safe_create_spec_helper
-      safe_create_rakefile
+      target = File.join('spec', 'fixtures', 'modules', module_name)
+      if File.symlink?(target) && File.readlink(target) == File.expand_path('.')
+        File.unlink(target)
+      end
     end
-
   protected
     def self.get_module_name
       module_name = nil
@@ -78,14 +91,14 @@ module RSpec::Puppet
       Dir["*"].entries.include? "manifests"
     end
 
-    def self.safe_mkdir(dir)
+    def self.safe_mkdir(dir, verbose=true)
       if File.exists? dir
         unless File.directory? dir
           $stderr.puts "!! #{dir} already exists and is not a directory"
         end
       else
         FileUtils.mkdir dir
-        puts " + #{dir}/"
+        puts " + #{dir}/" if verbose
       end
     end
 
@@ -115,18 +128,26 @@ module RSpec::Puppet
     end
 
     def self.safe_create_spec_helper
-      content = "require 'rspec-puppet/spec_helper'\n"
+      content = File.read(File.expand_path(File.join(__FILE__, '..', 'spec_helper.rb')))
       safe_create_file('spec/spec_helper.rb', content)
     end
 
-    def self.safe_make_symlink(source, target)
-      if File.exists? target
-        unless File.symlink? target
+    def self.safe_make_link(source, target, verbose=true)
+      if File.exists?(target)
+        unless File.symlink?(target) && File.readlink(target) == File.expand_path(source)
           $stderr.puts "!! #{target} already exists and is not a symlink"
         end
       else
-        FileUtils.ln_s(source, target)
-        puts " + #{target}"
+        if Puppet::Util::Platform.windows?
+          output = `call mklink /J "#{target.gsub('/', '\\')}" "#{source}"`
+          unless $?.success?
+            puts output
+            abort
+          end
+        else
+          FileUtils.ln_s(File.expand_path(source), target)
+        end
+        puts " + #{target}" if verbose
       end
     end
 

data/lib/rspec-puppet/spec_helper.rb

@@ -1,9 +1,10 @@
 require 'rspec-puppet'
 
-fixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))
+fixture_path = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures')
 
 RSpec.configure do |c|
-  c.module_path = File.join(fixture_path, 'modules')
-  c.manifest_dir = File.join(fixture_path, 'manifests')
+  c.module_path     = File.join(fixture_path, 'modules')
+  c.manifest_dir    = File.join(fixture_path, 'manifests')
+  c.manifest        = File.join(fixture_path, 'manifests', 'site.pp')
   c.environmentpath = File.join(Dir.pwd, 'spec')
 end

data/lib/rspec-puppet/support.rb

@@ -15,22 +15,84 @@ module RSpec::Puppet
       'rp_env'
     end
 
-    def load_catalogue(type, exported = false)
-      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
+    def build_code(type, manifest_opts)
+      if Puppet.version.to_f >= 4.0 or Puppet[:parser] == 'future'
+        [site_pp_str, pre_cond, test_manifest(type, manifest_opts), post_cond].compact.join("\n")
+      else
+        [import_str, pre_cond, test_manifest(type, manifest_opts), post_cond].compact.join("\n")
+      end
+    end
+
+    def guess_type_from_path(path)
+      case path
+      when /spec\/defines/
+        :define
+      when /spec\/classes/
+        :class
+      when /spec\/functions/
+        :function
+      when /spec\/hosts/
+        :host
+      when /spec\/types/
+        :type
+      when /spec\/type_aliases/
+        :type_alias
+      when /spec\/provider/
+        :provider
+      when /spec\/applications/
+        :application
+      else
+        :unknown
+      end
+    end
+
+    def stub_file_consts(example)
+      if example.respond_to?(:metadata)
+        type = example.metadata[:type]
+      else
+        type = guess_type_from_path(example.example.metadata[:file_path])
+      end
+
+      munged_facts = facts_hash(nodename(type))
 
+      if munged_facts['operatingsystem'] && munged_facts['operatingsystem'].to_s.downcase == 'windows'
+        stub_const_wrapper('File::PATH_SEPARATOR', ';')
+        stub_const_wrapper('File::ALT_SEPARATOR', "\\")
+        stub_const_wrapper('Pathname::SEPARATOR_PAT', /[#{Regexp.quote(File::ALT_SEPARATOR)}#{Regexp.quote(File::SEPARATOR)}]/)
+      else
+        stub_const_wrapper('File::PATH_SEPARATOR', ':')
+        stub_const_wrapper('File::ALT_SEPARATOR', nil)
+        stub_const_wrapper('Pathname::SEPARATOR_PAT', /#{Regexp.quote(File::SEPARATOR)}/)
+      end
+    end
+
+    def stub_const_wrapper(const, value)
+      if defined?(RSpec::Core::MockingAdapters::RSpec) && RSpec.configuration.mock_framework == RSpec::Core::MockingAdapters::RSpec
+        stub_const(const, value)
+      else
+        klass_name, const_name = const.split('::', 2)
+        klass = Object.const_get(klass_name)
+        klass.send(:remove_const, const_name) if klass.const_defined?(const_name)
+        klass.const_set(const_name, value)
+      end
+    end
+
+    def load_catalogue(type, exported = false, manifest_opts = {})
+      with_vardir do
         node_name = nodename(type)
 
         hiera_config_value = self.respond_to?(:hiera_config) ? hiera_config : nil
+        hiera_data_value = self.respond_to?(:hiera_data) ? hiera_data : nil
 
-        catalogue = build_catalog(node_name, facts_hash(node_name), hiera_config_value, code, exported)
+        catalogue = build_catalog(node_name, facts_hash(node_name), trusted_facts_hash(node_name), hiera_config_value,
+                                  build_code(type, manifest_opts), exported, node_params_hash, hiera_data_value)
 
-        test_module = class_name.split('::').first
-        RSpec::Puppet::Coverage.add_filter(type.to_s, self.class.description)
+        test_module = type == :host ? nil : class_name.split('::').first
+        if type == :define
+          RSpec::Puppet::Coverage.add_filter(class_name, title)
+        else
+          RSpec::Puppet::Coverage.add_filter(type.to_s, class_name)
+        end
         RSpec::Puppet::Coverage.add_from_catalog(catalogue, test_module)
 
         catalogue
@@ -61,27 +123,41 @@ module RSpec::Puppet
       import_str
     end
 
-    def test_manifest(type)
+    def site_pp_str
+      site_pp_str = ''
+      filepath = adapter.manifest
+
+      if (!filepath.nil?) && File.file?(filepath)
+        site_pp_str = File.open(filepath).read
+      end
+      site_pp_str
+    end
+
+    def test_manifest(type, opts = {})
+      opts[:params] = params if self.respond_to?(:params)
+
       if type == :class
-        if !self.respond_to?(:params) || params == {}
+        if opts[:params].nil? || opts[:params] == {}
           "include #{class_name}"
         else
-          "class { '#{class_name}': #{param_str} }"
+          "class { '#{class_name}': #{param_str(opts[:params])} }"
         end
       elsif type == :application
-        if self.respond_to? :params
-          "site { #{class_name} { '#{title}': #{param_str} } }"
+        if opts.has_key?(:params)
+          "site { #{class_name} { '#{title}': #{param_str(opts[:params])} } }"
         else
-          raise ArgumentException, "You need to provide params for an application"
+          raise ArgumentError, "You need to provide params for an application"
         end
       elsif type == :define
-        if self.respond_to? :params
-          "#{class_name} { '#{title}': #{param_str} }"
+        if opts.has_key?(:params)
+          "#{class_name} { #{title.inspect}: #{param_str(opts[:params])} }"
         else
-          "#{class_name} { '#{title}': }"
+          "#{class_name} { #{title.inspect}: }"
         end
       elsif type == :host
         nil
+      elsif type == :type_alias
+        "$test = #{str_from_value(opts[:test_value])}\nassert_type(#{self.class.top_level_description}, $test)"
       end
     end
 
@@ -110,28 +186,78 @@ module RSpec::Puppet
       end
     end
 
+    def post_cond
+      if self.respond_to?(:post_condition) && !post_condition.nil?
+        if post_condition.is_a? Array
+          post_condition.compact.join("\n")
+        else
+          post_condition
+        end
+      else
+        nil
+      end
+    end
+
     def facts_hash(node)
-      facts_val = {
+      base_facts = {
         'clientversion' => Puppet::PUPPETVERSION,
         'environment'   => environment,
+      }
+
+      node_facts = {
         'hostname'      => node.split('.').first,
         'fqdn'          => node,
         'domain'        => node.split('.', 2).last,
-        'clientcert'    => node
+        'clientcert'    => node,
+        'networking'    => {
+          'fqdn'          => node,
+          'domain'        => node.split('.', 2).last,
+          'hostname'      => node.split('.').first
+        }
       }
 
-      if RSpec.configuration.default_facts.any?
-        facts_val.merge!(munge_facts(RSpec.configuration.default_facts))
-      end
+      result_facts = if RSpec.configuration.default_facts.any?
+                       munge_facts(RSpec.configuration.default_facts)
+                     else
+                       {}
+                     end
+
+      result_facts.merge!(munge_facts(base_facts))
+      result_facts.merge!(munge_facts(facts)) if self.respond_to?(:facts)
+      result_facts.merge!(munge_facts(node_facts))
+
+      # Facter currently supports lower case facts.  Bug FACT-777 has been submitted to support case sensitive
+      # facts.
+      downcase_facts = Hash[result_facts.map { |k, v| [k.downcase, v] }]
+      downcase_facts
+    end
 
-      facts_val.merge!(munge_facts(facts)) if self.respond_to?(:facts)
-      facts_val
+    def node_params_hash
+      params = RSpec.configuration.default_node_params
+      if respond_to?(:node_params)
+        params.merge(node_params)
+      else
+        params.dup
+      end
     end
 
-    def param_str
+    def param_str(params)
       param_str_from_hash(params)
     end
 
+    def trusted_facts_hash(node_name)
+      return {} unless Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0
+
+      extensions = {}
+
+      if RSpec.configuration.default_trusted_facts.any?
+        extensions.merge!(RSpec.configuration.default_trusted_facts)
+      end
+
+      extensions.merge!(trusted_facts) if self.respond_to?(:trusted_facts)
+      extensions
+    end
+
     def str_from_value(value)
       case value
       when Hash
@@ -139,8 +265,17 @@ module RSpec::Puppet
           "#{str_from_value(k)} => #{str_from_value(v)}"
         end.join(", ")
         "{ #{kvs} }"
+      when Array
+        vals = value.map do |v|
+          str_from_value(v)
+        end.join(", ")
+        "[ #{vals} ]"
+      when :default
+        'default'  # verbatim default keyword
       when :undef
         'undef'  # verbatim undef keyword
+      when Symbol
+        str_from_value(value.to_s)
       else
         escape_special_chars(value.inspect)
       end
@@ -159,7 +294,7 @@ module RSpec::Puppet
       Puppet[:vardir] = vardir
 
       # Enable app_management by default for Puppet versions that support it
-      if Puppet.version.to_f >= 4.3
+      if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0 && Puppet.version.to_i < 5
         Puppet[:app_management] = true
       end
 
@@ -177,11 +312,11 @@ module RSpec::Puppet
         vardir = setup_puppet
         return yield(vardir) if block_given?
       ensure
-        FileUtils.rm_rf(vardir) if File.directory?(vardir)
+        FileUtils.rm_rf(vardir) if vardir && File.directory?(vardir)
       end
     end
 
-    def build_catalog_without_cache(nodename, facts_val, hiera_config_val, code, exported)
+    def build_catalog_without_cache(nodename, facts_val, trusted_facts_val, hiera_config_val, code, exported, node_params, *_)
 
       # If we're going to rebuild the catalog, we should clear the cached instance
       # of Hiera that Puppet is using.  This opens the possibility of the catalog
@@ -197,13 +332,29 @@ module RSpec::Puppet
       stub_facts! facts_val
 
       node_facts = Puppet::Node::Facts.new(nodename, facts_val.dup)
+      node_params = facts_val.merge(node_params)
 
-      node_obj = Puppet::Node.new(nodename, { :parameters => facts_val, :facts => node_facts })
+      node_obj = Puppet::Node.new(nodename, { :parameters => node_params, :facts => node_facts })
+
+      if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0
+        Puppet.push_context(
+          {
+            :trusted_information => Puppet::Context::TrustedInformation.new('remote', nodename, trusted_facts_val)
+          },
+          "Context for spec trusted hash"
+        )
+      end
 
       adapter.catalog(node_obj, exported)
     end
 
     def stub_facts!(facts)
+      if facts['operatingsystem'] && facts['operatingsystem'].to_s.downcase == 'windows'
+        Puppet::Util::Platform.pretend_to_be :windows
+      else
+        Puppet::Util::Platform.pretend_to_be :posix
+      end
+      Puppet.settings[:autosign] = false
       facts.each { |k, v| Facter.add(k) { setcode { v } } }
     end
 
@@ -213,11 +364,9 @@ module RSpec::Puppet
       end
     end
 
-    # Facter currently supports lower case facts.  Bug FACT-777 has been submitted to support case sensitive
-    # facts.
     def munge_facts(facts)
       return facts.reduce({}) do | memo, (k, v)|
-        memo.tap { |m| m[k.to_s.downcase] = munge_facts(v) }
+        memo.tap { |m| m[k.to_s] = munge_facts(v) }
       end if facts.is_a? Hash
 
       return facts.reduce([]) do |memo, v|

data/lib/rspec-puppet.rb

@@ -14,6 +14,12 @@ begin
 rescue LoadError
 end
 
+RSpec.configure do |c|
+  c.add_setting :enable_pathname_stubbing, :default => false
+end
+
+require 'rspec-puppet/monkey_patches'
+
 RSpec.configure do |c|
   c.add_setting :environmentpath, :default => '/etc/puppetlabs/code/environments'
   c.add_setting :module_path, :default => nil
@@ -23,6 +29,8 @@ RSpec.configure do |c|
   c.add_setting :config, :default => nil
   c.add_setting :confdir, :default => '/etc/puppet'
   c.add_setting :default_facts, :default => {}
+  c.add_setting :default_node_params, :default => {}
+  c.add_setting :default_trusted_facts, :default => {}
   c.add_setting :hiera_config, :default => '/dev/null'
   c.add_setting :parser, :default => 'current'
   c.add_setting :trusted_node_data, :default => false
@@ -31,6 +39,10 @@ RSpec.configure do |c|
   c.add_setting :strict_variables, :default => false
   c.add_setting :adapter
 
+  c.before(:all) do
+    RSpec::Puppet::Setup.safe_setup_directories(nil, false)
+  end
+
   if defined?(Puppet::Test::TestHelper)
     begin
       Puppet::Test::TestHelper.initialize
@@ -55,6 +67,8 @@ RSpec.configure do |c|
     c.before :each do
       begin
         Puppet::Test::TestHelper.before_each_test
+      rescue Puppet::Context::DuplicateRollbackMarkError
+        Puppet::Test::TestHelper.send(:initialize_settings_before_each)
       rescue
       end
     end
@@ -74,4 +88,8 @@ RSpec.configure do |c|
       c.adapter = adapter
     end
   end
+
+  c.before :each do |example|
+    stub_file_consts(example) if self.respond_to?(:stub_file_consts)
+  end
 end

metadata

@@ -1,27 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
+  prerelease: 
 platform: ruby
 authors:
 - Tim Sharpe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2017-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: RSpec tests for your Puppet manifests
@@ -33,56 +36,60 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - README.md
-- bin/rspec-puppet-init
 - lib/rspec-puppet.rb
+- lib/rspec-puppet/raw_string.rb
+- lib/rspec-puppet/monkey_patches.rb
+- lib/rspec-puppet/support.rb
+- lib/rspec-puppet/matchers/run.rb
+- lib/rspec-puppet/matchers/allow_value.rb
+- lib/rspec-puppet/matchers/parameter_matcher.rb
+- lib/rspec-puppet/matchers/count_generic.rb
+- lib/rspec-puppet/matchers/create_generic.rb
+- lib/rspec-puppet/matchers/dynamic_matchers.rb
+- lib/rspec-puppet/matchers/include_class.rb
+- lib/rspec-puppet/matchers/compile.rb
+- lib/rspec-puppet/matchers/type_matchers.rb
+- lib/rspec-puppet/spec_helper.rb
 - lib/rspec-puppet/adapters.rb
 - lib/rspec-puppet/cache.rb
+- lib/rspec-puppet/setup.rb
 - 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
+- lib/rspec-puppet/example/type_alias_example_group.rb
+- lib/rspec-puppet/example/type_example_group.rb
 - lib/rspec-puppet/example/host_example_group.rb
 - lib/rspec-puppet/example/provider_example_group.rb
-- lib/rspec-puppet/example/type_example_group.rb
+- lib/rspec-puppet/example/application_example_group.rb
+- lib/rspec-puppet/example/define_example_group.rb
+- lib/rspec-puppet/example/class_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
-- lib/rspec-puppet/matchers/dynamic_matchers.rb
-- lib/rspec-puppet/matchers/include_class.rb
-- lib/rspec-puppet/matchers/parameter_matcher.rb
-- 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
+- lib/rspec-puppet/errors.rb
+- bin/rspec-puppet-init
 homepage: https://github.com/rodjek/rspec-puppet/
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 1.8.23.2
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: RSpec tests for your Puppet manifests
 test_files: []

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 1a4f52ea0428c49bc328570e7a71776b75b800b2
-  data.tar.gz: 461fadebe1cd4756715a99d54fefdf51c020a17b
-SHA512:
-  metadata.gz: 8f79f8be40bf4e2c77e11ddf68130ea0fe97b8e629cf4768c2da1a15a096ed65fad3dff160208a36b9d221f652564956fc15113b56589562a8890c01a4678098
-  data.tar.gz: bc64b10392874054ebf8cfe7712abc25874bfa3d44ebd3c6dced81d3eae7c99b359754dd3d74481dfc1851264ce347f8f76990e0022f8e653b622a77ade449d5