facter 2.1.0 → 2.2.0

data/lib/facter/filesystems.rb

@@ -1,9 +1,16 @@
+# Fact: filesystems
 #
-# filesystems.rb
+# Purpose:
+#   This fact provides an alphabetic list of usable file systems that can
+#   be used for block devices like hard drives, media cards, etc.
 #
-# This fact provides an alphabetic list of usable file systems that can
-# be used for block devices like hard drives, media cards and so on ...
+# Resolution:
+#   Checks `/proc/filesystems`.
 #
+# Caveats:
+#   Only supports Linux.
+#
+
 Facter.add('filesystems') do
   confine :kernel => :linux
   setcode do

data/lib/facter/fqdn.rb

@@ -1,6 +1,6 @@
 # Fact: fqdn
 #
-# Purpose: Returns the fully qualified domain name of the host.
+# Purpose: Returns the fully-qualified domain name of the host.
 #
 # Resolution: Simply joins the hostname fact with the domain name fact.
 #

data/lib/facter/gid.rb

@@ -0,0 +1,16 @@
+# Fact: gid
+#
+# Purpose: Return the GID (group identifier) of the user running puppet.
+#
+# Resolution:
+#
+# Caveats:
+#   Not supported in Windows yet.
+#
+
+Facter.add(:gid) do
+  confine do
+    Facter::Core::Execution.which('id')
+  end
+  setcode { Facter::Core::Execution.exec('id -ng') }
+end

data/lib/facter/hardwareisa.rb

@@ -4,11 +4,11 @@
 #   Returns hardware processor type.
 #
 # Resolution:
-#   On Solaris, AIX, Linux and the BSDs simply uses the output of "uname -p"
-#   On HP-UX, "uname -m" gives us the same information.
+#   On Solaris, AIX, Linux and the BSDs simply uses the output of `uname -p`.
+#   On HP-UX, `uname -m` gives us the same information.
 #
 # Caveats:
-#   Some linuxes return unknown to uname -p with relative ease.
+#   Some Linuxes return unknown to `uname -p` with relative ease.
 #
 
 Facter.add(:hardwareisa) do

data/lib/facter/hardwaremodel.rb

@@ -4,9 +4,9 @@
 #   Returns the hardware model of the system.
 #
 # Resolution:
-#   Uses purely "uname -m" on all platforms other than AIX and Windows.
-#   On AIX uses the parsed "modelname" output of "lsattr -El sys0 -a modelname".
-#   On Windows uses the 'host_cpu' pulled out of Ruby's config.
+#   Uses purely `uname -m` on all platforms other than AIX and Windows.
+#   On AIX uses the parsed `modelname` output of `lsattr -El sys0 -a modelname`.
+#   On Windows uses the `host_cpu` pulled out of Ruby's config.
 #
 # Caveats:
 #

data/lib/facter/hostname.rb

@@ -3,7 +3,7 @@
 # Purpose: Return the system's short hostname.
 #
 # Resolution:
-#   On all system bar Darwin, parses the output of the "hostname" system command
+#   On all systems but Darwin, parses the output of the `hostname` system command
 #   to everything before the first period.
 #   On Darwin, uses the system configuration util to get the LocalHostName
 #   variable.

data/lib/facter/id.rb

@@ -1,12 +1,12 @@
 # Fact: id
 #
 # Purpose: Internal fact used to specity the program to return the currently
-# running user id.
+# running user ID.
 #
 # Resolution:
-#   On all Unixes bar Solaris, just returns "whoami".
-#   On Solaris, parses the output of the "id" command to grab the username, as
-#   Solaris doesn't have the whoami command.
+#   On all Unixes but Solaris, just returns the output from `whoami`.
+#   On Solaris, parses the output of the `id` command to grab the username,
+#   as Solaris doesn't have the `whoami` command.
 #
 # Caveats:
 #

data/lib/facter/interfaces.rb

@@ -1,6 +1,9 @@
 # Fact: interfaces
 #
 # Purpose:
+#   Generates the following facts on supported platforms: `<interface>_ipaddress`,
+#   `<interface>_ipaddress6`, `<interface>_macaddress`, `<interface>_netmask`,
+#   and `<interface>_mtu`.
 #
 # Resolution:
 #

data/lib/facter/ipaddress6.rb

@@ -3,15 +3,15 @@
 # Purpose: Returns the "main" IPv6 IP address of a system.
 #
 # Resolution:
