facter 1.1.1 → 1.3.3

data/lib/facter.rb

@@ -1,9 +1,20 @@
-# $Id: facter.rb 78 2006-01-10 22:57:50Z luke $
+# $Id: facter.rb 153 2006-06-28 17:38:18Z luke $
 #--
-# Copyright 2004 Luke Kanies <luke@madstop.com>
-#
-# This program is free software. It may be redistributed and/or modified under
-# the terms of the Apache license.
+# Copyright 2006 Luke Kanies <luke@madstop.com>
+# 
+# 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.
+# 
+# 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.
+# 
+# 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
 # 
 #--
 
@@ -11,8 +22,8 @@ class Facter
     include Comparable
     include Enumerable
 
-FACTERVERSION = '1.1.1'
-	# = Facter 1.0
+    FACTERVERSION = '1.3.3'
+	# = Facter
     # Functions as a hash of 'facts' you might care about about your
     # system, such as mac address, IP address, Video card, etc.
     # returns them dynamically
@@ -30,10 +41,8 @@ FACTERVERSION = '1.1.1'
     GREEN = ""
     RESET = ""
     @@debug = 0
-    @@os = nil
-    @@osrel = nil
 
-    attr_accessor :name, :os, :osrel, :hardware, :searching
+    attr_accessor :name, :searching, :ldapname
 
 	# module methods
 
@@ -52,17 +61,18 @@ FACTERVERSION = '1.1.1'
         end
     end
 
-    # Return a fact object by name.  If you use this, you still have to call 'value'
-    # on it to retrieve the actual value.
-	def Facter.[](name)
-        @@facts[name.to_s.downcase]
+    # Return a fact object by name.  If you use this, you still have to call
+    # 'value' on it to retrieve the actual value.
+    def Facter.[](name)
+        name = name.to_s.downcase
+        @@facts[name]
     end
 
-    # Add a resolution mechanism for a named fact.  This does not distinguish between
-    # adding a new fact and adding a new way to resolve a fact.
+    # Add a resolution mechanism for a named fact.  This does not distinguish
+    # between adding a new fact and adding a new way to resolve a fact.
     def Facter.add(name, &block)
         fact = nil
-        dcname = name.downcase
+        dcname = name.to_s.downcase
 
         if @@facts.include?(dcname)
             fact = @@facts[dcname]
@@ -93,26 +103,42 @@ FACTERVERSION = '1.1.1'
                 end
             }
         end
-    end
 
-    def Facter.value(name)
-        if @@facts.include?(name.to_s.downcase)
-            @@facts[name.to_s.downcase].value
-        else
-            nil
-        end
-    end
+        # Allow users to call fact names directly on the Facter class,
+        # either retrieving the value or comparing it to an existing value.
+        def method_missing(name, *args)
+            question = false
+            if name.to_s =~ /\?$/
+                question = true
+                name = name.to_s.sub(/\?$/,'')
+            end
 
-    # Flush all cached values.
-    def Facter.flush
-        @@facts.each { |fact| fact.flush }
+            if fact = self[name]
+                if question
+                    value = fact.value.downcase
+                    args.each do |arg|
+                        if arg.to_s.downcase == value
+                            return true
+                        end
+                    end
+
+                    # If we got this far, there was no match.
+                    return false
+                else
+                    return fact.value
+                end
+            else
+                # Else, fail like a normal missing method.
+                return super
+            end
+        end
     end
 
-    # Remove them all.
-    def Facter.reset
-        @@facts.each { |name,fact|
-            @@facts.delete(name)
-        }
+    # Clear all facts.  Mostly used for testing.
+    def Facter.clear
+        Facter.reset
+        Facter.flush
+        @@facts.clear
     end
 
 	# Set debugging on or off.
@@ -141,11 +167,44 @@ FACTERVERSION = '1.1.1'
 		end
 	end
 
+    # Flush all cached values.
+    def Facter.flush
+        @@facts.each { |fact| fact.flush }
+    end
+
     # Return a list of all of the facts.
     def Facter.list
         return @@facts.keys
     end
 
