bolt 0.24.0 → 0.25.0

data/vendored/puppet/lib/puppet_pal.rb

@@ -1,1135 +0,0 @@
-# Puppet as a Library "PAL"
-
-# Yes, this requires all of puppet for now because 'settings' and many other things...
-require 'puppet'
-require 'puppet/parser/script_compiler'
-require 'puppet/parser/catalog_compiler'
-
-# This is the main entry point for "Puppet As a Library" PAL.
-# This file should be required instead of "puppet"
-# Initially, this will require ALL of puppet - over time this will change as the monolithical "puppet" is broken up
-# into smaller components.
-#
-# @example Running a snippet of Puppet Language code
-#   require 'puppet_pal'
-#   result = Puppet::Pal.in_tmp_environment('pal_env', modulepath: ['/tmp/testmodules']) do |pal|
-#     pal.evaluate_script_string('1+2+3')
-#   end
-#   # The result is the value 6
-#
-# @example Calling a function
-#   require 'puppet_pal'
-#   result = Puppet::Pal.in_tmp_environment('pal_env', modulepath: ['/tmp/testmodules']) do |pal|
-#     pal.call_function('mymodule::myfunction', 10, 20)
-#   end
-#   # The result is what 'mymodule::myfunction' returns
-#
-module Puppet
-module Pal
-
-  # A configured compiler as obtained in the callback from `with_script_compiler`.
-  # (Later, there may also be a catalog compiler available.)
-  #
-  class Compiler
-    attr_reader :internal_compiler
-    protected :internal_compiler
-
-    attr_reader :internal_evaluator
-    protected :internal_evaluator
-
-    def initialize(internal_compiler)
-      @internal_compiler = internal_compiler
-      @internal_evaluator = Puppet::Pops::Parser::EvaluatingParser.new
-    end
-
-    # Calls a function given by name with arguments specified in an `Array`, and optionally accepts a code block.
-    # @param function_name [String] the name of the function to call
-    # @param args [Object] the arguments to the function
-    # @param block [Proc] an optional callable block that is given to the called function
-    # @return [Object] what the called function returns
-    #
-    def call_function(function_name, *args, &block)
-      # TRANSLATORS: do not translate variable name strings in these assertions
-      Pal::assert_non_empty_string(function_name, 'function_name', false)
-      Pal::assert_type(Pal::T_ANY_ARRAY, args, 'args', false)
-      internal_evaluator.evaluator.external_call_function(function_name, args, topscope, &block)
-    end
-
-    # Returns a Puppet::Pal::FunctionSignature object or nil if function is not found
-    # The returned FunctionSignature has information about all overloaded signatures of the function
-    #
-    # @example using function_signature
-    #   # returns true if 'myfunc' is callable with three integer arguments 1, 2, 3
-    #   compiler.function_signature('myfunc').callable_with?([1,2,3])
-    #
-    # @param function_name [String] the name of the function to get a signature for
-    # @return [Puppet::Pal::FunctionSignature] a function signature, or nil if function not found
-    #
-    def function_signature(function_name)
-      loader = internal_compiler.loaders.private_environment_loader
-      if func = loader.load(:function, function_name)
-        return FunctionSignature.new(func.class)
-      end
-      # Could not find function
-      nil
-    end
-
-    # Returns an array of TypedName objects for all functions, 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 function 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 functions
-    #   compiler.list_functions.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_functions(filter_regex = nil, error_collector = nil)
-      list_loadable_kind(:function, filter_regex, error_collector)
-    end
-
-    # Evaluates a string of puppet language code in top scope.
-    # A "source_file" reference to a source can be given - if not an actual file name, by convention the name should
-    # be bracketed with < > to indicate it is something symbolic; for example `<commandline>` if the string was given on the
-    # command line.
-    #
-    # If the given `puppet_code` is `nil` or an empty string, `nil` is returned, otherwise the result of evaluating the
-    # puppet language string. The given string must form a complete and valid expression/statement as an error is raised
-    # otherwise. That is, it is not possible to divide a compound expression by line and evaluate each line individually.
-    #
-    # @param puppet_code [String, nil] the puppet language code to evaluate, must be a complete expression/statement
-    # @param source_file [String, nil] an optional reference to a source (a file or symbolic name/location)
-    # @return [Object] what the `puppet_code` evaluates to
-    #
-    def evaluate_string(puppet_code, source_file = nil)
-      return nil if puppet_code.nil? || puppet_code == ''
-      unless puppet_code.is_a?(String)
-        raise ArgumentError, _("The argument 'puppet_code' must be a String, got %{type}") % { type: puppet_code.class }
-      end
-      evaluate(parse_string(puppet_code, source_file))
-    end
-
-    # Evaluates a puppet language file in top scope.
-    # The file must exist and contain valid puppet language code or an error is raised.
-    #
-    # @param file [Path, String] an absolute path to a file with puppet language code, must exist
-    # @return [Object] what the last evaluated expression in the file evaluated to
-    #
-    def evaluate_file(file)
-      evaluate(parse_file(file))
-    end
-
-    # Evaluates an AST obtained from `parse_string` or `parse_file` in topscope.
-    # If the ast is a `Puppet::Pops::Model::Program` (what is returned from the `parse` methods, any definitions
-    # in the program (that is, any function, plan, etc. that is defined will be made available for use).
-    #
-    # @param ast [Puppet::Pops::Model::PopsObject] typically the returned `Program` from the parse methods, but can be any `Expression`
-    # @returns [Object] whatever the ast evaluates to
-    #
-    def evaluate(ast)
-      if ast.is_a?(Puppet::Pops::Model::Program)
-        loaders = Puppet.lookup(:loaders)
-        loaders.instantiate_definitions(ast, loaders.public_environment_loader)
-      end
-      internal_evaluator.evaluate(topscope, ast)
-    end
-
-    # Produces a literal value if the AST obtained from `parse_string` or `parse_file` does not require any actual evaluation.
-    # This method is useful if obtaining an AST that represents literal values; string, integer, float, boolean, regexp, array, hash;
-    # for example from having read this from the command line or as values in some file.
-    #
-    # @param ast [Puppet::Pops::Model::PopsObject] typically the returned `Program` from the parse methods, but can be any `Expression`
-    # @returns [Object] whatever the literal value the ast evaluates to
-    #
-    def evaluate_literal(ast)
-      catch :not_literal do
-        return Puppet::Pops::Evaluator::LiteralEvaluator.new().literal(ast)
-      end
-      # TRANSLATORS, the 'ast' is the name of a parameter, do not translate
-      raise ArgumentError, _("The given 'ast' does not represent a literal value")
-    end
-
-    # Parses and validates a puppet language string and returns an instance of Puppet::Pops::Model::Program on success.
-    # If the content is not valid an error is raised.
-    #
-    # @param code_string [String] a puppet language string to parse and validate
-    # @param source_file [String] an optional reference to a file or other location in angled brackets
-    # @return [Puppet::Pops::Model::Program] returns a `Program` instance on success
-    #
-    def parse_string(code_string, source_file = nil)
-      unless code_string.is_a?(String)
-        raise ArgumentError, _("The argument 'code_string' must be a String, got %{type}") % { type: code_string.class }
-      end
-      internal_evaluator.parse_string(code_string, source_file)
-    end
-
-    # Parses and validates a puppet language file and returns an instance of Puppet::Pops::Model::Program on success.
-    # If the content is not valid an error is raised.
-    #
-    # @param file [String] a file with puppet language content to parse and validate
-    # @return [Puppet::Pops::Model::Program] returns a `Program` instance on success
-    #
-    def parse_file(file)
-      unless file.is_a?(String)
-        raise ArgumentError, _("The argument 'file' must be a String, got %{type}") % { type: file.class }
-      end
-      internal_evaluator.parse_file(file)
-    end
-
-    # Parses a puppet data type given in String format and returns that type, or raises an error.
-    # A type is needed in calls to `new` to create an instance of the data type, or to perform type checking
-    # of values - typically using `type.instance?(obj)` to check if `obj` is an instance of the type.
-    #
-    # @example Verify if obj is an instance of a data type
-    #   # evaluates to true
-    #   pal.type('Enum[red, blue]').instance?("blue")
-    #
-    # @example Create an instance of a data type
-    #   # using an already create type
-    #   t = pal.type('Car')
-    #   pal.create(t, 'color' => 'black', 'make' => 't-ford')
-    #
-    #   # letting 'new_object' parse the type from a string
-    #   pal.create('Car', 'color' => 'black', 'make' => 't-ford')
-    #
-    # @param type_string [String] a puppet language data type
-    # @return [Puppet::Pops::Types::PAnyType] the data type
-    #
-    def type(type_string)
-      Puppet::Pops::Types::TypeParser.singleton.parse(type_string)
-    end
-
-    # Creates a new instance of a given data type.
-    # @param data_type [String, Puppet::Pops::Types::PAnyType] the data type as a data type or in String form.
-    # @param arguments [Object] one or more arguments to the called `new` function
-    # @return [Object] an instance of the given data type,
-    #   or raises an error if it was not possible to parse data type or create an instance.
-    #
-    def create(data_type, *arguments)
-      t = data_type.is_a?(String) ? type(data_type) : data_type
-      unless t.is_a?(Puppet::Pops::Types::PAnyType)
-        raise ArgumentError, _("Given data_type value is not a data type, got '%{type}'") % {type: t.class}
-      end
-      call_function('new', t, *arguments)
-    end
-
-    # Returns true if this is a compiler that compiles a catalog.
-    # This implementation returns `false`
-    # @return Boolan false
-    def has_catalog?
-      false
-    end
-
-    protected
-
-    def list_loadable_kind(kind, filter_regex = nil, error_collector = nil)
-      loader = internal_compiler.loaders.private_environment_loader
-      if filter_regex.nil?
-        loader.discover(kind, error_collector)
-      else
-        loader.discover(kind, error_collector) {|f| f.name =~ filter_regex }
-      end
-    end
-
-    private
-
-    def topscope
-      internal_compiler.topscope
-    end
-  end
-
-  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
-      if func = loader.load(:plan, plan_name)
-        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
-      if task = loader.load(:task, task_name)
-        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
-
-  # A CatalogCompiler is a compiler that builds a catalog of resources and dependencies as a side effect of
-  # evaluating puppet language code.
-  # When the compilation of the given input manifest(s)/code string/file is finished the catalog is complete
-  # for encoding and use. It is also possible to evaluate more strings within the same compilation context to
-  # add or remove things from the catalog.
-  #
-  # @api public
-  class CatalogCompiler < Compiler
-
-    # @api private
-    def catalog
-      internal_compiler.catalog
-    end
-    private :catalog
-
-    # Returns true if this is a compiler that compiles a catalog.
-    # This implementation returns `true`
-    # @return [Boolean] true
-    # @api public
-    def has_catalog?
-      true
-    end
-
-    # Calls a block of code and yields a configured `JsonCatalogEncoder` to the block.
-    # @example Get resulting catalog as pretty printed Json
-    #   Puppet::Pal.in_environment(...) do |pal|
-    #     pal.with_catalog_compiler(...) do |compiler|
-    #       compiler.with_json_encoding {| encoder | encoder.encode
-    #     end
-    #   end
-    #
-    # @api public
-    #
-    def with_json_encoding(pretty: true, exclude_virtual: true)
-      yield JsonCatalogEncoder.new(catalog, pretty: pretty, exclude_virtual: exclude_virtual)
-    end
-
-    # Evaluates an AST obtained from `parse_string` or `parse_file` in topscope.
-    # If the ast is a `Puppet::Pops::Model::Program` (what is returned from the `parse` methods, any definitions
-    # in the program (that is, any function, plan, etc. that is defined will be made available for use).
-    #
-    # @param ast [Puppet::Pops::Model::PopsObject] typically the returned `Program` from the parse methods, but can be any `Expression`
-    # @returns [Object] whatever the ast evaluates to
-    #
-    def evaluate(ast)
-      if ast.is_a?(Puppet::Pops::Model::Program)
-        bridged = Puppet::Parser::AST::PopsBridge::Program.new(ast)
-        # define all catalog types
-        internal_compiler.environment.known_resource_types.import_ast(bridged, "")
-        bridged.evaluate(internal_compiler.topscope)
-      else
-        internal_evaluator.evaluate(topscope, ast)
-      end
-    end
-
-
-    # Compiles the result of additional evaluation taking place in a PAL catalog compilation.
-    # This will evaluate all lazy constructs until all have been evaluated, and will the validate
-    # the result.
-    #
-    # This should be called if evaluating string or files of puppet logic after the initial
-    # compilation taking place by giving PAL a manifest or code-string.
-    # This method should be called when a series of evaluation should have reached a
-    # valid state (there should be no dangling relationships (to resources that does not
-    # exist).
-    #
-    # As an alternative the methods `evaluate_additions` can be called without any
-    # requirements on consistency and then calling `validate` at the end.
-    #
-    # Can be called multiple times.
-    #
-    # @return [Void]
-    def compile_additions
-      internal_compiler.compile_additions
-    end
-
-    # Validates the state of the catalog (without performing evaluation of any elements
-    # requiring lazy evaluation. Can be called multiple times.
-    #
-    def validate
-      internal_compiler.validate
-    end
-
-    # Evaluates all lazy constructs that were produced as a side effect of evaluating puppet logic.
-    # Can be called multiple times.
-    #
-    def evaluate_additions
-      internal_compiler.evaluate_additions
-    end
-
-  end
-
-  # The JsonCatalogEncoder is a wrapper around a catalog produced by the Pal::CatalogCompiler.with_json_encoding
-  # method.
-  # It allows encoding the entire catalog or an individual resource as Rich Data Json.
-  #
-  # @api public
-  #
-  class JsonCatalogEncoder
-    # Is the resulting Json pretty printed or not.
-    attr_reader :pretty
-
-    # Should unrealized virtual resources be included in the result or not.
-    attr_reader :exclude_virtual
-
-    # The internal catalog being build - what this class wraps with a public API.
-    attr_reader :catalog
-    private :catalog
-
-    # Do not instantiate this class directly! Use the `Pal::CatalogCompiler#with_json_encoding` method
-    # instead.
-    #
-    # @param catalog [Puppet::Resource::Catalog] the internal catalog that this class wraps
-    # @param pretty [Boolean] (true), if the resulting JSON should be pretty printed or not
-    # @param exclude_virtual [Boolean] (true), if the resulting catalog should contain unrealzed virtual resources or not
-    #
-    # @api private
-    #
-    def initialize(catalog, pretty: true, exclude_virtual: true)
-      @catalog = catalog
-      @pretty = pretty
-      @exclude_virtual = exclude_virtual
-    end
-
-    # Encodes the entire catalog as a rich-data Json catalog.
-    # @return String The catalog in Json format using rich data format
-    # @api public
-    #
-    def encode
-      possibly_filtered_catalog.to_json(:pretty => pretty)
-    end
-
-    # Returns one particular resource as a Json string, or returns nil if resource was not found.
-    # @param type [String] the name of the puppet type (case independent)
-    # @param title [String] the title of the wanted resource
-    # @return [String] the resulting Json text
-    # @api public
-    #
-    def encode_resource(type, title)
-      # Ensure that both type and title are given since the underlying API will do mysterious things
-      # if 'title' is nil. (Other assertions are made by the catalog when looking up the resource).
-      #
-      # TRANSLATORS 'type' and 'title' are internal parameter names - do not translate
-      raise ArgumentError, _("Both type and title must be given") if type.nil? or title.nil?
-      r = possibly_filtered_catalog.resource(type, title)
-      return nil if r.nil?
-      r.to_data_hash.to_json(:pretty => pretty)
-    end
-
-    # Applies a filter for virtual resources and returns filtered catalog
-    # or the catalog itself if filtering was not needed.
-    # The result is cached.
-    # @api private
-    #
-    def possibly_filtered_catalog
-      @filtered ||= (exclude_virtual ? catalog.filter { |r| r.virtual? } : catalog)
-    end
-    private :possibly_filtered_catalog
-  end
-
-  # A FunctionSignature is returned from `function_signature`. Its purpose is to answer questions about the function's parameters
-  # and if it can be called with a set of parameters.
-  #
-  # It is also possible to get an array of puppet Callable data type where each callable describes one possible way
-  # the function can be called.
-  #
-  # @api public
-  #
-  class FunctionSignature
-    # @api private
-    def initialize(function_class)
-      @func = function_class
-    end
-
-    # Returns true if the function can be called with the given arguments and false otherwise.
-    # If the function is not callable, and a code block is given, it is given a formatted error message that describes
-    # the type mismatch. That error message can be quite complex if the function has multiple dispatch depending on
-    # given types.
-    #
-    # @param args [Array] The arguments as given to the function call
-    # @param callable [Proc, nil] An optional ruby Proc or puppet lambda given to the function
-    # @yield [String] a formatted error message describing a type mismatch if the function is not callable with given args + block
-    # @return [Boolean] true if the function can be called with given args + block, and false otherwise
-    # @api public
-    #
-    def callable_with?(args, callable=nil)
-      signatures = @func.dispatcher.to_type
-      callables = signatures.is_a?(Puppet::Pops::Types::PVariantType) ? signatures.types : [signatures]
-
-      return true if callables.any? {|t| t.callable_with?(args) }
-      return false unless block_given?
-      args_type = Puppet::Pops::Types::TypeCalculator.singleton.infer_set(callable.nil? ? args : args + [callable])
-      error_message = Puppet::Pops::Types::TypeMismatchDescriber.describe_signatures(@func.name, @func.signatures, args_type)
-      yield error_message
-      false
-    end
-
-    # Returns an array of Callable puppet data type
-    # @return [Array<Puppet::Pops::Types::PCallableType] one callable per way the function can be called
-    #
-    # @api public
-    #
-    def callables
-      signatures = @func.dispatcher.to_type
-      signatures.is_a?(Puppet::Pops::Types::PVariantType) ? signatures.types : [signatures]
-    end
-  end
-
-  # 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 {|e| e.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
-
-  # A PlanSignature is returned from `plan_signature`. Its purpose is to answer questions about the plans's parameters
-  # and if it can be called with a hash of named parameters.
-  #
-  # @api public
-  #
-  class PlanSignature
-    def initialize(plan_function)
-      @plan_func = plan_function
-    end
-
-    # Returns true or false depending on if the given PlanSignature is callable with a set of named arguments or not
-    # 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.
-    #
-    # @example Checking if signature is acceptable
-    #
-    #   signature = pal.plan_signature('myplan')
-    #   signature.callable_with?({x => 10}) { |errors| raise ArgumentError("Ooops: given arguments does not match\n#{errors}") }
-    #
-    # @api public
-    #
-    def callable_with?(args_hash)
-      dispatcher = @plan_func.class.dispatcher.dispatchers[0]
-
-      param_scope = {}
-      # Assign all non-nil values, even those that represent non-existent parameters.
-      args_hash.each { |k, v| param_scope[k] = v unless v.nil? }
-      dispatcher.parameters.each do |p|
-        name = p.name
-        arg = args_hash[name]
-        if arg.nil?
-          # Arg either wasn't given, or it was undef
-          if p.value.nil?
-            # No default. Assign nil if the args_hash included it
-            param_scope[name] = nil if args_hash.include?(name)
-          else
-            # parameter does not have a default value, it will be assigned its default when being called
-            # we assume that the default value is of the correct type and therefore simply skip
-            # checking this
-            # param_scope[name] = param_scope.evaluate(name, p.value, closure_scope, @evaluator)
-          end
-        end
-      end
-
-      errors = Puppet::Pops::Types::TypeMismatchDescriber.singleton.describe_struct_signature(dispatcher.params_struct, param_scope).flatten
-      return true if errors.empty?
-      if block_given?
-        yield errors.map {|e| e.format }.join("\n")
-      end
-      false
-    end
-
-    # Returns a PStructType describing the parameters as a puppet Struct data type
-    # Note that a `to_s` on the returned structure will result in a human readable Struct datatype as a
-    # description of what a plan expects.
-    #
-    # @return [Puppet::Pops::Types::PStructType] a struct data type describing the parameters and their types
-    #
-    # @api public
-    #
-    def params_type
-      dispatcher = @plan_func.class.dispatcher.dispatchers[0]
-      dispatcher.params_struct
-    end
-  end
-
-  # Defines a context in which multiple operations in an env with a script compiler can be performed in a given block.
-  # The calls that takes place to PAL inside of the given block are all with the same instance of the compiler.
-  # The parameter `configured_by_env` makes it possible to either use the configuration in the environment, or specify
-  # `manifest_file` or `code_string` manually. If neither is given, an empty `code_string` is used.
-  #
-  # @example define a script compiler without any initial logic
-  #   pal.with_script_compiler do | compiler |
-  #     # do things with compiler
-  #   end
-  #
-  # @example define a script compiler with a code_string containing initial logic
-  #   pal.with_script_compiler(code_string: '$myglobal_var = 42')  do | compiler |
-  #     # do things with compiler
-  #   end
-  #
-  # @param configured_by_env [Boolean] when true the environment's settings are used, otherwise the given `manifest_file` or `code_string`
-  # @param manifest_file [String] a Puppet Language file to load and evaluate before calling the given block, mutually exclusive with `code_string`
-  # @param code_string [String] a Puppet Language source string to load and evaluate before calling the given block, mutually exclusive with `manifest_file`
-  # @param facts [Hash] optional map of fact name to fact value - if not given will initialize the facts (which is a slow operation)
-  #   If given at the environment level, the facts given here are merged with higher priority.
-  # @param variables [Hash] optional map of fully qualified variable name to value. If given at the environment level, the variables
-  #   given here are merged with higher priority.
-  # @param block [Proc] the block performing operations on compiler
-  # @return [Object] what the block returns
-  # @yieldparam [Puppet::Pal::ScriptCompiler] compiler, a ScriptCompiler to perform operations on.
-  #
-  def self.with_script_compiler(
-      configured_by_env: false,
-      manifest_file:     nil,
-      code_string:       nil,
-      facts:             nil,
-      variables:         nil,
-      &block
-    )
-    # TRANSLATORS: do not translate variable name strings in these assertions
-    assert_mutually_exclusive(manifest_file, code_string, 'manifest_file', 'code_string')
-    assert_non_empty_string(manifest_file, 'manifest_file', true)
-    assert_non_empty_string(code_string, 'code_string', true)
-    assert_type(T_BOOLEAN, configured_by_env, "configured_by_env", false)
-
-    if configured_by_env
-      unless manifest_file.nil? && code_string.nil?
-        # TRANSLATORS: do not translate the variable names in this error message
-        raise ArgumentError, _("manifest_file or code_string cannot be given when configured_by_env is true")
-      end
-      # Use the manifest setting
-      manifest_file = Puppet[:manifest]
-    else
-      # An "undef" code_string is the only way to override Puppet[:manifest] & Puppet[:code] settings since an
-      # empty string is taken as Puppet[:code] not being set.
-      #
-      if manifest_file.nil? && code_string.nil?
-        code_string = 'undef'
-      end
-    end
-
-    Puppet[:tasks] = true
-    # After the assertions, if code_string is non nil - it has the highest precedence
-    Puppet[:code] = code_string unless code_string.nil?
-
-    # If manifest_file is nil, the #main method will use the env configured manifest
-    # to do things in the block while a Script Compiler is in effect
-    main(manifest_file, facts, variables, :script, &block)
-  end
-
-  # Evaluates a Puppet Language script string.
-  # @param code_string [String] a snippet of Puppet Language source code
-  # @return [Object] what the Puppet Language code_string evaluates to
-  # @deprecated Use {#with_script_compiler} and then evaluate_string on the given compiler - to be removed in 1.0 version
-  #
-  def self.evaluate_script_string(code_string)
-    # prevent the default loading of Puppet[:manifest] which is the environment's manifest-dir by default settings
-    # by setting code_string to 'undef'
-    with_script_compiler do |compiler|
-      compiler.evaluate_string(code_string)
-    end
-  end
-
-  # Evaluates a Puppet Language script (.pp) file.
-  # @param manifest_file [String] a file with Puppet Language source code
-  # @return [Object] what the Puppet Language manifest_file contents evaluates to
-  # @deprecated Use {#with_script_compiler} and then evaluate_file on the given compiler - to be removed in 1.0 version
-  #
-  def self.evaluate_script_manifest(manifest_file)
-    with_script_compiler do |compiler|
-      compiler.evaluate_file(manifest_file)
-    end
-  end
-
-  # Defines a context in which multiple operations in an env with a catalog producing compiler can be performed
-  # in a given block.
-  # The calls that takes place to PAL inside of the given block are all with the same instance of the compiler.
-  # The parameter `configured_by_env` makes it possible to either use the configuration in the environment, or specify
-  # `manifest_file` or `code_string` manually. If neither is given, an empty `code_string` is used.
-  #
-  # @example define a catalog compiler without any initial logic
-  #   pal.with_catalog_compiler do | compiler |
-  #     # do things with compiler
-  #   end
-  #
-  # @example define a catalog compiler with a code_string containing initial logic
-  #   pal.with_catalog_compiler(code_string: '$myglobal_var = 42')  do | compiler |
-  #     # do things with compiler
-  #   end
-  #
-  # @param configured_by_env [Boolean] when true the environment's settings are used, otherwise the
-  #   given `manifest_file` or `code_string`
-  # @param manifest_file [String] a Puppet Language file to load and evaluate before calling the given block, mutually exclusive
-  #   with `code_string`
-  # @param code_string [String] a Puppet Language source string to load and evaluate before calling the given block, mutually
-  #   exclusive with `manifest_file`
-  # @param facts [Hash] optional map of fact name to fact value - if not given will initialize the facts (which is a slow operation)
-  #   If given at the environment level, the facts given here are merged with higher priority.
-  # @param variables [Hash] optional map of fully qualified variable name to value. If given at the environment level, the variables
-  #   given here are merged with higher priority.
-  # @param block [Proc] the block performing operations on compiler
-  # @return [Object] what the block returns
-  # @yieldparam [Puppet::Pal::CatalogCompiler] compiler, a CatalogCompiler to perform operations on.
-  #
-  def self.with_catalog_compiler(
-    configured_by_env: false,
-      manifest_file:     nil,
-      code_string:       nil,
-      facts:             nil,
-      variables:         nil,
-      &block
-  )
-    # TRANSLATORS: do not translate variable name strings in these assertions
-    assert_mutually_exclusive(manifest_file, code_string, 'manifest_file', 'code_string')
-    assert_non_empty_string(manifest_file, 'manifest_file', true)
-    assert_non_empty_string(code_string, 'code_string', true)
-    assert_type(T_BOOLEAN, configured_by_env, "configured_by_env", false)
-
-    if configured_by_env
-      unless manifest_file.nil? && code_string.nil?
-        # TRANSLATORS: do not translate the variable names in this error message
-        raise ArgumentError, _("manifest_file or code_string cannot be given when configured_by_env is true")
-      end
-      # Use the manifest setting
-      manifest_file = Puppet[:manifest]
-    else
-      # An "undef" code_string is the only way to override Puppet[:manifest] & Puppet[:code] settings since an
-      # empty string is taken as Puppet[:code] not being set.
-      #
-      if manifest_file.nil? && code_string.nil?
-        code_string = 'undef'
-      end
-    end
-
-    Puppet[:tasks] = false
-    # After the assertions, if code_string is non nil - it has the highest precedence
-    Puppet[:code] = code_string unless code_string.nil?
-
-    # If manifest_file is nil, the #main method will use the env configured manifest
-    # to do things in the block while a Script Compiler is in effect
-    main(manifest_file, facts, variables, :catalog, &block)
-  end
-
-  # Defines the context in which to perform puppet operations (evaluation, etc)
-  # The code to evaluate in this context is given in a block.
-  #
-  # @param env_name [String] a name to use for the temporary environment - this only shows up in errors
-  # @param modulepath [Array<String>] an array of directory paths containing Puppet modules, may be empty, defaults to empty array
-  # @param settings_hash [Hash] a hash of settings - currently not used for anything, defaults to empty hash
-  # @param facts [Hash] optional map of fact name to fact value - if not given will initialize the facts (which is a slow operation)
-  # @param variables [Hash] optional map of fully qualified variable name to value
-  # @return [Object] returns what the given block returns
-  # @yieldparam [Puppet::Pal] context, a context that responds to Puppet::Pal methods
-  #
-  def self.in_tmp_environment(env_name,
-      modulepath:    [],
-      settings_hash: {},
-      facts:         nil,
-      variables:     {},
-      &block
-    )
-    assert_non_empty_string(env_name, _("temporary environment name"))
-    # TRANSLATORS: do not translate variable name string in these assertions
-    assert_optionally_empty_array(modulepath, 'modulepath')
-
-    unless block_given?
-      raise ArgumentError, _("A block must be given to 'in_tmp_environment'") # TRANSLATORS 'in_tmp_environment' is a name, do not translate
-    end
-
-    env = Puppet::Node::Environment.create(env_name, modulepath)
-
-    in_environment_context(
-      Puppet::Environments::Static.new(env), # The tmp env is the only known env
-      env, facts, variables, &block
-      )
-  end
-
-  # Defines the context in which to perform puppet operations (evaluation, etc)
-  # The code to evaluate in this context is given in a block.
-  #
-  # The name of an environment (env_name) is always given. The location of that environment on disk
-  # is then either constructed by:
-  # * searching a given envpath where name is a child of a directory on that path, or
-  # * it is the directory given in env_dir (which must exist).
-  #
-  # The env_dir and envpath options are mutually exclusive.
-  #
-  # @param env_name [String] the name of an existing environment
-  # @param modulepath [Array<String>] an array of directory paths containing Puppet modules, overrides the modulepath of an existing env.
-  #   Defaults to `{env_dir}/modules` if `env_dir` is given,
-  # @param pre_modulepath [Array<String>] like modulepath, but is prepended to the modulepath
-  # @param post_modulepath [Array<String>] like modulepath, but is appended to the modulepath
-  # @param settings_hash [Hash] a hash of settings - currently not used for anything, defaults to empty hash
-  # @param env_dir [String] a reference to a directory being the named environment (mutually exclusive with `envpath`)
-  # @param envpath [String] a path of directories in which there are environments to search for `env_name` (mutually exclusive with `env_dir`).
-  #   Should be a single directory, or several directories separated with platform specific `File::PATH_SEPARATOR` character.
-  # @param facts [Hash] optional map of fact name to fact value - if not given will initialize the facts (which is a slow operation)
-  # @param variables [Hash] optional map of fully qualified variable name to value
-  # @return [Object] returns what the given block returns
-  # @yieldparam [Puppet::Pal] context, a context that responds to Puppet::Pal methods
-  #
-  def self.in_environment(env_name,
-      modulepath:    nil,
-      pre_modulepath: [],
-      post_modulepath: [],
-      settings_hash: {},
-      env_dir:       nil,
-      envpath:       nil,
-      facts:         nil,
-      variables:     {},
-      &block
-    )
-    # TRANSLATORS terms in the assertions below are names of terms in code
-    assert_non_empty_string(env_name, 'env_name')
-    assert_optionally_empty_array(modulepath, 'modulepath', true)
-    assert_optionally_empty_array(pre_modulepath, 'pre_modulepath', false)
-    assert_optionally_empty_array(post_modulepath, 'post_modulepath', false)
-    assert_mutually_exclusive(env_dir, envpath, 'env_dir', 'envpath')
-
-    unless block_given?
-      raise ArgumentError, _("A block must be given to 'in_environment'") # TRANSLATORS 'in_environment' is a name, do not translate
-    end
-
-    if env_dir
-      unless Puppet::FileSystem.exist?(env_dir)
-        raise ArgumentError, _("The environment directory '%{env_dir}' does not exist") % { env_dir: env_dir }
-      end
-
-      # a nil modulepath for env_dir means it should use its ./modules directory
-      mid_modulepath = modulepath.nil? ? [Puppet::FileSystem.expand_path(File.join(env_dir, 'modules'))] : modulepath
-
-      env = Puppet::Node::Environment.create(env_name, pre_modulepath + mid_modulepath + post_modulepath)
-      environments = Puppet::Environments::StaticDirectory.new(env_name, env_dir, env) # The env being used is the only one...
-    else
-      assert_non_empty_string(envpath, 'envpath')
-
-      # The environment is resolved against the envpath. This is setup without a basemodulepath
-      # The modulepath defaults to the 'modulepath' in the found env when "Directories" is used
-      #
-      if envpath.is_a?(String) && envpath.include?(File::PATH_SEPARATOR)
-        # potentially more than one directory to search
-        env_loaders = Puppet::Environments::Directories.from_path(envpath, [])
-        environments = Puppet::Environments::Combined.new(*env_loaders)
-      else
-        environments = Puppet::Environments::Directories.new(envpath, [])
-      end
-      env = environments.get(env_name)
-      if env.nil?
-        raise ArgumentError, _("No directory found for the environment '%{env_name}' on the path '%{envpath}'") % { env_name: env_name, envpath: envpath }
-      end
-      # A given modulepath should override the default
-      mid_modulepath = modulepath.nil? ? env.modulepath : modulepath
-      env_path = env.configuration.path_to_env
-      env = env.override_with(:modulepath => pre_modulepath + mid_modulepath + post_modulepath)
-      # must configure this in case logic looks up the env by name again (otherwise the looked up env does
-      # not have the same effective modulepath).
-      environments = Puppet::Environments::StaticDirectory.new(env_name, env_path, env) # The env being used is the only one...
-    end
-    in_environment_context(environments, env, facts, variables, &block)
-  end
-
-  # Prepares the puppet context with pal information - and delegates to the block
-  # No set up is performed at this step - it is delayed until it is known what the
-  # operation is going to be (for example - using a ScriptCompiler).
-  #
-  def self.in_environment_context(environments, env, facts, variables, &block)
-    # Create a default node to use (may be overridden later)
-    node = Puppet::Node.new(Puppet[:node_name_value], :environment => env)
-
-    Puppet.override(
-      environments: environments,     # The env being used is the only one...
-      pal_env: env,                   # provide as convenience
-      pal_current_node: node,         # to allow it to be picked up instead of created
-      pal_variables: variables,       # common set of variables across several inner contexts
-      pal_facts: facts                # common set of facts across several inner contexts (or nil)
-    ) do
-      # DELAY: prepare_node_facts(node, facts)
-      return block.call(self)
-    end
-  end
-  private_class_method :in_environment_context
-
-  # Prepares the node for use by giving it node_facts (if given)
-  # If a hash of facts values is given, then the operation of creating a node with facts is much
-  # speeded up (as getting a fresh set of facts is avoided in a later step).
-  #
-  def self.prepare_node_facts(node, facts)
-    # Prepare the node with facts if it does not already have them
-    if node.facts.nil?
-      node_facts = facts.nil? ? nil : Puppet::Node::Facts.new(Puppet[:node_name_value], facts)
-      node.fact_merge(node_facts)
-      # Add server facts so $server_facts[environment] exists when doing a puppet script
-      # SCRIPT TODO: May be needed when running scripts under orchestrator. Leave it for now.
-      #
-      node.add_server_facts({})
-    end
-  end
-  private_class_method :prepare_node_facts
-
-  def self.add_variables(scope, variables)
-    return if variables.nil?
-    unless variables.is_a?(Hash)
-      raise ArgumentError, _("Given variables must be a hash, got %{type}") % { type: variables.class }
-    end
-
-    rich_data_t = Puppet::Pops::Types::TypeFactory.rich_data
-    variables.each_pair do |k,v|
-      unless k =~ Puppet::Pops::Patterns::VAR_NAME
-        raise ArgumentError, _("Given variable '%{varname}' has illegal name") % { varname: k }
-      end
-
-      unless rich_data_t.instance?(v)
-        raise ArgumentError, _("Given value for '%{varname}' has illegal type - got: %{type}") % { varname: k, type: v.class }
-      end
-
-      scope.setvar(k, v)
-    end
-  end
-  private_class_method :add_variables
-
-  # The main routine for script compiler
-  # Picks up information from the puppet context and configures a script compiler which is given to
-  # the provided block
-  #
-  def self.main(manifest, facts, variables, internal_compiler_class)
-    # Configure the load path
-    env = Puppet.lookup(:pal_env)
-    env.each_plugin_directory do |dir|
-      $LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
-    end
-
-    # Puppet requires Facter, which initializes its lookup paths. Reset Facter to
-    # pickup the new $LOAD_PATH.
-    Facter.reset
-
-    node = Puppet.lookup(:pal_current_node)
-    pal_facts = Puppet.lookup(:pal_facts)
-    pal_variables = Puppet.lookup(:pal_variables)
-
-    overrides = {}
-    unless facts.nil? || facts.empty?
-      pal_facts = pal_facts.merge(facts)
-      overrides[:pal_facts] = pal_facts
-    end
-    unless variables.nil? || variables.empty?
-      pal_variables = pal_variables.merge(variables)
-      overrides[:pal_variables] = pal_variables
-    end
-
-    prepare_node_facts(node, pal_facts)
-
-    configured_environment = node.environment || Puppet.lookup(:current_environment)
-
-    apply_environment = manifest ?
-      configured_environment.override_with(:manifest => manifest) :
-      configured_environment
-
-    # Modify the node descriptor to use the special apply_environment.
-    # It is based on the actual environment from the node, or the locally
-    # configured environment if the node does not specify one.
-    # If a manifest file is passed on the command line, it overrides
-    # the :manifest setting of the apply_environment.
-    node.environment = apply_environment
-
-    # TRANSLATORS, the string "For puppet PAL" is not user facing
-    Puppet.override({:current_environment => apply_environment}, "For puppet PAL") do
-      begin
-        # support the following features when evaluating puppet code
-        # * $facts with facts from host running the script
-        # * $settings with 'settings::*' namespace populated, and '$settings::all_local' hash
-        # * $trusted as setup when using puppet apply
-        # * an environment
-        #
-
-        # fixup trusted information
-        node.sanitize()
-
-        compiler = create_internal_compiler(internal_compiler_class, node)
-        # compiler = Puppet::Parser::ScriptCompiler.new(node.environment, node.name)
-        topscope = compiler.topscope
-
-        # When scripting the trusted data are always local, but set them anyway
-        # When compiling for a catalog, the catalog compiler does this
-        unless internal_compiler_class == :catalog
-          topscope.set_trusted(node.trusted_data)
-
-          # Server facts are always about the local node's version etc.
-          topscope.set_server_facts(node.server_facts)
-
-          # Set $facts for the node running the script
-          facts_hash = node.facts.nil? ? {} : node.facts.values
-          topscope.set_facts(facts_hash)
-
-          # create the $settings:: variables
-          topscope.merge_settings(node.environment.name, false)
-        end
-
-        add_variables(topscope, pal_variables)
-
-        case internal_compiler_class
-        when :script
-          pal_compiler = ScriptCompiler.new(compiler)
-          overrides[:pal_script_compiler] = overrides[:pal_compiler] = pal_compiler
-        when :catalog
-          pal_compiler = CatalogCompiler.new(compiler)
-          overrides[:pal_catalog_compiler] = overrides[:pal_compiler] = pal_compiler
-        end
-
-        # Make compiler available to Puppet#lookup and injection in functions
-        # TODO: The compiler instances should be available under non PAL use as well!
-        # TRANSLATORS: Do not translate, symbolic name
-        Puppet.override(overrides, "PAL::with_#{internal_compiler_class}_compiler") do
-          compiler.compile do | compiler_yield |
-            # wrap the internal compiler to prevent it from leaking in the PAL API
-            if block_given?
-              yield(pal_compiler)
-            end
-          end
-        end
-
-      rescue Puppet::ParseErrorWithIssue, Puppet::Error
-        # already logged and handled by the compiler for these two cases
-        raise
-
-      rescue => detail
-        Puppet.log_exception(detail)
-        raise
-      end
-    end
-  end
-  private_class_method :main
-
-  def self.create_internal_compiler(compiler_class_reference, node)
-    case compiler_class_reference
-    when :script
-      Puppet::Parser::ScriptCompiler.new(node.environment, node.name)
-    when :catalog
-      Puppet::Parser::CatalogCompiler.new(node)
-    else
-      raise ArgumentError, "Internal Error: Invalid compiler type requested."
-    end
-  end
-
-  T_STRING = Puppet::Pops::Types::PStringType::NON_EMPTY
-  T_STRING_ARRAY = Puppet::Pops::Types::TypeFactory.array_of(T_STRING)
-  T_ANY_ARRAY = Puppet::Pops::Types::TypeFactory.array_of_any
-  T_BOOLEAN = Puppet::Pops::Types::PBooleanType::DEFAULT
-
-  T_GENERIC_TASK_HASH = Puppet::Pops::Types::TypeFactory.hash_kv(
-    Puppet::Pops::Types::TypeFactory.pattern(/\A[a-z][a-z0-9_]*\z/), Puppet::Pops::Types::TypeFactory.data)
-
-  def self.assert_type(type, value, what, allow_nil=false)
-    Puppet::Pops::Types::TypeAsserter.assert_instance_of(nil, type, value, allow_nil) { _('Puppet Pal: %{what}') % {what: what} }
-  end
-
-  def self.assert_non_empty_string(s, what, allow_nil=false)
-    assert_type(T_STRING, s, what, allow_nil)
-  end
-
-  def self.assert_optionally_empty_array(a, what, allow_nil=false)
-    assert_type(T_STRING_ARRAY, a, what, allow_nil)
-  end
-  private_class_method :assert_optionally_empty_array
-
-  def self.assert_mutually_exclusive(a, b, a_term, b_term)
-    if a && b
-      raise ArgumentError, _("Cannot use '%{a_term}' and '%{b_term}' at the same time") % { a_term: a_term, b_term: b_term }
-    end
-  end
-  private_class_method :assert_mutually_exclusive
-
-  def self.assert_block_given(block)
-    if block.nil?
-      raise ArgumentError, _("A block must be given")
-    end
-  end
-  private_class_method :assert_block_given
-end
-end
-