facter 2.3.0 → 2.4.0

data/lib/facter/application.rb

@@ -187,7 +187,7 @@ OPTIONS
 
     def self.load_puppet
       require 'puppet'
-      Puppet.parse_config
+      Puppet.initialize_settings
 
       # If you've set 'vardir' but not 'libdir' in your
       # puppet.conf, then the hook to add libdir to $:

data/lib/facter/core/logging.rb

@@ -21,6 +21,22 @@ module Facter::Core::Logging
   # @api private
   @@debug_messages = {}
 
+  # @api private
+  @@message_callback = nil
+
+  # Used to register a callback that is called when a message is logged.
+  # If a block is given, Facter will not log messages.
+  # If a block is not given, Facter will resume logging messages.
+  # @param block [Proc] the callback to call when a message is logged.
+  #   The first argument to the callback will be a symbol representing a level. The supported
+  #   levels are: :trace, :debug, :info, :warn, :error, and :fatal.
+  #   The second argument to the callback will be a string containing the message
+  #   that was logged.
+  # @api public
+  def on_message(&block)
+    @@message_callback = block
+  end
+
   # Prints a debug message if debugging is turned on
   #
   # @param msg [String] the debug message
@@ -30,6 +46,8 @@ module Facter::Core::Logging
       if msg.nil? or msg.empty?
         invoker = caller[0].slice(/.*:\d+/)
         self.warn "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
+      elsif @@message_callback
+        @@message_callback.call(:debug, msg)
       else
         puts GREEN + msg + RESET
       end
@@ -59,7 +77,10 @@ module Facter::Core::Logging
   def warn(msg)
     if msg.nil? or msg.empty?
       invoker = caller[0].slice(/.*:\d+/)
-      Kernel.warn "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
+      msg = "#{self.class}#debug invoked with invalid message #{msg.inspect}:#{msg.class} at #{invoker}"
+    end
+    if @@message_callback
+      @@message_callback.call(:warn, msg)
     else
       Kernel.warn msg
     end
@@ -111,7 +132,13 @@ module Facter::Core::Logging
   #
   # @api private
   def show_time(string)
-    $stderr.puts "#{GREEN}#{string}#{RESET}" if string and self.timing?
+    return unless string && self.timing?
+
+    if @@message_callback
+      @@message_callback.call(:info, string)
+    else
+      $stderr.puts "#{GREEN}#{string}#{RESET}"
+    end
   end
 
   # Enable or disable logging of debug messages
@@ -158,12 +185,13 @@ module Facter::Core::Logging
     @@trace
   end
 
-  # Clears the seen state of warning messages. See {warnonce}.
+  # Clears the seen state of debug and warning messages. See {debugonce} and {warnonce}.
   #
   # @return [void]
   #
   # @api private
   def clear_messages
+    @@debug_messages.clear
     @@warn_messages.clear
   end
 end

data/lib/facter/dhcp_servers.rb

@@ -5,6 +5,8 @@
 #   If the interface that is the default gateway is DHCP assigned, there
 #   will also be a `"system"` entry in the hash.
 #
+#   This fact is structured. Values are returned as a group of key-value pairs.
+#
 # Resolution:
 #   Parses the output of `nmcli` to find the DHCP server for the interface if available.
 #
@@ -21,6 +23,9 @@ Facter.add(:dhcp_servers) do
   confine do
     Facter::Core::Execution.which('nmcli')
   end
+  confine do
+    Facter::Util::DHCPServers.network_manager_state != 'unknown'
+  end
 
   setcode do
     gwdev   = Facter::Util::DHCPServers.gateway_device

data/lib/facter/interfaces.rb

@@ -1,9 +1,16 @@
 # Fact: interfaces
 #
 # Purpose:
