puppet 6.10.1 → 6.11.0

data/lib/puppet/network/resolver.rb

@@ -23,8 +23,8 @@ module Puppet::Network
       end
     end
 
-    def initialize
-      @resolver = Resolv::DNS.new
+    def initialize(resolver = Resolv::DNS.new)
+      @resolver = resolver
 
       # Stores DNS records per service, along with their TTL
       # and the time at which they were resolved, for cache
@@ -50,7 +50,7 @@ module Puppet::Network
       case service_name
         when :puppet then service = '_x-puppet'
         when :file   then service = '_x-puppet-fileserver'
-        else              service = "_x-puppet-#{service_name.to_s}"
+        else              service = "_x-puppet-#{service_name}"
       end
       record_name = "#{service}._tcp.#{domain}"
 
@@ -72,7 +72,7 @@ module Puppet::Network
       else
         each_priority(records) do |recs|
           while next_rr = recs.delete(find_weighted_server(recs)) #rubocop:disable Lint/AssignmentInCondition
-            Puppet.debug "Yielding next server of #{next_rr.target.to_s}:#{next_rr.port}"
+            Puppet.debug "Yielding next server of #{next_rr.target}:#{next_rr.port}"
             yield next_rr.target.to_s, next_rr.port
           end
         end

data/lib/puppet/node/environment.rb

@@ -480,8 +480,7 @@ class Puppet::Node::Environment
     [self.class, name, full_modulepath, manifest].hash
   end
 
-  private
-
+  # not private so it can be called in tests
   def self.extralibs()
     if Puppet::Util.get_env('PUPPETLIB')
       split_path(Puppet::Util.get_env('PUPPETLIB'))
@@ -490,12 +489,15 @@ class Puppet::Node::Environment
     end
   end
 
+  # not private so it can be called in initialize
   def self.expand_dirs(dirs)
     dirs.collect do |dir|
       Puppet::FileSystem.expand_path(dir)
     end
   end
 
+  private
+
   # Reparse the manifests for the given environment
   #
   # There are two sources that can be used for the initial parse:

data/lib/puppet/pal/pal_impl.rb

@@ -470,8 +470,8 @@ module Pal
           end
         end
 
-      rescue Puppet::ParseErrorWithIssue, Puppet::Error
-        # already logged and handled by the compiler for these two cases
+      rescue Puppet::Error
+        # already logged and handled by the compiler, including Puppet::ParseErrorWithIssue
         raise
 
       rescue => detail

data/lib/puppet/parser/ast.rb

@@ -11,7 +11,7 @@ class Puppet::Parser::AST
   attr_accessor :parent, :scope, :file, :line, :pos
 
   def inspect
-    "( #{self.class} #{self.to_s} #{@children.inspect} )"
+    "( #{self.class} #{self} #{@children.inspect} )"
   end
 
   # Evaluate the current object.  Just a stub method, since the subclass

data/lib/puppet/parser/ast/resourceparam.rb

@@ -26,6 +26,6 @@ class Puppet::Parser::AST::ResourceParam < Puppet::Parser::AST::Branch
   end
 
   def to_s
-    "#{@param} => #{@value.to_s}"
+    "#{@param} => #{@value}"
   end
 end

data/lib/puppet/parser/functions.rb

@@ -24,7 +24,7 @@ module Puppet::Parser::Functions
     Puppet::Util::Log.levels.each do |level|
       newfunction(level,
                   :environment => root_env,
-                  :doc => "Log a message on the server at level #{level.to_s}.") do |vals|
+                  :doc => "Log a message on the server at level #{level}.") do |vals|
         send(level, vals.join(" "))
       end
     end

data/lib/puppet/parser/scope.rb

@@ -66,8 +66,8 @@ class Puppet::Parser::Scope
       false
     end
 
-    def add_entries_to(target = {})
-      @parent.add_entries_to(target) unless @parent.nil?
+    def add_entries_to(target = {}, include_undef = false)
+      @parent.add_entries_to(target, include_undef) unless @parent.nil?
       # do not include match data ($0-$n)
       target
     end
@@ -105,10 +105,10 @@ class Puppet::Parser::Scope
       @symbols.include?(name)
     end
 