-#  OS dependant code that parses the output of various networking
-#  tools and currently not very intelligent. Returns the first
-#  non-loopback and non-linklocal address found in the ouput unless
-#  a default route can be mapped to a routeable interface. Guessing
-#  an interface is currently only possible with BSD type systems
-#  to many assumptions have to be made on other platforms to make
-#  this work with the current code. Most code ported or modeled
-#  after the ipaddress fact for the sake of similar functionality
-#  and familiar mechanics.
+#   OS-dependent code that parses the output of various networking
+#   tools and currently not very intelligent. Returns the first
+#   non-loopback and non-linklocal address found in the ouput unless
+#   a default route can be mapped to a routable interface. Guessing
+#   an interface is currently only possible with BSD-type systems;
+#   too many assumptions have to be made on other platforms to make
+#   this work with the current code. Most of this code is ported or
+#   modeled after the ipaddress fact for the sake of similar
+#   functionality and familiar mechanics.
 #
 # Caveats:
 #

data/lib/facter/kernel.rb

@@ -3,8 +3,8 @@
 # Purpose: Returns the operating system's name.
 #
 # Resolution:
-#   Uses Ruby's rbconfig to find host_os, if that is a Windows derivative, the
-#   returns 'windows', otherwise returns "uname -s" verbatim.
+#   Uses Ruby's RbConfig to find host_os, if that is a Windows derivative, then
+#   returns `windows`, otherwise returns the output of `uname -s` verbatim.
 #
 # Caveats:
 #

data/lib/facter/kernelmajversion.rb

@@ -3,8 +3,8 @@
 # Purpose: Return the operating system's release number's major value.
 #
 # Resolution:
-#   Takes the first 2 elements of the kernel version as delimited by periods.
-#   Takes the first element of the kernel version on FreeBSD
+#   Takes the first two elements of the kernel version as delimited by periods.
+#   Takes the first element of the kernel version on FreeBSD.
 #
 # Caveats:
 #

data/lib/facter/kernelrelease.rb

@@ -3,10 +3,10 @@
 # Purpose: Return the operating system's release number.
 #
 # Resolution:
-#   On AIX returns the output from the "oslevel -s" system command.
-#   On Windows based systems, uses the win32ole gem to query Windows Management
-#   for the 'Win32_OperatingSystem' value.
-#   Otherwise uses the output of "uname -r" system command.
+#   On AIX, returns the output from the `oslevel -s` system command.
+#   On Windows-based systems, uses the win32ole gem to query Windows Management
+#   for the `Win32_OperatingSystem` value.
+#   Otherwise uses the output of `uname -r` system command.
 #
 # Caveats:
 #

data/lib/facter/kernelversion.rb

@@ -3,9 +3,9 @@
 # Purpose: Return the operating system's kernel version.
 #
 # Resolution:
-#   On Solaris and SunOS based machines, returns the output of "uname -v".
-#   Otherwise returns the 'kernerlversion' fact up to the first '-'. This may be
-#   the entire 'kernelversion' fact in many cases.
+#   On Solaris and SunOS based machines, returns the output of `uname -v`.
+#   Otherwise returns the kernerlversion fact up to the first `-`. This may be
+#   the entire kernelversion fact in many cases.
 #
 # Caveats:
 #

data/lib/facter/ldom.rb

@@ -1,3 +1,14 @@
+# Fact: ldom
+#
+# Purpose:
+#   Returns a list of dynamic facts that describe the attributes of
+#   a Solaris logical domain. The facts returned will include: domainrole,
+#   domainname, domainuuid, domaincontrol, and domainchassis.
+#
+# Resolution:
+#   Uses the output of `virtinfo -ap`.
+#
+
 if Facter.value(:kernel) == 'SunOS' and Facter::Core::Execution.which('virtinfo')
   virtinfo = Facter::Core::Execution.exec('virtinfo -ap')
 

data/lib/facter/lsbdistcodename.rb

@@ -3,14 +3,18 @@
 # Purpose: Return Linux Standard Base information for the host.
 #
 # Resolution:
-#   Uses the lsb_release system command
+#   Uses the lsbdistcodename key of the os structured fact, which 
+#   itself uses the `lsb_release` system command.
 #
 # Caveats:
 #   Only works on Linux (and the kfreebsd derivative) systems.
-#   Requires the lsb_release program, which may not be installed by default.
+#   Requires the `lsb_release` program, which may not be installed by default.
 #   Also is as only as accurate as that program outputs.
 
 Facter.add(:lsbdistcodename) do
