Class: Puppet::Resource::Catalog

Inherits:
Graph::SimpleGraph show all
Extended by:
Indirector
Includes:
Util::Tagging
Defined in:
lib/puppet/resource/catalog.rb

Overview

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.

Defined Under Namespace

Classes: Compiler, DuplicateResourceError, Json, Msgpack, Rest, StoreConfigs, Yaml

Constant Summary

Constants included from Indirector

Indirector::BadNameRegexp

Constants included from Util::Tagging

Util::Tagging::ValidTagRegex

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Indirector

configure_routes, indirects

Methods included from Util::Tagging

#merge_into, #merge_tags_from, #raw_tagged?, #set_tags, #tag, #tag_if_valid, #tagged?, #tags, #tags=, #valid_tag?

Methods inherited from Graph::SimpleGraph

#add_edge, #add_relationship, #add_vertex, #adjacent, #dependencies, #dependents, #direct_dependencies_of, #direct_dependents_of, #directed?, #downstream_from_vertex, #each_edge, #edge?, #edges, #edges_between, #find_cycles_in_graph, #initialize_from_hash, #leaves, #matching_edges, #path_between, #paths_in_cycle, #remove_edge!, #remove_vertex!, #report_cycles_in_graph, #reversal, #size, #stringify, #tarjan, #to_a, #to_dot, #to_dot_graph, #tree_from_vertex, #upstream_from_vertex, #vertex?, #vertices, #walk, #write_cycles_to_graph

Methods included from Util::PsychSupport

#encode_with, #init_with

Constructor Details

#initialize(name = nil, environment = Puppet::Node::Environment::NONE, code_id = nil) ⇒ Catalog

Returns a new instance of Catalog.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/puppet/resource/catalog.rb', line 313

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

Instance Attribute Details

#catalog_format ⇒ Integer

Returns 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.