+    # Remove them all.
+    def Facter.reset
+        @@facts.each { |name,fact|
+            @@facts.delete(name)
+        }
+    end
+
+    # Return a hash of all of our facts.
+    def Facter.to_hash(*tags)
+        @@facts.inject({}) do |h, ary|
+            if ary[1].suitable? and (tags.empty? or ary[1].tagged?(*tags))
+                value = ary[1].value
+                if value
+                    h[ary[0]] = value
+                end
+            end
+            h
+        end
+    end
+
+    def Facter.value(name)
+        if @@facts.include?(name.to_s.downcase)
+            @@facts[name.to_s.downcase].value
+        else
+            nil
+        end
+    end
+
     # Compare one value to another.
     def <=>(other)
         return self.value <=> other
@@ -158,7 +217,7 @@ FACTERVERSION = '1.1.1'
 
     # Create a new fact, with no resolution mechanisms.
     def initialize(name)
-        @name = name.downcase
+        @name = name.downcase if name.is_a? String
         if @@facts.include?(@name)
             raise ArgumentError, "A fact named %s already exists" % name
         else
@@ -166,9 +225,12 @@ FACTERVERSION = '1.1.1'
         end
 
         @resolves = []
+        @tags = []
         @searching = false
 
         @value = nil
+
+        @ldapname = name
     end
 
     # Add a new resolution mechanism.  This requires a block, which will then
@@ -180,6 +242,8 @@ FACTERVERSION = '1.1.1'
 
         resolve = Resolution.new(@name)
 
+        resolve.fact = self
+
         resolve.instance_eval(&block)
 
         # skip resolves that will never be suitable for us
@@ -187,7 +251,7 @@ FACTERVERSION = '1.1.1'
             return
         end
 