-    def add_entries_to(target = {})
+    def add_entries_to(target = {}, include_undef = false)
       super
       @symbols.each do |k, v|
-        if v == :undef || v.nil?
+        if (v == :undef || v.nil?) && !include_undef
           target.delete(k)
         else
           target[ k ] = v
@@ -160,7 +160,7 @@ class Puppet::Parser::Scope
       raise Puppet::ParseError, _("Numerical variables cannot be deleted: Attempt to delete: $%{name}") % { name: name }
     end
 
-    def add_entries_to(target = {})
+    def add_entries_to(target = {}, include_undef = false)
       # do not include match data ($0-$n)
       super
     end
@@ -662,8 +662,9 @@ class Puppet::Parser::Scope
   # Returns a Hash containing all variables and their values, optionally (and
   # by default) including the values defined in parent. Local values
   # shadow parent values. Ephemeral scopes for match results ($0 - $n) are not included.
+  # Optionally include the variables that are explicitly set to `undef`.
   #
-  def to_hash(recursive = true)
+  def to_hash(recursive = true, include_undef = false)
     if recursive and has_enclosing_scope?
       target = enclosing_scope.to_hash(recursive)
       if !(inherited = inherited_scope).nil?
@@ -674,7 +675,7 @@ class Puppet::Parser::Scope
     end
 
     # add all local scopes
-    @ephemeral.last.add_entries_to(target)
+    @ephemeral.last.add_entries_to(target, include_undef)
     target
   end
 

data/lib/puppet/pops/evaluator/collectors/catalog_collector.rb

@@ -24,6 +24,6 @@ class Puppet::Pops::Evaluator::Collectors::CatalogCollector < Puppet::Pops::Eval
   end
 
   def to_s
-    "Catalog-Collector[#{@type.to_s}]"
+    "Catalog-Collector[#{@type}]"
   end
 end

data/lib/puppet/pops/evaluator/collectors/exported_collector.rb

@@ -65,6 +65,6 @@ class Puppet::Pops::Evaluator::Collectors::ExportedCollector < Puppet::Pops::Eva
   end
 
   def to_s
-    "Exported-Collector[#{@type.to_s}]"
+    "Exported-Collector[#{@type}]"
   end
 end

data/lib/puppet/pops/evaluator/external_syntax_support.rb

@@ -35,10 +35,11 @@ module Puppet::Pops::Evaluator::ExternalSyntaxSupport
   def lookup_keys_for_syntax(syntax)
     segments = syntax.split(/\+/)
     result = []
-    begin
+    loop do
       result << segments.join("+")
       segments.shift
-    end until segments.empty?
+      break if segments.empty?
+    end
     result
   end
 

data/lib/puppet/pops/evaluator/runtime3_support.rb

@@ -298,14 +298,11 @@ module Runtime3Support
   def call_function(name, args, o, scope, &block)
     file, line = extract_file_line(o)
     loader = Adapters::LoaderAdapter.loader_for_model_object(o, file)
-    # 'ruby -wc' thinks that _func is unused, because the only reference to it
-    # is inside of the Kernel.eval string below. By prefixing it with the
-    # underscore, we let Ruby know to not worry about whether it's unused or not.
-    _func = loader.load(:function, name) if loader
-    if _func
+    func = loader.load(:function, name) if loader
+    if func
       Puppet::Util::Profiler.profile(name, [:functions, name]) do
-        # Add stack frame when calling. See Puppet::Pops::PuppetStack
-        return Kernel.eval('_func.call(scope, *args, &block)'.freeze, Kernel.binding, file || '', line)
+        # Add stack frame when calling.
+        return Puppet::Pops::PuppetStack.stack(file || '', line, func, :call, [scope, *args], &block)
       end
     end
     # Call via 3x API if function exists there without having been autoloaded

data/lib/puppet/pops/loader/module_loaders.rb

@@ -33,7 +33,7 @@ module ModuleLoaders
       NAMESPACE_WILDCARD,
       Puppet[:libdir],
       'cached_puppet_lib',
-      [:func_4x, :datatype]
+      [:func_4x, :func_3x, :datatype]
     )
   end
 

