rspec-puppet 2.11.0 → 4.0.0

data/lib/rspec-puppet/monkey_patches.rb

@@ -1,35 +1,32 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 # Load this library before enabling the monkey-patches to avoid HI-581
 begin
-require 'hiera/util/win32'
+  require 'hiera/util/win32'
 rescue LoadError
   # ignore this on installs without hiera, e.g. puppet 3 gems
 end
 
 class RSpec::Puppet::EventListener
   def self.example_started(example)
-    if rspec3?
-      @rspec_puppet_example = example.example.example_group.ancestors.include?(RSpec::Puppet::Support)
-      @current_example = example.example
-      if !@current_example.respond_to?(:environment) && @current_example.respond_to?(:example_group_instance)
-        @current_example = @current_example.example_group_instance
-      end
-    else
-      @rspec_puppet_example = example.example_group.ancestors.include?(RSpec::Puppet::Support)
-      @current_example = example
-    end
+    @rspec_puppet_example = example.example.example_group.ancestors.include?(RSpec::Puppet::Support)
+    @current_example = example.example
+    return unless !@current_example.respond_to?(:environment) && @current_example.respond_to?(:example_group_instance)
+
+    @current_example = @current_example.example_group_instance
   end
 
-  def self.example_passed(example)
+  def self.example_passed(_example)
     @rspec_puppet_example = false
   end
 
-  def self.example_pending(example)
+  def self.example_pending(_example)
     @rspec_puppet_example = false
   end
 
-  def self.example_failed(example)
+  def self.example_failed(_example)
     @rspec_puppet_example = false
   end
 
@@ -37,20 +34,13 @@ class RSpec::Puppet::EventListener
     @rspec_puppet_example || false
   end
 
-  def self.rspec3?
-    if @rspec3.nil?
-      @rspec3 = defined?(RSpec::Core::Notifications)
-    end
-
-    @rspec3
-  end
-
-  def self.current_example
-    @current_example
+  class << self
+    attr_reader :current_example
   end
 end
 
-RSpec.configuration.reporter.register_listener(RSpec::Puppet::EventListener, :example_started, :example_pending, :example_passed, :example_failed)
+RSpec.configuration.reporter.register_listener(RSpec::Puppet::EventListener, :example_started, :example_pending,
+                                               :example_passed, :example_failed)
 
 require 'rspec-puppet/monkey_patches/win32/taskscheduler'
 require 'rspec-puppet/monkey_patches/win32/registry'
@@ -84,24 +74,20 @@ module Puppet
           end
         end
 
-        retval = old_set_default.bind(self).call(attr)
+        retval = old_set_default.bind_call(self, attr)
 
-        unless old_posix.nil?
-          Puppet.features.add(:posix) { old_posix }
-        end
-        unless old_microsoft_windows.nil?
-          Puppet.features.add(:microsoft_windows) { old_microsoft_windows }
-        end
+        Puppet.features.add(:posix) { old_posix } unless old_posix.nil?
+        Puppet.features.add(:microsoft_windows) { old_microsoft_windows } unless old_microsoft_windows.nil?
 
         retval
       else
-        old_set_default.bind(self).call(attr)
+        old_set_default.bind_call(self, attr)
       end
     end
   end
 
   module Parser::Files
-    alias :old_find_manifests_in_modules :find_manifests_in_modules
+    alias old_find_manifests_in_modules find_manifests_in_modules
     module_function :old_find_manifests_in_modules
 
     def find_manifests_in_modules(pattern, environment)
@@ -113,8 +99,9 @@ module Puppet
           RSpec::Puppet::Consts.stub_consts_for(RSpec.configuration.platform)
         end
 
-        if pretending && pretending != Puppet::Util::Platform.actual_platform
-          environment.send(:value_cache).clear if environment.respond_to?(:value_cache, true)
+        if pretending && pretending != Puppet::Util::Platform.actual_platform && environment.respond_to?(:value_cache,
+                                                                                                         true)
+          environment.send(:value_cache).clear
         end
         output = old_find_manifests_in_modules(pattern, environment)
 
