puppet 6.0.5-x64-mingw32 → 8.8.1-x64-mingw32

data/lib/puppet/pal/script_compiler.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Puppet
+module Pal
+  class ScriptCompiler < Compiler
+    # Returns the signature of the given plan name
+    # @param plan_name [String] the name of the plan to get the signature of
+    # @return [Puppet::Pal::PlanSignature, nil] returns a PlanSignature, or nil if plan is not found
+    #
+    def plan_signature(plan_name)
+      loader = internal_compiler.loaders.private_environment_loader
+      func = loader.load(:plan, plan_name)
+      if func
+        return PlanSignature.new(func)
+      end
+
+      # Could not find plan
+      nil
+    end
+
+    # Returns an array of TypedName objects for all plans, optionally filtered by a regular expression.
+    # The returned array has more information than just the leaf name - the typical thing is to just get
+    # the name as showing the following example.
+    #
+    # Errors that occur during plan discovery will either be logged as warnings or collected by the optional
+    # `error_collector` array. When provided, it will receive {Puppet::DataTypes::Error} instances describing
+    # each error in detail and no warnings will be logged.
+    #
+    # @example getting the names of all plans
+    #   compiler.list_plans.map {|tn| tn.name }
+    #
+    # @param filter_regex [Regexp] an optional regexp that filters based on name (matching names are included in the result)
+    # @param error_collector [Array<Puppet::DataTypes::Error>] an optional array that will receive errors during load
+    # @return [Array<Puppet::Pops::Loader::TypedName>] an array of typed names
+    #
+    def list_plans(filter_regex = nil, error_collector = nil)
+      list_loadable_kind(:plan, filter_regex, error_collector)
+    end
+
+    # Returns the signature callable of the given task (the arguments it accepts, and the data type it returns)
+    # @param task_name [String] the name of the task to get the signature of
+    # @return [Puppet::Pal::TaskSignature, nil] returns a TaskSignature, or nil if task is not found
+    #
+    def task_signature(task_name)
+      loader = internal_compiler.loaders.private_environment_loader
+      task = loader.load(:task, task_name)
+      if task
+        return TaskSignature.new(task)
+      end
+
+      # Could not find task
+      nil
+    end
+
+    # Returns an array of TypedName objects for all tasks, optionally filtered by a regular expression.
+    # The returned array has more information than just the leaf name - the typical thing is to just get
+    # the name as showing the following example.
+    #
+    # @example getting the names of all tasks
+    #   compiler.list_tasks.map {|tn| tn.name }
+    #
+    # Errors that occur during task discovery will either be logged as warnings or collected by the optional
+    # `error_collector` array. When provided, it will receive {Puppet::DataTypes::Error} instances describing
+    # each error in detail and no warnings will be logged.
+    #
+    # @param filter_regex [Regexp] an optional regexp that filters based on name (matching names are included in the result)
+    # @param error_collector [Array<Puppet::DataTypes::Error>] an optional array that will receive errors during load
+    # @return [Array<Puppet::Pops::Loader::TypedName>] an array of typed names
+    #
+    def list_tasks(filter_regex = nil, error_collector = nil)
+      list_loadable_kind(:task, filter_regex, error_collector)
+    end
+  end
+end
+end

