rspec-puppet 2.11.0 → 4.0.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module DefineExampleGroup
     include RSpec::Puppet::ManifestMatchers
@@ -8,7 +10,7 @@ module RSpec::Puppet
     end
 
     def exported_resources
-      lambda { load_catalogue(:define, true) }
+      -> { load_catalogue(:define, true) }
     end
 
     def rspec_puppet_cleanup

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module FunctionExampleGroup
     include RSpec::Puppet::FunctionMatchers
@@ -15,14 +17,14 @@ module RSpec::Puppet
 
       # 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, &block)
-        Puppet.override(@overrides, "rspec-test scope") do
+        Puppet.override(@overrides, 'rspec-test scope') do
           @func.call(@overrides[:global_scope], *freeze_arg(args), &block)
         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()")
+      def call(_scope, *args)
+        RSpec.deprecate('subject.call', replacement: 'is_expected.to run.with().and_raise_error(), or execute()')
         execute(*args)
       end
 
@@ -36,7 +38,10 @@ module RSpec::Puppet
           arg.each { |a| freeze_arg(a) }
           arg.freeze
         when Hash
-          arg.each { |k,v| freeze_arg(k); freeze_arg(v) }
+          arg.each do |k, v|
+            freeze_arg(k)
+            freeze_arg(v)
+          end
           arg.freeze
         when String
           arg.freeze
@@ -64,7 +69,7 @@ module RSpec::Puppet
 
       # 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()")
+        RSpec.deprecate('subject.call', replacement: 'is_expected.to run.with().and_raise_error(), or execute()')
         if args.nil?
           @func.call
         else
@@ -83,30 +88,27 @@ 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))
-        else
-          nil
         end
       end
     end
+
     def call_function(function_name, *args)
-#      function = find_function(function_name)
-#      function.execute(*args)
-     scope.call_function(function_name, args)
+      scope.call_function(function_name, args)
     end
+
     def scope
       @scope ||= build_scope(compiler, nodename(:function))
     end
@@ -135,7 +137,7 @@ module RSpec::Puppet
       trusted_values = trusted_facts_hash(node_name)
 
       # Allow different Hiera configurations:
-      HieraPuppet.instance_variable_set('@hiera', nil) if defined? HieraPuppet
+      HieraPuppet.instance_variable_set(:@hiera, nil) if defined? HieraPuppet
 
       # if we specify a pre_condition, we should ensure that we compile that
       # code into a catalog that is accessible from the scope where the
@@ -145,58 +147,41 @@ module RSpec::Puppet
       node_facts = Puppet::Node::Facts.new(node_name, fact_values.dup)
 
       node_options = {
-        :parameters => fact_values,
-        :facts => node_facts
+        parameters: fact_values,
+        facts: node_facts
       }
 
       stub_facts! fact_values
 
       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 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
-        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 = {})
       node_environment = adapter.current_environment
-      opts.merge!({:environment => node_environment})
+      opts[:environment] = node_environment
       Puppet::Node.new(name, opts)
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module HostExampleGroup
     include RSpec::Puppet::ManifestMatchers
@@ -8,7 +10,7 @@ module RSpec::Puppet
     end
 
     def exported_resources
-      lambda { load_catalogue(:host, true) }
+      -> { load_catalogue(:host, true) }
     end
 
     def rspec_puppet_cleanup

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module ProviderExampleGroup
   end

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

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module TypeAliasExampleGroup
     include RSpec::Puppet::TypeAliasMatchers
     include RSpec::Puppet::Support
 
     def catalogue(test_value)
-      load_catalogue(:type_alias, false, :test_value => test_value)
+      load_catalogue(:type_alias, false, test_value: test_value)
     end
 
     def subject
-      lambda { |test_value| catalogue(test_value) }
+      ->(test_value) { catalogue(test_value) }
     end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module TypeExampleGroup
     include RSpec::Puppet::TypeMatchers
@@ -7,7 +9,7 @@ module RSpec::Puppet
       @type_and_resource ||= begin
         setup_puppet
         type_name = self.class.top_level_description.downcase