@@ -135,30 +122,30 @@ module Puppet
     # Fix for removal of default_env function
     # Bug: https://github.com/rodjek/rspec-puppet/issues/796
     # Upstream: https://github.com/puppetlabs/puppet/commit/94df3c1a3992d89b2d7d5db8a70373c135bdd86b
-    if !respond_to?(:default_env)
-      def default_env()
+    unless respond_to?(:default_env)
+      def default_env
         DEFAULT_ENV
       end
       module_function :default_env
     end
 
     if respond_to?(:get_env)
-      alias :old_get_env :get_env
+      alias old_get_env get_env
       module_function :old_get_env
 
       def get_env(name, mode = default_env)
         if RSpec::Puppet.rspec_puppet_example?
           # use the actual platform, not the pretended
-         old_get_env(name, Platform.actual_platform)
+          old_get_env(name, Platform.actual_platform)
         else
-         old_get_env(name, mode)
+          old_get_env(name, mode)
         end
       end
       module_function :get_env
     end
 
     if respond_to?(:path_to_uri)
-      alias :old_path_to_uri :path_to_uri
+      alias old_path_to_uri path_to_uri
       module_function :old_path_to_uri
 
       def path_to_uri(*args)
@@ -175,12 +162,12 @@ module Puppet
 
     # Allow rspec-puppet to pretend to be different platforms.
     module Platform
-      alias :old_windows? :windows?
+      alias old_windows? windows?
       module_function :old_windows?
 
       def windows?
         if RSpec::Puppet.rspec_puppet_example?
-          !pretending? ? (actual_platform == :windows) : pretend_windows?
+          pretending? ? pretend_windows? : (actual_platform == :windows)
         else
           old_windows?
         end
@@ -249,7 +236,7 @@ module Puppet
         if RSpec::Puppet.rspec_puppet_example?
           true
         else
-          old_pass.bind(self).call(value)
+          old_pass.bind_call(self, value)
         end
       end
     end
@@ -263,43 +250,46 @@ module Puppet
         if RSpec::Puppet.rspec_puppet_example?
           true
         else
-          old_pass.bind(self).call(value)
+          old_pass.bind_call(self, value)
         end
       end
     end
   end
 
-  if Puppet::Util::Package.versioncmp(Puppet.version, '4.9.0') >= 0
-    class Module
-      old_hiera_conf_file = instance_method(:hiera_conf_file)
-      define_method(:hiera_conf_file) do
-        if RSpec::Puppet.rspec_puppet_example?
-          if RSpec.configuration.disable_module_hiera
-            return nil
-          elsif RSpec.configuration.fixture_hiera_configs.key?(name)
-            config = RSpec.configuration.fixture_hiera_configs[name]
-            config = File.absolute_path(config, path) unless config.nil?
-            return config
-          elsif RSpec.configuration.use_fixture_spec_hiera
-            config = RSpec::Puppet.current_example.fixture_spec_hiera_conf(self)
-            return config unless config.nil? && RSpec.configuration.fallback_to_default_hiera
-          end
+  class Module
+    old_hiera_conf_file = instance_method(:hiera_conf_file)
+    define_method(:hiera_conf_file) do
+      if RSpec::Puppet.rspec_puppet_example?
+        if RSpec.configuration.disable_module_hiera
+          return nil
+        elsif RSpec.configuration.fixture_hiera_configs.key?(name)
+          config = RSpec.configuration.fixture_hiera_configs[name]
+          config = File.absolute_path(config, path) unless config.nil?
+          return config
+        elsif RSpec.configuration.use_fixture_spec_hiera
+          config = RSpec::Puppet.current_example.fixture_spec_hiera_conf(self)
+          return config unless config.nil? && RSpec.configuration.fallback_to_default_hiera
         end
-        old_hiera_conf_file.bind(self).call
       end