Returns:

  • (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.



41
42
43
 
# File 'lib/puppet/resource/catalog.rb', line 41

def catalog_format
  @catalog_format
end

#catalog_uuid ⇒ Object

The UUID of the catalog



36
37
38
 
# File 'lib/puppet/resource/catalog.rb', line 36

def catalog_uuid
  @catalog_uuid
end

#client_version ⇒ Object

Some metadata to help us compile and generally respond to the current state.



66
67
68
 
# File 'lib/puppet/resource/catalog.rb', line 66

def client_version
  @client_version
end

#code_id ⇒ Object

The id of the code input to the compiler.



33
34
35
 
# File 'lib/puppet/resource/catalog.rb', line 33

def code_id
  @code_id
end

#environment ⇒ Object

A String representing the environment for this catalog



69
70
71
 
# File 'lib/puppet/resource/catalog.rb', line 69

def environment
  @environment
end

#environment_instance ⇒ Object

The actual environment instance that was used during compilation



72
73
74
 
# File 'lib/puppet/resource/catalog.rb', line 72

def environment_instance
  @environment_instance
end

#from_cache ⇒ Object

Whether this catalog was retrieved from the cache, which affects whether it is written back out again.



63
64
65
 
# File 'lib/puppet/resource/catalog.rb', line 63

def from_cache
  @from_cache
end

#host_config ⇒ Object

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.



59
60
61
 
# File 'lib/puppet/resource/catalog.rb', line 59

def host_config
  @host_config
end

#metadata ⇒ Object

Inlined file metadata for non-recursive find A hash of title => metadata



45
46
47
 
# File 'lib/puppet/resource/catalog.rb', line 45

def metadata
  @metadata
end

#name ⇒ Object

The host name this is a catalog for.



26
27
28
 
# File 'lib/puppet/resource/catalog.rb', line 26

def name
  @name
end

#recursive_metadata ⇒ Object

Inlined file metadata for recursive search A hash of title => { source => [metadata, …] }



49
50
51
 
# File 'lib/puppet/resource/catalog.rb', line 49

def recursive_metadata
  @recursive_metadata
end

#retrieval_duration ⇒ Object

How long this catalog took to retrieve. Used for reporting stats.



52
53
54
 
# File 'lib/puppet/resource/catalog.rb', line 52

def retrieval_duration
  @retrieval_duration
end

#server_version ⇒ Object

Some metadata to help us compile and generally respond to the current state.



66
67
68
 
# File 'lib/puppet/resource/catalog.rb', line 66

def server_version
  @server_version
end

#version ⇒ Object

The catalog version. Used for testing whether a catalog is up to date.



30
31
32
 
# File 'lib/puppet/resource/catalog.rb', line 30

def version
  @version
end

Class Method Details

.from_data_hash(data) ⇒ Object 



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/puppet/resource/catalog.rb', line 408

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'].inject({}) { |h, (k, v)| h[k] = Puppet::FileServing::Metadata.from_data_hash(v); h } if data['metadata']

  recursive_metadata = data['recursive_metadata']
  if recursive_metadata
    result.recursive_metadata = recursive_metadata.inject({}) do |h, (title, source_to_meta_hash)|
      h[title] = source_to_meta_hash.inject({}) do |inner_h, (source, metas)|
        inner_h[source] = metas.map {|meta| Puppet::FileServing::Metadata.from_data_hash(meta)}
        inner_h
      end
      h
    end
  end

  result
end

Instance Method Details

#add_class(*classes) ⇒ Object

Add classes to our class list.



75
76
77
78
79
80
81
82
 
# File 'lib/puppet/resource/catalog.rb', line 75

def add_class(*classes)
  classes.each do |klass|
    @classes << klass
  end

  # Add the class names as tags, too.
  tag(*classes)
end

#add_resource(*resources) ⇒ Object 



125
126
127
128
129
 
# File 'lib/puppet/resource/catalog.rb', line 125

def add_resource(*resources)
  resources.each do |resource|
    add_one_resource(resource)
  end
end

#add_resource_after(other, *resources) ⇒ Object

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]`.



113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/puppet/resource/catalog.rb', line 113

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

#add_resource_before(other, *resources) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/puppet/resource/catalog.rb', line 98

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

#alias(resource, key) ⇒ Object

Create an alias for a resource.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/puppet/resource/catalog.rb', line 183

def alias(resource, key)
  ref = resource.ref
  ref =~ /^(.+)\[/
  class_name = $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(options = {}) {|transaction| ... } ⇒ Puppet::Transaction

Apply our catalog to the local host.

Parameters:

  • options (Hash{Symbol => Object}) (defaults to: {}) —

    a hash of options

Options Hash (options):

  • :report (Puppet::Transaction::Report) —

    The report object to log this transaction to. This is optional, and the resulting transaction will create a report if not supplied.

Yields:

  • (transaction)

Returns:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/puppet/resource/catalog.rb', line 231

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

#classes ⇒ Object 



283
284
285
 
# File 'lib/puppet/resource/catalog.rb', line 283

def classes
  @classes.dup
end

#clear(remove_resources = true) ⇒ Object 



270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/puppet/resource/catalog.rb', line 270

def clear(remove_resources = true)
  super()
  # We have to do this so that the resources clean themselves up.
  @resource_table.values.each { |resource| resource.remove } if remove_resources
  @resource_table.clear
  @resources = []

  if @relationship_graph
    @relationship_graph.clear
    @relationship_graph = nil
  end
end

#container_of(resource) ⇒ A Resource?

Returns the resource that contains the given resource.

Parameters:

  • resource (A Resource) —

    a resource in the catalog

Returns:

  • (A Resource, nil) —

    the resource that contains the given resource



134
135
136
 
# File 'lib/puppet/resource/catalog.rb', line 134

def container_of(resource)
  adjacent(resource, :direction => :in)[0]
end

#create_resource(type, options) ⇒ Object

Create a new resource and register it in the catalog.



288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/puppet/resource/catalog.rb', line 288

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

#filter(&block) ⇒ Object

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



507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/puppet/resource/catalog.rb', line 507

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

#finalize ⇒ Object

Make sure all of our resources are “finished”.



301
302
303
304
305
306
307
 
# File 'lib/puppet/resource/catalog.rb', line 301

def finalize
  make_default_resources

  @resource_table.values.each { |resource| resource.finish }

  write_graph(:resources)
end

#host_config? ⇒ Boolean

Returns:

  • (Boolean) 


309
310
311
 
# File 'lib/puppet/resource/catalog.rb', line 309

def host_config?
  host_config
end

#make_default_resources ⇒ Object

Make the default objects necessary for function.



339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/puppet/resource/catalog.rb', line 339

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

#relationship_graph(given_prioritizer = nil) ⇒ Puppet::Graph::RelationshipGraph

The relationship_graph form of the catalog. This contains all of the dependency edges that are used for determining order.

Parameters:

  • given_prioritizer (Puppet::Graph::Prioritizer) (defaults to: nil) —

    The prioritization strategy to use when constructing the relationship graph. Defaults the being determined by the ‘ordering` setting.