-        # insert resolves in order of number of tags
+        # insert resolves in order of number of confinements
         inserted = false
         @resolves.each_with_index { |r,index|
             if resolve.length > r.length
@@ -208,7 +272,7 @@ FACTERVERSION = '1.1.1'
     end
 
     # Iterate across all of the fact resolution mechanisms and yield each in
-    # turn.  These are inserted in order of most tags.
+    # turn.  These are inserted in order of most confinements.
     def each
         @resolves.each { |r| yield r }
     end
@@ -239,6 +303,29 @@ FACTERVERSION = '1.1.1'
         return @suitable
     end
 
+    # Add one ore more tags
+    def tag(*tags)
+        tags.each do |t|
+            t = t.to_s.downcase.intern
+            @tags << t unless @tags.include?(t)
+        end
+    end
+
+    # Is our fact tagged with all of the specified tags?
+    def tagged?(*tags)
+        tags.each do |t|
+            unless @tags.include? t.to_s.downcase.intern
+                return false
+            end
+        end
+
+        return true
+    end
+
+    def tags
+        @tags.dup
+    end
+
     # Return the value for a given fact.  Searches through all of the mechanisms
     # and returns either the first value or nil.
     def value
@@ -290,12 +377,13 @@ FACTERVERSION = '1.1.1'
         end
     end
 
-    # An actual fact resolution mechanism.  These are largely just chunks of code,
-    # with optional tags restricting the mechanisms to only working on specific
-    # systems.  Note that the tags are always ANDed, so any tags specified
-    # must all be true for the resolution to be suitable.
+    # An actual fact resolution mechanism.  These are largely just chunks of
+    # code, with optional confinements restricting the mechanisms to only working on
+    # specific systems.  Note that the confinements are always ANDed, so any
+    # confinements specified must all be true for the resolution to be
+    # suitable.
     class Resolution
-        attr_accessor :interpreter, :code, :name
+        attr_accessor :interpreter, :code, :name, :fact
 
         # Execute a chunk of code.
         def Resolution.exec(code, interpreter = "/bin/sh")
@@ -330,20 +418,33 @@ FACTERVERSION = '1.1.1'
                     return out
                 end
             else
-                raise ArgumentError, "non-sh interpreters are not currently supported"
+                raise ArgumentError,
+                    "non-sh interpreters are not currently supported"
+            end
+        end
+
+        # Add a new confine to the resolution mechanism.
+        def confine(*args)
+            if args[0].is_a? Hash
+                args[0].each do |fact, values|
+                    @confines.push Confine.new(fact,*values)
+                end
+            else
+                fact = args.shift
+                @confines.push Confine.new(fact,*args)
             end
         end
 
         # Create a new resolution mechanism.
         def initialize(name)
             @name = name
-            @tags = []
+            @confines = []
             @value = nil
         end
 
-        # Return the number of tags.
+        # Return the number of confines.
         def length
-            @tags.length
+            @confines.length
         end
 
         # Set our code for returning a value.
@@ -359,15 +460,21 @@ FACTERVERSION = '1.1.1'
             end
         end
 
+        # Set the name by which this parameter is known in LDAP.  The default
+        # is just the fact name.
+        def setldapname(name)
+            @fact.ldapname = name
+        end
+
         # Is this resolution mechanism suitable on the system in question?
         def suitable?
             unless defined? @suitable
                 @suitable = true
-                if @tags.length == 0
+                if @confines.length == 0
                     return true
                 end
-                @tags.each { |tag|
-                    unless tag.true?
+                @confines.each { |confine|
+                    unless confine.true?
                         @suitable = false
                     end
                 }
@@ -376,9 +483,9 @@ FACTERVERSION = '1.1.1'
             return @suitable
         end
 
-        # Add a new tag to the resolution mechanism.
-        def tag(fact,*values)
-            @tags.push Tag.new(fact,*values)
+        # Set tags on our parent fact.
+        def tag(*values)
+            @fact.tag(*values)
         end
 
         def to_s
@@ -413,14 +520,21 @@ FACTERVERSION = '1.1.1'
 
     # A restricting tag for fact resolution mechanisms.  The tag must be true
     # for the resolution mechanism to be suitable.
-    class Tag
+    class Confine
         attr_accessor :fact, :op, :value
 
-        # Add the tag.  Requires the fact name, an operator, and the value we're
-        # comparing to.
+        # Add the tag.  Requires the fact name, an operator, and the value
+        # we're comparing to.
         def initialize(fact, *values)
+            fact = fact.to_s if fact.is_a? Symbol
             @fact = fact
-            @values = values
+            @values = values.collect do |value|
+                if value.is_a? String
+                    value
+                else
+                    value.to_s
+                end
+            end
         end
 
         def to_s
@@ -441,7 +555,7 @@ FACTERVERSION = '1.1.1'
             end
 
             retval = @values.find { |v|
-                if value == v
+                if value.downcase == v.downcase
                     break true
                 end
             }
@@ -457,7 +571,35 @@ FACTERVERSION = '1.1.1'
     end
 
     # Load all of the default facts
-    def Facter.load
+    def Facter.loadfacts
+        Facter.add("FacterVersion") do
+            setcode { FACTERVERSION.to_s }
+        end
+
+        Facter.add("RubyVersion") do
+            setcode { RUBY_VERSION.to_s }
+        end
+
+        Facter.add("PuppetVersion") do
+            setcode {
+                begin
+                    require 'puppet'
+                    Puppet::PUPPETVERSION.to_s
+                rescue LoadError
+                    nil
+                end
+            }
+        end
+
+        Facter.add :rubysitedir do
+            setcode do
+                version = RUBY_VERSION.to_s.sub(/\.\d+$/, '')
+                $:.find do |dir|
+                    dir =~ /#{File.join("site_ruby", version)}$/
+                end
+            end
+        end
+
         Facter.add("Kernel") do
             setcode 'uname -s'
         end
@@ -477,13 +619,13 @@ FACTERVERSION = '1.1.1'
 
         Facter.add("OperatingSystem") do
             #obj.os = "Linux"
-            tag("kernel","SunOS")
+            confine :kernel => :sunos
             setcode do "Solaris" end
         end
 
         Facter.add("OperatingSystem") do
             #obj.os = "Linux"
-            tag("kernel","Linux")
+            confine :kernel => :linux
             setcode do
                 if FileTest.exists?("/etc/debian_version")
                     "Debian"
@@ -492,7 +634,12 @@ FACTERVERSION = '1.1.1'
                 elsif FileTest.exists?("/etc/fedora-release")
                     "Fedora"
                 elsif FileTest.exists?("/etc/redhat-release")
-                    "RedHat"
+                    txt = File.read("/etc/redhat-release")
+                    if txt =~ /centos/i
+                        "CentOS"
+                    else
+                        "RedHat"
+                    end
                 elsif FileTest.exists?("/etc/SuSE-release")
                     "SuSE"
                 end
@@ -501,7 +648,19 @@ FACTERVERSION = '1.1.1'
 
         Facter.add("HardwareModel") do
             setcode 'uname -m'
-            #tag("operatingsystem","SunOS")
+        end
+
+        Facter.add("Architecture") do
+            confine :operatingsystem => :debian
+            setcode do
+                model = Facter.hardwaremodel
+                case model
+                when 'x86_64': "amd64" 
+                when /(i[3456]86|pentium)/: "i386"
+                else
+                    model
+                end
+            end
         end
 
         Facter.add("CfKey") do
@@ -539,6 +698,18 @@ FACTERVERSION = '1.1.1'
                 end
             end
         end
+        # Look for the DNS domain name command first.
+        Facter.add("Domain") do
+            setcode do
+                domain = Resolution.exec('dnsdomainname') or nil
+                # make sure it's a real domain
+                if domain and domain =~ /.+\..+/
+                    domain
+                else
+                    nil
+                end
+            end
+        end
         Facter.add("Domain") do
             setcode do
                 domain = Resolution.exec('domainname') or nil
@@ -579,6 +750,7 @@ FACTERVERSION = '1.1.1'
             end
         end
         Facter.add("Hostname") do
+            setldapname "cn"
             setcode do
                 hostname = nil
                 name = Resolution.exec('hostname') or nil
@@ -597,7 +769,8 @@ FACTERVERSION = '1.1.1'
             end
         end
 
-        Facter.add("IPHostNumber") do
+        Facter.add("IPAddress") do
+            setldapname "iphostnumber"
             setcode do
                 require 'resolv'
 
@@ -617,7 +790,7 @@ FACTERVERSION = '1.1.1'
                 end
             end
         end
-        Facter.add("IPHostNumber") do
+        Facter.add("IPAddress") do
             setcode do
                 if hostname = Facter["hostname"].value
                     # we need Hostname to exist for this to work
@@ -658,16 +831,16 @@ FACTERVERSION = '1.1.1'
 
         Facter.add("UniqueId") do
             setcode 'hostid',  '/bin/sh'
-            tag("operatingsystem","Solaris")
+            confine :operatingsystem => :solaris
         end
 
         Facter.add("HardwareISA") do
             setcode 'uname -p', '/bin/sh'
-            tag("operatingsystem","Solaris")
+            confine :operatingsystem => :solaris
         end
 
         Facter.add("MacAddress") do
-            tag("operatingsystem","Solaris")
+            confine :operatingsystem => :solaris
             setcode do
                 ether = nil
                 output = %x{/sbin/ifconfig -a}
@@ -680,7 +853,7 @@ FACTERVERSION = '1.1.1'
         end
 
         Facter.add("MacAddress") do
-            tag("Kernel","Darwin")
+            confine :kernel => :darwin
             setcode do
                 ether = nil
                 output = %x{/sbin/ifconfig}
@@ -695,8 +868,8 @@ FACTERVERSION = '1.1.1'
                 ether
             end
         end
-        Facter.add("IPHostnumber") do
-            tag("Kernel","Darwin")
+        Facter.add("IPAddress") do
+            confine :kernel => :darwin
             setcode do
                 ip = nil
                 output = %x{/sbin/ifconfig}
@@ -715,72 +888,19 @@ FACTERVERSION = '1.1.1'
             end
         end
         Facter.add("Hostname") do
-            tag("Kernel","Darwin")
-            tag("KernelRelease","R7")
+            confine :kernel => :darwin, :kernelrelease => "R7"
             setcode do
-                hostname = nil
-                if FileTest.exists?("/Library/Preferences/SystemConfiguration/preferences.plist")
-                    File.open(
-                        "/Library/Preferences/SystemConfiguration/preferences.plist"
-                    ) { |file|
-                        found = 0
-                        file.each { |line|
-                            if line =~ /ComputerName/i
-                                found = 1
-                                next
-                            end
-                            if found == 1
-                                if line =~ /<string>([\w|-]+)<\/string>/
-                                    hostname = $1
-                                    break
-                                end
-                            end
-                        }
-                    }
-                end
-
-                if hostname != nil
-                    hostname
-                else
-                    nil
-                end
+                %x{/usr/sbin/scutil --get LocalHostName}
             end
         end
         Facter.add("IPHostnumber") do
-            tag("Kernel","Darwin")
-            tag("KernelRelease","R6")
+            confine :kernel => :darwin, :kernelrelease => "R6"
             setcode do
-                hostname = nil
-                if FileTest.exists?("/var/db/SystemConfiguration/preferences.xml")
-                    File.open(
-                        "/var/db/SystemConfiguration/preferences.xml"
-                    ) { |file|
-                        found = 0
-                        file.each { |line|
-                            if line =~ /ComputerName/i
-                                found = 1
-                                next
-                            end
-                            if found == 1
-                                if line =~ /<string>([\w|-]+)<\/string>/
-                                    hostname = $1
-                                    break
-                                end
-                            end
-                        }
-                    }
-                end
-
-                if hostname != nil
-                    hostname
-                else
-                    nil
-                end
+                %x{/usr/sbin/scutil --get LocalHostName}
             end
         end
         Facter.add("IPHostnumber") do
-            tag("Kernel","Darwin")
-            tag("KernelRelease","R6")
+            confine :kernel => :darwin, :kernelrelease => "R6"
             setcode do
                 ether = nil
                 output = %x{/sbin/ifconfig}
@@ -797,22 +917,45 @@ FACTERVERSION = '1.1.1'
         end
 
         Facter.add("ps") do
-            tag("operatingsystem","FreeBSD", "NetBSD", "OpenBSD", "Darwin")
+            confine :operatingsystem => %w{FreeBSD NetBSD OpenBSD Darwin}
             setcode do 'ps -auxwww' end
         end
 
         Facter.add("id") do
-            tag("operatingsystem","Linux")
+            confine :operatingsystem => :linux
             setcode "whoami"
         end
-    end
 
-    Facter.load
-end
+        locals = []
+
+        # Now see if we can find any other facts
+        $:.each do |dir|
+            fdir = File.join(dir, "facter")
+            if FileTest.exists?(fdir) and FileTest.directory?(fdir)
+                Dir.glob("#{fdir}/*.rb").each do |file|
+                    # Load here, rather than require, because otherwise
+                    # the facts won't get reloaded if someone calls
+                    # "loadfacts".  Really only important in testing, but,
+                    # well, it's important in testing.
+                    begin
+                        load file
+                    rescue => detail
+                        warn "Could not load %s: %s" %
+                            [file, detail]
+                    end
+                end
+            end
+        end
+
+        # Now try to get facts from the environment
+        ENV.each do |name, value|
+            if name =~ /^facter_?(\w+)$/i
+                Facter.add($1) do
+                    setcode { value }
+                end
+            end
+        end
+    end
 
-# try to load a local fact library, if there happens to be one
-begin
-    require 'facter/local'
-rescue LoadError
-    # no worries
+    Facter.loadfacts
 end