data/lib/puppet/pal/task_signature.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Puppet
+module Pal
+  # A TaskSignature is returned from `task_signature`. Its purpose is to answer questions about the task's parameters
+  # and if it can be run/called with a hash of named parameters.
+  #
+  class TaskSignature
+    def initialize(task)
+      @task = task
+    end
+
+    # Returns whether or not the given arguments are acceptable when running the task.
+    # In addition to returning the boolean outcome, if a block is given, it is called with a string of formatted
+    # error messages that describes the difference between what was given and what is expected. The error message may
+    # have multiple lines of text, and each line is indented one space.
+    #
+    # @param args_hash [Hash] a hash mapping parameter names to argument values
+    # @yieldparam [String] a formatted error message if a type mismatch occurs that explains the mismatch
+    # @return [Boolean] if the given arguments are acceptable when running the task
+    #
+    def runnable_with?(args_hash)
+      params = @task.parameters
+      params_type = if params.nil?
+                      T_GENERIC_TASK_HASH
+                    else
+                      Puppet::Pops::Types::TypeFactory.struct(params)
+                    end
+      return true if params_type.instance?(args_hash)
+
+      if block_given?
+        tm = Puppet::Pops::Types::TypeMismatchDescriber.singleton
+        error = if params.nil?
+                  tm.describe_mismatch('', params_type,
+                                       Puppet::Pops::Types::TypeCalculator
+                                         .infer_set(args_hash))
+                else
+                  tm.describe_struct_signature(params_type, args_hash)
+                    .flatten
+                    .map(&:format)
+                    .join("\n")
+                end
+        yield "Task #{@task.name}:\n#{error}"
+      end
+      false
+    end
+
+    # Returns the Task instance as a hash
+    #
+    # @return [Hash{String=>Object}] the hash representation of the task
+    def task_hash
+      @task._pcore_init_hash
+    end
+
+    # Returns the Task instance which can be further explored. It contains all meta-data defined for
+    # the task such as the description, parameters, output, etc.
+    #
+    # @return [Puppet::Pops::Types::PuppetObject] An instance of a dynamically created Task class
+    def task
+      @task
+    end
+  end
+end
+end

data/lib/puppet/parameter/boolean.rb

@@ -1,4 +1,6 @@
-require 'puppet/coercion'
+# frozen_string_literal: true
+
+require_relative '../../puppet/coercion'
 
 # This specialized {Puppet::Parameter} handles Boolean options, accepting lots
 # of strings and symbols for both truth and falsehood.

data/lib/puppet/parameter/package_options.rb

@@ -1,4 +1,6 @@
-require 'puppet/parameter'
+# frozen_string_literal: true
+
+require_relative '../../puppet/parameter'
 
 # This specialized {Puppet::Parameter} handles munging of package options.
 # Package options are passed as an array of key value pairs. Special munging is
@@ -26,6 +28,6 @@ class Puppet::Parameter::PackageOptions < Puppet::Parameter
 
   # @api private
   def quote(value)
-    value.include?(' ') ? %Q["#{value.gsub(/"/, '\"')}"] : value
+    value.include?(' ') ? %Q("#{value.gsub(/"/, '\"')}") : value
   end
 end

data/lib/puppet/parameter/path.rb

@@ -1,4 +1,6 @@
-require 'puppet/parameter'
+# frozen_string_literal: true
+
+require_relative '../../puppet/parameter'
 
 # This specialized {Puppet::Parameter} handles validation and munging of paths.
 # By default, a single path is accepted, and by calling {accept_arrays} it is possible to
@@ -11,6 +13,7 @@ class Puppet::Parameter::Path < Puppet::Parameter
   def self.accept_arrays(bool = true)
     @accept_arrays = !!bool
   end
+
   def self.arrays?
     @accept_arrays
   end
@@ -23,11 +26,11 @@ class Puppet::Parameter::Path < Puppet::Parameter
   # @return [Array<String>] the given paths
   #
   def validate_path(paths)
-    if paths.is_a?(Array) and ! self.class.arrays? then
+    if paths.is_a?(Array) and !self.class.arrays? then
       fail _("%{name} only accepts a single path, not an array of paths") % { name: name }
     end
 
-    fail(_("%{name} must be a fully qualified path") % { name: name }) unless Array(paths).all? {|path| absolute_path?(path)}
+    fail(_("%{name} must be a fully qualified path") % { name: name }) unless Array(paths).all? { |path| absolute_path?(path) }
 
     paths
   end
@@ -49,9 +52,10 @@ class Puppet::Parameter::Path < Puppet::Parameter
   # @return [String, Array<String>] the given paths
   # @raise [Puppet::Error] if the given paths does not comply with the on/many paths rule.
   def unsafe_munge(paths)
-    if paths.is_a?(Array) and ! self.class.arrays? then
+    if paths.is_a?(Array) and !self.class.arrays? then
       fail _("%{name} only accepts a single path, not an array of paths") % { name: name }
     end