-  confine :kernel => [ :linux, :"gnu/kfreebsd" ]
-  setcode 'lsb_release -c -s 2>/dev/null'
+  confine do
+    !Facter.value(:os)["lsb"].nil?
+  end
+
+  setcode { Facter.value("os")["lsb"]["distcodename"] }
 end

data/lib/facter/lsbdistdescription.rb

@@ -3,23 +3,19 @@
 # Purpose: Return Linux Standard Base information for the host.
 #
 # Resolution:
-#   Uses the lsb_release system command
+#   Uses the lsbdistdescription key of the os structured fact, which itself
+#   uses the `lsb_release` system command.
 #
 # Caveats:
 #   Only works on Linux (and the kfreebsd derivative) systems.
-#   Requires the lsb_release program, which may not be installed by default.
+#   Requires the `lsb_release` program, which may not be installed by default.
 #   Also is as only as accurate as that program outputs.
+#
 
 Facter.add(:lsbdistdescription) do
-  confine :kernel => [ :linux, :"gnu/kfreebsd" ]
   confine do
-    Facter::Core::Execution.which("lsb_release")
+    !Facter.value(:os)["lsb"].nil?
   end
 
-  setcode do
-    if output = Facter::Core::Execution.exec('lsb_release -d -s 2>/dev/null')
-      # the output may be quoted (at least it is on gentoo)
-      output.sub(/^"(.*)"$/,'\1')
-    end
-  end
+  setcode { Facter.value("os")["lsb"]["distdescription"] }
 end

data/lib/facter/lsbdistid.rb

@@ -3,14 +3,18 @@
 # Purpose: Return Linux Standard Base information for the host.
 #
 # Resolution:
-#   Uses the lsb_release system command
+#   Uses the lsbdistid key of the os structured fact, which itself
+#   uses the `lsb_release` system command.
 #
 # Caveats:
 #   Only works on Linux (and the kfreebsd derivative) systems.
-#   Requires the lsb_release program, which may not be installed by default.
+#   Requires the `lsb_release` program, which may not be installed by default.
 #   Also is as only as accurate as that program outputs.
 
 Facter.add(:lsbdistid) do
-  confine :kernel => [ :linux, :"gnu/kfreebsd" ]
-  setcode 'lsb_release -i -s 2>/dev/null'
+  confine do
+    !Facter.value(:os)["lsb"].nil?
+  end
+
+  setcode { Facter.value("os")["lsb"]["distid"] }
 end

data/lib/facter/lsbdistrelease.rb

@@ -3,14 +3,18 @@
 # Purpose: Return Linux Standard Base information for the host.
 #
 # Resolution:
-#   Uses the lsb_release system command
+#   Uses the lsbdistrelease key of the os structured fact, which itself
+#   uses the `lsb_release` system command.
 #
 # Caveats:
 #   Only works on Linux (and the kfreebsd derivative) systems.
-#   Requires the lsb_release program, which may not be installed by default.
+#   Requires the `lsb_release` program, which may not be installed by default.
 #   Also is as only as accurate as that program outputs.
 
 Facter.add(:lsbdistrelease) do
-  confine :kernel => [ :linux, :"gnu/kfreebsd" ]
-  setcode 'lsb_release -r -s 2>/dev/null'
+  confine do
+    !Facter.value(:os)["lsb"].nil?
+  end
+
+  setcode { Facter.value("os")["lsb"]["distrelease"] }
 end

data/lib/facter/lsbmajdistrelease.rb

@@ -4,24 +4,19 @@
 # from the lsbdistrelease fact.
 #
 # Resolution:
-#   Parses the lsbdistrelease fact for numbers followed by a period and
+#   Uses the lsbmajdistrelease key of the os structured fact, which itself
+#   parses the lsbdistrelease fact for numbers followed by a period and
 #   returns those, or just the lsbdistrelease fact if none were found.
 #
 # Caveats:
 #
 
-# lsbmajdistrelease.rb
-#
 require 'facter'
 
-Facter.add("lsbmajdistrelease") do
-  confine :kernel => %w{Linux GNU/kFreeBSD}
-  setcode do
-    if /(\d*)\./i =~ Facter.value(:lsbdistrelease)
-      result=$1
-    else
-      result=Facter.value(:lsbdistrelease)
-    end
-    result
+Facter.add(:lsbmajdistrelease) do
+  confine do
+    !Facter.value("os")["lsb"].nil?
   end