+      old_hiera_conf_file.bind_call(self)
     end
+  end
 
-    class Pops::Lookup::ModuleDataProvider
-      old_configuration_path = instance_method(:configuration_path)
-      define_method(:configuration_path) do |lookup_invocation|
-        if RSpec::Puppet.rspec_puppet_example?
-          env = lookup_invocation.scope.environment
-          mod = env.module(module_name)
-          raise Puppet::DataBinding::LookupError, _("Environment '%{env}', cannot find module '%{module_name}'") % { :env => env.name, :module_name => module_name } unless mod
-          return Pathname.new(mod.hiera_conf_file)
+  class Pops::Lookup::ModuleDataProvider
+    old_configuration_path = instance_method(:configuration_path)
+    define_method(:configuration_path) do |lookup_invocation|
+      if RSpec::Puppet.rspec_puppet_example?
+        env = lookup_invocation.scope.environment
+        mod = env.module(module_name)
+        unless mod
+          raise Puppet::DataBinding::LookupError,
+                format(_("Environment '%<env>s', cannot find module '%<module_name>s'"), env: env.name,
+                                                                                         module_name: module_name)
         end
-        old_configuration_path.bind(self).call(lookup_invocation)
+
+        return Pathname.new(mod.hiera_conf_file)
       end
+      old_configuration_path.bind_call(self, lookup_invocation)
     end
   end
 end
@@ -308,29 +298,26 @@ class Pathname
   def rspec_puppet_basename(path)
     raise ArgumentError, 'pathname stubbing not enabled' unless RSpec.configuration.enable_pathname_stubbing
 
