Class: Puppet::Type::RelationshipMetaparam

Inherits:
Parameter show all
Defined in:
lib/puppet/type.rb

Overview

RelationshipMetaparam is an implementation supporting the meta-parameters `:require`, `:subscribe`, `:notify`, and `:before`.

Constant Summary

Constants included from Util::Docs

Util::Docs::HEADER_LEVELS

Constants included from Util

Util::ALNUM, Util::ALPHA, Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::ESCAPED, Util::HEX, Util::HttpProxy, Util::PUPPET_STACK_INSERTION_FRAME, Util::RESERVED, Util::RFC_3986_URI_REGEX, Util::UNRESERVED, Util::UNSAFE

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Class Attribute Summary collapse

Attributes inherited from Parameter

#name, #parent, #resource, #sensitive

Attributes included from Util::Docs

#doc, #nodoc

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Parameter

aliasvalue, defaultto, desc, doc, #file, #format, format_value_for_display, #initialize, initvars, isnamevar, isnamevar?, #isnamevar?, isrequired, #line, #log, #metaparam?, munge, newvalues, nodefault, #noop, #path, #pathbuilder, #provider, proxymethods, #remove, #required?, required?, sensitive, #tags, #to_s, #unmunge, unmunge, #unsafe_munge, #unsafe_validate, #validate, validate, #value, #value=, #version

Methods included from Util::Docs

#desc, #dochook, #doctable, #markdown_definitionlist, #markdown_header, #nodoc?, #pad, scrub

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, format_backtrace_array, format_puppetstack_frame, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, resolve_stackframe, rfc2396_escape, safe_posix_fork, set_env, skip_external_facts, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, uri_unescape, which, withenv, withumask

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Methods included from Util::SymbolicFileMode

#display_mode, #normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::Logging

#clear_deprecation_warnings, #debug, #deprecation_warning, #format_backtrace, #format_exception, #get_deprecation_offender, #log_and_raise, #log_deprecations_to_file, #log_exception, #puppet_deprecation_warning, #send_log, setup_facter_logging!, #warn_once

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, error_location, error_location_with_space, error_location_with_unknowns, #exceptwrap, #fail

Constructor Details

This class inherits a constructor from Puppet::Parameter

Class Attribute Details

.callbackObject

Returns the value of attribute callback.


1496
1497
1498
# File 'lib/puppet/type.rb', line 1496

def callback
  @callback
end

.directionObject

Returns the value of attribute direction.


1496
1497
1498
# File 'lib/puppet/type.rb', line 1496

def direction
  @direction
end

.eventsObject

Returns the value of attribute events.


1496
1497
1498
# File 'lib/puppet/type.rb', line 1496

def events
  @events
end

.subclassesObject

Returns the value of attribute subclasses.


1496
1497
1498
# File 'lib/puppet/type.rb', line 1496

def subclasses
  @subclasses
end

Class Method Details

.inherited(sub) ⇒ Object


1501
1502
1503
# File 'lib/puppet/type.rb', line 1501

def self.inherited(sub)
  @subclasses << sub
end

Instance Method Details

#munge(references) ⇒ Array<Puppet::Resource>

Returns turns attribute values into list of resources.

Returns:


1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
# File 'lib/puppet/type.rb', line 1506

def munge(references)
  references = [references] unless references.is_a?(Array)
  references.collect do |ref|
    if ref.is_a?(Puppet::Resource)
      ref
    else
      Puppet::Resource.new(ref)
    end
  end
end

#to_edgesArray<Puppet::Relationship>

TODO:

references to “event-receivers” and “event generator” means in this context - are those just the resources at the two ends of the relationship?

Creates edges for all relationships. The `:in` relationships are specified by the event-receivers, and `:out` relationships are specified by the event generator. This way 'source' and 'target' are consistent terms in both edges and events, i.e. an event targets edges whose source matches the event's source. The direction of the relationship determines which resource is applied first and which resource is considered to be the event generator.

Returns:

Raises:

  • (???fail)

    when a reference can not be resolved


1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'lib/puppet/type.rb', line 1544

def to_edges
  @value.collect do |reference|
    reference.catalog = resource.catalog

    # Either of the two retrieval attempts could have returned
    # nil.
    related_resource = reference.resolve
    unless related_resource
      self.fail "Could not retrieve dependency '#{reference}' of #{@resource.ref}"
    end

    # Are we requiring them, or vice versa?  See the method docs
    # for further info on this.
    if self.class.direction == :in
      source = related_resource
      target = @resource
    else
      source = @resource
      target = related_resource
    end

    method = self.class.callback
    if method
      subargs = {
        :event => self.class.events,
        :callback => method
      }
    else
      # If there's no callback, there's no point in even adding
      # a label.
      subargs = nil
    end

    ## Corrected syntax of debug statement to reflect the way this was called.
    # i.e. before, after, subscribe, notify
    self.debug do
      relation = case self.class.name
      when "subscribe"
        "subscribes"
      when "notify"
        "notifies"
      else
        self.class.name
      end

      "#{relation} to #{related_resource.ref}"
    end

    Puppet::Relationship.new(source, target, subargs)
  end
end

#validate_relationshipvoid

This method returns an undefined value.

Checks each reference to assert that what it references exists in the catalog.

Raises:

  • (???fail)

    if the referenced resource can not be found


1521
1522
1523
1524
1525
1526
1527
1528
1529
# File 'lib/puppet/type.rb', line 1521

def validate_relationship
  @value.each do |ref|
    unless @resource.catalog.resource(ref.to_s)
      description = self.class.direction == :in ? "dependency" : "dependent"
      fail ResourceError, _("Could not find %{description} %{ref} for %{resource}") %
          { description: description, ref: ref, resource: resource.ref }
    end
  end
end