rspec-puppet 3.0.0 → 4.0.0

data/lib/rspec-puppet/adapters.rb

@@ -12,12 +12,6 @@ module RSpec::Puppet
       # executing RSpec context. When a setting is specified both in the global configuration and in
       # the example group, the setting in the example group is preferred.
       #
-      # @example Configuring a Puppet setting from a global RSpec configuration value
-      #   RSpec.configure do |config|
-      #     config.parser = "future"
-      #   end
-      #   # => Puppet[:parser] will be future
-      #
       # @example Configuring a Puppet setting from within an RSpec example group
       #   RSpec.describe 'my_module::my_class', :type => :class do
       #     let(:module_path) { "/Users/luke/modules" }
@@ -42,6 +36,19 @@ module RSpec::Puppet
       # @param example_group [RSpec::Core::ExampleGroup] The RSpec context to use for local settings
       # @return [void]
       def setup_puppet(example_group)
+        case RSpec.configuration.facter_implementation.to_sym
+        when :rspec
+          # Lazily instantiate FacterTestImpl here to optimize memory
+          # allocation, as the proc will only be called if FacterImpl is unset
+          set_facter_impl(proc { RSpec::Puppet::FacterTestImpl.new })
+        when :facter
+          set_facter_impl(Facter)
+        else
+          raise "Unsupported facter_implementation '#{RSpec.configuration.facter_implementation}'"
+        end
+
+        Puppet.runtime[:facter] = FacterImpl
+
         settings = settings_map.map do |puppet_setting, rspec_setting|
           [puppet_setting, get_setting(example_group, rspec_setting)]
         end.flatten
@@ -56,82 +63,14 @@ module RSpec::Puppet
           end
         end
 
-        if Puppet.settings.respond_to?(:initialize_app_defaults)
-          Puppet.settings.initialize_app_defaults(settings_hash)
+        Puppet.settings.initialize_app_defaults(settings_hash)
 
-          # Forcefully apply the environmentpath setting instead of relying on
-          # the application defaults as Puppet::Test::TestHelper automatically
-          # sets this value as well, overriding our application default
-          Puppet.settings[:environmentpath] = settings_hash[:environmentpath] if settings_hash.key?(:environmentpath)
-        else
-          # Set settings the old way for Puppet 2.x, because that's how
-          # they're defaulted in that version of Puppet::Test::TestHelper and
-          # we won't be able to override them otherwise.
-          settings_hash.each do |setting, value|
-            Puppet.settings[setting] = value
-          end
-        end
+        # Forcefully apply the environmentpath setting instead of relying on
+        # the application defaults as Puppet::Test::TestHelper automatically
+        # sets this value as well, overriding our application default
+        Puppet.settings[:environmentpath] = settings_hash[:environmentpath] if settings_hash.key?(:environmentpath)
 
         @environment_name = example_group.environment
-      end
-
-      def get_setting(example_group, rspec_setting)
-        if example_group.respond_to?(rspec_setting)
-          example_group.send(rspec_setting)
-        else
-          RSpec.configuration.send(rspec_setting)
-        end
-      end
-
-      def catalog(node, exported)
-        if exported
-          # Use the compiler directly to skip the filtering done by the indirector
-          Puppet::Parser::Compiler.compile(node).filter { |r| !r.exported? }
-        else
-          Puppet::Resource::Catalog.indirection.find(node.name, use_node: node)
-        end
-      end
-
-      def current_environment
-        Puppet::Node::Environment.new(@environment_name)
-      end
-
-      def settings_map
-        [
-          %i[modulepath module_path],
-          %i[config config],
-          %i[confdir confdir]
-        ]
-      end
-
-      def modulepath
-        Puppet[:modulepath].split(File::PATH_SEPARATOR)
-      end
-
-      # @return [String, nil] The path to the Puppet manifest if it is present and set, nil otherwise.
-      def manifest
-        Puppet[:manifest]
-      end
-    end
-
-    class Adapter40 < Base
-      #
-      # @api private
-      #
-      # Set the FacterImpl constant to the given Facter implementation or noop
-      # if the constant is already set. If a proc is given, it will only be
-      # called if FacterImpl is not defined.
-      #
-      # @param impl [Object, Proc] An object or a proc that implements the Facter API
-      def set_facter_impl(impl)
-        return if defined?(FacterImpl)
-
-        impl = impl.call if impl.is_a?(Proc)
-        Object.send(:const_set, :FacterImpl, impl)
-      end
-
-      def setup_puppet(example_group)
-        super
 
         modulepath = if (rspec_modulepath = RSpec.configuration.module_path)
                        rspec_modulepath.split(File::PATH_SEPARATOR)