data/lib/puppet/pops/loader/task_instantiator.rb

@@ -18,6 +18,10 @@ class TaskInstantiator
     task = { 'name' => name, 'metadata' => metadata, 'files' => files }
 
     begin
+      unless metadata['parameters'].is_a?(Hash) || metadata['parameters'].nil?
+        msg = _('Failed to load metadata for task %{name}: \'parameters\' must be a hash') % { name: name }
+        raise Puppet::ParseError.new(msg, metadata_file)
+      end
       task['parameters'] = convert_types(metadata['parameters'])
 
       Types::TypeFactory.task.from_hash(task)

data/lib/puppet/pops/loaders.rb

@@ -283,7 +283,7 @@ class Loaders
         nil
       elsif File.directory?(file)
         raise Puppet::Error, "manifest of environment '#{@environment.name}' appoints directory '#{file}'. It must be a file"
-      elsif File.exists?(file)
+      elsif File.exist?(file)
         parser.parse_file(file)
       else
         raise Puppet::Error, "manifest of environment '#{@environment.name}' appoints '#{file}'. It does not exist"

data/lib/puppet/pops/lookup/hiera_config.rb

@@ -339,6 +339,7 @@ class HieraConfig
   def self.not_implemented(impl, method_name)
     raise NotImplementedError, "The class #{impl.class.name} should have implemented the method #{method_name}()"
   end
+  private_class_method :not_implemented
 end
 
 # @api private

data/lib/puppet/pops/lookup/sub_lookup.rb

@@ -30,7 +30,7 @@ module SubLookup
       raise yield('Syntax error') unless segments.size * 2 == count + 1
       segments.map! do |segment|
         segment.strip!
-        if segment.start_with?('"') || segment.start_with?("'")
+        if segment.start_with?('"', "'")
           segment[1..-2]
         elsif segment =~ /^(:?[+-]?[0-9]+)$/
           segment.to_i

data/lib/puppet/pops/merge_strategy.rb

@@ -173,12 +173,14 @@ module Puppet::Pops
 
     protected
 
-    # Returns the type used to validate the options hash
-    #
-    # @return [Types::PStructType] the puppet type
-    #
-    def self.options_t
-      @options_t ||=Types::TypeParser.singleton.parse("Struct[{strategy=>Optional[Pattern[/#{key}/]]}]")
+    class << self
+      # Returns the type used to validate the options hash
+      #
+      # @return [Types::PStructType] the puppet type
+      #
+      def options_t
+        @options_t ||=Types::TypeParser.singleton.parse("Struct[{strategy=>Optional[Pattern[/#{key}/]]}]")
+      end
     end
 
     # Returns the type used to validate the options hash
@@ -383,18 +385,20 @@ module Puppet::Pops
 
     protected
 
-    # Returns a type that allows all deep_merge options except 'preserve_unmergeables' since we force
-    # the setting of that option to false
-    #
-    # @return [Types::PAnyType] the puppet type used when validating the options hash
-    def self.options_t
-      @options_t ||= Types::TypeParser.singleton.parse('Struct[{'\
-          "strategy=>Optional[Pattern[#{key}]],"\
-          'knockout_prefix=>Optional[String],'\
-          'merge_debug=>Optional[Boolean],'\
-          'merge_hash_arrays=>Optional[Boolean],'\
-          'sort_merged_arrays=>Optional[Boolean],'\
-          '}]')
+    class << self
+      # Returns a type that allows all deep_merge options except 'preserve_unmergeables' since we force
+      # the setting of that option to false
+      #
+      # @return [Types::PAnyType] the puppet type used when validating the options hash
+      def options_t
+        @options_t ||= Types::TypeParser.singleton.parse('Struct[{'\
+                                                         "strategy=>Optional[Pattern[#{key}]],"\
+                                                         'knockout_prefix=>Optional[String],'\
+                                                         'merge_debug=>Optional[Boolean],'\
+                                                         'merge_hash_arrays=>Optional[Boolean],'\
+                                                         'sort_merged_arrays=>Optional[Boolean],'\
+                                                         '}]')
+      end
     end
 
     def value_t

data/lib/puppet/pops/parser/heredoc_support.rb

