facter 2.0.1.rc1-universal-darwin

data/lib/facter/util/directory_loader.rb

@@ -0,0 +1,83 @@
+# A Facter plugin that loads external facts.
+#
+# Default Unix Directories:
+# /etc/facter/facts.d", "/etc/puppetlabs/facter/facts.d"
+#
+# Default Windows Direcotires:
+# C:\ProgramData\Puppetlabs\facter\facts.d (2008)
+# C:\Documents and Settings\All Users\Application Data\Puppetlabs\facter\facts.d (2003)
+#
+# Can also load from command-line specified directory
+#
+# Facts can be in the form of JSON, YAML or Text files
+# and any executable that returns key=value pairs.
+
+require 'facter'
+require 'facter/util/config'
+require 'facter/util/composite_loader'
+require 'facter/util/parser'
+require 'yaml'
+
+class Facter::Util::DirectoryLoader
+
+  class NoSuchDirectoryError < Exception
+  end
+
+  # This value makes it highly likely that external facts will take
+  # precedence over all other facts
+  EXTERNAL_FACT_WEIGHT = 10000
+
+  # Directory for fact loading
+  attr_reader :directory
+
+  def initialize(dir)
+    @directory = dir
+  end
+
+  def self.loader_for(dir)
+    if File.directory?(dir)
+      Facter::Util::DirectoryLoader.new(dir)
+    else
+      raise NoSuchDirectoryError
+    end
+  end
+
+  def self.default_loader
+    loaders = Facter::Util::Config.external_facts_dirs.collect do |dir|
+      Facter::Util::DirectoryLoader.new(dir)
+    end
+    Facter::Util::CompositeLoader.new(loaders)
+  end
+
+  # Load facts from files in fact directory using the relevant parser classes to
+  # parse them.
+  def load(collection)
+    entries.each do |file|
+      parser = Facter::Util::Parser.parser_for(file)
+      if parser == nil
+        next
+      end
+
+      data = parser.results
+      if data == false
+        Facter.warn "Could not interpret fact file #{file}"
+      elsif data == {} or data == nil
+        Facter.warn "Fact file #{file} was parsed but returned an empty data set"
+      else
+        data.each { |p,v| collection.add(p, :value => v) { has_weight(EXTERNAL_FACT_WEIGHT) } }
+      end
+    end
+  end
+
+private
+
+  def entries
+    Dir.entries(directory).find_all { |f| should_parse?(f) }.sort.map { |f| File.join(directory, f) }
+  rescue Errno::ENOENT => detail
+    []
+  end
+
+  def should_parse?(file)
+    not file =~ /^\./
+  end
+end

data/lib/facter/util/ec2.rb

@@ -0,0 +1,101 @@
+require 'timeout'
+require 'open-uri'
+
+# Provide a set of utility static methods that help with resolving the EC2
+# fact.
+module Facter::Util::EC2
+  class << self
+    # Test if we can connect to the EC2 api. Return true if able to connect.
+    # On failure this function fails silently and returns false.
+    #
+    # The +wait_sec+ parameter provides you with an adjustable timeout.
+    #
+    def can_connect?(wait_sec=2)
+      url = "http://169.254.169.254:80/"
+      Timeout::timeout(wait_sec) {open(url)}
+      return true
+    rescue Timeout::Error
+      return false
+    rescue
+      return false
+    end
+
+    # Test if this host has a mac address used by Eucalyptus clouds, which
+    # normally is +d0:0d+.
+    def has_euca_mac?
+      !!(Facter.value(:macaddress) =~ %r{^[dD]0:0[dD]:})
+    end
+
+    # Test if this host has a mac address used by OpenStack, which
+    # normally starts with FA:16:3E (older versions of OpenStack
+    # may generate mac addresses starting with 02:16:3E)
+    def has_openstack_mac?
+      !!(Facter.value(:macaddress) =~ %r{^(02|[fF][aA]):16:3[eE]})
+    end
+
+    # Test if the host has an arp entry in its cache that matches the EC2 arp,
+    # which is normally +fe:ff:ff:ff:ff:ff+.
+    def has_ec2_arp?
+      kernel = Facter.value(:kernel)
+
+      mac_address_re = case kernel
+                       when /Windows/i
+                         /fe-ff-ff-ff-ff-ff/i
+                       else
+                         /fe:ff:ff:ff:ff:ff/i
+                       end
+
+      arp_command = case kernel
+                    when /Windows/i, /SunOS/i
+                      "arp -a"
+                    else
+                      "arp -an"
+                    end
+
+      if arp_table = Facter::Core::Execution.exec(arp_command)
+        return true if arp_table.match(mac_address_re)
+      end
+      return false
+    end
+  end
+
+  ##
+  # userdata returns a single string containing the body of the response of the
+  # GET request for the URI http://169.254.169.254/latest/user-data/  If the
+  # metadata server responds with a 404 Not Found error code then this method
+  # retuns `nil`.
+  #
+  # @param version [String] containing the API version for the request.
+  # Defaults to "latest" and other examples are documented at
+  # http://aws.amazon.com/archives/Amazon%20EC2
+  #
+  # @api public
+  #
+  # @return [String] containing the response body or `nil`
+  def self.userdata(version="latest")
+    uri = "http://169.254.169.254/#{version}/user-data/"
+    begin
+      read_uri(uri)
+    rescue OpenURI::HTTPError => detail
+      case detail.message
+      when /404 Not Found/i
+        Facter.debug "No user-data present at #{uri}: server responded with #{detail.message}"
+        return nil
+      else
+        raise detail
+      end
+    end
+  end
+
+  ##
+  # read_uri provides a seam method to easily test the HTTP client
+  # functionality of a HTTP based metadata server.
+  #
+  # @api private
+  #
+  # @return [String] containing the body of the response
+  def self.read_uri(uri)
+    open(uri).read
+  end
+  private_class_method :read_uri
+end