@@ -162,19 +101,18 @@ module RSpec::Puppet
           {
             environments: loader,
             current_environment: env,
-            loaders: (Puppet::Pops::Loaders.new(env) if Gem::Version.new(Puppet.version) >= Gem::Version.new('6.0.0'))
+            loaders: Puppet::Pops::Loaders.new(env)
           },
           'Setup rspec-puppet environments'
         )
       end
 
-      def settings_map
-        super.push(
-          %i[environmentpath environmentpath],
-          %i[hiera_config hiera_config],
-          %i[strict_variables strict_variables],
-          %i[manifest manifest]
-        )
+      def get_setting(example_group, rspec_setting)
+        if example_group.respond_to?(rspec_setting)
+          example_group.send(rspec_setting)
+        else
+          RSpec.configuration.send(rspec_setting)
+        end
       end
 
       def catalog(node, exported)
@@ -182,10 +120,36 @@ module RSpec::Puppet
         # Override $::environment to workaround PUP-5835, where Puppet otherwise
         # stores a symbol for the parameter
         if node.parameters['environment'] != node.parameters['environment'].to_s
-          node.parameters['environment'] =
-            current_environment.name.to_s
+          node.parameters['environment'] = current_environment.name.to_s
         end
-        super
+
+        catalog = if exported
+                    # Use the compiler directly to skip the filtering done by the indirector
+                    Puppet::Parser::Compiler.compile(node).filter { |r| !r.exported? }
+                  else
+                    Puppet::Resource::Catalog.indirection.find(node.name, use_node: node)
+                  end
+
+        Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(node.facts, catalog)
+
+        catalog
+      end
+
+      def current_environment
+        Puppet::Node::Environment.new(@environment_name)
+      end
+
+      def settings_map
+        [
+          %i[modulepath module_path],
+          %i[basemodulepath basemodulepath],
+          %i[config config],
+          %i[confdir confdir],
+          %i[environmentpath environmentpath],
+          %i[hiera_config hiera_config],
+          %i[strict_variables strict_variables],
+          %i[vendormoduledir vendormoduledir]
+        ]
       end
 
       def current_environment
@@ -196,9 +160,6 @@ module RSpec::Puppet
         current_environment.modulepath
       end
 
-      # Puppet 4.0 specially handles environments that don't have a manifest set, so we check for the no manifest value
-      # and return nil when it is set.
-      #
       # @return [String, nil] The path to the Puppet manifest if it is present and set, nil otherwise.
       def manifest
         m = current_environment.manifest
@@ -208,144 +169,25 @@ module RSpec::Puppet
           m
         end
       end
-    end
-
-    class Adapter4X < Adapter40
-      def setup_puppet(example_group)
-        super
-
-        set_facter_impl(Facter)
-      end
-
-      def settings_map
-        super.push(
-          %i[trusted_server_facts trusted_server_facts]
-        )
-      end
-    end
 
-    class Adapter6X < Adapter40
-      #
       # @api private
       #
-      # Check to see if Facter runtime implementations are supported in the
-      # current Puppet version
+      # Set the FacterImpl constant to the given Facter implementation or noop
+      # if the constant is already set. If a proc is given, it will only be
+      # called if FacterImpl is not defined.
       #