+
+  setcode { Facter.value("os")["lsb"]["majdistrelease"] }
 end

data/lib/facter/lsbminordistrelease.rb

@@ -0,0 +1,22 @@
+# Fact: lsbminordistrelease
+#
+# Purpose: Returns the minor version of the operation system version as gleaned
+# from the lsbdistrelease fact.
+#
+# Resolution:
+#   Parses the lsbdistrelease fact for x.y and returns y. If y is not present,
+#   the fact is not present.
+#
+#   For both values '1.2.3' and '1.2' of lsbdistrelease, lsbminordistrelease
+#   would return '2'. For the value '1', no fact would be set for
+#   lsbminordistrelease.
+#
+require 'facter'
+
+Facter.add('lsbminordistrelease') do
+  confine do
+    !Facter.value("os")["lsb"].nil?
+  end
+
+  setcode { Facter.value("os")["lsb"]["minordistrelease"] }
+end

data/lib/facter/lsbrelease.rb

@@ -3,14 +3,18 @@
 # Purpose: Return Linux Standard Base information for the host.
 #
 # Resolution:
-#   Uses the lsb_release system command
+#   Uses the lsbrelease key of the os structured fact, which itself
+#   uses the `lsb_release` system command.
 #
 # Caveats:
 #   Only works on Linux (and the kfreebsd derivative) systems.
-#   Requires the lsb_release program, which may not be installed by default.
+#   Requires the `lsb_release` program, which may not be installed by default.
 #   Also is as only as accurate as that program outputs.
 
 Facter.add(:lsbrelease) do
-  confine :kernel => [ :linux, :"gnu/kfreebsd" ]
-  setcode 'lsb_release -v -s 2>/dev/null'
+  confine do
+    !Facter.value(:os)["lsb"].nil?
+  end
+
+  setcode { Facter.value("os")["lsb"]["release"] }
 end

data/lib/facter/macaddress.rb

@@ -1,6 +1,7 @@
 # Fact: macaddress
 #
 # Purpose:
+#   Returns the MAC address of the primary network interface.
 #
 # Resolution:
 #

data/lib/facter/macosx.rb

@@ -6,7 +6,7 @@
 #
 # Resolution:
 #   Uses util/macosx.rb to do the fact reconnaissance, then outputs them
-#   preceded by 'sp_'
+#   preceded by `sp_`
 #
 # Caveats:
 #

data/lib/facter/manufacturer.rb

@@ -3,10 +3,10 @@
 # Purpose: Return the hardware manufacturer information about the hardware.
 #
 # Resolution:
-#   On OpenBSD, queries sysctl values, via a util class.
-#   On SunOS Sparc, uses prtdiag via a util class.
+#   On OpenBSD, queries `sysctl` values, via a util class.
+#   On SunOS Sparc, uses `prtdiag` via a util class.
 #   On Windows, queries the system via a util class.
-#   Uses the 'util/manufacturer.rb' for fallback parsing.
+#   Uses `util/manufacturer.rb` for fallback parsing.
 #
 # Caveats:
 #

data/lib/facter/memory.rb

@@ -3,15 +3,15 @@
 # Purpose: Return information about memory and swap usage.
 #
 # Resolution:
-#   On Linuxes, uses Facter::Memory.meminfo_number from
-#   'facter/util/memory.rb'
-#   On AIX, parses "swap -l" for swap values only.
-#   On OpenBSD, it parses "swapctl -l" for swap values, vmstat via a module for
-#   free memory, and "sysctl hw.physmem" for maximum memory.
-#   On FreeBSD, it parses "swapinfo -k" for swap values, and parses sysctl for
+#   On Linuxes, uses `Facter::Memory.meminfo_number` from
+#   `facter/util/memory.rb`
+#   On AIX, parses `swap -l` for swap values only.
+#   On OpenBSD, it parses `swapctl -l` for swap values, `vmstat` via a module for
+#   free memory, and `sysctl hw.physmem` for maximum memory.
+#   On FreeBSD, it parses `swapinfo -k` for swap values, and parses `sysctl` for
 #   maximum memory.
-#   On Solaris, use "swap -l" for swap values, and parsing prtconf for maximum
-#   memory, and again, the vmstat module for free memory.
+#   On Solaris, use `swap -l` for swap values, and parsing `prtconf` for maximum
+#   memory, and again, the `vmstat` module for free memory.
 #
 # Caveats:
 #   Some BSD platforms aren't covered at all. AIX is missing memory values.