@@ -137,7 +137,7 @@ module HeredocSupport
       # simply leaves lines that have text in the margin untouched.
       #
       processed_lines = lines.collect {|s| s.gsub(leading_pattern, '') }
-      margin_per_line = processed_lines.length.times.map {|x| lines[x].length - processed_lines[x].length }
+      margin_per_line = Array.new(processed_lines.length) {|x| lines[x].length - processed_lines[x].length }
       lines = processed_lines
     else
       # Array with a 0 per line

data/lib/puppet/pops/parser/interpolation_support.rb

@@ -23,7 +23,7 @@ module Puppet::Pops::Parser::InterpolationSupport
     value,terminator = slurp_dqstring()
     text = value
     after = scn.pos
-    while true
+    loop do
       case terminator
       when '"'
         # simple case, there was no interpolation, return directly
@@ -64,7 +64,7 @@ module Puppet::Pops::Parser::InterpolationSupport
     value,terminator = slurp_dqstring
     text = value
     after = scn.pos
-    while true
+    loop do
       case terminator
       when '"'
         # simple case, there was no further interpolation, return directly
@@ -109,7 +109,7 @@ module Puppet::Pops::Parser::InterpolationSupport
     value,terminator = slurp_uqstring()
     text = value
     after = scn.pos
-    while true
+    loop do
       case terminator
       when ''
         # simple case, there was no interpolation, return directly
@@ -150,7 +150,7 @@ module Puppet::Pops::Parser::InterpolationSupport
     value,terminator = slurp_uqstring
     text = value
     after = scn.pos
-    while true
+    loop do
       case terminator
       when ''
         # simple case, there was no further interpolation, return directly

data/lib/puppet/pops/parser/locator.rb

@@ -90,7 +90,7 @@ class Locator
       f = Puppet::Util.path_to_uri(f).to_s
     end
     offset = ast.offset
-    URI("#{f}?line=#{line_for_offset(offset).to_s}&pos=#{pos_on_line(offset).to_s}")
+    URI("#{f}?line=#{line_for_offset(offset)}&pos=#{pos_on_line(offset)}")
   end
 
   class AbstractLocator < Locator

data/lib/puppet/pops/parser/pn_parser.rb

@@ -48,6 +48,23 @@ class PNParser
     parse_next
   end
 
+  def self.char_types
+    unless instance_variable_defined?(:@char_types)
+      @char_types = Array.new(0x80, TYPE_IDENTIFIER)
+      @char_types[0] = TYPE_END
+      [0x09, 0x0d, 0x0a, 0x20].each { |n| @char_types[n] = TYPE_WS }
+      [TOKEN_LP, TOKEN_RP, TOKEN_LB, TOKEN_RB, TOKEN_LC, TOKEN_RC].each { |n| @char_types[n] = TYPE_DELIM }
+      @char_types[0x2d] = TYPE_MINUS
+      (0x30..0x39).each { |n| @char_types[n] = TYPE_DIGIT }
+      (0x41..0x5a).each { |n| @char_types[n] = TYPE_ALPHA }
+      (0x61..0x7a).each { |n| @char_types[n] = TYPE_ALPHA }
+      @char_types[TOKEN_KEY] = TYPE_KEY_START
+      @char_types[TOKEN_STRING] = TYPE_STRING_START
+      @char_types.freeze
+    end
+    @char_types
+  end
+
   private
 
   def parse_next
@@ -128,22 +145,6 @@ class PNParser
   end
 
   # All methods below belong to the PN lexer
-  def self.char_types
-    unless instance_variable_defined?(:@char_types)
-      @char_types = Array.new(0x80, TYPE_IDENTIFIER)
-      @char_types[0] = TYPE_END
-      [0x09, 0x0d, 0x0a, 0x20].each { |n| @char_types[n] = TYPE_WS }
-      [TOKEN_LP, TOKEN_RP, TOKEN_LB, TOKEN_RB, TOKEN_LC, TOKEN_RC].each { |n| @char_types[n] = TYPE_DELIM }
-      @char_types[0x2d] = TYPE_MINUS
-      (0x30..0x39).each { |n| @char_types[n] = TYPE_DIGIT }
-      (0x41..0x5a).each { |n| @char_types[n] = TYPE_ALPHA }
-      (0x61..0x7a).each { |n| @char_types[n] = TYPE_ALPHA }
-      @char_types[TOKEN_KEY] = TYPE_KEY_START
-      @char_types[TOKEN_STRING] = TYPE_STRING_START
-      @char_types.freeze
-    end
-    @char_types
-  end
 
   def next_token
     skip_white

