openvox 8.19.0

data/lib/puppet/parser/compiler.rb

@@ -0,0 +1,616 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative '../../puppet/node'
+require_relative '../../puppet/resource/catalog'
+require_relative '../../puppet/util/errors'
+
+require_relative '../../puppet/loaders'
+require_relative '../../puppet/pops'
+
+# Maintain a graph of scopes, along with a bunch of data
+# about the individual catalog we're compiling.
+class Puppet::Parser::Compiler
+  include Puppet::Parser::AbstractCompiler
+
+  extend Forwardable
+
+  include Puppet::Util
+  include Puppet::Util::Errors
+  include Puppet::Pops::Evaluator::Runtime3Support
+
+  def self.compile(node, code_id = nil)
+    node.environment.check_for_reparse
+
+    errors = node.environment.validation_errors
+    unless errors.empty?
+      errors.each { |e| Puppet.err(e) } if errors.size > 1
+      errmsg = [
+        _("Compilation has been halted because: %{error}") % { error: errors.first },
+        _("For more information, see https://puppet.com/docs/puppet/latest/environments_about.html")
+      ]
+      raise(Puppet::Error, errmsg.join(' '))
+    end
+
+    new(node, :code_id => code_id).compile(&:to_resource)
+  rescue Puppet::ParseErrorWithIssue => detail
+    detail.node = node.name
+    Puppet.log_exception(detail)
+    raise
+  rescue => detail
+    message = _("%{message} on node %{node}") % { message: detail, node: node.name }
+    Puppet.log_exception(detail, message)
+    raise Puppet::Error, message, detail.backtrace
+  end
+
+  attr_reader :node, :facts, :collections, :catalog, :resources, :relationships, :topscope
+  attr_reader :qualified_variables
+
+  # Access to the configured loaders for 4x
+  # @return [Puppet::Pops::Loader::Loaders] the configured loaders
+  # @api private
+  attr_reader :loaders
+
+  # The id of code input to the compiler.
+  # @api private
+  attr_accessor :code_id
+
+  # Add a collection to the global list.
+  def_delegator :@collections,   :<<, :add_collection
+  def_delegator :@relationships, :<<, :add_relationship
+
+  # Store a resource override.
+  def add_override(override)
+    # If possible, merge the override in immediately.
+    resource = @catalog.resource(override.ref)
+    if resource
+      resource.merge(override)
+    else
+      # Otherwise, store the override for later; these
+      # get evaluated in Resource#finish.
+      @resource_overrides[override.ref] << override
+    end
+  end
+
+  def add_resource(scope, resource)
+    @resources << resource
+
+    # Note that this will fail if the resource is not unique.
+    @catalog.add_resource(resource)
+
+    if !resource.class? and resource[:stage]
+      # TRANSLATORS "stage" is a keyword in Puppet and should not be translated
+      raise ArgumentError, _("Only classes can set 'stage'; normal resources like %{resource} cannot change run stage") % { resource: resource }
+    end
+
+    # Stages should not be inside of classes.  They are always a
+    # top-level container, regardless of where they appear in the
+    # manifest.
+    return if resource.stage?
+
+    # This adds a resource to the class it lexically appears in in the
+    # manifest.
+    unless resource.class?
+      @catalog.add_edge(scope.resource, resource)
+    end
+  end
+
+  # Store the fact that we've evaluated a class
+  def add_class(name)
+    @catalog.add_class(name) unless name == ""
+  end
+
+  # Add a catalog validator that will run at some stage to this compiler
+  # @param catalog_validators [Class<CatalogValidator>] The catalog validator class to add
+  def add_catalog_validator(catalog_validators)
+    @catalog_validators << catalog_validators
+    nil
+  end
+
+  def add_catalog_validators
+    add_catalog_validator(CatalogValidator::RelationshipValidator)
+  end
+
+  # Return a list of all of the defined classes.
+  def_delegator :@catalog, :classes, :classlist
+
+  def with_context_overrides(description = '', &block)
+    Puppet.override(@context_overrides, description, &block)
+  end
+
+  # Compiler our catalog.  This mostly revolves around finding and evaluating classes.
+  # This is the main entry into our catalog.
+  def compile
+    Puppet.override(@context_overrides, _("For compiling %{node}") % { node: node.name }) do
+      @catalog.environment_instance = environment
+
+      # Set the client's parameters into the top scope.
+      Puppet::Util::Profiler.profile(_("Compile: Set node parameters"), [:compiler, :set_node_params]) { set_node_parameters }
+
+      Puppet::Util::Profiler.profile(_("Compile: Created settings scope"), [:compiler, :create_settings_scope]) { create_settings_scope }
+
+      # TRANSLATORS "main" is a function name and should not be translated
+      Puppet::Util::Profiler.profile(_("Compile: Evaluated main"), [:compiler, :evaluate_main]) { evaluate_main }
+
+      Puppet::Util::Profiler.profile(_("Compile: Evaluated AST node"), [:compiler, :evaluate_ast_node]) { evaluate_ast_node }
+
+      Puppet::Util::Profiler.profile(_("Compile: Evaluated node classes"), [:compiler, :evaluate_node_classes]) { evaluate_node_classes }
+
+      Puppet::Util::Profiler.profile(_("Compile: Evaluated generators"), [:compiler, :evaluate_generators]) { evaluate_generators }
+
+      Puppet::Util::Profiler.profile(_("Compile: Validate Catalog pre-finish"), [:compiler, :validate_pre_finish]) do
+        validate_catalog(CatalogValidator::PRE_FINISH)
+      end
+
+      Puppet::Util::Profiler.profile(_("Compile: Finished catalog"), [:compiler, :finish_catalog]) { finish }
+
+      fail_on_unevaluated
+
+      Puppet::Util::Profiler.profile(_("Compile: Validate Catalog final"), [:compiler, :validate_final]) do
+        validate_catalog(CatalogValidator::FINAL)
+      end
+
+      if block_given?
+        yield @catalog
+      else
+        @catalog
+      end
+    end
+  end
+
+  def validate_catalog(validation_stage)
+    @catalog_validators.select { |vclass| vclass.validation_stage?(validation_stage) }.each { |vclass| vclass.new(@catalog).validate }
+  end
+
+  # Constructs the overrides for the context
+  def context_overrides
+    {
+      :current_environment => environment,
+      :global_scope => @topscope, # 4x placeholder for new global scope
+      :loaders => @loaders, # 4x loaders
+    }
+  end
+
+  def_delegator :@collections, :delete, :delete_collection
+
+  # Return the node's environment.
+  def environment
+    node.environment
+  end
+
+  # Evaluate all of the classes specified by the node.
+  # Classes with parameters are evaluated as if they were declared.
+  # Classes without parameters or with an empty set of parameters are evaluated
+  # as if they were included. This means classes with an empty set of
+  # parameters won't conflict even if the class has already been included.
+  def evaluate_node_classes
+    if @node.classes.is_a? Hash
+      classes_with_params, classes_without_params = @node.classes.partition { |_name, params| params and !params.empty? }
+
+      # The results from Hash#partition are arrays of pairs rather than hashes,
+      # so we have to convert to the forms evaluate_classes expects (Hash, and
+      # Array of class names)
+      classes_with_params = classes_with_params.to_h
+      classes_without_params.map!(&:first)
+    else
+      classes_with_params = {}
+      classes_without_params = @node.classes
+    end
+
+    evaluate_classes(classes_with_params, @node_scope || topscope)
+    evaluate_classes(classes_without_params, @node_scope || topscope)
+  end
+
+  # If ast nodes are enabled, then see if we can find and evaluate one.
+  #
+  # @api private
+  def evaluate_ast_node
+    krt = environment.known_resource_types
+    return unless krt.nodes? # ast_nodes?
+
+    # Now see if we can find the node.
+    astnode = nil
+    @node.names.each do |name|
+      astnode = krt.node(name.to_s.downcase)
+      break if astnode
+    end
+
+    unless astnode ||= krt.node("default")
+      raise Puppet::ParseError, _("Could not find node statement with name 'default' or '%{names}'") % { names: node.names.join(", ") }
+    end
+
+    # Create a resource to model this node, and then add it to the list
+    # of resources.
+    resource = astnode.ensure_in_catalog(topscope)
+
+    resource.evaluate
+
+    @node_scope = topscope.class_scope(astnode)
+  end
+
+  # Evaluates each specified class in turn. If there are any classes that
+  # can't be found, an error is raised. This method really just creates resource objects
+  # that point back to the classes, and then the resources are themselves
+  # evaluated later in the process.
+  #
+  def evaluate_classes(classes, scope, lazy_evaluate = true)
+    raise Puppet::DevError, _("No source for scope passed to evaluate_classes") unless scope.source
+
+    class_parameters = nil
+    # if we are a param class, save the classes hash
+    # and transform classes to be the keys
+    if classes.instance_of?(Hash)
+      class_parameters = classes
+      classes = classes.keys
+    end
+
+    hostclasses = classes.collect do |name|
+      environment.known_resource_types.find_hostclass(name) or raise Puppet::Error, _("Could not find class %{name} for %{node}") % { name: name, node: node.name }
+    end
+
+    if class_parameters
+      resources = ensure_classes_with_parameters(scope, hostclasses, class_parameters)
+      unless lazy_evaluate
+        resources.each(&:evaluate)
+      end
+
+      resources
+    else
+      already_included, newly_included = ensure_classes_without_parameters(scope, hostclasses)
+      unless lazy_evaluate
+        newly_included.each(&:evaluate)
+      end
+
+      already_included + newly_included
+    end
+  end
+
+  def evaluate_relationships
+    @relationships.each { |rel| rel.evaluate(catalog) }
+  end
+
+  # Return a resource by either its ref or its type and title.
+  def_delegator :@catalog, :resource, :findresource
+
+  def initialize(node, code_id: nil)
+    @node = sanitize_node(node)
+    @code_id = code_id
+    initvars
+    add_catalog_validators
+    # Resolutions of fully qualified variable names
+    @qualified_variables = {}
+  end
+
+  # Create a new scope, with either a specified parent scope or
+  # using the top scope.
+  def newscope(parent, options = {})
+    parent ||= topscope
+    scope = Puppet::Parser::Scope.new(self, **options)
+    scope.parent = parent
+    scope
+  end
+
+  # Return any overrides for the given resource.
+  def resource_overrides(resource)
+    @resource_overrides[resource.ref]
+  end
+
+  private
+
+  def ensure_classes_with_parameters(scope, hostclasses, parameters)
+    hostclasses.collect do |klass|
+      klass.ensure_in_catalog(scope, parameters[klass.name] || {})
+    end
+  end
+
+  def ensure_classes_without_parameters(scope, hostclasses)
+    already_included = []
+    newly_included = []
+    hostclasses.each do |klass|
+      class_scope = scope.class_scope(klass)
+      if class_scope
+        already_included << class_scope.resource
+      else
+        newly_included << klass.ensure_in_catalog(scope)
+      end
+    end
+
+    [already_included, newly_included]
+  end
+
+  # Evaluate our collections and return true if anything returned an object.
+  # The 'true' is used to continue a loop, so it's important.
+  def evaluate_collections
+    return false if @collections.empty?
+
+    exceptwrap do
+      # We have to iterate over a dup of the array because
+      # collections can delete themselves from the list, which
+      # changes its length and causes some collections to get missed.
+      Puppet::Util::Profiler.profile(_("Evaluated collections"), [:compiler, :evaluate_collections]) do
+        found_something = false
+        @collections.dup.each do |collection|
+          found_something = true if collection.evaluate
+        end
+        found_something
+      end
+    end
+  end
+
+  # Make sure all of our resources have been evaluated into native resources.
+  # We return true if any resources have, so that we know to continue the
+  # evaluate_generators loop.
+  def evaluate_definitions
+    exceptwrap do
+      Puppet::Util::Profiler.profile(_("Evaluated definitions"), [:compiler, :evaluate_definitions]) do
+        urs = unevaluated_resources.each do |resource|
+          resource.evaluate
+        rescue Puppet::Pops::Evaluator::PuppetStopIteration => detail
+          # needs to be handled specifically as the error has the file/line/position where this
+          # occurred rather than the resource
+          fail(Puppet::Pops::Issues::RUNTIME_ERROR, detail, { :detail => detail.message }, detail)
+        rescue Puppet::Error => e
+          # PuppetError has the ability to wrap an exception, if so, use the wrapped exception's
+          # call stack instead
+          fail(Puppet::Pops::Issues::RUNTIME_ERROR, resource, { :detail => e.message }, e.original || e)
+        end
+        !urs.empty?
+      end
+    end
+  end
+
+  # Iterate over collections and resources until we're sure that the whole
+  # compile is evaluated.  This is necessary because both collections
+  # and defined resources can generate new resources, which themselves could
+  # be defined resources.
+  def evaluate_generators
+    count = 0
+    loop do
+      done = true
+
+      Puppet::Util::Profiler.profile(_("Iterated (%{count}) on generators") % { count: count + 1 }, [:compiler, :iterate_on_generators]) do
+        # Call collections first, then definitions.
+        done = false if evaluate_collections
+        done = false if evaluate_definitions
+      end
+
+      break if done
+
+      count += 1
+
+      if count > 1000
+        raise Puppet::ParseError, _("Somehow looped more than 1000 times while evaluating host catalog")
+      end
+    end
+  end
+  protected :evaluate_generators
+
+  # Find and evaluate our main object, if possible.
+  def evaluate_main
+    krt = environment.known_resource_types
+    @main = krt.find_hostclass('') || krt.add(Puppet::Resource::Type.new(:hostclass, ''))
+    @topscope.source = @main
+    @main_resource = Puppet::Parser::Resource.new('class', :main, :scope => @topscope, :source => @main)
+    @topscope.resource = @main_resource
+
+    add_resource(@topscope, @main_resource)
+
+    @main_resource.evaluate
+  end
+
+  # Make sure the entire catalog is evaluated.
+  def fail_on_unevaluated
+    fail_on_unevaluated_overrides
+    fail_on_unevaluated_resource_collections
+  end
+
+  # If there are any resource overrides remaining, then we could
+  # not find the resource they were supposed to override, so we
+  # want to throw an exception.
+  def fail_on_unevaluated_overrides
+    remaining = @resource_overrides.values.flatten.collect(&:ref)
+
+    unless remaining.empty?
+      raise Puppet::ParseError, _("Could not find resource(s) %{resources} for overriding") % { resources: remaining.join(', ') }
+    end
+  end
+
+  # Make sure there are no remaining collections that are waiting for
+  # resources that have not yet been instantiated. If this occurs it
+  # is an error (missing resource - it could not be realized).
+  #
+  def fail_on_unevaluated_resource_collections
+    remaining = @collections.collect(&:unresolved_resources).flatten.compact
+    unless remaining.empty?
+      raise Puppet::ParseError, _("Failed to realize virtual resources %{resources}") % { resources: remaining.join(', ') }
+    end
+  end
+
+  # Make sure all of our resources and such have done any last work
+  # necessary.
+  def finish
+    evaluate_relationships
+
+    resources.each do |resource|
+      # Add in any resource overrides.
+      overrides = resource_overrides(resource)
+      if overrides
+        overrides.each do |over|
+          resource.merge(over)
+        end
+
+        # Remove the overrides, so that the configuration knows there
+        # are none left.
+        overrides.clear
+      end
+
+      resource.finish if resource.respond_to?(:finish)
+    end
+
+    add_resource_metaparams
+  end
+  protected :finish
+
+  def add_resource_metaparams
+    main = catalog.resource(:class, :main)
+    unless main
+      # TRANSLATORS "main" is a function name and should not be translated
+      raise _("Couldn't find main")
+    end
+
+    names = Puppet::Type.metaparams.select do |name|
+      !Puppet::Parser::Resource.relationship_parameter?(name)
+    end
+    data = {}
+    catalog.walk(main, :out) do |source, target|
+      source_data = data[source] || metaparams_as_data(source, names)
+      if source_data
+        # only store anything in the data hash if we've actually got
+        # data
+        data[source] ||= source_data
+        source_data.each do |param, value|
+          target[param] = value if target[param].nil?
+        end
+        data[target] = source_data.merge(metaparams_as_data(target, names))
+      end
+
+      target.merge_tags_from(source)
+    end
+  end
+
+  def metaparams_as_data(resource, params)
+    data = nil
+    params.each do |param|
+      next if resource[param].nil?
+
+      # Because we could be creating a hash for every resource,
+      # and we actually probably don't often have any data here at all,
+      # we're optimizing a bit by only creating a hash if there's
+      # any data to put in it.
+      data ||= {}
+      data[param] = resource[param]
+    end
+    data
+  end
+
+  # Set up all of our internal variables.
+  def initvars
+    # The list of overrides.  This is used to cache overrides on objects
+    # that don't exist yet.  We store an array of each override.
+    @resource_overrides = Hash.new do |overs, ref|
+      overs[ref] = []
+    end
+
+    # The list of collections that have been created.  This is a global list,
+    # but they each refer back to the scope that created them.
+    @collections = []
+
+    # The list of relationships to evaluate.
+    @relationships = []
+
+    # For maintaining the relationship between scopes and their resources.
+    @catalog = Puppet::Resource::Catalog.new(@node.name, @node.environment, @code_id)
+
+    # MOVED HERE - SCOPE IS NEEDED (MOVE-SCOPE)
+    # Create the initial scope, it is needed early
+    @topscope = Puppet::Parser::Scope.new(self)
+
+    # Initialize loaders and Pcore
+    @loaders = Puppet::Pops::Loaders.new(environment)
+
+    # Need to compute overrides here, and remember them, because we are about to
+    # enter the magic zone of known_resource_types and initial import.
+    # Expensive entries in the context are bound lazily.
+    @context_overrides = context_overrides()
+
+    # This construct ensures that initial import (triggered by instantiating
+    # the structure 'known_resource_types') has a configured context
+    # It cannot survive the initvars method, and is later reinstated
+    # as part of compiling...
+    #
+    Puppet.override(@context_overrides, _("For initializing compiler")) do
+      # THE MAGIC STARTS HERE ! This triggers parsing, loading etc.
+      @catalog.version = environment.known_resource_types.version
+      @loaders.pre_load
+    end
+
+    @catalog.add_resource(Puppet::Parser::Resource.new("stage", :main, :scope => @topscope))
+
+    # local resource array to maintain resource ordering
+    @resources = []
+
+    # Make sure any external node classes are in our class list
+    if @node.classes.instance_of?(Hash)
+      @catalog.add_class(*@node.classes.keys)
+    else
+      @catalog.add_class(*@node.classes)
+    end
+
+    @catalog_validators = []
+  end
+
+  def sanitize_node(node)
+    node.sanitize
+    node
+  end
+
+  # Set the node's parameters into the top-scope as variables.
+  def set_node_parameters
+    node.parameters.each do |param, value|
+      # We don't want to set @topscope['environment'] from the parameters,
+      # instead we want to get that from the node's environment itself in
+      # case a custom node terminus has done any mucking about with
+      # node.parameters.
+      next if param.to_s == 'environment'
+
+      # Ensure node does not leak Symbol instances in general
+      @topscope[param.to_s] = value.is_a?(Symbol) ? value.to_s : value
+    end
+    @topscope['environment'] = node.environment.name.to_s
+
+    # These might be nil.
+    catalog.client_version = node.parameters["clientversion"]
+    catalog.server_version = node.parameters["serverversion"]
+    @topscope.set_trusted(node.trusted_data)
+
+    @topscope.set_server_facts(node.server_facts)
+
+    facts_hash = node.facts.nil? ? {} : node.facts.values
+    @topscope.set_facts(facts_hash)
+  end
+
+  SETTINGS = 'settings'
+
+  def create_settings_scope
+    settings_type = create_settings_type
+    settings_resource = Puppet::Parser::Resource.new('class', SETTINGS, :scope => @topscope)
+
+    @catalog.add_resource(settings_resource)
+    settings_type.evaluate_code(settings_resource)
+    settings_resource.instance_variable_set(:@evaluated, true) # Prevents settings from being reevaluated
+
+    scope = @topscope.class_scope(settings_type)
+    scope.merge_settings(environment.name)
+  end
+
+  def create_settings_type
+    environment.lock.synchronize do
+      resource_types = environment.known_resource_types
+      settings_type = resource_types.hostclass(SETTINGS)
+      if settings_type.nil?
+        settings_type = Puppet::Resource::Type.new(:hostclass, SETTINGS)
+        resource_types.add(settings_type)
+      end
+
+      settings_type
+    end
+  end
+
+  # Return an array of all of the unevaluated resources.  These will be definitions,
+  # which need to get evaluated into native resources.
+  def unevaluated_resources
+    # The order of these is significant for speed due to short-circuiting
+    resources.reject { |resource| resource.evaluated? or resource.virtual? or resource.builtin_type? }
+  end
+end