-        my_params = self.respond_to?(:params) ? params : {}
+        my_params = respond_to?(:params) ? params : {}
         [
           Puppet::Type.type(type_name),
           # I don't want to create the resource here, so I have

data/lib/rspec-puppet/example.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec-puppet/support'
 require 'rspec-puppet/example/define_example_group'
 require 'rspec-puppet/example/class_example_group'
@@ -6,17 +8,13 @@ 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|
 
+RSpec.configure do |c|
   def c.rspec_puppet_include(group, type, file_path)
     escaped_file_path = Regexp.compile(file_path.join('[\\\/]'))
-    if RSpec::Version::STRING < '3'
-      self.include group, :type => type, :example_group => { :file_path => escaped_file_path }, :spec_type => type
-    else
-      self.include group, :type => type, :file_path => lambda { |file_path, metadata| metadata[:type].nil? && escaped_file_path =~ file_path }
-    end
+    include group, type: type, file_path: lambda { |file_path, metadata|
+                                            metadata[:type].nil? && escaped_file_path =~ file_path
+                                          }
   end
 
   c.rspec_puppet_include RSpec::Puppet::DefineExampleGroup, :define, %w[spec defines]
@@ -26,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/facter_impl.rb

@@ -1,5 +1,6 @@
-module RSpec::Puppet
+# frozen_string_literal: true
 
+module RSpec::Puppet
   # Implements a simple hash-based version of Facter to be used in module tests
   # that use rspec-puppet.
   class FacterTestImpl
@@ -8,7 +9,9 @@ module RSpec::Puppet
     end
 
     def value(fact_name)
-      @facts[fact_name.to_s]
+      @facts.dig(*fact_name.to_s.split('.'))
+    rescue TypeError
+      nil
     end
 
     def clear
@@ -19,8 +22,9 @@ module RSpec::Puppet
       @facts
     end
 
-    def add(name, options = {}, &block)
-      raise 'Facter.add expects a block' unless block_given?
+    def add(name, _options = {}, &block)
+      raise 'Facter.add expects a block' unless block
+
       @facts[name.to_s] = instance_eval(&block)
     end
 
@@ -36,14 +40,11 @@ module RSpec::Puppet
     private
 
     def setcode(string = nil, &block)
-      if block_given?
-        value = block.call
+      if block
+        yield
       else
-        value = string
+        string
       end
-
-      value
     end
   end
 end
-

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module TypeAliasMatchers
     class AllowValue
@@ -8,13 +10,11 @@ module RSpec::Puppet
 
       def matches?(catalogue)
         matches = @values.map do |test_value|
-          begin
-            catalogue.call(test_value)
-            true
-          rescue Puppet::Error => e
-            @error_msgs << e.message
-            false
-          end
+          catalogue.call(test_value)
+          true
+        rescue Puppet::Error => e
+          @error_msgs << e.message
+          false
         end
         matches.all?
       end
@@ -28,11 +28,11 @@ module RSpec::Puppet
       end
 
       def failure_message
-        "expected that the type alias would " + description + " but it raised the #{@error_msgs.length == 1 ? 'error' : 'errors'} #{@error_msgs.join(', ')}"
+        "expected that the type alias would #{description} but it raised the #{@error_msgs.length == 1 ? 'error' : 'errors'} #{@error_msgs.join(', ')}"
       end
 
       def failure_message_when_negated
-        "expected that the type alias would not " + description + " but it does"
+        "expected that the type alias would not #{description} but it does"
       end
 
       def supports_block_expectations
@@ -48,6 +48,6 @@ module RSpec::Puppet
       RSpec::Puppet::TypeAliasMatchers::AllowValue.new(values)
     end
 
-    alias_method :allow_values, :allow_value
+    alias allow_values allow_value
   end
 end

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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module ManifestMatchers
     class Compile
       def initialize
-        @failed_resource = ""
+        @failed_resource = ''
         @check_deps = false
         @cycles = []
-        @error_msg = ""
+        @error_msg = ''
       end
 
       def with_all_deps
@@ -19,31 +21,29 @@ module RSpec::Puppet
       end
 
       def matches?(catalogue)
-        begin
-          @catalogue = catalogue.call
+        @catalogue = catalogue.call
 
-          if cycles_found?
-            false
-          elsif @check_deps == true && missing_dependencies?
-            false
-          else
-            @expected_error.nil?
-          end
-        rescue Puppet::Error => e
-          @error_msg = e.message
-          if @expected_error.nil?
-            false
-          else
-            method = @expected_error.is_a?(Regexp) ? :=~ : :==
-            e.message.send(method, @expected_error)
-          end
+        if cycles_found?
+          false
+        elsif @check_deps == true && missing_dependencies?
+          false
+        else
+          @expected_error.nil?
+        end
+      rescue Puppet::Error => e
+        @error_msg = e.message
+        if @expected_error.nil?
+          false
+        else
+          method = @expected_error.is_a?(Regexp) ? :=~ : :==
+          e.message.send(method, @expected_error)
         end
       end
 
       def description
         case @expected_error
         when nil
-          "compile into a catalogue without dependency cycles"
+          'compile into a catalogue without dependency cycles'
         when Regexp
           "fail to compile and raise an error matching #{@expected_error.inspect}"
         else
@@ -52,12 +52,8 @@ module RSpec::Puppet
       end
 
       def failure_message
-        unless @cycles.empty?
-          "dependency cycles found: #{@cycles.join('; ')}"
-        else
-          unless @error_msg.empty?
-            "error during compilation: #{@error_msg}"
-          else
+        if @cycles.empty?
+          if @error_msg.empty?
             case @expected_error
             when nil
               "expected that the catalogue would include #{@failed_resource}"
@@ -66,15 +62,19 @@ module RSpec::Puppet
             else
               "expected that the catalogue would fail to compile and raise the error #{@expected_error.inspect}"
             end
+          else
+            "error during compilation: #{@error_msg}"
           end
+        else
+          "dependency cycles found: #{@cycles.join('; ')}"
         end
       end
 
       def failure_message_when_negated
         if @expected_error.nil?
-          "expected that the catalogue would not compile but it does"
+          'expected that the catalogue would not compile but it does'
         else
-          "expected that the catalogue would compile but it does not"
+          'expected that the catalogue would compile but it does not'
         end
       end
 
@@ -87,19 +87,18 @@ module RSpec::Puppet
       end
 
       private
+
       def missing_dependencies?
         retval = false
 
         resource_vertices = @catalogue.vertices.select { |v| v.is_a? Puppet::Resource }
         resource_vertices.each do |vertex|
-          vertex.each do |param,value|
-            if [:require, :subscribe, :notify, :before].include? param
-              value = Array[value] unless value.is_a? Array
-              value.each do |val|
-                if val.is_a? Puppet::Resource
-                  retval = true unless resource_exists?(val, vertex)
-                end
-              end
+          vertex.each do |param, value|
+            next unless %i[require subscribe notify before].include? param
+
+            value = [value] unless value.is_a? Array
+            value.each do |val|
+              retval = true if val.is_a?(Puppet::Resource) && !resource_exists?(val, vertex)
             end
           end
         end
@@ -108,19 +107,15 @@ module RSpec::Puppet
       end
 
       def resource_hash
-        @resource_hash ||= Proc.new do
+        @resource_hash ||= proc do
           res_hash = {}
           @catalogue.vertices.each do |vertex|
-            if vertex.is_a? Puppet::Resource
-              res_hash[vertex.ref] = 1
-              if vertex[:alias]
-                res_hash["#{vertex.type.to_s}[#{vertex[:alias]}]"] = 1
-              end
-
-              if vertex.uniqueness_key != [vertex.title]
-                res_hash["#{vertex.type.to_s}[#{vertex.uniqueness_key.first}]"] = 1
-              end
-            end
+            next unless vertex.is_a? Puppet::Resource
+
+            res_hash[vertex.ref] = 1
+            res_hash["#{vertex.type}[#{vertex[:alias]}]"] = 1 if vertex[:alias]
+
+            res_hash["#{vertex.type}[#{vertex.uniqueness_key.first}]"] = 1 if vertex.uniqueness_key != [vertex.title]
           end
           res_hash
         end.call
@@ -129,7 +124,7 @@ module RSpec::Puppet
       def check_resource(res)
         if resource_hash[res.ref]
           true
-        elsif res[:alias] && resource_hash["#{res.type.to_s}[#{res[:alias]}]"]
+        elsif res[:alias] && resource_hash["#{res.type}[#{res[:alias]}]"]
           true
         else
           false
@@ -137,11 +132,11 @@ module RSpec::Puppet
       end
 
       def resource_exists?(res, vertex)
-        unless check_resource(res)
+        if check_resource(res)
+          true
+        else
           @failed_resource = "#{res.ref} used at #{vertex.file}:#{vertex.line} in #{vertex.ref}"
           false
-        else
-          true
         end
       end
 
@@ -159,20 +154,18 @@ module RSpec::Puppet
 
       def find_cycles(catalogue)
         cycles = catalogue.find_cycles_in_graph
-        if cycles.length > 0
-          cycles.each do |cycle|
-            paths = catalogue.paths_in_cycle(cycle)
-            @cycles << (paths.map{ |path| '(' + path.join(" => ") + ')'}.join("\n") + "\n")
-          end
+        return unless cycles.length.positive?
+
+        cycles.each do |cycle|
+          paths = catalogue.paths_in_cycle(cycle)
+          @cycles << (paths.map { |path| "(#{path.join(' => ')})" }.join("\n") + "\n")
         end
       end
 
       def find_cycles_legacy(catalogue)
-        begin
-          catalogue.topsort
-        rescue Puppet::Error => e
-          @cycles = [e.message.rpartition(';').first.partition(':').last]
-        end
+        catalogue.topsort
+      rescue Puppet::Error => e
+        @cycles = [e.message.rpartition(';').first.partition(':').last]
       end
     end
   end

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

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 module RSpec::Puppet
   module ManifestMatchers
     class CountGeneric
       DEFAULT_RESOURCES = [
         'Class[main]',
         'Class[Settings]',
-        'Stage[main]',
+        'Stage[main]'
       ].freeze
 
       attr_reader :resource_type
 
       def initialize(type, count, *method)
-        if type.nil?
-          @type = method[0].to_s.gsub(/^have_(.+)_resource_count$/, '\1')
-        else
-          @type = type
-        end
+        @type = if type.nil?
+                  method[0].to_s.gsub(/^have_(.+)_resource_count$/, '\1')
+                else
+                  type
+                end
         @resource_type = referenced_type(@type)
         @expected_number = count.to_i
       end
@@ -28,7 +30,7 @@ module RSpec::Puppet
 
         @actual_number = if @type == 'resource'
                            resources.count do |res|
-                             !['Class', 'Node'].include?(res.type)
+                             !%w[Class Node].include?(res.type)
                            end
                          else
                            resources.count do |res|
@@ -43,24 +45,22 @@ module RSpec::Puppet
         desc = []
 
         desc << "contain exactly #{@expected_number}"
-        if @type == "class"
-          desc << "#{@expected_number == 1 ? "class" : "classes" }"
+        if @type == 'class'
+          desc << (@expected_number == 1 ? 'class' : 'classes').to_s
         else
-          unless @type == "resource"
-            desc << "#{@resource_type}"
-          end
-          desc << "#{@expected_number == 1 ? "resource" : "resources" }"
+          desc << @resource_type.to_s unless @type == 'resource'
+          desc << (@expected_number == 1 ? 'resource' : 'resources').to_s
         end
 
-        desc.join(" ")
+        desc.join(' ')
       end
 
       def failure_message
-        "expected that the catalogue would " + description + " but it contains #{@actual_number}"
+        "expected that the catalogue would #{description} but it contains #{@actual_number}"
       end
 
       def failure_message_when_negated
-        "expected that the catalogue would not " + description + " but it does"
+        "expected that the catalogue would not #{description} but it does"
       end
 
       def supports_block_expectations
@@ -71,10 +71,10 @@ module RSpec::Puppet
         true
       end
 
-    private
+      private
 
       def referenced_type(type)
-        type.split('__').map { |r| r.capitalize }.join('::')
+        type.split('__').map(&:capitalize).join('::')
       end
     end