Returns:



262
263
264
265
266
267
268
 
# File 'lib/puppet/resource/catalog.rb', line 262

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

#remove_resource(*resources) ⇒ Object

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.



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/puppet/resource/catalog.rb', line 356

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

#resource(type, title = nil) ⇒ Object

Look a resource up by its reference (e.g., File).



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/puppet/resource/catalog.rb', line 375

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

#resource_keys ⇒ Object 



398
399
400
 
# File 'lib/puppet/resource/catalog.rb', line 398

def resource_keys
  @resource_table.keys
end

#resource_refs ⇒ Object 



394
395
396
 
# File 'lib/puppet/resource/catalog.rb', line 394

def resource_refs
  resource_keys.collect{ |type, name| name.is_a?( String ) ? "#{type}[#{name}]" : nil}.compact
end

#resources ⇒ Object 



402
403
404
405
406
 
# File 'lib/puppet/resource/catalog.rb', line 402

def resources
  @resources.collect do |key|
    @resource_table[key]
  end
end

#title_key_for_ref(ref) ⇒ Object

Returns [typename, title] when given a String with “Type”. Returns [nil, nil] if ‘[’ ‘]’ not detected.



87
88
89
90
91
92
93
94
95
96
 
# File 'lib/puppet/resource/catalog.rb', line 87

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
  return a
end

#to_data_hash ⇒ Object 



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/puppet/resource/catalog.rb', line 468

def to_data_hash
  metadata_hash = metadata.inject({}) { |h, (k, v)| h[k] = v.to_data_hash; h }
  recursive_metadata_hash = recursive_metadata.inject({}) do |h, (title, source_to_meta_hash)|
    h[title] = source_to_meta_hash.inject({}) do |inner_h, (source, metas)|
      inner_h[source] = metas.map {|meta| meta.to_data_hash}
      inner_h
    end
    h
  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 { |e| e.to_data_hash },
    'classes'   => classes,
  }.merge(metadata_hash.empty? ?
    {} : {'metadata' => metadata_hash}).merge(recursive_metadata_hash.empty? ?
      {} : {'recursive_metadata' => recursive_metadata_hash})
end

#to_ral ⇒ Object

Convert our catalog into a RAL catalog.



495
496
497
 
# File 'lib/puppet/resource/catalog.rb', line 495

def to_ral
  to_catalog :to_ral
end

#to_resource ⇒ Object

Convert our catalog into a catalog of Puppet::Resource instances.



500
501
502
 
# File 'lib/puppet/resource/catalog.rb', line 500

def to_resource
  to_catalog :to_resource
end

#write_class_file ⇒ Object

Store the classes in the classfile.



523
524
525
526
527
528
529
530
531
532
 
# File 'lib/puppet/resource/catalog.rb', line 523

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

#write_graph(name) ⇒ Object

Produce the graph files if requested.



551
552
553
554
555
556
 
# File 'lib/puppet/resource/catalog.rb', line 551

def write_graph(name)
  # We only want to graph the main host catalog.
  return unless host_config?

  super
end

#write_resource_file ⇒ Object

Store the list of resources we manage



535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/puppet/resource/catalog.rb', line 535

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.map do |resource|
      next unless resource.managed?
      "#{resource.ref.downcase}"
    end.compact
    f.puts to_print.join("\n")
  end
rescue => detail
  Puppet.err _("Could not create resource file %{file}: %{detail}") % { file: Puppet[:resourcefile], detail: detail }
end