data/lib/puppet/parser/e4_parser_adapter.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative '../../puppet/pops'
+
+module Puppet
+module Parser
+# Adapts an egrammar/eparser to respond to the public API of the classic parser
+# and makes use of the new evaluator.
+#
+class E4ParserAdapter
+  def initialize
+    @file = ''
+    @string = ''
+    @use = :unspecified
+  end
+
+  def file=(file)
+    @file = file
+    @use = :file
+  end
+
+  def parse(string = nil)
+    self.string = string if string
+    parser = Pops::Parser::EvaluatingParser.singleton
+    model =
+      if @use == :string
+        # Parse with a source_file to set in created AST objects (it was either given, or it may be unknown
+        # if caller did not set a file and the present a string.
+        #
+        parser.parse_string(@string, @file || "unknown-source-location")
+      else
+        parser.parse_file(@file)
+      end
+
+    # the parse_result may be
+    # * empty / nil (no input)
+    # * a Model::Program
+    # * a Model::Expression
+    #
+    args = {}
+    Pops::Model::AstTransformer.new(@file).merge_location(args, model)
+
+    ast_code =
+      if model.is_a? Pops::Model::Program
+        AST::PopsBridge::Program.new(model, args)
+      else
+        args[:value] = model
+        AST::PopsBridge::Expression.new(args)
+      end
+
+    # Create the "main" class for the content - this content will get merged with all other "main" content
+    AST::Hostclass.new('', :code => ast_code)
+  end
+
+  def string=(string)
+    @string = string
+    @use = :string
+  end
+end
+end
+end