-#   Generates the following facts on supported platforms: `<interface>_ipaddress`,
-#   `<interface>_ipaddress6`, `<interface>_macaddress`, `<interface>_netmask`,
-#   and `<interface>_mtu`.
+#   Returns a comma-separated list of the system's network interfaces.
+#
+#   In addition to the main `interfaces` fact, this code will generate the
+#   following facts for each interface:
+#
+#   * `ipaddress_<INTERFACE>`
+#   * `ipaddress6_<INTERFACE>`
+#   * `macaddress_<INTERFACE>`
+#   * `netmask_<INTERFACE>`
+#   * `mtu_<INTERFACE>`
 #
 # Resolution:
 #

data/lib/facter/ipaddress.rb

@@ -49,7 +49,7 @@ Facter.add(:ipaddress) do
     ip = nil
     output = Facter::Util::IP.exec_ifconfig
 
-    output.split(/^\S/).each { |str|
+    output.split(/^\S/).each do |str|
       if str =~ /inet ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/
         tmp = $1
         unless tmp =~ /^127\./
@@ -57,7 +57,7 @@ Facter.add(:ipaddress) do
           break
         end
       end
-    }
+    end
 
     ip
   end
@@ -69,7 +69,7 @@ Facter.add(:ipaddress) do
     ip = nil
     output = Facter::Util::IP.exec_ifconfig(["-a"])
 
-    output.split(/^\S/).each { |str|
+    output.split(/^\S/).each do |str|
       if str =~ /inet ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/
         tmp = $1
         unless tmp =~ /^127\./ or tmp == "0.0.0.0"
@@ -77,7 +77,7 @@ Facter.add(:ipaddress) do
           break
         end
       end
-    }
+    end
 
     ip
   end
@@ -87,17 +87,15 @@ Facter.add(:ipaddress) do
   confine :kernel => %w{AIX}
   setcode do
     ip = nil
-    output = Facter::Util::IP.exec_ifconfig(["-a"])
 