+
     paths
   end
 end

data/lib/puppet/parameter/value.rb

@@ -1,4 +1,6 @@
-require 'puppet/parameter/value_collection'
+# frozen_string_literal: true
+
+require_relative '../../puppet/parameter/value_collection'
 
 # Describes an acceptable value for a parameter or property.
 # An acceptable value is either specified as a literal value or a regular expression.
@@ -55,9 +57,9 @@ class Puppet::Parameter::Value
   #
   def match?(value)
     if regex?
-      return true if name =~ value.to_s
+      true if name =~ value.to_s
     else
-      return(name == convert(value) ? true : @aliases.include?(convert(value)))
+      (name == convert(value) ? true : @aliases.include?(convert(value)))
     end
   end
 
@@ -76,7 +78,7 @@ class Puppet::Parameter::Value
   #
   def convert(value)
     case value
-    when Symbol, ''             # can't intern an empty string
+    when Symbol, '' # can't intern an empty string
       value
     when String
       value.intern

data/lib/puppet/parameter/value_collection.rb

@@ -1,4 +1,6 @@
-require 'puppet/parameter/value'
+# frozen_string_literal: true
+
+require_relative '../../puppet/parameter/value'
 
 # A collection of values and regular expressions, used for specifying allowed values
 # in a given parameter.
@@ -11,16 +13,14 @@ require 'puppet/parameter/value'
 # @api private
 #
 class Puppet::Parameter::ValueCollection
-
   # Aliases the given existing _other_ value with the additional given _name_.
   # @return [void]
   # @api private
   #
   def aliasvalue(name, other)
     other = other.to_sym
-    unless value = match?(other)
-      raise Puppet::DevError, _("Cannot alias nonexistent value %{value}") % { value: other }
-    end
+    value = match?(other)
+    raise Puppet::DevError, _("Cannot alias nonexistent value %{value}") % { value: other } unless value
 
     value.alias(name)
   end
@@ -31,12 +31,13 @@ class Puppet::Parameter::ValueCollection
   #
   def doc
     unless defined?(@doc)
-      @doc = ""
+      @doc = ''.dup
       unless values.empty?
         @doc << "Valid values are "
         @doc << @strings.collect do |value|
-          if aliases = value.aliases and ! aliases.empty?
-            "`#{value.name}` (also called `#{aliases.join(", ")}`)"
+          aliases = value.aliases
+          if aliases && !aliases.empty?
+            "`#{value.name}` (also called `#{aliases.join(', ')}`)"
           else
             "`#{value.name}`"
           end
@@ -44,7 +45,7 @@ class Puppet::Parameter::ValueCollection
       end
 
       unless regexes.empty?
-        @doc << "Values can match `#{regexes.join("`, `")}`."
+        @doc << "Values can match `#{regexes.join('`, `')}`."
       end
     end
 
@@ -81,9 +82,8 @@ class Puppet::Parameter::ValueCollection
   #
   def match?(test_value)
     # First look for normal values
-    if value = @strings.find { |v| v.match?(test_value) }
-      return value
-    end
+    value = @strings.find { |v| v.match?(test_value) }
+    return value if value
 
     # Then look for a regex match
     @regexes.find { |v| v.match?(test_value) }
@@ -100,14 +100,15 @@ class Puppet::Parameter::ValueCollection
   def munge(value)
     return value if empty?
 
-    if instance = match?(value)
+    instance = match?(value)
+    if instance
       if instance.regex?
-        return value
+        value
       else
-        return instance.name
+        instance.name
       end
     else
-      return value
+      value
     end
   end
 
@@ -120,7 +121,7 @@ class Puppet::Parameter::ValueCollection
   # @option options [Symbol] :event The event that should be emitted when this value is set.
   # @todo Option :event original comment says "event should be returned...", is "returned" the correct word
   #   to use?
- # @option options [Symbol] :invalidate_refreshes True if a change on this property should invalidate and
+  # @option options [Symbol] :invalidate_refreshes True if a change on this property should invalidate and
   #   remove any scheduled refreshes (from notify or subscribe) targeted at the same resource. For example, if
   #   a change in this property takes into account any changes that a scheduled refresh would have performed,
   #   then the scheduled refresh would be deleted.