-      # @return [Boolean] true if runtime implementations are supported
-      def supports_facter_runtime?
-        unless defined?(@supports_facter_runtime)
-          begin
-            Puppet.runtime[:facter]
-            @supports_facter_runtime = true
-          rescue StandardError
-            @supports_facter_runtime = false
-          end
-        end
-
-        @supports_facter_runtime
-      end
-
-      def setup_puppet(example_group)
-        case RSpec.configuration.facter_implementation.to_sym
-        when :rspec
-          if supports_facter_runtime?
-            # Lazily instantiate FacterTestImpl here to optimize memory
-            # allocation, as the proc will only be called if FacterImpl is unset
-            set_facter_impl(proc { RSpec::Puppet::FacterTestImpl.new })
-            Puppet.runtime[:facter] = FacterImpl
-          else
-            warn "Facter runtime implementations are not supported in Puppet #{Puppet.version}, continuing with facter_implementation 'facter'"
-            RSpec.configuration.facter_implementation = :facter
-            set_facter_impl(Facter)
-          end
-        when :facter
-          set_facter_impl(Facter)
-        else
-          raise "Unsupported facter_implementation '#{RSpec.configuration.facter_implementation}'"
-        end
-
-        super
-      end
-
-      def settings_map
-        super.push(
-          %i[basemodulepath basemodulepath],
-          %i[vendormoduledir vendormoduledir]
-        )
-      end
-
-      def catalog(node, _exported)
-        super.tap do |c|
-          Puppet::Pops::Evaluator::DeferredResolver.resolve_and_replace(node.facts, c)
-        end
-      end
-    end
-
-    class Adapter30 < Base
-      def settings_map
-        super.push(
-          %i[manifestdir manifest_dir],
-          %i[manifest manifest],
-          %i[templatedir template_dir],
-          %i[hiera_config hiera_config]
-        )
-      end
-    end
-
-    class Adapter32 < Adapter30
-      def settings_map
-        super.push(
-          %i[parser parser]
-        )
-      end
-    end
-
-    class Adapter33 < Adapter32
-      def settings_map
-        super.push(
-          %i[ordering ordering],
-          %i[stringify_facts stringify_facts]
-        )
-      end
-    end
-
-    class Adapter34 < Adapter33
-      def settings_map
-        super.push(
-          %i[trusted_node_data trusted_node_data]
-        )
-      end
-    end
-
-    class Adapter35 < Adapter34
-      def settings_map
-        super.push(
-          %i[strict_variables strict_variables]
-        )
-      end
-    end
+      # @param impl [Object, Proc] An object or a proc that implements the Facter API
+      def set_facter_impl(impl)
+        return if defined?(FacterImpl)
 
-    class Adapter27 < Base
-      def settings_map
-        super.push(
-          %i[manifestdir manifest_dir],
-          %i[manifest manifest],
-          %i[templatedir template_dir]
-        )
+        impl = impl.call if impl.is_a?(Proc)
+        Object.send(:const_set, :FacterImpl, impl)
       end
     end
 
     def self.get
       [
-        ['6.0', Adapter6X],
-        ['4.1', Adapter4X],
-        ['4.0', Adapter40],
-        ['3.5', Adapter35],
-        ['3.4', Adapter34],
-        ['3.3', Adapter33],
-        ['3.2', Adapter32],
-        ['3.0', Adapter30],
-        ['2.7', Adapter27]
+        ['7.11', Base]
       ].each do |(version, klass)|
         return klass.new if Puppet::Util::Package.versioncmp(Puppet.version, version) >= 0
       end

data/lib/rspec-puppet/consts.rb