-    output.split(/^\S/).each { |str|
+    default_interface = Facter::Util::IP.exec_netstat(["-rn | grep default | awk '{ print $6 }'"])
+    output = Facter::Util::IP.exec_ifconfig([default_interface])
+
+    output.split(/^\S/).each do |str|
       if str =~ /inet ([0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)/
-        tmp = $1
-        unless tmp =~ /^127\./
-          ip = tmp
-          break
-        end
+        ip = $1
       end
-    }
+    end
 
     ip
   end

data/lib/facter/macaddress.rb

@@ -72,7 +72,8 @@ Facter.add(:macaddress) do
   setcode do
     ether = []
     ip = nil
-    output = Facter::Util::IP.exec_ifconfig(["-a"])
+    default_interface = Facter::Util::IP.exec_netstat(["-rn | grep default | awk '{ print $6 }'"])
+    output = Facter::Util::IP.exec_ifconfig([default_interface])
     output.each_line do |str|
       if str =~ /([a-z]+\d+): flags=/
         devname = $1

data/lib/facter/operatingsystemmajrelease.rb

@@ -3,11 +3,14 @@
 # Purpose: Returns the major release of the operating system.
 #
 # Resolution:
-#   Uses the releasemajor key of the os structured fact, which itself
-#   splits down its operatingsystemrelease key at decimal point for
-#   osfamily RedHat derivatives and Debian.
-#   Uses operatingsystemrelease key to the first non decimal
-#   character for operatingsystem Solaris.
+#   Uses the release['major'] entry of the os structured fact, which itself
+#   attempts to use its own release['full'] entry to determine the major release value.
+#   In RedHat osfamily derivatives and Debian, splits down the release string for a decimal point
+#   and uses the first non-decimal character.
+#   In Solaris, uses the first non-decimal character of the release string.
+#   In Ubuntu, uses the characters before and after the first decimal point, as in '14.04'.
+#   In Windows, uses the full release string in the case of server releases, such as '2012 R2',
+#   and uses the first non-decimal character in the cases of releases such as '8.1'.
 #
 #   This should be the same as lsbmajdistrelease, but on minimal systems there
 #   are too many dependencies to use LSB
@@ -16,7 +19,7 @@
 #   "Alpine" "Amazon" "Archlinux" "Ascendos" "Bluewhite64" "CentOS" "CloudLinux" 
 #   "Debian" "Fedora" "Gentoo" "Mandrake" "Mandriva" "MeeGo" "OEL" "OpenSuSE" 
 #   "OracleLinux" "OVS" "PSBM" "RedHat" "Scientific" "Slackware" "Slamd64" "SLC"
-#   "SLED" "SLES" "SuSE" "Ubuntu" "VMWareESX"
+#   "SLED" "SLES" "Solaris" "SuSE" "Ubuntu" "VMWareESX"
 #
 
 Facter.add(:operatingsystemmajrelease) do

data/lib/facter/os.rb

@@ -1,29 +1,58 @@
 # Fact: os
 #
 # Purpose:
-#   Return various facts related to the machine's operating system.
+#   Return various facts related to the machine's operating system, including:
+#   Name: The name of the operating system.
+#   Family: A mapping of the operating system to an operating system family.
+#   Release: The release version of the operating system. Includes entries for the
+#   major and minor release versions, as well as the full release string.
+#   Lsb: Linux Standard Base information for the system.
+#
+#   This fact is structured. These values are returned as a group of key-value pairs.
 #
 # Resolution:
-#   For operatingsystem, if the kernel is a Linux kernel, check for the
-#   existence of a selection of files in `/etc` to find the specific flavor.
+#   For the name entry, if the kernel is a Linux kernel, check for the existence of a 
+#   selection of files in `/etc` to find the specific flavor.
 #   On SunOS based kernels, attempt to determine the flavor, otherwise return Solaris.
 #   On systems other than Linux, use the kernel value.
 #
-#   For operatingsystemrelease, on RedHat derivatives, we return their `/etc/<varient>-release` file.
+#   For the family entry, map operating systems to operating system families, such
+#   as linux distribution derivatives. Adds mappings from specific operating systems
+#   to kernels in the case that it is relevant.
+#
+#   For the release entry, on RedHat derivatives, returns `/etc/<variant>-release` file.
 #   On Debian, returns `/etc/debian_version`.
 #   On Ubuntu, parses `/etc/lsb-release` for the release version
-#   On Suse and derivatives, parses `/etc/SuSE-release` for a selection of version information.
+#   On Suse and derivatives, parses `/etc/SuSE-release` for a selection of version
+#   information.
 #   On Slackware, parses `/etc/slackware-version`.
 #   On Amazon Linux, returns the lsbdistrelease fact's value.
 #   On Mageia, parses `/etc/mageia-release` for the release version.
 #   On all remaining systems, returns the kernelrelease fact's value.
 #
-#   For the lsb facts, uses the `lsb_release` system command.
+#   For the major version, uses the value of the full release string to determine the major
+#   release version.
+#   In RedHat osfamily derivatives and Debian, splits down the release string for a decimal point
+#   and uses the first non-decimal character.
+#   In Solaris, uses the first non-decimal character of the release string.
+#   In Ubuntu, uses the characters before and after the first decimal point, as in '14.04'.
+#   In Windows, uses the full release string in the case of server releases, such as '2012 R2',
+#   and uses the first non-decimal character in the cases of releases such as '8.1'.
+#
+#   For the minor version, attempts to split the full release version string and return
+#   the value of the character after the first decimal.
+#
+#   For the lsb entries, uses the `lsb_release` system command.
 #
 # Caveats:
-#   Lsb facts only work on Linux (and the kfreebsd derivative) systems.
-#   Requires the `lsb_release` program, which may not be installed by default.
-#   It is only as accurate as the ourput of lsb_release.
+#   The family entry is completely reliant on the name key, and no heuristics are used.
+#
+#   The major and minor release sub-facts of the release entry are not currenty
+#   supported on all platforms.
+#
+#   The lsb entries only work on Linux (and the kfreebsd derivative) systems. Requires
+#   the `lsb_release` program, which may not be installed by default. It is only as 
+#   accurate as the output of `lsb_release`.
 #
 
 require 'facter/operatingsystem/implementation'

data/lib/facter/partitions.rb

@@ -3,6 +3,8 @@
 # Purpose:
 #   Return the details of the disk partitions.
 #
+#   This fact is structured. Values are returned as a group of key-value pairs.
+#
 # Resolution:
 #   Parse the contents of `/sys/block/<device>/size` to receive the size (multiplying by 512 to correct for blocks-to-bytes).
 #
@@ -27,6 +29,7 @@ Facter.add(:partitions) do
       details['uuid']       = Facter::Util::Partitions.uuid(part)
       details['size']       = Facter::Util::Partitions.size(part)
       details['mount']      = Facter::Util::Partitions.mount(part)
+      details['label']      = Facter::Util::Partitions.label(part)
       details['filesystem'] = Facter::Util::Partitions.filesystem(part)
       details.reject! {|k,v| v.nil? || v.to_s.empty? }
       partitions[part] = details

data/lib/facter/processors.rb

@@ -1,18 +1,24 @@
 # Fact: processors
 #
 # Purpose:
-#   Additional facts about the machine's CPU's, including
-#   processor lists, models, counts, and speeds.
+#   Provide additional facts about the machine's CPUs, including:
+#   Models: A list of processors present on the system.
+#   Count:  The number of hardware threads.
+#   Physicalcount: The number of physical processors.
+#   Speed: The speed of the processors on the system.
+#
+#   This fact is structured. These values are returned as a group of key-value pairs.
 #
 # Resolution:
-#   Each kernel utilizes its own implementation object to collect
-#   processor data. Linux and kFreeBSD parse `/proc/cpuinfo` for each
-#   processor. AIX parses the output of `lsdev` for its processor section.
-#   For Solaris, we parse the output of `kstat` for each processor. OpenBSD uses
-#   the sysctl variables 'hw.model' and 'hw.ncpu' for the CPU model and 
-#   the CPU count respectively. Darwin utilizes the system profiler to collect
-#   the physical CPU count and speed.
+#   Linux and kFreeBSD parse `/proc/cpuinfo` for each processor.
+#   AIX parses the output of `lsdev` for its processor section.
+#   Solaris parses the output of `kstat` for each processor.
+#   OpenBSD uses the sysctl variables `hw.model` and `hw.ncpu` for the CPU model
+#   and the CPU count respectively.
+#   Darwin utilizes the system profiler to collect the physical CPU count and speed.
 #
+# Caveats:
+#   The 'speed' sub-fact is not currently supported on all platforms.
 
 require 'facter/processors/os'
 

data/lib/facter/system32.rb

@@ -12,7 +12,7 @@
 Facter.add(:system32) do
   confine :kernel => :windows
   setcode do
-    if File.exists?("#{ENV['SYSTEMROOT']}\\sysnative")
+    if File.exist?("#{ENV['SYSTEMROOT']}\\sysnative")
       "#{ENV['SYSTEMROOT']}\\sysnative"
     else
       "#{ENV['SYSTEMROOT']}\\system32"

data/lib/facter/system_uptime.rb

@@ -5,6 +5,8 @@
 #   seconds, hours, days and a general, human
 #   readable uptime.
 #
+#   This fact is structured. These values are returned as a group of key-value pairs.
+#
 # Resolution:
 #   Does basic math on the get_uptime_seconds utility
 #   to calculate seconds, hours and days.

data/lib/facter/util/config.rb

@@ -41,7 +41,11 @@ module Facter::Util::Config
     if Facter::Util::Root.root?
       windows_dir = windows_data_dir
       if windows_dir.nil? then
-        @external_facts_dirs = ["/etc/facter/facts.d", "/etc/puppetlabs/facter/facts.d"]
+        # Note: Beginning with Facter 3, /opt/puppetlabs/agent/facts.d will be the only
+        # default external fact directory.
+        @external_facts_dirs = ["/opt/puppetlabs/agent/facts.d",
+                                "/etc/facter/facts.d",
+                                "/etc/puppetlabs/facter/facts.d"]
       else
         @external_facts_dirs = [File.join(windows_dir, 'PuppetLabs', 'facter', 'facts.d')]
       end

data/lib/facter/util/dhcp_servers.rb

@@ -25,9 +25,8 @@ module Facter::Util::DHCPServers
 
   def self.device_dhcp_server(device)
     if Facter::Core::Execution.which('nmcli')
-      version = self.nmcli_version
       # If the version is >= 0.9.9, use show instead of list
-      if version && version[0] > 0 || version[1] > 9 || (version[1] == 9 && version[2] >= 9)
+      if is_newer_nmcli?
         Facter::Core::Execution.exec("nmcli -f all d show #{device}").scan(/dhcp_server_identifier.*?(\d+\.\d+\.\d+\.\d+)$/).flatten.first
       else
         Facter::Core::Execution.exec("nmcli -f all d list iface #{device}").scan(/dhcp_server_identifier.*?(\d+\.\d+\.\d+\.\d+)$/).flatten.first
@@ -35,9 +34,25 @@ module Facter::Util::DHCPServers
     end
   end
 
+  def self.network_manager_state
+    # If the version is >= 0.9.9, use g instead of nm
+    if is_newer_nmcli?
+      output = Facter::Core::Execution.exec('nmcli -t -f STATE g 2>/dev/null')
+    else
+      output = Facter::Core::Execution.exec('nmcli -t -f STATE nm 2>/dev/null')
+    end
+    return nil unless output
+    output.strip
+  end
+
   def self.nmcli_version
     if version = Facter::Core::Execution.exec("nmcli --version")
       version.scan(/version\s(\d+)\.?(\d+)?\.?(\d+)?\.?(\d+)?/).flatten.map(&:to_i)
     end
   end
+
+  def self.is_newer_nmcli?
+    version = nmcli_version
+    version && (version[0] > 0 || version[1] > 9 || (version[1] == 9 && version[2] >= 9))
+  end
 end

data/lib/facter/util/directory_loader.rb

@@ -1,7 +1,10 @@
 # A Facter plugin that loads external facts.
 #
 # Default Unix Directories:
-# /etc/facter/facts.d", "/etc/puppetlabs/facter/facts.d"
+# /opt/puppetlabs/agent/facts.d, /etc/facter/facts.d, /etc/puppetlabs/facter/facts.d
+#
+# Beginning with Facter 3, only /opt/puppetlabs/agent/facts.d will be a default external fact
+# directory in Unix.
 #
 # Default Windows Direcotires:
 # C:\ProgramData\Puppetlabs\facter\facts.d (2008)
@@ -30,8 +33,9 @@ class Facter::Util::DirectoryLoader
   # Directory for fact loading
   attr_reader :directory
 
-  def initialize(dir)
+  def initialize(dir, weight = nil)
     @directory = dir
+    @weight = weight || EXTERNAL_FACT_WEIGHT
   end
 
   def self.loader_for(dir)
@@ -52,6 +56,7 @@ class Facter::Util::DirectoryLoader
   # Load facts from files in fact directory using the relevant parser classes to
   # parse them.
   def load(collection)
+    weight = @weight
     entries.each do |file|
       parser = Facter::Util::Parser.parser_for(file)
       if parser == nil
@@ -64,7 +69,7 @@ class Facter::Util::DirectoryLoader
       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) } }
+        data.each { |p,v| collection.add(p, :value => v) { has_weight(weight) } }
       end
     end
   end