@@ -133,11 +134,11 @@ class Puppet::Parameter::ValueCollection
     call_opt = options[:call]
     unless call_opt.nil?
       devfail "Cannot use obsolete :call value '#{call_opt}' for property '#{self.class.name}'" unless call_opt == :none || call_opt == :instead
-      #TRANSLATORS ':call' is a property and should not be translated
+      # TRANSLATORS ':call' is a property and should not be translated
       message = _("Property option :call is deprecated and no longer used.")
       message += ' ' + _("Please remove it.")
       Puppet.deprecation_warning(message)
-      options = options.reject { |k,v| k == :call }
+      options = options.reject { |k, _v| k == :call }
     end
 
     value = Puppet::Parameter::Value.new(name)
@@ -152,9 +153,9 @@ class Puppet::Parameter::ValueCollection
     if block_given?
       devfail "Cannot use :call value ':none' in combination with a block for property '#{self.class.name}'" if call_opt == :none
       value.block = block
-      value.method ||= "set_#{value.name}" if !value.regex?
-    else
-      devfail "Cannot use :call value ':instead' without a block for property '#{self.class.name}'" if call_opt == :instead
+      value.method ||= "set_#{value.name}" unless value.regex?
+    elsif call_opt == :instead
+      devfail "Cannot use :call value ':instead' without a block for property '#{self.class.name}'"
     end
     value
   end
@@ -183,7 +184,7 @@ class Puppet::Parameter::ValueCollection
   def validate(value)
     return if empty?
 
-    unless @values.detect {|name, v| v.match?(value)}
+    unless @values.detect { |_name, v| v.match?(value) }
       str = _("Invalid value %{value}.") % { value: value.inspect }
       str += " " + _("Valid values are %{value_list}.") % { value_list: values.join(", ") } unless values.empty?
       str += " " + _("Valid values match %{pattern}.") % { pattern: regexes.join(", ") } unless regexes.empty?
@@ -207,6 +208,6 @@ class Puppet::Parameter::ValueCollection
   # @api private
   #
   def values
-    @strings.collect { |s| s.name }
+    @strings.collect(&:name)
   end
 end

data/lib/puppet/parameter.rb

@@ -1,5 +1,7 @@
-require 'puppet/util/logging'
-require 'puppet/util/docs'
+# frozen_string_literal: true
+
+require_relative '../puppet/util/logging'
+require_relative '../puppet/util/docs'
 
 # The Parameter class is the implementation of a resource's attributes of _parameter_ kind.
 # The Parameter class is also the base class for {Puppet::Property}, and is used to describe meta-parameters
@@ -22,7 +24,7 @@ class Puppet::Parameter
   include Puppet::Util::Errors
   include Puppet::Util::Logging
 
-  require 'puppet/parameter/value_collection'
+  require_relative 'parameter/value_collection'
 
   class << self
     include Puppet::Util
@@ -70,7 +72,7 @@ class Puppet::Parameter
     # @overload defaultto(value)
     #   Defines the default value with a literal value
     #   @param value [Object] the literal value to use as the default value
-    # @overload defaultto({|| ... })
+    # @overload defaultto({ ... })
     #   Defines that the default value is produced by the given block. The given block
     #   should produce the default value.
     # @raise [Puppet::DevError] if value is nil, and no block is given.
@@ -85,12 +87,13 @@ class Puppet::Parameter
       else
         if value.nil?
           raise Puppet::DevError,
-            "Either a default value or block must be provided"
+                "Either a default value or block must be provided"
         end
         define_method(:default) do value end
       end
     end
 
+    # rubocop:disable Naming/PredicateName
     def sensitive(value = nil, &block)
       if block
         define_method(:is_sensitive, &block)
@@ -98,6 +101,7 @@ class Puppet::Parameter
         define_method(:is_sensitive) do value end
       end
     end
+    # rubocop:enable Naming/PredicateName
 
     # Produces a documentation string.
     # If an enumeration of _valid values_ has been defined, it is appended to the documentation