data/lib/facter/util/fact.rb

@@ -0,0 +1,204 @@
+require 'facter'
+require 'facter/util/resolution'
+require 'facter/core/aggregate'
+
+# This class represents a fact. Each fact has a name and multiple
+# {Facter::Util::Resolution resolutions}.
+#
+# Create facts using {Facter.add}
+#
+# @api public
+class Facter::Util::Fact
+  # The name of the fact
+  # @return [String]
+  attr_accessor :name
+
+  # @return [String]
+  # @deprecated
+  attr_accessor :ldapname
+
+  # Creates a new fact, with no resolution mechanisms. See {Facter.add}
+  # for the public API for creating facts.
+  # @param name [String] the fact name
+  # @param options [Hash] optional parameters
+  # @option options [String] :ldapname set the ldapname property on the fact
+  #
+  # @api private
+  def initialize(name, options = {})
+    @name = name.to_s.downcase.intern
+
+    extract_ldapname_option!(options)
+
+    @ldapname ||= @name.to_s
+
+    @resolves = []
+    @searching = false
+
+    @value = nil
+  end
+
+  # Adds a new {Facter::Util::Resolution resolution}.  This requires a
+  # block, which will then be evaluated in the context of the new
+  # resolution.
+  #
+  # @param options [Hash] A hash of options to set on the resolution
+  #
+  # @return [Facter::Util::Resolution]
+  #
+  # @api private
+  def add(options = {}, &block)
+    define_resolution(nil, options, &block)
+  end
+
+  # Define a new named resolution or return an existing resolution with
+  # the given name.
+  #
+  # @param resolution_name [String] The name of the resolve to define or look up
+  # @param options [Hash] A hash of options to set on the resolution
+  # @return [Facter::Util::Resolution]
+  #
+  # @api public
+  def define_resolution(resolution_name, options = {}, &block)
+
+    resolution_type = options.delete(:type) || :simple
+
+    resolve = create_or_return_resolution(resolution_name, resolution_type)
+
+    resolve.set_options(options) unless options.empty?
+    resolve.evaluate(&block) if block
+
+    resolve
+  rescue => e
+    Facter.log_exception(e, "Unable to add resolve #{resolution_name.inspect} for fact #{@name}: #{e.message}")
+  end
+
+  # Retrieve an existing resolution by name
+  #
+  # @param name [String]
+  #
+  # @return [Facter::Util::Resolution, nil] The resolution if exists, nil if
+  #   it doesn't exist or name is nil
+  def resolution(name)
+    return nil if name.nil?
+
+    @resolves.find { |resolve| resolve.name == name }
+  end
+
+  # Flushes any cached values.
+  #
+  # @return [void]
+  #
+  # @api private
+  def flush
+    @resolves.each { |r| r.flush }
+    @value = nil
+  end
+
+  # Returns the value for this fact. This searches all resolutions by
+  # suitability and weight (see {Facter::Util::Resolution}). If no
+  # suitable resolution is found, it returns nil.
+  #
+  # @api public
+  def value
+    return @value if @value
+
+    if @resolves.empty?
+      Facter.debug "No resolves for %s" % @name
+      return nil
+    end
+
+    searching do
+
+      suitable_resolutions = sort_by_weight(find_suitable_resolutions(@resolves))
+      @value = find_first_real_value(suitable_resolutions)
+
+      announce_when_no_suitable_resolution(suitable_resolutions)
+      announce_when_no_value_found(@value)
+
+      @value
+    end
+  end
+
+  # @api private
+  # @deprecated
+  def extract_ldapname_option!(options)
+    if options[:ldapname]
+      Facter.warnonce("ldapname is deprecated and will be removed in a future version")
+      self.ldapname = options.delete(:ldapname)
+    end
+  end
+
+  private
+
+  # Are we in the midst of a search?
+  def searching?
+    @searching
+  end
+
+  # Lock our searching process, so we never ge stuck in recursion.
+  def searching
+    raise RuntimeError, "Caught recursion on #{@name}" if searching?
+
+    # If we've gotten this far, we're not already searching, so go ahead and do so.
+    @searching = true
+    begin
+      yield
+    ensure
+      @searching = false
+    end
+  end
+
+  def find_suitable_resolutions(resolutions)
+    resolutions.find_all{ |resolve| resolve.suitable? }
+  end
+
+  def sort_by_weight(resolutions)
+    resolutions.sort { |a, b| b.weight <=> a.weight }
+  end
+
+  def find_first_real_value(resolutions)
+    resolutions.each do |resolve|
+      value = resolve.value
+      if not value.nil?
+        return value
+      end
+    end
+    nil
+  end
+
+  def announce_when_no_suitable_resolution(resolutions)
+    if resolutions.empty?
+      Facter.debug "Found no suitable resolves of %s for %s" % [@resolves.length, @name]
+    end
+  end
+
+  def announce_when_no_value_found(value)
+    if value.nil?
+      Facter.debug("value for %s is still nil" % @name)
+    end
+  end
+
+  def create_or_return_resolution(resolution_name, resolution_type)
+    resolve = self.resolution(resolution_name)
+
+    if resolve
+      if resolution_type != resolve.resolution_type
+        raise ArgumentError, "Cannot return resolution #{resolution_name} with type" +
+          " #{resolution_type}; already defined as #{resolve.resolution_type}"
+      end
+    else
+      case resolution_type
+      when :simple
+        resolve = Facter::Util::Resolution.new(resolution_name, self)
+      when :aggregate
+        resolve = Facter::Core::Aggregate.new(resolution_name, self)
+      else
+        raise ArgumentError, "Expected resolution type to be one of (:simple, :aggregate) but was #{resolution_type}"
+      end
+
+      @resolves << resolve
+    end
+
+    resolve
+  end
+end