-    if path =~ /\A[a-zA-Z]:(#{SEPARATOR_PAT}.*)\z/
-      path = path[2..-1]
-    end
+    path = path[2..-1] if /\A[a-zA-Z]:(#{SEPARATOR_PAT}.*)\z/.match?(path)
     path.split(SEPARATOR_PAT).last || path[/(#{SEPARATOR_PAT})/, 1] || path
   end
 
-  if instance_methods.include?("chop_basename")
+  if instance_methods.include?('chop_basename')
     old_chop_basename = instance_method(:chop_basename)
 
     define_method(:chop_basename) do |path|
       if RSpec::Puppet.rspec_puppet_example?
         if RSpec.configuration.enable_pathname_stubbing
           base = rspec_puppet_basename(path)
-          if /\A#{SEPARATOR_PAT}?\z/o =~ base
-            return nil
-          else
-            return path[0, path.rindex(base)], base
-          end
+          return nil if /\A#{SEPARATOR_PAT}?\z/o.match?(base)
+
+          [path[0, path.rindex(base)], base]
+
         else
-          old_chop_basename.bind(self).call(path)
+          old_chop_basename.bind_call(self, path)
         end
       else
-        old_chop_basename.bind(self).call(path)
+        old_chop_basename.bind_call(self, path)
       end
     end
   end
@@ -345,10 +332,8 @@ class Puppet::Module
     old_match_manifests = instance_method(:match_manifests)
 
     define_method(:match_manifests) do |rest|
-      result = old_match_manifests.bind(self).call(rest)
-      if result.length > 1 && File.basename(result[0]) == 'init.pp'
-        result.shift
-      end
+      result = old_match_manifests.bind_call(self, rest)
+      result.shift if result.length > 1 && File.basename(result[0]) == 'init.pp'
       result
     end
   end
@@ -361,7 +346,7 @@ Puppet::Type.type(:file).paramclass(:path).munge do |value|
   if RSpec::Puppet.rspec_puppet_example?
     value
   else
-    file_path_munge.bind(self).call(value)
+    file_path_munge.bind_call(self, value)
   end
 end
 
@@ -373,7 +358,7 @@ Puppet::Type.type(:exec).paramclass(:user).validate do |value|
   if RSpec::Puppet.rspec_puppet_example?
     true
   else
-    exec_user_validate.bind(self).call(value)
+    exec_user_validate.bind_call(self, value)
   end
 end
 
@@ -383,11 +368,11 @@ end
 Puppet::Type.type(:file).provide(:windows).class_eval do
   old_supports_acl = instance_method(:supports_acl?) if respond_to?(:supports_acl?)
 
-  def supports_acl?(path)
+  def supports_acl?(_path)
     if RSpec::Puppet.rspec_puppet_example?
       true
     else
-      old_supports_acl.bind(self).call(value)
+      old_supports_acl.bind_call(self, value)
     end
   end
 
@@ -397,7 +382,7 @@ Puppet::Type.type(:file).provide(:windows).class_eval do
     if RSpec::Puppet.rspec_puppet_example?
       true
     else
-      old_manages_symlinks.bind(self).call(value)
+      old_manages_symlinks.bind_call(self, value)
     end
   end
 end
@@ -406,9 +391,11 @@ end
 # windows, otherwise it will require other libraries that probably won't be
 # available on non-windows hosts.
 module Kernel
-  alias :old_require :require
+  alias old_require require
   def require(path)
-    return if (['puppet/util/windows', 'win32/registry'].include?(path)) && RSpec::Puppet.rspec_puppet_example? && Puppet::Util::Platform.pretend_windows?
+    return if ['puppet/util/windows',
+               'win32/registry'].include?(path) && RSpec::Puppet.rspec_puppet_example? && Puppet::Util::Platform.pretend_windows?
+
     old_require(path)
   end
 end

data/lib/rspec-puppet/rake_task.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 require 'rake'
 require 'rspec/core/rake_task'
 
-desc "Run all RSpec code examples"
+desc 'Run all RSpec code examples'
 RSpec::Core::RakeTask.new(:rspec) do |t|
-  File.exist?('spec/spec.opts') ? opts = File.read("spec/spec.opts").chomp : opts = ""
+  opts = File.exist?('spec/spec.opts') ? File.read('spec/spec.opts').chomp : ''
   t.rspec_opts = opts
 end
 
-SPEC_SUITES = (Dir.entries('spec') - ['.', '..','fixtures']).select {|e| File.directory? "spec/#{e}" }
+SPEC_SUITES = (Dir.entries('spec') - ['.', '..', 'fixtures']).select { |e| File.directory? "spec/#{e}" }
 namespace :rspec do
   SPEC_SUITES.each do |suite|
     desc "Run #{suite} RSpec code examples"
     RSpec::Core::RakeTask.new(suite) do |t|
       t.pattern = "spec/#{suite}/**/*_spec.rb"
-      File.exist?('spec/spec.opts') ? opts = File.read("spec/spec.opts").chomp : opts = ""
+      opts = File.exist?('spec/spec.opts') ? File.read('spec/spec.opts').chomp : ''
       t.rspec_opts = opts
     end
   end

data/lib/rspec-puppet/raw_string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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.

data/lib/rspec-puppet/sensitive.rb

@@ -1,51 +1,43 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
-  if defined?(::Puppet::Pops::Types::PSensitiveType::Sensitive)
-    # A wrapper representing Sensitive data type, eg. in class params.
-    class Sensitive < ::Puppet::Pops::Types::PSensitiveType::Sensitive
-      # Create a new Sensitive object
-      # @param [Object] value to wrap
-      def initialize(value)
-        @value = value
-      end
+  # A wrapper representing Sensitive data type, eg. in class params.
+  class Sensitive < ::Puppet::Pops::Types::PSensitiveType::Sensitive
+    # Create a new Sensitive object
+    # @param [Object] value to wrap
+    def initialize(value)
+      @value = value
+    end
 
-      # @return the wrapped value
-      def unwrap
-        @value
-      end
+    # @return the wrapped value
+    def unwrap
+      @value
+    end
 
-      # @return true
-      def sensitive?
-        true
-      end
+    # @return true
+    def sensitive?
+      true
+    end
 
-      # @return inspect of the wrapped value, inside Sensitive()
-      def inspect
-        "Sensitive(#{@value.inspect})"
-      end
+    # @return inspect of the wrapped value, inside Sensitive()
+    def inspect
+      "Sensitive(#{@value.inspect})"
+    end
 
-      # Check for equality with another value.
-      # If compared to Puppet Sensitive type, it compares the wrapped values.
+    # Check for equality with another value.
+    # If compared to Puppet Sensitive type, it compares the wrapped values.
 
-      # @param other [#unwrap, Object] value to compare to
-      def == other
-        if other.respond_to? :unwrap
-          if unwrap.kind_of?(Regexp)
-            return unwrap =~ other.unwrap
-          else
-            return unwrap == other.unwrap
-          end
+    # @param other [#unwrap, Object] value to compare to
+    def ==(other)
+      if other.respond_to? :unwrap
+        if unwrap.is_a?(Regexp)
+          unwrap =~ other.unwrap
         else
-          super
+          unwrap == other.unwrap
         end
+      else
+        super
       end
     end
-  else
-    #:nocov:
-    class Sensitive
-      def initialize(value)
-        raise 'The use of the Sensitive data type is not supported by this Puppet version'
-      end
-    end
-    #:nocov:
   end
 end

data/lib/rspec-puppet/setup.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'English'
 require 'puppet'
 require 'fileutils'
 
@@ -9,17 +12,17 @@ end
 
 module RSpec::Puppet
   class Setup
-    def self.run(module_name=nil)
+    def self.run(module_name = nil)
       unless is_module_dir?
-        $stderr.puts "Does not appear to be a Puppet module.  Aborting"
+        warn 'Does not appear to be a Puppet module.  Aborting'
         return false
       end
 
       if control_repo?
-        $stderr.puts <<-END
-Unable to find a metadata.json file. If this is a module, please create a
-metadata.json file and try again.
-END
+        warn <<~END
+          Unable to find a metadata.json file. If this is a module, please create a
+          metadata.json file and try again.
+        END
         return false
       end
 
@@ -30,16 +33,16 @@ END
       safe_create_rakefile
     end
 
-    def self.safe_setup_directories(module_name=nil, verbose=true)
+    def self.safe_setup_directories(module_name = nil, verbose = true)
       if control_repo?
-        $stderr.puts "Unable to setup rspec-puppet automatically in a control repo" if verbose
+        warn 'Unable to setup rspec-puppet automatically in a control repo' if verbose
         return false
       end
 
       if module_name.nil?
         module_name = get_module_name
         if module_name.nil?
-          $stderr.puts "Unable to determine module name.  Aborting" if verbose
+          warn 'Unable to determine module name.  Aborting' if verbose
           return false
         end
       end
@@ -52,35 +55,35 @@ END
         File.join('spec', 'hosts'),
         File.join('spec', 'fixtures'),
         File.join('spec', 'fixtures', 'manifests'),
-        File.join('spec', 'fixtures', 'modules'),
+        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)
+    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"
+          warn 'Unable to determine module name.  Aborting'
           return false
         end
       end
 
       target = File.join('spec', 'fixtures', 'modules', module_name)
-      if File.symlink?(target) && File.readlink(target) == File.expand_path('.')
-        File.unlink(target)
-      end
+      return unless File.symlink?(target) && File.readlink(target) == File.expand_path('.')
+
+      File.unlink(target)
     end
-  protected
+
     def self.control_repo?
       !File.exist?('metadata.json')
     end
 
     def self.get_module_name
       module_name = nil
-      Dir["manifests/*.pp"].entries.each do |manifest|
+      Dir['manifests/*.pp'].entries.each do |manifest|
         module_name = get_module_name_from_file(manifest)
         break unless module_name.nil?
       end
@@ -88,35 +91,25 @@ END
     end
 
     def self.get_module_name_from_file(file)
-      # FIXME: see discussion at
-      # https://github.com/rodjek/rspec-puppet/issues/290
-      if Puppet.version.to_f >= 4.0 || RSpec.configuration.parser == 'future'
-        require 'puppet/pops'
-        p = Puppet::Pops::Parser::Lexer2.new
-      else
-        p = Puppet::Parser::Lexer.new
-      end
+      require 'puppet/pops'
+      p = Puppet::Pops::Parser::Lexer2.new
       module_name = nil
       p.string = File.read(file)
       tokens = p.fullscan
 
-      i = tokens.index { |token| [:CLASS, :DEFINE].include? token.first }
-      unless i.nil?
-        module_name = tokens[i + 1].last[:value].split('::').first
-      end
+      i = tokens.index { |token| %i[CLASS DEFINE].include? token.first }
+      module_name = tokens[i + 1].last[:value].split('::').first unless i.nil?
 
       module_name
     end
 
     def self.is_module_dir?
-      Dir["*"].entries.include? "manifests"
+      Dir['*'].entries.include? 'manifests'
     end
 
-    def self.safe_mkdir(dir, verbose=true)
+    def self.safe_mkdir(dir, verbose = true)
       if File.exist? dir
-        unless File.directory? dir
-          $stderr.puts "!! #{dir} already exists and is not a directory"
-        end
+        warn "!! #{dir} already exists and is not a directory" unless File.directory? dir
       else
         begin
           FileUtils.mkdir dir
@@ -129,9 +122,7 @@ END
 
     def self.safe_touch(file)
       if File.exist? file
-        unless File.file? file
-          $stderr.puts "!! #{file} already exists and is not a regular file"
-        end
+        warn "!! #{file} already exists and is not a regular file" unless File.file? file
       else
         FileUtils.touch file
         puts " + #{file}"
@@ -141,9 +132,7 @@ END
     def self.safe_create_file(filename, content)
       if File.exist? filename
         old_content = File.read(filename)
-        if old_content != content
-          $stderr.puts "!! #{filename} already exists and differs from template"
-        end
+        warn "!! #{filename} already exists and differs from template" if old_content != content
       else
         File.open(filename, 'w') do |f|
           f.puts content
@@ -169,17 +158,17 @@ END
       Dir.respond_to?(:junction?) ? Dir.junction?(target) : File.symlink?(target)
     end
 
-    def self.safe_make_link(source, target, verbose=true)
+    def self.safe_make_link(source, target, verbose = true)
       if File.exist?(target) && !link?(target)
-        $stderr.puts "!! #{target} already exists and is not a symlink"
+        warn "!! #{target} already exists and is not a symlink"
         return
       end
 
       return if link_to_source?(target, source)
 
       if Puppet::Util::Platform.windows?
-        output = `call mklink /J "#{target.gsub('/', '\\')}" "#{source}"`
-        unless $?.success?
+        output = `call mklink /J "#{target.tr('/', '\\')}" "#{source}"`
+        unless $CHILD_STATUS.success?
           puts output
           abort
         end
@@ -194,19 +183,19 @@ END
     end
 
     def self.safe_create_rakefile
-      content = <<-'EOF'
-require 'rspec-puppet/rake_task'
+      content = <<~EOF
+        require 'rspec-puppet/rake_task'
 
-begin
-  if Gem::Specification::find_by_name('puppet-lint')
-    require 'puppet-lint/tasks/puppet-lint'
-    PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "vendor/**/*.pp"]
-    task :default => [:rspec, :lint]
-  end
-rescue Gem::LoadError
-  task :default => :rspec
-end
-EOF
+        begin
+          if Gem::Specification::find_by_name('puppet-lint')
+            require 'puppet-lint/tasks/puppet-lint'
+            PuppetLint.configuration.ignore_paths = ["spec/**/*.pp", "vendor/**/*.pp"]
+            task :default => [:rspec, :lint]
+          end
+        rescue Gem::LoadError
+          task :default => :rspec
+        end
+      EOF
       safe_create_file('Rakefile', content)
     end
   end