@@ -110,12 +114,14 @@ class Puppet::Parameter
 
       unless defined?(@addeddocvals)
         @doc = Puppet::Util::Docs.scrub(@doc)
-        if vals = value_collection.doc
+        vals = value_collection.doc
+        if vals
           @doc << "\n\n#{vals}"
         end
 
-        if features = self.required_features
-          @doc << "\n\nRequires features #{features.flatten.collect { |f| f.to_s }.join(" ")}."
+        features = required_features
+        if features
+          @doc << "\n\nRequires features #{features.flatten.collect(&:to_s).join(' ')}."
         end
         @addeddocvals = true
       end
@@ -158,7 +164,7 @@ class Puppet::Parameter
       @value_collection = ValueCollection.new
     end
 
-    # @overload munge {|| ... }
+    # @overload munge { ... }
     # Defines an optional method used to convert the parameter value from DSL/string form to an internal form.
     # If a munge method is not defined, the DSL/string value is used as is.
     # @note This adds a method with the name `unsafe_munge` in the created parameter class. Later this method is
@@ -174,16 +180,16 @@ class Puppet::Parameter
       define_method(:unsafe_munge, &block)
     end
 
-    # @overload unmunge {|| ... }
-    # Defines an optional method used to convert the parameter value to DSL/string form from an internal form.
+    # @overload unmunge { ... }
+    # Defines an optional method used to convert the parameter value from internal form to DSL/string form.
     # If an `unmunge` method is not defined, the internal form is used.
     # @see munge
-    # @note This adds a method with the name `unmunge` in the created parameter class.
+    # @note This adds a method with the name `unsafe_unmunge` in the created parameter class.
     # @dsl type
     # @api public
     #
     def unmunge(&block)
-      define_method(:unmunge, &block)
+      define_method(:unsafe_unmunge, &block)
     end
 
     # Sets a marker indicating that this parameter is the _namevar_ (unique identifier) of the type
@@ -234,7 +240,7 @@ class Puppet::Parameter
       @required
     end
 
-    # @overload validate {|| ... }
+    # @overload validate { ... }
     # Defines an optional method that is used to validate the parameter's DSL/string value.
     # Validation should raise appropriate exceptions, the return value of the given block is ignored.
     # The easiest way to raise an appropriate exception is to call the method {Puppet::Util::Errors.fail} with
@@ -327,7 +333,6 @@ class Puppet::Parameter
     resource.version
   end
 
-
   # Initializes the parameter with a required resource reference and optional attribute settings.
   # The option `:resource` must be specified or an exception is raised. Any additional options passed
   # are used to initialize the attributes of this parameter by treating each key in the `options` hash as
@@ -380,9 +385,7 @@ class Puppet::Parameter
   #
   def noop
     @noop ||= false
-    tmp = @noop || self.resource.noop || Puppet[:noop] || false
-    #debug "noop is #{tmp}"
-    tmp
+    @noop || resource.noop || Puppet[:noop] || false
   end
 
   # Returns an array of strings representing the containment hierarchy
@@ -392,9 +395,9 @@ class Puppet::Parameter
   # @api private
   def pathbuilder
     if @resource
-      return [@resource.pathbuilder, self.name]
+      [@resource.pathbuilder, name]
     else
-      return [self.name]
+      [name]
     end
   end
 
@@ -413,10 +416,21 @@ class Puppet::Parameter
   # @return [Object] the unmunged value
   #
   def unmunge(value)
+    return value if value.is_a?(Puppet::Pops::Evaluator::DeferredValue)
+
+    unsafe_unmunge(value)
+  end
+
+  # This is the default implementation of `unmunge` that simply produces the value (if it is valid).
+  # The DSL method {unmunge} should be used to define an overriding method if unmunging is required.
+  #
+  # @api private
+  #
+  def unsafe_unmunge(value)
     value
   end
 
-  # Munges the value to internal form.
+  # Munges the value from DSL form to internal form.
   # This implementation of `munge` provides exception handling around the specified munging of this parameter.
   # @note This method should not be overridden. Use the DSL method {munge} to define a munging method
   #   if required.