data/lib/facter/util/file_read.rb

@@ -0,0 +1,37 @@
+module Facter
+module Util
+
+# {Facter::Util::FileRead} is a utility module intended to provide easily
+# mockable methods that delegate to simple file read methods.  The intent is to
+# avoid the need to execute the `cat` system command or `File.read` directly in
+# Ruby, as mocking these behaviors can have wide-ranging effects.
+#
+# All Facter facts are encouraged to use this method instead of File.read or
+# Facter::Core::Execution.exec('cat ...')
+#
+# @api public
+module FileRead
+  # read returns the raw content of a file as a string.  If the file does not
+  # exist, or the process does not have permission to read the file then nil is
+  # returned.
+  #
+  # @api public
+  #
+  # @param path [String] the path to be read
+  #
+  # @return [String, nil] the raw contents of the file or `nil` if the
+  #   file cannot be read because it does not exist or the process does not have
+  #   permission to read the file.
+  def self.read(path)
+    File.read(path)
+  rescue Errno::ENOENT, Errno::EACCES => detail
+    Facter.debug "Could not read #{path}: #{detail.message}"
+    nil
+  end
+
+  def self.read_binary(path)
+    File.open(path, "rb") { |contents| contents.read }
+  end
+end
+end
+end

data/lib/facter/util/formatter.rb

@@ -0,0 +1,38 @@
+require 'yaml'
+
+module Facter
+  module Util
+    module Formatter
+
+      def self.format_json(hash)
+        if Facter.json?
+          JSON.pretty_generate(hash)
+        else
+          raise "Cannot format facts as JSON; 'json' library is not present"
+        end
+      end
+
+      def self.format_yaml(hash)
+        YAML.dump(hash)
+      end
+
+      def self.format_plaintext(hash)
+        output = ''
+
+        # Print the value of a single fact, otherwise print a list sorted by fact
+        # name and separated by "=>"
+        if hash.length == 1
+          if value = hash.values.first
+            output = value
+          end
+        else
+          hash.sort_by { |(name, value)| name }.each do |name,value|
+            output << "#{name} => #{value}\n"
+          end
+        end
+
+        output
+      end
+    end
+  end
+end