puppet-retrospec 0.7.0 → 0.7.2

data/vendor/gems/puppet-3.7.3/lib/puppet/indirector/file_metadata/file_server.rb

@@ -0,0 +1,7 @@
+require 'puppet/file_serving/metadata'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/file_server'
+
+class Puppet::Indirector::FileMetadata::FileServer < Puppet::Indirector::FileServer
+  desc "Retrieve file metadata using Puppet's fileserver."
+end

data/vendor/gems/puppet-3.7.3/lib/puppet/indirector/file_metadata/rest.rb

@@ -0,0 +1,9 @@
+require 'puppet/file_serving/metadata'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/rest'
+
+class Puppet::Indirector::FileMetadata::Rest < Puppet::Indirector::REST
+  desc "Retrieve file metadata via a REST HTTP interface."
+
+  use_srv_service(:fileserver)
+end

data/vendor/gems/puppet-3.7.3/lib/puppet/indirector/file_metadata/selector.rb

@@ -0,0 +1,30 @@
+require 'puppet/file_serving/metadata'
+require 'puppet/indirector/file_metadata'
+require 'puppet/indirector/code'
+require 'puppet/file_serving/terminus_selector'
+
+class Puppet::Indirector::FileMetadata::Selector < Puppet::Indirector::Code
+  desc "Select the terminus based on the request"
+  include Puppet::FileServing::TerminusSelector
+
+  def get_terminus(request)
+    indirection.terminus(select(request))
+  end
+
+  def find(request)
+    get_terminus(request).find(request)
+  end
+
+  def search(request)
+    get_terminus(request).search(request)
+  end
+
+  def authorized?(request)
+    terminus = get_terminus(request)
+    if terminus.respond_to?(:authorized?)
+      terminus.authorized?(request)
+    else
+      true
+    end
+  end
+end

data/vendor/gems/puppet-3.7.3/lib/puppet/indirector/file_server.rb

@@ -0,0 +1,65 @@
+require 'puppet/file_serving/configuration'
+require 'puppet/file_serving/fileset'
+require 'puppet/file_serving/terminus_helper'
+require 'puppet/indirector/terminus'
+
+# Look files up using the file server.
+class Puppet::Indirector::FileServer < Puppet::Indirector::Terminus
+  include Puppet::FileServing::TerminusHelper
+
+  # Is the client authorized to perform this action?
+  def authorized?(request)
+    return false unless [:find, :search].include?(request.method)
+
+    mount, file_path = configuration.split_path(request)
+
+    # If we're not serving this mount, then access is denied.
+    return false unless mount
+    mount.allowed?(request.node, request.ip)
+  end
+
+  # Find our key using the fileserver.
+  def find(request)
+    mount, relative_path = configuration.split_path(request)
+
+    return nil unless mount
+
+    # The mount checks to see if the file exists, and returns nil
+    # if not.
+    return nil unless path = mount.find(relative_path, request)
+    result = model.new(path)
+    result.links = request.options[:links] if request.options[:links]
+    result.collect(request.options[:source_permissions])
+    result
+  end
+
+  # Search for files.  This returns an array rather than a single
+  # file.
+  def search(request)
+    mount, relative_path = configuration.split_path(request)
+
+    unless mount and paths = mount.search(relative_path, request)
+      Puppet.info "Could not find filesystem info for file '#{request.key}' in environment #{request.environment}"
+      return nil
+    end
+
+    filesets = paths.collect do |path|
+      # Filesets support indirector requests as an options collection
+      Puppet::FileServing::Fileset.new(path, request)
+    end
+
+    Puppet::FileServing::Fileset.merge(*filesets).collect do |file, base_path|
+      inst = model.new(base_path, :relative_path => file)
+      inst.links = request.options[:links] if request.options[:links]
+      inst.collect
+      inst
+    end
+  end
+
+  private
+
+  # Our fileserver configuration, if needed.
+  def configuration
+    Puppet::FileServing::Configuration.configuration
+  end
+end

data/vendor/gems/puppet-3.7.3/lib/puppet/indirector/hiera.rb