@@ -424,13 +438,15 @@ class Puppet::Parameter
   # @return [Object] the munged (internal) value
   #
   def munge(value)
+    return value if value.is_a?(Puppet::Pops::Evaluator::DeferredValue)
+
     begin
       ret = unsafe_munge(value)
     rescue Puppet::Error => detail
-      Puppet.debug "Reraising #{detail}"
+      Puppet.debug { "Reraising #{detail}" }
       raise
     rescue => detail
-      raise Puppet::DevError, _("Munging failed for value %{value} in class %{class_name}: %{detail}") % { value: value.inspect, class_name: self.name, detail: detail }, detail.backtrace
+      raise Puppet::DevError, _("Munging failed for value %{value} in class %{class_name}: %{detail}") % { value: value.inspect, class_name: name, detail: detail }, detail.backtrace
     end
     ret
   end
@@ -457,6 +473,8 @@ class Puppet::Parameter
   # @api public
   #
   def validate(value)
+    return if value.is_a?(Puppet::Pops::Evaluator::DeferredValue)
+
     begin
       unsafe_validate(value)
     rescue ArgumentError => detail
@@ -464,7 +482,7 @@ class Puppet::Parameter
     rescue Puppet::Error, TypeError
       raise
     rescue => detail
-      raise Puppet::DevError, _("Validate method failed for class %{class_name}: %{detail}") % { class_name: self.name, detail: detail }, detail.backtrace
+      raise Puppet::DevError, _("Validate method failed for class %{class_name}: %{detail}") % { class_name: name, detail: detail }, detail.backtrace
     end
   end
 
@@ -521,7 +539,7 @@ class Puppet::Parameter
       @tags = []
       # This might not be true in testing
       @tags = @resource.tags if @resource.respond_to? :tags
-      @tags << self.name.to_s
+      @tags << name.to_s
     end
     @tags
   end
@@ -569,4 +587,4 @@ class Puppet::Parameter
   #   @see Puppet::Parser::Compiler#finish
 end
 
-require 'puppet/parameter/path'
+require_relative 'parameter/path'

data/lib/puppet/parser/abstract_compiler.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
 
 module Puppet::Parser::AbstractCompiler
-
-  # Returns the catalog for a compilation. Must return a Puppet::Resource::Catalog or fail with an 
+  # Returns the catalog for a compilation. Must return a Puppet::Resource::Catalog or fail with an
   # error if the specific compiler does not support catalog operations.
   #
   def catalog
@@ -32,5 +32,4 @@ module Puppet::Parser::AbstractCompiler
   def topscope
     raise Puppet::DevError("Class '#{self.class}' should have implemented 'topscope'")
   end
-
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Evaluates contained expressions, produce result of the last
 #
 class Puppet::Parser::AST::BlockExpression < Puppet::Parser::AST::Branch
@@ -6,10 +8,10 @@ class Puppet::Parser::AST::BlockExpression < Puppet::Parser::AST::Branch
   end
 
   def sequence_with(other)
-    Puppet::Parser::AST::BlockExpression.new(:children => self.children + other.children)
+    Puppet::Parser::AST::BlockExpression.new(:children => children + other.children)
   end
 
   def to_s
-    "[" + @children.collect { |c| c.to_s }.join(', ') + "]"
+    "[" + @children.collect(&:to_s).join(', ') + "]"
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The parent class of all AST objects that contain other AST objects.
 # Everything but the really simple objects descend from this.  It is
 # important to note that Branch objects contain other AST objects only --

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

@@ -1,4 +1,6 @@
-require 'puppet/parser/ast/top_level_construct'
+# frozen_string_literal: true
+
+require_relative '../../../puppet/parser/ast/top_level_construct'
 
 class Puppet::Parser::AST::Hostclass < Puppet::Parser::AST::TopLevelConstruct
   attr_accessor :name, :context
@@ -18,10 +20,10 @@ class Puppet::Parser::AST::Hostclass < Puppet::Parser::AST::TopLevelConstruct
         end
       end
     end
-    return all_types
+    all_types
   end
 
-  def code()
+  def code
     @context[:code]
   end
 end