File: //usr/lib/ruby/site_ruby/1.8/puppet/transaction/additional_resource_generator.rb
# Adds additional resources to the catalog and relationship graph that are
# generated by existing resources. There are two ways that a resource can
# generate additional resources, either through the #generate method or the
# #eval_generate method.
#
# @api private
class Puppet::Transaction::AdditionalResourceGenerator
def initialize(catalog, relationship_graph, prioritizer)
@catalog = catalog
@relationship_graph = relationship_graph
@prioritizer = prioritizer
end
def generate_additional_resources(resource)
return unless resource.respond_to?(:generate)
begin
generated = resource.generate
rescue => detail
resource.log_exception(detail, "Failed to generate additional resources using 'generate': #{detail}")
end
return unless generated
generated = [generated] unless generated.is_a?(Array)
generated.collect do |res|
@catalog.resource(res.ref) || res
end.each do |res|
priority = @prioritizer.generate_priority_contained_in(resource, res)
add_resource(res, resource, priority)
add_conditional_directed_dependency(resource, res)
generate_additional_resources(res)
end
end
def eval_generate(resource)
return false unless resource.respond_to?(:eval_generate)
raise Puppet::DevError,"Depthfirst resources are not supported by eval_generate" if resource.depthfirst?
begin
generated = replace_duplicates_with_catalog_resources(resource.eval_generate)
return false if generated.empty?
rescue => detail
resource.log_exception(detail, "Failed to generate additional resources using 'eval_generate': #{detail}")
return false
end
add_resources(generated, resource)
made = Hash[generated.map(&:name).zip(generated)]
contain_generated_resources_in(resource, made)
connect_resources_to_ancestors(resource, made)
true
end
private
def replace_duplicates_with_catalog_resources(generated)
generated.collect do |generated_resource|
@catalog.resource(generated_resource.ref) || generated_resource
end
end
def contain_generated_resources_in(resource, made)
sentinel = Puppet::Type.type(:whit).new(:name => "completed_#{resource.title}", :catalog => resource.catalog)
priority = @prioritizer.generate_priority_contained_in(resource, sentinel)
@relationship_graph.add_vertex(sentinel, priority)
redirect_edges_to_sentinel(resource, sentinel, made)
made.values.each do |res|
# This resource isn't 'completed' until each child has run
add_conditional_directed_dependency(res, sentinel, Puppet::Graph::RelationshipGraph::Default_label)
end
# This edge allows the resource's events to propagate, though it isn't
# strictly necessary for ordering purposes
add_conditional_directed_dependency(resource, sentinel, Puppet::Graph::RelationshipGraph::Default_label)
end
def redirect_edges_to_sentinel(resource, sentinel, made)
@relationship_graph.adjacent(resource, :direction => :out, :type => :edges).each do |e|
next if made[e.target.name]
@relationship_graph.add_relationship(sentinel, e.target, e.label)
@relationship_graph.remove_edge! e
end
end
def connect_resources_to_ancestors(resource, made)
made.values.each do |res|
# Depend on the nearest ancestor we generated, falling back to the
# resource if we have none
parent_name = res.ancestors.find { |a| made[a] and made[a] != res }
parent = made[parent_name] || resource
add_conditional_directed_dependency(parent, res)
end
end
def add_resources(generated, resource)
generated.each do |res|
priority = @prioritizer.generate_priority_contained_in(resource, res)
add_resource(res, resource, priority)
end
end
def add_resource(res, parent_resource, priority)
if @catalog.resource(res.ref).nil?
res.tag(*parent_resource.tags)
@catalog.add_resource(res)
@relationship_graph.add_vertex(res, priority)
@catalog.add_edge(@catalog.container_of(parent_resource), res)
res.finish
end
end
# Copy an important relationships from the parent to the newly-generated
# child resource.
def add_conditional_directed_dependency(parent, child, label=nil)
@relationship_graph.add_vertex(child)
edge = parent.depthfirst? ? [child, parent] : [parent, child]
if @relationship_graph.edge?(*edge.reverse)
parent.debug "Skipping automatic relationship to #{child}"
else
@relationship_graph.add_relationship(edge[0],edge[1],label)
end
end
end