openvox 8.19.0

data/lib/puppet/resource/catalog.rb

@@ -0,0 +1,655 @@
+# frozen_string_literal: true
+
+require_relative '../../puppet/node'
+require_relative '../../puppet/indirector'
+require_relative '../../puppet/transaction'
+require_relative '../../puppet/util/tagging'
+require_relative '../../puppet/graph'
+require 'securerandom'
+
+# This class models a node catalog.  It is the thing meant to be passed
+# from server to client, and it contains all of the information in the
+# catalog, including the resources and the relationships between them.
+#
+# @api public
+
+class Puppet::Resource::Catalog < Puppet::Graph::SimpleGraph
+  class DuplicateResourceError < Puppet::Error
+    include Puppet::ExternalFileError
+  end
+
+  extend Puppet::Indirector
+  indirects :catalog, :terminus_setting => :catalog_terminus
+
+  include Puppet::Util::Tagging
+
+  # The host name this is a catalog for.
+  attr_accessor :name
+
+  # The catalog version.  Used for testing whether a catalog
+  # is up to date.
+  attr_accessor :version
+
+  # The id of the code input to the compiler.
+  attr_accessor :code_id
+
+  # The UUID of the catalog
+  attr_accessor :catalog_uuid
+
+  # @return [Integer] catalog format version number. This value is constant
+  #  for a given version of Puppet; it is incremented when a new release of
+  #  Puppet changes the API for the various objects that make up the catalog.
+  attr_accessor :catalog_format
+
+  # Inlined file metadata for non-recursive find
+  # A hash of title => metadata
+  attr_accessor :metadata
+
+  # Inlined file metadata for recursive search
+  # A hash of title => { source => [metadata, ...] }
+  attr_accessor :recursive_metadata
+
+  # How long this catalog took to retrieve.  Used for reporting stats.
+  attr_accessor :retrieval_duration
+
+  # Whether this is a host catalog, which behaves very differently.
+  # In particular, reports are sent, graphs are made, and state is
+  # stored in the state database.  If this is set incorrectly, then you often
+  # end up in infinite loops, because catalogs are used to make things
+  # that the host catalog needs.
+  attr_accessor :host_config
+
+  # Whether this catalog was retrieved from the cache, which affects
+  # whether it is written back out again.
+  attr_accessor :from_cache
+
+  # Some metadata to help us compile and generally respond to the current state.
+  attr_accessor :client_version, :server_version
+
+  # A String representing the environment for this catalog
+  attr_accessor :environment
+
+  # The actual environment instance that was used during compilation
+  attr_accessor :environment_instance
+
+  # Add classes to our class list.
+  def add_class(*classes)
+    classes.each do |klass|
+      @classes << klass
+    end
+
+    # Add the class names as tags, too.
+    tag(*classes)
+  end
+
+  # Returns [typename, title] when given a String with "Type[title]".
+  # Returns [nil, nil] if '[' ']' not detected.
+  #
+  def title_key_for_ref(ref)
+    s = ref.index('[')
+    e = ref.rindex(']')
+    if s && e && e > s
+      a = [ref[0, s], ref[s + 1, e - s - 1]]
+    else
+      a = [nil, nil]
+    end
+    a
+  end
+
+  def add_resource_before(other, *resources)
+    resources.each do |resource|
+      other_title_key = title_key_for_ref(other.ref)
+      idx = @resources.index(other_title_key)
+      if idx.nil?
+        raise ArgumentError, _("Cannot add resource %{resource_1} before %{resource_2} because %{resource_2} is not yet in the catalog") %
+                             { resource_1: resource.ref, resource_2: other.ref }
+      end
+      add_one_resource(resource, idx)
+    end
+  end
+
+  # Add `resources` to the catalog after `other`. WARNING: adding
+  # multiple resources will produce the reverse ordering, e.g. calling
+  # `add_resource_after(A, [B,C])` will result in `[A,C,B]`.
+  def add_resource_after(other, *resources)
+    resources.each do |resource|
+      other_title_key = title_key_for_ref(other.ref)
+      idx = @resources.index(other_title_key)
+      if idx.nil?
+        raise ArgumentError, _("Cannot add resource %{resource_1} after %{resource_2} because %{resource_2} is not yet in the catalog") %
+                             { resource_1: resource.ref, resource_2: other.ref }
+      end
+      add_one_resource(resource, idx + 1)
+    end
+  end
+
+  def add_resource(*resources)
+    resources.each do |resource|
+      add_one_resource(resource)
+    end
+  end
+
+  # @param resource [A Resource] a resource in the catalog
+  # @return [A Resource, nil] the resource that contains the given resource
+  # @api public
+  def container_of(resource)
+    adjacent(resource, :direction => :in)[0]
+  end
+
+  def add_one_resource(resource, idx = -1)
+    title_key = title_key_for_ref(resource.ref)
+    if @resource_table[title_key]
+      fail_on_duplicate_type_and_title(resource, title_key)
+    end
+
+    add_resource_to_table(resource, title_key, idx)
+    create_resource_aliases(resource)
+
+    resource.catalog = self if resource.respond_to?(:catalog=)
+    add_resource_to_graph(resource)
+  end
+  private :add_one_resource
+
+  def add_resource_to_table(resource, title_key, idx)
+    @resource_table[title_key] = resource
+    @resources.insert(idx, title_key)
+  end
+  private :add_resource_to_table
+
+  def add_resource_to_graph(resource)
+    add_vertex(resource)
+    @relationship_graph.add_vertex(resource) if @relationship_graph
+  end
+  private :add_resource_to_graph
+
+  def create_resource_aliases(resource)
+    # Explicit aliases must always be processed
+    # The alias setting logic checks, and does not error if the alias is set to an already set alias
+    # for the same resource (i.e. it is ok if alias == title
+    explicit_aliases = [resource[:alias]].flatten.compact
+    explicit_aliases.each { |given_alias| self.alias(resource, given_alias) }
+
+    # Skip creating uniqueness key alias and checking collisions for non-isomorphic resources.
+    return unless resource.respond_to?(:isomorphic?) and resource.isomorphic?
+
+    # Add an alias if the uniqueness key is valid and not the title, which has already been checked.
+    ukey = resource.uniqueness_key
+    if ukey.any? and ukey != [resource.title]
+      self.alias(resource, ukey)
+    end
+  end
+  private :create_resource_aliases
+
+  # Create an alias for a resource.
+  def alias(resource, key)
+    ref = resource.ref
+    ref =~ /^(.+)\[/
+    class_name = ::Regexp.last_match(1) || resource.class.name
+
+    newref = [class_name, key].flatten
+
+    if key.is_a? String
+      ref_string = "#{class_name}[#{key}]"
+      return if ref_string == ref
+    end
+
+    # LAK:NOTE It's important that we directly compare the references,
+    # because sometimes an alias is created before the resource is
+    # added to the catalog, so comparing inside the below if block
+    # isn't sufficient.
+    existing = @resource_table[newref]
+    if existing
+      return if existing == resource
+
+      resource_declaration = Puppet::Util::Errors.error_location(resource.file, resource.line)
+      msg = if resource_declaration.empty?
+              # TRANSLATORS 'alias' should not be translated
+              _("Cannot alias %{resource} to %{key}; resource %{newref} already declared") %
+                { resource: ref, key: key.inspect, newref: newref.inspect }
+            else
+              # TRANSLATORS 'alias' should not be translated
+              _("Cannot alias %{resource} to %{key} at %{resource_declaration}; resource %{newref} already declared") %
+                { resource: ref, key: key.inspect, resource_declaration: resource_declaration, newref: newref.inspect }
+            end
+      msg += Puppet::Util::Errors.error_location_with_space(existing.file, existing.line)
+      raise ArgumentError, msg
+    end
+    @resource_table[newref] = resource
+    @aliases[ref] ||= []
+    @aliases[ref] << newref
+  end
+
+  # Apply our catalog to the local host.
+  # @param options [Hash{Symbol => Object}] a hash of options
+  # @option options [Puppet::Transaction::Report] :report
+  #   The report object to log this transaction to. This is optional,
+  #   and the resulting transaction will create a report if not
+  #   supplied.
+  #
+  # @return [Puppet::Transaction] the transaction created for this
+  #   application
+  #
+  # @api public
+  def apply(options = {})
+    Puppet::Util::Storage.load if host_config?
+
+    transaction = create_transaction(options)
+
+    begin
+      transaction.report.as_logging_destination do
+        transaction_evaluate_time = Puppet::Util.thinmark do
+          transaction.evaluate
+        end
+        transaction.report.add_times(:transaction_evaluation, transaction_evaluate_time)
+      end
+    ensure
+      # Don't try to store state unless we're a host config
+      # too recursive.
+      Puppet::Util::Storage.store if host_config?
+    end
+
+    yield transaction if block_given?
+
+    transaction
+  end
+
+  # The relationship_graph form of the catalog. This contains all of the
+  # dependency edges that are used for determining order.
+  #
+  # @param given_prioritizer [Puppet::Graph::Prioritizer] The prioritization
+  #   strategy to use when constructing the relationship graph. Defaults the
+  #   being determined by the `ordering` setting.
+  # @return [Puppet::Graph::RelationshipGraph]
+  # @api public
+  def relationship_graph(given_prioritizer = nil)
+    if @relationship_graph.nil?
+      @relationship_graph = Puppet::Graph::RelationshipGraph.new(given_prioritizer || prioritizer)
+      @relationship_graph.populate_from(self)
+    end
+    @relationship_graph
+  end
+
+  def clear(remove_resources = true)
+    super()
+    # We have to do this so that the resources clean themselves up.
+    @resource_table.values.each(&:remove) if remove_resources
+    @resource_table.clear
+    @resources = []
+
+    if @relationship_graph
+      @relationship_graph.clear
+      @relationship_graph = nil
+    end
+  end
+
+  def classes
+    @classes.dup
+  end
+
+  # Create a new resource and register it in the catalog.
+  def create_resource(type, options)
+    klass = Puppet::Type.type(type)
+    unless klass
+      raise ArgumentError, _("Unknown resource type %{type}") % { type: type }
+    end
+
+    resource = klass.new(options)
+    return unless resource
+
+    add_resource(resource)
+    resource
+  end
+
+  # Make sure all of our resources are "finished".
+  def finalize
+    make_default_resources
+
+    @resource_table.values.each(&:finish)
+
+    write_graph(:resources)
+  end
+
+  def host_config?
+    host_config
+  end
+
+  def initialize(name = nil, environment = Puppet::Node::Environment::NONE, code_id = nil)
+    super()
+    @name = name
+    @catalog_uuid = SecureRandom.uuid
+    @catalog_format = 2
+    @metadata = {}
+    @recursive_metadata = {}
+    @classes = []
+    @resource_table = {}
+    @resources = []
+    @relationship_graph = nil
+
+    @host_config = true
+    @environment_instance = environment
+    @environment = environment.to_s
+    @code_id = code_id
+
+    @aliases = {}
+
+    if block_given?
+      yield(self)
+      finalize
+    end
+  end
+
+  # Make the default objects necessary for function.
+  def make_default_resources
+    # We have to add the resources to the catalog, or else they won't get cleaned up after
+    # the transaction.
+
+    # First create the default scheduling objects
+    Puppet::Type.type(:schedule).mkdefaultschedules.each { |res| add_resource(res) unless resource(res.ref) }
+
+    # And filebuckets
+    bucket = Puppet::Type.type(:filebucket).mkdefaultbucket
+    if bucket
+      add_resource(bucket) unless resource(bucket.ref)
+    end
+  end
+
+  # Remove the resource from our catalog.  Notice that we also call
+  # 'remove' on the resource, at least until resource classes no longer maintain
+  # references to the resource instances.
+  def remove_resource(*resources)
+    resources.each do |resource|
+      ref = resource.ref
+      title_key = title_key_for_ref(ref)
+      @resource_table.delete(title_key)
+      aliases = @aliases[ref]
+      if aliases
+        aliases.each { |res_alias| @resource_table.delete(res_alias) }
+        @aliases.delete(ref)
+      end
+      remove_vertex!(resource) if vertex?(resource)
+      @relationship_graph.remove_vertex!(resource) if @relationship_graph and @relationship_graph.vertex?(resource)
+      @resources.delete(title_key)
+      # Only Puppet::Type kind of resources respond to :remove, not Puppet::Resource
+      resource.remove if resource.respond_to?(:remove)
+    end
+  end
+
+  # Look a resource up by its reference (e.g., File[/etc/passwd]).
+  def resource(type, title = nil)
+    # Retain type if it's a type
+    type_name = type.is_a?(Puppet::CompilableResourceType) || type.is_a?(Puppet::Resource::Type) ? type.name : type
+    type_name, title = Puppet::Resource.type_and_title(type_name, title)
+    type = type_name if type.is_a?(String)
+    title_key = [type_name, title.to_s]
+    result = @resource_table[title_key]
+    if result.nil?
+      # an instance has to be created in order to construct the unique key used when
+      # searching for aliases
+      res = Puppet::Resource.new(type, title, { :environment => @environment_instance })
+
+      # Must check with uniqueness key because of aliases or if resource transforms title in title
+      # to attribute mappings.
+      result = @resource_table[[type_name, res.uniqueness_key].flatten]
+    end
+    result
+  end
+
+  def resource_refs
+    resource_keys.filter_map { |type, name| name.is_a?(String) ? "#{type}[#{name}]" : nil }
+  end
+
+  def resource_keys
+    @resource_table.keys
+  end
+
+  def resources
+    @resources.collect do |key|
+      @resource_table[key]
+    end
+  end
+
+  def self.from_data_hash(data)
+    result = new(data['name'], Puppet::Node::Environment::NONE)
+
+    result.tag(*data['tags']) if data['tags']
+    result.version = data['version'] if data['version']
+    result.code_id = data['code_id'] if data['code_id']
+    result.catalog_uuid = data['catalog_uuid'] if data['catalog_uuid']
+    result.catalog_format = data['catalog_format'] || 0
+
+    environment = data['environment']
+    if environment
+      result.environment = environment
+      result.environment_instance = Puppet::Node::Environment.remote(environment.to_sym)
+    end
+
+    result.add_resource(
+      *data['resources'].collect do |res|
+        Puppet::Resource.from_data_hash(res)
+      end
+    ) if data['resources']
+
+    if data['edges']
+      data['edges'].each do |edge_hash|
+        edge = Puppet::Relationship.from_data_hash(edge_hash)
+        source = result.resource(edge.source)
+        unless source
+          raise ArgumentError, _("Could not intern from data: Could not find relationship source %{source} for %{target}") %
+                               { source: edge.source.inspect, target: edge.target.to_s }
+        end
+        edge.source = source
+
+        target = result.resource(edge.target)
+        unless target
+          raise ArgumentError, _("Could not intern from data: Could not find relationship target %{target} for %{source}") %
+                               { target: edge.target.inspect, source: edge.source.to_s }
+        end
+        edge.target = target
+
+        result.add_edge(edge)
+      end
+    end
+
+    result.add_class(*data['classes']) if data['classes']
+
+    result.metadata = data['metadata'].transform_values { |v| Puppet::FileServing::Metadata.from_data_hash(v); } if data['metadata']
+
+    recursive_metadata = data['recursive_metadata']
+    if recursive_metadata
+      result.recursive_metadata = recursive_metadata.transform_values do |source_to_meta_hash|
+        source_to_meta_hash.transform_values do |metas|
+          metas.map { |meta| Puppet::FileServing::Metadata.from_data_hash(meta) }
+        end
+      end
+    end
+
+    result
+  end
+
+  def to_data_hash
+    metadata_hash = metadata.transform_values(&:to_data_hash)
+    recursive_metadata_hash = recursive_metadata.transform_values do |source_to_meta_hash|
+      source_to_meta_hash.transform_values do |metas|
+        metas.map(&:to_data_hash)
+      end
+    end
+
+    {
+      'tags' => tags.to_a,
+      'name' => name,
+      'version' => version,
+      'code_id' => code_id,
+      'catalog_uuid' => catalog_uuid,
+      'catalog_format' => catalog_format,
+      'environment' => environment.to_s,
+      'resources' => @resources.map { |v| @resource_table[v].to_data_hash },
+      'edges' => edges.map(&:to_data_hash),
+      'classes' => classes,
+    }.merge(metadata_hash.empty? ?
+      {} : { 'metadata' => metadata_hash }).merge(recursive_metadata_hash.empty? ?
+        {} : { 'recursive_metadata' => recursive_metadata_hash })
+  end
+
+  # Convert our catalog into a RAL catalog.
+  def to_ral
+    to_catalog :to_ral
+  end
+
+  # Convert our catalog into a catalog of Puppet::Resource instances.
+  def to_resource
+    to_catalog :to_resource
+  end
+
+  # filter out the catalog, applying +block+ to each resource.
+  # If the block result is false, the resource will
+  # be kept otherwise it will be skipped
+  def filter(&block)
+    # to_catalog must take place in a context where current_environment is set to the same env as the
+    # environment set in the catalog (if it is set)
+    # See PUP-3755
+    if environment_instance
+      Puppet.override({ :current_environment => environment_instance }) do
+        to_catalog :to_resource, &block
+      end
+    else
+      # If catalog has no environment_instance, hope that the caller has made sure the context has the
+      # correct current_environment
+      to_catalog :to_resource, &block
+    end
+  end
+
+  # Store the classes in the classfile.
+  def write_class_file
+    # classfile paths may contain UTF-8
+    # https://puppet.com/docs/puppet/latest/configuration.html#classfile
+    classfile = Puppet.settings.setting(:classfile)
+    Puppet::FileSystem.open(classfile.value, classfile.mode.to_i(8), "w:UTF-8") do |f|
+      f.puts classes.join("\n")
+    end
+  rescue => detail
+    Puppet.err _("Could not create class file %{file}: %{detail}") % { file: Puppet[:classfile], detail: detail }
+  end
+
+  # Store the list of resources we manage
+  def write_resource_file
+    # resourcefile contains resources that may be UTF-8 names
+    # https://puppet.com/docs/puppet/latest/configuration.html#resourcefile
+    resourcefile = Puppet.settings.setting(:resourcefile)
+    Puppet::FileSystem.open(resourcefile.value, resourcefile.mode.to_i(8), "w:UTF-8") do |f|
+      to_print = resources.filter_map do |resource|
+        next unless resource.managed?
+
+        resource.ref.downcase.to_s
+      end
+      f.puts to_print.join("\n")
+    end
+  rescue => detail
+    Puppet.err _("Could not create resource file %{file}: %{detail}") % { file: Puppet[:resourcefile], detail: detail }
+  end
+
+  # Produce the graph files if requested.
+  def write_graph(name)
+    # We only want to graph the main host catalog.
+    return unless host_config?
+
+    super
+  end
+
+  private
+
+  def prioritizer
+    @prioritizer = Puppet::Graph::SequentialPrioritizer.new
+  end
+
+  def create_transaction(options)
+    transaction = Puppet::Transaction.new(self, options[:report], prioritizer)
+    transaction.tags = options[:tags] if options[:tags]
+    transaction.ignoreschedules = true if options[:ignoreschedules]
+    transaction.for_network_device = Puppet.lookup(:network_device) { nil } || options[:network_device]
+
+    transaction
+  end
+
+  # Verify that the given resource isn't declared elsewhere.
+  def fail_on_duplicate_type_and_title(resource, title_key)
+    # Short-circuit the common case,
+    existing_resource = @resource_table[title_key]
+    return unless existing_resource
+
+    # If we've gotten this far, it's a real conflict
+    error_location_str = Puppet::Util::Errors.error_location(existing_resource.file, existing_resource.line)
+    msg = if error_location_str.empty?
+            _("Duplicate declaration: %{resource} is already declared; cannot redeclare") % { resource: resource.ref }
+          else
+            _("Duplicate declaration: %{resource} is already declared at %{error_location}; cannot redeclare") % { resource: resource.ref, error_location: error_location_str }
+          end
+    raise DuplicateResourceError.new(msg, resource.file, resource.line)
+  end
+
+  # An abstracted method for converting one catalog into another type of catalog.
+  # This pretty much just converts all of the resources from one class to another, using
+  # a conversion method.
+  def to_catalog(convert)
+    result = self.class.new(name, environment_instance)
+
+    result.version = version
+    result.code_id = code_id
+    result.catalog_uuid = catalog_uuid
+    result.catalog_format = catalog_format
+    result.metadata = metadata
+    result.recursive_metadata = recursive_metadata
+
+    map = {}
+    resources.each do |resource|
+      next if virtual_not_exported?(resource)
+      next if block_given? and yield resource
+
+      newres = resource.copy_as_resource
+      newres.catalog = result
+
+      if convert != :to_resource
+        newres = newres.to_ral
+      end
+
+      # We can't guarantee that resources don't munge their names
+      # (like files do with trailing slashes), so we have to keep track
+      # of what a resource got converted to.
+      map[resource.ref] = newres
+
+      result.add_resource newres
+    end
+
+    message = convert.to_s.tr "_", " "
+    edges.each do |edge|
+      # Skip edges between virtual resources.
+      next if virtual_not_exported?(edge.source)
+      next if block_given? and yield edge.source
+
+      next if virtual_not_exported?(edge.target)
+      next if block_given? and yield edge.target
+
+      source = map[edge.source.ref]
+      unless source
+        raise Puppet::DevError, _("Could not find resource %{resource} when converting %{message} resources") % { resource: edge.source.ref, message: message }
+      end
+
+      target = map[edge.target.ref]
+      unless target
+        raise Puppet::DevError, _("Could not find resource %{resource} when converting %{message} resources") % { resource: edge.target.ref, message: message }
+      end
+
+      result.add_edge(source, target, edge.label)
+    end
+
+    map.clear
+
+    result.add_class(*classes)
+    result.merge_tags_from(self)
+
+    result
+  end
+
+  def virtual_not_exported?(resource)
+    resource.virtual && !resource.exported
+  end
+end