@@ -10,7 +10,7 @@ module RSpec::Puppet::Consts
     windows: {
       'File::PATH_SEPARATOR' => ';',
       'File::ALT_SEPARATOR' => '\\',
-      'Pathname::SEPARATOR_PAT' => /[#{Regexp.quote("\\")}#{Regexp.quote('/')}]/
+      'Pathname::SEPARATOR_PAT' => /[#{Regexp.quote('\\')}#{Regexp.quote('/')}]/
     }
   }.freeze
 

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

@@ -88,19 +88,17 @@ module RSpec::Puppet
       with_vardir do
         env = adapter.current_environment
 
-        if Puppet.version.to_f >= 4.0
-          context_overrides = compiler.context_overrides
-          func = nil
-          loaders = Puppet.lookup(:loaders)
-          Puppet.override(context_overrides, 'rspec-test scope') do
-            func = V4FunctionWrapper.new(function_name,
-                                         loaders.private_environment_loader.load(:function, function_name), context_overrides)
-            @scope = context_overrides[:global_scope]
-          end
-
-          return func if func.func
+        context_overrides = compiler.context_overrides
+        func = nil
+        loaders = Puppet.lookup(:loaders)
+        Puppet.override(context_overrides, 'rspec-test scope') do
+          func = V4FunctionWrapper.new(function_name,
+                                       loaders.private_environment_loader.load(:function, function_name), context_overrides)
+          @scope = context_overrides[:global_scope]
         end
 
+        return func if func.func
+
         if Puppet::Parser::Functions.function(function_name)
           V3FunctionWrapper.new(function_name, scope.method("function_#{function_name}".intern))
         end
@@ -157,46 +155,28 @@ module RSpec::Puppet
 
       node = build_node(node_name, node_options)
 
-      if Puppet::Util::Package.versioncmp(Puppet.version, '4.3.0') >= 0
-        Puppet.push_context(
-          {
-            trusted_information: Puppet::Context::TrustedInformation.new('remote', node_name, trusted_values)
-          },
-          'Context for spec trusted hash'
-        )
-      end
+      Puppet.push_context(
+        {
+          trusted_information: Puppet::Context::TrustedInformation.new('remote', node_name, trusted_values)
+        },
+        'Context for spec trusted hash'
+      )
 
       compiler = Puppet::Parser::Compiler.new(node)
       compiler.compile
-      if Puppet::Util::Package.versioncmp(Puppet.version, '4.0.0') >= 0
-        loaders = Puppet::Pops::Loaders.new(adapter.current_environment)
-        Puppet.push_context(
-          {
-            loaders: loaders,
-            global_scope: compiler.context_overrides[:global_scope]
-          },
-          'set globals'
-        )
-      end
+      loaders = Puppet::Pops::Loaders.new(adapter.current_environment)
+      Puppet.push_context(
+        {
+          loaders: loaders,
+          global_scope: compiler.context_overrides[:global_scope]
+        },
+        'set globals'
+      )
       compiler
     end
 
-    def build_scope(compiler, node_name)
-      if Puppet.version.to_f >= 4.0
-        return compiler.context_overrides[:global_scope]
-      elsif /^2\.[67]/.match?(Puppet.version)
-        # 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
-        Puppet::Parser::Functions.autoloader.loadall
-        scope = Puppet::Parser::Scope.new(compiler: compiler)
-      else
-        scope = Puppet::Parser::Scope.new(compiler)
-      end
-
-      scope.source = Puppet::Resource::Type.new(:node, node_name)
-      scope.parent = compiler.topscope
-      scope
+    def build_scope(compiler, _node_name)
+      compiler.context_overrides[:global_scope]
     end
 
     def build_node(name, opts = {})

data/lib/rspec-puppet/example.rb

@@ -8,7 +8,6 @@ require 'rspec-puppet/example/host_example_group'
 require 'rspec-puppet/example/type_example_group'
 require 'rspec-puppet/example/type_alias_example_group'
 require 'rspec-puppet/example/provider_example_group'
-require 'rspec-puppet/example/application_example_group'
 
 RSpec.configure do |c|
   def c.rspec_puppet_include(group, type, file_path)
@@ -25,7 +24,6 @@ RSpec.configure do |c|
   c.rspec_puppet_include RSpec::Puppet::TypeExampleGroup, :type, %w[spec types]
   c.rspec_puppet_include RSpec::Puppet::TypeAliasExampleGroup, :type_alias, %w[spec type_aliases]
   c.rspec_puppet_include RSpec::Puppet::ProviderExampleGroup, :provider, %w[spec providers]
-  c.rspec_puppet_include RSpec::Puppet::ApplicationExampleGroup, :application, %w[spec applications]
 
   # Hook for each example group type to remove any caches or instance variables, since they will remain
   # and cause a memory leak.  Can't be assigned per type by :file_path, so check for its presence.

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

@@ -96,7 +96,7 @@ module RSpec::Puppet
           vertex.each do |param, value|
             next unless %i[require subscribe notify before].include? param
 
-            value = Array[value] unless value.is_a? Array
+            value = [value] unless value.is_a? Array
             value.each do |val|
               retval = true if val.is_a?(Puppet::Resource) && !resource_exists?(val, vertex)
             end

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

@@ -290,7 +290,7 @@ module RSpec::Puppet
 
         visited << resource.object_id
 
-        Array[resource[type]].flatten.compact.each do |r|
+        [resource[type]].flatten.compact.each do |r|
           results << canonicalize_resource_ref(r)
           results << relationship_refs(r, type, visited)
 

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

@@ -26,8 +26,8 @@ module RSpec::Puppet
   end
 
   module TypeMatchers
-    def method_missing(method, *args, &block)
-      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, *args, &block) if method == :be_valid_type
+    def method_missing(method, ...)
+      return RSpec::Puppet::TypeMatchers::CreateGeneric.new(method, ...) if method == :be_valid_type
 
       super
     end

data/lib/rspec-puppet/monkey_patches.rb

@@ -11,16 +11,11 @@ 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)
@@ -39,12 +34,6 @@ class RSpec::Puppet::EventListener
     @rspec_puppet_example || false
   end
 
-  def self.rspec3?
-    @rspec3 = defined?(RSpec::Core::Notifications) if @rspec3.nil?
-
-    @rspec3
-  end
-
   class << self
     attr_reader :current_example
   end
@@ -267,42 +256,40 @@ module Puppet
     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_call(self)
       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)
-          unless mod
-            raise Puppet::DataBinding::LookupError,
-                  format(_("Environment '%<env>s', cannot find module '%<module_name>s'"), env: env.name,
-                                                                                           module_name: module_name)
-          end
-
-          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_call(self, lookup_invocation)
+
+        return Pathname.new(mod.hiera_conf_file)
       end
+      old_configuration_path.bind_call(self, lookup_invocation)
     end
   end
 end