@@ -0,0 +1,48 @@
+require 'puppet/indirector/terminus'
+require 'hiera/scope'
+
+class Puppet::Indirector::Hiera < Puppet::Indirector::Terminus
+  def initialize(*args)
+    if ! Puppet.features.hiera?
+      raise "Hiera terminus not supported without hiera library"
+    end
+    super
+  end
+
+  if defined?(::Psych::SyntaxError)
+    DataBindingExceptions = [::StandardError, ::Psych::SyntaxError]
+  else
+    DataBindingExceptions = [::StandardError]
+  end
+
+  def find(request)
+    hiera.lookup(request.key, nil, Hiera::Scope.new(request.options[:variables]), nil, nil)
+  rescue *DataBindingExceptions => detail
+    raise Puppet::DataBinding::LookupError.new(detail.message, detail)
+  end
+
+  private
+
+  def self.hiera_config
+    hiera_config = Puppet.settings[:hiera_config]
+    config = {}
+
+    if Puppet::FileSystem.exist?(hiera_config)
+      config = Hiera::Config.load(hiera_config)
+    else
+      Puppet.warning "Config file #{hiera_config} not found, using Hiera defaults"
+    end
+
+    config[:logger] = 'puppet'
+    config
+  end
+
+  def self.hiera
+    @hiera ||= Hiera.new(:config => hiera_config)
+  end
+
+  def hiera
+    self.class.hiera
+  end
+end
+

data/vendor/gems/puppet-3.7.3/lib/puppet/indirector/indirection.rb

