facter 1.5.9 → 1.6.0

data/CHANGELOG

@@ -1,3 +1,42 @@
+1.6.0
+===
+9404a7a (#7670) Add an acceptance test
+0c23845 maint: Fix spelling of acceptance directory
+926e912 (#7670) Stop preloading all facts in the application
+2255abe (#7670) Never fail to find a fact that is present
+8002c24 (#7507) Fix 1.9.2 test failure
+0635822 Removed inappropriately uncredited Ohai method from ec2 fact
+6b1cd16 (#6614) Update ipaddress6 fact to work with Ruby 1.9
+21fe217 (#6612) Changed uptime spec to be endian agnostic
+19f96b5 (#6728) Facter improperly detects openvzve on CloudLinux systems
+5b10173 (#5135) Fix faulty logic in physicalprocessorcount
+53cd946 Ensures that ARP facts are returned only on EC2 hosts
+bfa038d Fixed #6974 - Moved to Apache 2.0 license
+d56bca8 refactor the mechanism for allowing for resolution ordering to be influenced
+9f4c5c6 (#6740) facter doesn't always respect facts in environment variables
+7441b32 Partial fix for #6971 - Fix for virtual tests
+7f3e89d (#2714) Fixed faulty test
+bfc16f6 (#2714) Added timeout to prtdiag resulution
+c2ff833 (#5135) Refactored physicalprocessorcount
+0c4a98b Re-factor. Do not use pure-Ruby file reading against "/proc/cpuinfo" and possibly any entry under "/sys" from the sysfs file system.
+cb52b06 Fix. Using sysfs file system entries to count the number of physical CPUs. Fall-back to "/proc/cpuinfo" included for backward-compatibility with legacy systems.
+3efa9d7 (#3856) Add virtualbox detection via lspci (graphics card), dmidecode, and prtdiag for Solaris and corresponding tests. Darwin case is not handled yet.
+7c80172 (#6883) Update Facter install.rb to be slightly more informative.
+d31e3f9 (#5394) Document each Facter fact.
+af4947c (#6862) Add a default subject for the mail_patches rake task
+d6967a0 (#6613) Switch solaris macaddress fact to netstat
+e056218 (#6817) Fix for Ruby 1.9 by calling .each_line on a string
+861c2b2 maint: cleanup whitespace
+f6c9927 (#6719) Corrected faulty logic in bugfix
+e42e57c (#3856) Add virtualbox detection via lspci (graphics card), dmidecode, and prtdiag for Solaris and corresponding tests. Darwin case is not handled yet.
+0b5b546 (#6883) Update Facter install.rb to be slightly more informative.
+7c08270 (#5394) Document each Facter fact.
+06eb3f5 (#6883) Update Facter install.rb to be slightly more informative.
+1063753 (#6862) Add a default subject for the mail_patches rake task
+56b5f10 (#6613) Switch solaris macaddress fact to netstat
+fd4f31c (#6817) Fix for Ruby 1.9 by calling .each_line on a string
+72996ff maint: cleanup whitespace
+
 1.5.9
 =====
 4de8b20 Updated CHANGELOG for 1.5.9rc6

data/LICENSE

@@ -1,17 +1,15 @@
-Facter - Host Fact Detection and Reporting. Copyright (C) 2005 Reductive Labs LLC
+Facter - Host Fact Detection and Reporting
 
-Reductive Labs can be contacted at: info@reductivelabs.com
+Copyright 2011 Puppet Labs Inc
 
-This program and entire repository is free software; you can
-redistribute it and/or modify it under the terms of the GNU 
-General Public License as published by the Free Software 
-Foundation; either version 2 of the License, or any later version.
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+http://www.apache.org/licenses/LICENSE-2.0
 
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and 
+limitations under the License.

data/README.md

@@ -0,0 +1,24 @@
+Facter
+======
+
+This package is largely meant to be a library for collecting facts about your
+system.  These facts are mostly strings (i.e., not numbers), and are things
+like the output of `uname`, public ssh and cfengine keys, the number of
+processors, etc.
+
+See `bin/facter` for an example of the interface.
+
+Running Facter
+--------------
+
+Run the `facter` binary on the command for a full list of facts supported on your host.
+
+Adding your own facts
+---------------------
+
+See the [Adding Facts](http://docs.puppetlabs.com/guides/custom_facts.html) page for details of how to add your own custom facts to Facter.
+
+Further Information
+-------------------
+
+See http://www.puppetlabs.com/puppet/related-projects/facter for more details.

data/bin/facter

@@ -52,8 +52,8 @@
 #
 # = Copyright
 #
-# Copyright (c) 2006 Reductive Labs, LLC
-# Licensed under the GNU Public License
+# Copyright (c) 2011 Puppet Labs, Inc
+# Licensed under the Apache 2.0 license
 
 require 'facter/application'
 

data/conf/redhat/facter.spec

@@ -5,9 +5,9 @@
 
 Summary: Ruby module for collecting simple facts about a host operating system
 Name: facter
-Version: 1.5.8
+Version: 1.6.0
 Release: 1%{?dist}
-License: GPLv2+
+License: Apache 2.0
 Group: System Environment/Base
 URL: http://www.puppetlabs.com/puppet/related-projects/%{name}/
 Source0: http://puppetlabs.com/downloads/%{name}/%{name}-%{version}.tar.gz
@@ -52,6 +52,9 @@ rm -rf %{buildroot}
 
 
 %changelog
+* Thu Jun 23 2011 Michael Stahnke <stahnma@puppetlabs.com> - 1.6.0-1
+- Update to 1.6.0
+
 * Sat Aug 28 2010 Todd Zullinger <tmz@pobox.com> - 1.5.8-1
 - Update to 1.5.8
 

data/conf/solaris/pkginfo

@@ -1,6 +1,6 @@
 PKG=CSWfacter
 NAME=facter - System Fact Gatherer
-VERSION=1.3.5
+VERSION=1.6.0
 CATEGORY=application
 VENDOR=http://www.puppetlabs.com/puppet/related-projects/facter
 HOTLINE=http://puppetlabs.com/cgi-bin/facter.cgi

data/install.rb

@@ -119,7 +119,7 @@ def check_prereqs
         begin
             require pre
         rescue LoadError
-            puts "Could not load %s; cannot install" % pre
+            puts "Could not load #{pre} Ruby library; cannot install"
             exit -1
         end
     }

data/lib/facter.rb

@@ -1,21 +1,18 @@
-#--
-# Copyright 2006 Luke Kanies <luke@madstop.com>
+# Facter - Host Fact Detection and Reporting
 #
-# This library is free software; you can redistribute it and/or
-# modify it under the terms of the GNU Lesser General Public
-# License as published by the Free Software Foundation; either
-# version 2.1 of the License, or (at your option) any later version.
+# Copyright 2011 Puppet Labs Inc
 #
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# Lesser General Public License for more details.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
 #
-# You should have received a copy of the GNU Lesser General Public
-# License along with this library; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+# http://www.apache.org/licenses/LICENSE-2.0
 #
-#--
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and 
+# limitations under the License.
 
 module Facter
     # This is just so the other classes have the constant.
@@ -27,7 +24,7 @@ module Facter
     include Comparable
     include Enumerable
 
-    FACTERVERSION = '1.5.9'
+    FACTERVERSION = '1.6.0'
     # = Facter
     # Functions as a hash of 'facts' you might care about about your
     # system, such as mac address, IP address, Video card, etc.

data/lib/facter/Cfkey.rb

@@ -1,17 +1,17 @@
+# Fact: Cfkey
+#
+# Purpose: Return the public key(s) for CFengine.
+#
+# Resolution:
+#   Tries each file of standard localhost.pub & cfkey.pub locations,
+#   checks if they appear to be a public key, and then join them all together.
+#
+# Caveats:
+#
+
 ## Cfkey.rb
 ## Facts related to cfengine
 ##
-## This program is free software; you can redistribute it and/or
-## modify it under the terms of the GNU General Public License
-## as published by the Free Software Foundation (version 2 of the License)
-## This program is distributed in the hope that it will be useful,
-## but WITHOUT ANY WARRANTY; without even the implied warranty of
-## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-## GNU General Public License for more details.
-## You should have received a copy of the GNU General Public License
-## along with this program; if not, write to the Free Software
-## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston MA  02110-1301 USA
-##
 
 Facter.add(:Cfkey) do
     setcode do

data/lib/facter/application.rb

@@ -10,10 +10,6 @@ module Facter
       names = argv
 
       # Create the facts hash that is printed to standard out.
-      # Pre-load all of the facts, since we can have multiple facts
-      # per file, and since we can't know ahead of time which file a
-      # fact will be in, we'll need to load every file.
-      facts = Facter.to_hash
       unless names.empty?
         facts = {}
         names.each do |name|
@@ -26,6 +22,9 @@ module Facter
         end
       end
 
+      # Print everything if they didn't ask for specific facts.
+      facts ||= Facter.to_hash
+
       # Print the facts as YAML and exit
       if options[:yaml]
         require 'yaml'

data/lib/facter/architecture.rb

@@ -1,3 +1,16 @@
+# Fact: architecture
+#
+# Purpose:
+#   Return the CPU hardware architecture.
+# 
+# Resolution:
+#   On OpenBSD, Linux and Debian's kfreebsd, use the hardwaremodel fact.
+#   Gentoo and Debian call "x86_86" "amd64".
+#   Gentoo also calls "i386" "x86".
+#
+# Caveats:
+#
+
 Facter.add(:architecture) do
     confine :kernel => [:linux, :"gnu/kfreebsd"]
     setcode do

data/lib/facter/domain.rb

@@ -1,3 +1,23 @@
+# Fact: domain
+#
+# Purpose:
+#   Return the host's primary DNS domain name.
+# 
+# Resolution:
+#   On UNIX (excluding Darwin), first try and use the hostname fact,
+#   which uses the hostname system command, and then parse the output
+#   of that.
+#   Failing that it tries the dnsdomainname system command.
+#   Failing that it uses /etc/resolv.conf and takes the domain from that, or as
+#   a final resort, the search from that.
+#   Otherwise returns nil.
+#
+#   On Windows uses the win32ole gem and winmgmts to get the DNSDomain value
+#   from the Win32 networking stack.
+#
+# Caveats:
+#
+
 Facter.add(:domain) do
     setcode do
         # Get the domain from various sources; the order of these

data/lib/facter/facterversion.rb

@@ -1,3 +1,12 @@
+# Fact: facterversion
+#
+# Purpose: returns the version of the facter module.
+#
+# Resolution: Uses the version constant.
+#
+# Caveats:
+#
+
 Facter.add(:facterversion) do
     setcode { Facter::FACTERVERSION.to_s }
 end

data/lib/facter/fqdn.rb

@@ -1,3 +1,14 @@
+# Fact: fqdn
+#
+# Purpose: Returns the fully qualified domain name of the host.
+#
+# Resolution: Simply joins the hostname fact with the domain name fact.
+#
+# Caveats: No attempt is made to check that the two facts are accurate or that
+# the two facts go together. At no point is there any DNS resolution made
+# either.
+#
+
 Facter.add(:fqdn) do
     setcode do
         host = Facter.value(:hostname)

data/lib/facter/hardwareisa.rb

@@ -1,3 +1,15 @@
+# Fact: hardwareisa
+#
+# Purpose:
+#   Returns hardware processor type.
+#
+# Resolution:
+#   On Solaris, Linux and the BSDs simply uses the output of "uname -p"
+#
+# Caveats:
+#   Some linuxes return unknown to uname -p with relative ease.
+#
+
 Facter.add(:hardwareisa) do
     setcode 'uname -p', '/bin/sh'
     confine :operatingsystem => %w{Solaris Linux Fedora RedHat CentOS SuSE SLES Debian Ubuntu Gentoo FreeBSD OpenBSD NetBSD OEL OVS GNU/kFreeBSD}

data/lib/facter/hardwaremodel.rb

@@ -1,3 +1,16 @@
+# Fact: hardwaremodel
+#
+# Purpose:
+#   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.
+#
+# Caveats:
+#
+
 Facter.add(:hardwaremodel) do
     setcode 'uname -m'
 end

data/lib/facter/hostname.rb

@@ -1,3 +1,16 @@
+# Fact: hostname
+#
+# Purpose: Return the system's short hostname.
+#
+# Resolution:
+#   On all system bar 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.
+#
+# Caveats:
+#
+
 Facter.add(:hostname, :ldapname => "cn") do
     setcode do
         hostname = nil

data/lib/facter/id.rb

@@ -1,3 +1,16 @@
+# Fact: id
+#
+# Purpose: Internal fact used to specity the program to return the currently
+# 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.
+#
+# Caveats:
+#
+
 Facter.add(:id) do
     setcode "whoami"
 end

data/lib/facter/interfaces.rb

@@ -1,3 +1,12 @@
+# Fact: interfaces
+#
+# Purpose:
+#
+# Resolution:
+#
+# Caveats:
+#
+
 # interfaces.rb
 # Try to get additional Facts about the machine's network interfaces
 #

data/lib/facter/ipaddress.rb

@@ -1,3 +1,27 @@
+# Fact: ipaddress
+#
+# Purpose: Return the main IP address for a host.
+#
+# Resolution:
+#   On the Unixes does an ifconfig, and returns the first non 127.0.0.0/8
+#   subnetted IP it finds.
+#   On Windows, it attempts to use the socket library and resolve the machine's
+#   hostname via DNS.
+#
+#   On LDAP based hosts it tries to use either the win32/resolv library to
+#   resolve the hostname to an IP address, or on Unix, it uses the resolv
+#   library.
+#
+#   As a fall back for undefined systems, it tries to run the "host" command to
+#   resolve the machine's hostname using the system DNS.
+#
+# Caveats:
+#   DNS resolution relies on working DNS infrastructure and resolvers on the
+#   host system.
+#   The ifconfig parsing purely takes the first IP address it finds without any
+#   checking this is a useful IP address.
+#
+
 Facter.add(:ipaddress) do
     confine :kernel => :linux
     setcode do

data/lib/facter/ipaddress6.rb

@@ -1,32 +1,46 @@
+# Fact: ipaddress6
+#
+# 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.
+#
+# Caveats:
+#
+
 # Cody Herriges <c.a.herriges@gmail.com>
 #
 # Used the ipaddress fact that is already part of
 # Facter as a template.
 
-# 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.
+def get_address_after_token(output, token, return_first=false)
+  ip = nil
+
+  output.scan(/#{token} ((?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/).each do |match|
+    match = match.first
+    unless match =~ /fe80.*/ or match == "::1"
+      ip = match
+      break if return_first
+    end
+  end
+
+  ip
+end
+
 Facter.add(:ipaddress6) do
   confine :kernel => :linux
   setcode do
-    ip = nil
     output = Facter::Util::Resolution.exec('/sbin/ifconfig')
 
-    output.scan(/inet6 addr: ((?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/).each { |str|
-      str = str.to_s
-      unless str =~ /fe80.*/ or str == "::1"
-        ip = str
-      end
-    }
-
-    ip
-
+    get_address_after_token(output, 'inet6 addr:')
   end
 end
 
@@ -34,17 +48,8 @@ Facter.add(:ipaddress6) do
   confine :kernel => %w{SunOS}
   setcode do
     output = Facter::Util::Resolution.exec('/usr/sbin/ifconfig -a')
-    ip = nil
-
-    output.scan(/inet6 ((?>[0-9,a-f,A-F]*\:{0,2})+[0-9,a-f,A-F]{0,4})/).each { |str|
-      str = str.to_s
-      unless str =~ /fe80.*/ or str == "::1"
-        ip = str
-      end
-    }
-
-    ip
 
+    get_address_after_token(output, 'inet6')
   end
 end
 
@@ -52,17 +57,7 @@ Facter.add(:ipaddress6) do
   confine :kernel => %w{Darwin FreeBSD OpenBSD}
   setcode do
     output = Facter::Util::Resolution.exec('/sbin/ifconfig -a')
-    ip = nil
-
-    output.scan(/inet6 ((?>[0-9,a-f,A-F]*\:{1,2})+[0-9,a-f,A-F]{0,4})/).each do |str|
-      str = str.to_s
-      unless str =~ /fe80.*/ or str == "::1"
-        ip = str
-        break
-      end
-    end
 
-    ip
+    get_address_after_token(output, 'inet6', true)
   end
 end
-