data/lib/puppet/pops/puppet_stack.rb

@@ -1,57 +1,61 @@
-module Puppet::Pops
-# Module for making a call such that there is an identifiable entry on
-# the ruby call stack enabling getting a puppet call stack
-# To use this make a call with:
-# ```
-# Puppet::Pops::PuppetStack.stack(file, line, receiver, message, args)
-# ```
-# To get the stack call:
-# ```
-# Puppet::Pops::PuppetStack.stacktrace
-#
-# When getting a backtrace in Ruby, the puppet stack frames are
-# identified as coming from "in 'stack'" and having a ".pp" file
-# name.
-# To support testing, a given file that is an empty string, or nil
-# as well as a nil line number are supported. Such stack frames
-# will be represented with the text `unknown` and `0´ respectively.
-#
-module PuppetStack
-  # Pattern matching an entry in the ruby stack that is a puppet entry
-  PP_ENTRY_PATTERN = /^(.*\.pp)?:([0-9]+):in (`stack'|`block in call_function'|`<eval>')/
+require 'puppet/thread_local'
 
-  # Sends a message to an obj such that it appears to come from
-  # file, line when calling stacktrace.
-  #
-  def self.stack(file, line, obj, message, args, &block)
-    file = '' if file.nil?
-    line = 0 if line.nil?
+module Puppet
+  module Pops
+    # Utility class for keeping track of the "Puppet stack", ie the file
+    # and line numbers of Puppet Code that created the current context.
+    #
+    # To use this make a call with:
+    #
+    # ```rb
+    # Puppet::Pops::PuppetStack.stack(file, line, receiver, message, args)
+    # ```
+    #
+    # To get the stack call:
+    #
+    # ```rb
+    # Puppet::Pops::PuppetStack.stacktrace
+    # ```
+    #
+    # or
+    #
+    # ```rb
+    # Puppet::Pops::PuppetStack.top_of_stack
+    # ```
+    #
+    # To support testing, a given file that is an empty string, or nil
+    # as well as a nil line number are supported. Such stack frames
+    # will be represented with the text `unknown` and `0´ respectively.
+    module PuppetStack
+      @stack = Puppet::ThreadLocal.new { Array.new }
 
-    if block_given?
-      Kernel.eval("obj.send(message, *args, &block)", Kernel.binding(), file, line)
-    else
-      Kernel.eval("obj.send(message, *args)", Kernel.binding(), file, line)
-    end
-  end
+      def self.stack(file, line, obj, message, args, &block)
+        file = 'unknown' if (file.nil? || file == '')
+        line = 0 if line.nil?
 
-  def self.stacktrace
-    caller().reduce([]) do |memo, loc|
-      if loc =~ PP_ENTRY_PATTERN
-        memo << [$1.nil? ? 'unknown' : $1, $2.to_i]
+        result = nil
+        @stack.value.unshift([file, line])
+        begin
+          if block_given?
+            result = obj.send(message, *args, &block)
+          else
+            result = obj.send(message, *args)
+          end
+        ensure
+          @stack.value.shift()
+        end
+        result
       end
-      memo
-    end
-  end
 
-  # Returns an Array with the top of the puppet stack, or an empty Array if there was no such entry.
-  #
-  def self.top_of_stack
-    caller.each do |loc|
-      if loc =~ PP_ENTRY_PATTERN
-        return [$1.nil? ? 'unknown' : $1, $2.to_i]
+      def self.stacktrace
+        @stack.value.dup
+      end
+
+      # Returns an Array with the top of the puppet stack, or an empty
+      # Array if there was no such entry.
+      def self.top_of_stack
+        @stack.value.first || []
       end
     end
-    []
   end
 end
-end