@@ -0,0 +1,336 @@
+require 'puppet/util/docs'
+require 'puppet/util/profiler'
+require 'puppet/util/methodhelper'
+require 'puppet/indirector/envelope'
+require 'puppet/indirector/request'
+require 'puppet/util/instrumentation/instrumentable'
+
+# The class that connects functional classes with their different collection
+# back-ends.  Each indirection has a set of associated terminus classes,
+# each of which is a subclass of Puppet::Indirector::Terminus.
+class Puppet::Indirector::Indirection
+  include Puppet::Util::MethodHelper
+  include Puppet::Util::Docs
+  extend Puppet::Util::Instrumentation::Instrumentable
+
+  attr_accessor :name, :model
+  attr_reader :termini
+
+  probe :find, :label => Proc.new { |parent, key, *args| "find_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+  probe :save, :label => Proc.new { |parent, key, *args| "save_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+  probe :search, :label => Proc.new { |parent, key, *args| "search_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+  probe :destroy, :label => Proc.new { |parent, key, *args| "destroy_#{parent.name}_#{parent.terminus_class}" }, :data => Proc.new { |parent, key, *args| { :key => key }}
+
+  @@indirections = []
+
+  # Find an indirection by name.  This is provided so that Terminus classes
+  # can specifically hook up with the indirections they are associated with.
+  def self.instance(name)
+    @@indirections.find { |i| i.name == name }
+  end
+
+  # Return a list of all known indirections.  Used to generate the
+  # reference.
+  def self.instances
+    @@indirections.collect { |i| i.name }
+  end
+
+  # Find an indirected model by name.  This is provided so that Terminus classes
+  # can specifically hook up with the indirections they are associated with.
+  def self.model(name)
+    return nil unless match = @@indirections.find { |i| i.name == name }
+    match.model
+  end
+
+  # Create and return our cache terminus.
+  def cache
+    raise(Puppet::DevError, "Tried to cache when no cache class was set") unless cache_class
+    terminus(cache_class)
+  end
+
+  # Should we use a cache?
+  def cache?
+    cache_class ? true : false
+  end
+
+  attr_reader :cache_class
+  # Define a terminus class to be used for caching.
+  def cache_class=(class_name)
+    validate_terminus_class(class_name) if class_name
+    @cache_class = class_name
+  end
+
+  # This is only used for testing.
+  def delete
+    @@indirections.delete(self) if @@indirections.include?(self)
+  end
+
+  # Set the time-to-live for instances created through this indirection.
+  def ttl=(value)
+    raise ArgumentError, "Indirection TTL must be an integer" unless value.is_a?(Fixnum)
+    @ttl = value
+  end
+
+  # Default to the runinterval for the ttl.
+  def ttl
+    @ttl ||= Puppet[:runinterval]
+  end
+
+  # Calculate the expiration date for a returned instance.
+  def expiration
+    Time.now + ttl
+  end
+
+  # Generate the full doc string.
+  def doc
+    text = ""
+
+    text << scrub(@doc) << "\n\n" if @doc
+
+    text << "* **Indirected Class**: `#{@indirected_class}`\n";
+    if terminus_setting
+      text << "* **Terminus Setting**: #{terminus_setting}\n"
+    end
+
+    text
+  end
+
+  def initialize(model, name, options = {})
+    @model = model
+    @name = name
+    @termini = {}
+
+    @cache_class = nil
+    @terminus_class = nil
+
+    raise(ArgumentError, "Indirection #{@name} is already defined") if @@indirections.find { |i| i.name == @name }
+    @@indirections << self
+
+    @indirected_class = options.delete(:indirected_class)
+    if mod = options[:extend]
+      extend(mod)
+      options.delete(:extend)
+    end
+
+    # This is currently only used for cache_class and terminus_class.
+    set_options(options)
+  end
+
+  # Set up our request object.
+  def request(*args)
+    Puppet::Indirector::Request.new(self.name, *args)
+  end
+
+  # Return the singleton terminus for this indirection.
+  def terminus(terminus_name = nil)
+    # Get the name of the terminus.
+    raise Puppet::DevError, "No terminus specified for #{self.name}; cannot redirect" unless terminus_name ||= terminus_class
+
+    termini[terminus_name] ||= make_terminus(terminus_name)
+  end
+
+  # This can be used to select the terminus class.
+  attr_accessor :terminus_setting
+
+  # Determine the terminus class.
+  def terminus_class
+    unless @terminus_class
+      if setting = self.terminus_setting
+        self.terminus_class = Puppet.settings[setting]
+      else
+        raise Puppet::DevError, "No terminus class nor terminus setting was provided for indirection #{self.name}"
+      end
+    end
+    @terminus_class
+  end
+
+  def reset_terminus_class
+    @terminus_class = nil
+  end
+
+  # Specify the terminus class to use.
+  def terminus_class=(klass)
+    validate_terminus_class(klass)
+    @terminus_class = klass
+  end
+
+  # This is used by terminus_class= and cache=.
+  def validate_terminus_class(terminus_class)
+    raise ArgumentError, "Invalid terminus name #{terminus_class.inspect}" unless terminus_class and terminus_class.to_s != ""
+    unless Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
+      raise ArgumentError, "Could not find terminus #{terminus_class} for indirection #{self.name}"
+    end
+  end
+
+  # Expire a cached object, if one is cached.  Note that we don't actually
+  # remove it, we expire it and write it back out to disk.  This way people
+  # can still use the expired object if they want.
+  def expire(key, options={})
+    request = request(:expire, key, nil, options)
+
+    return nil unless cache?
+
+    return nil unless instance = cache.find(request(:find, key, nil, options))
+
+    Puppet.info "Expiring the #{self.name} cache of #{instance.name}"
+
+    # Set an expiration date in the past
+    instance.expiration = Time.now - 60
+
+    cache.save(request(:save, nil, instance, options))
+  end
+
+  def allow_remote_requests?
+    terminus.allow_remote_requests?
+  end
+
+  # Search for an instance in the appropriate terminus, caching the
+  # results if caching is configured..
+  def find(key, options={})
+    request = request(:find, key, nil, options)
+    terminus = prepare(request)
+
+    result = find_in_cache(request)
+    if not result.nil?
+      result
+    elsif request.ignore_terminus?
+      nil
+    else
+      # Otherwise, return the result from the terminus, caching if
+      # appropriate.
+      result = terminus.find(request)
+      if not result.nil?
+        result.expiration ||= self.expiration if result.respond_to?(:expiration)
+        if cache?
+          Puppet.info "Caching #{self.name} for #{request.key}"
+          cache.save request(:save, key, result, options)
+        end
+
+        filtered = result
+        if terminus.respond_to?(:filter)
+          Puppet::Util::Profiler.profile("Filtered result for #{self.name} #{request.key}", [:indirector, :filter, self.name, request.key]) do
+            filtered = terminus.filter(result)
+          end
+        end
+
+        filtered
+      end
+    end
+  end
+
+  # Search for an instance in the appropriate terminus, and return a
+  # boolean indicating whether the instance was found.
+  def head(key, options={})
+    request = request(:head, key, nil, options)
+    terminus = prepare(request)
+
+    # Look in the cache first, then in the terminus.  Force the result
+    # to be a boolean.
+    !!(find_in_cache(request) || terminus.head(request))
+  end
+
+  def find_in_cache(request)
+    # See if our instance is in the cache and up to date.
+    return nil unless cache? and ! request.ignore_cache? and cached = cache.find(request)
+    if cached.expired?
+      Puppet.info "Not using expired #{self.name} for #{request.key} from cache; expired at #{cached.expiration}"
+      return nil
+    end
+
+    Puppet.debug "Using cached #{self.name} for #{request.key}"
+    cached
+  rescue => detail
+    Puppet.log_exception(detail, "Cached #{self.name} for #{request.key} failed: #{detail}")
+    nil
+  end
+
+  # Remove something via the terminus.
+  def destroy(key, options={})
+    request = request(:destroy, key, nil, options)
+    terminus = prepare(request)
+
+    result = terminus.destroy(request)
+
+    if cache? and cache.find(request(:find, key, nil, options))
+      # Reuse the existing request, since it's equivalent.
+      cache.destroy(request)
+    end
+
+    result
+  end
+
+  # Search for more than one instance.  Should always return an array.
+  def search(key, options={})
+    request = request(:search, key, nil, options)
+    terminus = prepare(request)
+
+    if result = terminus.search(request)
+      raise Puppet::DevError, "Search results from terminus #{terminus.name} are not an array" unless result.is_a?(Array)
+      result.each do |instance|
+        next unless instance.respond_to? :expiration
+        instance.expiration ||= self.expiration
+      end
+      return result
+    end
+  end
+
+  # Save the instance in the appropriate terminus.  This method is
+  # normally an instance method on the indirected class.
+  def save(instance, key = nil, options={})
+    request = request(:save, key, instance, options)
+    terminus = prepare(request)
+
+    result = terminus.save(request)
+
+    # If caching is enabled, save our document there
+    cache.save(request) if cache?
+
+    result
+  end
+
+  private
+
+  # Check authorization if there's a hook available; fail if there is one
+  # and it returns false.
+  def check_authorization(request, terminus)
+    # At this point, we're assuming authorization makes no sense without
+    # client information.
+    return unless request.node
+
+    # This is only to authorize via a terminus-specific authorization hook.
+    return unless terminus.respond_to?(:authorized?)
+
+    unless terminus.authorized?(request)
+      msg = "Not authorized to call #{request.method} on #{request}"
+      msg += " with #{request.options.inspect}" unless request.options.empty?
+      raise ArgumentError, msg
+    end
+  end
+
+  # Setup a request, pick the appropriate terminus, check the request's authorization, and return it.
+  def prepare(request)
+    # Pick our terminus.
+    if respond_to?(:select_terminus)
+      unless terminus_name = select_terminus(request)
+        raise ArgumentError, "Could not determine appropriate terminus for #{request}"
+      end
+    else
+      terminus_name = terminus_class
+    end
+
+    dest_terminus = terminus(terminus_name)
+    check_authorization(request, dest_terminus)
+    dest_terminus.validate(request)
+
+    dest_terminus
+  end
+
+  # Create a new terminus instance.
+  def make_terminus(terminus_class)
+    # Load our terminus class.
+    unless klass = Puppet::Indirector::Terminus.terminus_class(self.name, terminus_class)
+      raise ArgumentError, "Could not find terminus #{terminus_class} for indirection #{self.name}"
+    end
+    klass.new
+  end
+end