facter 1.6.9 → 1.6.10

data/CHANGELOG

@@ -1,3 +1,27 @@
+1.6.10
+===
+35067dc Bump Facter epoch to 1
+d6a3e91 Make package task depend on tar in Rakfile
+f42896d (#14764) Stub architecture fact when Windows facts run on Linux
+f44ca52 (maint) Fix hardware model fact for ruby 1.9
+964d1f0 (#12864) Close registry key
+ab025bb Revert "Revert "(#12864) Windows: get primary DNS from registry""
+478386d (#10261) Detect x64 architecture on Windows
+6cc881d Use git describe in Rakefile to determine pkg ver
+2043244 (#13678) Remove deprecation msg triggerd by the ipaddress6 fact
+d118d81 (#13678) Add filename extension on absolute paths on windows
+b050eb1 (#14582) Fix noise in LSB facts
+85654b0 (#13678) Allow passing shell built-ins to exec method on windows
+8f4c016 (#13678) Single quote paths on unix with spaces
+2d164e8 (#13678) Join PATHs correctly on windows
+e7e7e8f (#13678) Extend spec tests for expand_command
+0fea7b0 maint: Add shared context for specs to imitate windows or posix
+60d0cd2 (#13678) Fix spec failures on windows
+121a2ab (#13678) Fix quoting in expand_command
+55b1125 (#13678) Add more unit tests for new methods
+9086c0a (#13678) Add RDoc documentation for new methods
+165ace4 (#13678) Convert command to absolute paths before executing
+
 1.6.9
 ===
 b398bd8 (#14334) Fix dmidecode based facts on DragonFly BSD

data/Rakefile

@@ -17,10 +17,6 @@ require 'rake'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
 
-module Facter
-  FACTERVERSION = File.read('lib/facter.rb')[/FACTERVERSION *= *'(.*)'/,1] or fail "Couldn't find FACTERVERSION"
-end
-
 FILES = FileList[
   '[A-Z]*',
   'install.rb',
@@ -31,12 +27,50 @@ FILES = FileList[
   'spec/**/*'
 ]
 
+def get_version
+  `git describe`.strip
+end
+
+# :build_environment and :tar are mostly borrowed from puppet-dashboard Rakefile
+task :build_environment do
+  unless ENV['FORCE'] == '1'
+    modified = `git status --porcelain | sed -e '/^\?/d'`
+    if modified.split(/\n/).length != 0
+      puts <<-HERE
+!! ERROR: Your git working directory is not clean. You must
+!! remove or commit your changes before you can create a package:
+
+#{`git status | grep '^#'`.chomp}
+
+!! To override this check, set FORCE=1 -- e.g. `rake package:deb FORCE=1`
+      HERE
+      raise
+    end
+  end
+end
+
+desc "Create a release .tar.gz"
+task :tar => :build_environment do
+  name = "facter"
+  rm_rf 'pkg/tar'
+  temp=`mktemp -d -t tmpXXXXXX`.strip!
+  version = get_version
+  base = "#{temp}/#{name}-#{version}/"
+  mkdir_p base
+  sh "git checkout-index -af --prefix=#{base}"
+  mkdir_p "pkg/tar"
+  sh "tar -C #{temp} -pczf #{temp}/#{name}-#{version}.tar.gz #{name}-#{version}"
+  mv "#{temp}/#{name}-#{version}.tar.gz", "pkg/tar"
+  rm_rf temp
+  puts "Tarball is pkg/tar/#{name}-#{version}.tar.gz"
+end
+
 spec = Gem::Specification.new do |spec|
   spec.platform = Gem::Platform::RUBY
   spec.name = 'facter'
   spec.files = FILES.to_a
   spec.executables = %w{facter}
-  spec.version = Facter::FACTERVERSION
+  spec.version = get_version.split('-')[0]
   spec.summary = 'Facter, a system inventory tool'
   spec.description = 'You can prove anything with facts!'
   spec.author = 'Puppet Labs'
@@ -49,16 +83,11 @@ spec = Gem::Specification.new do |spec|
     '--main' << 'README' <<
     '--line-numbers'
 end
-
-Rake::PackageTask.new("facter", Facter::FACTERVERSION) do |pkg|
-  pkg.package_dir = 'pkg'
-  pkg.need_tar_gz = true
-  pkg.package_files = FILES.to_a
-end
-
 Rake::GemPackageTask.new(spec) do |pkg|
 end
 
+task :package => :tar
+
 task :default do
   sh %{rake -T}
 end

data/conf/redhat/facter.spec

@@ -2,9 +2,10 @@
 
 Summary: Ruby module for collecting simple facts about a host operating system
 Name: facter
-Version: 1.6.9
+Version: 1.6.10
 Release: 1%{?dist}
-#Release: 0.1rc1%{?dist}
+#Release: 0.1rc1.2%{?dist}
+Epoch: 1
 License: Apache 2.0
 Group: System Environment/Base
 URL: http://www.puppetlabs.com/puppet/related-projects/%{name}
@@ -53,6 +54,15 @@ rm -rf %{buildroot}
 
 
 %changelog
+* Wed Jun 13 2012 Moses Mendoza <moses@puppetlabs.com> - 1.6.10-1
+- Update for 1.6.10
+
+* Fri Jun 8 2012 Moses Mendoza <moses@puppetlabs.com> - 1.6.10-0.1rc1.2
+- Bump epoch to 1 to address errant Facter 2.0 rc release
+
+* Wed Jun 6 2012 Moses Mendoza <moses@puppetlabs.com> - 1.6.10-0.1rc1
+- Update for 1.6.10rc1
+
 * Thu May 17 2012 Moses Mendoza <moses@puppetlabs.com> - 1.6.9-1
 - Update for 1.6.9
 

data/lib/facter.rb

@@ -25,7 +25,7 @@ module Facter
   include Comparable
   include Enumerable
 
-  FACTERVERSION = '1.6.9'
+  FACTERVERSION = '1.6.10'
   # = 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/architecture.rb

@@ -25,7 +25,7 @@ Facter.add(:architecture) do
       end
     when /(i[3456]86|pentium)/
       case Facter.value(:operatingsystem)
-      when "Gentoo"
+      when "Gentoo", "windows"
         "x86"
       else
         "i386"

data/lib/facter/domain.rb

@@ -52,12 +52,17 @@ end
 Facter.add(:domain) do
   confine :kernel => :windows
   setcode do
-    require 'facter/util/wmi'
+    require 'facter/util/registry'
     domain = ""
-    Facter::Util::WMI.execquery("select DNSDomain from Win32_NetworkAdapterConfiguration where IPEnabled = True").each { |nic|
-      domain = nic.DNSDomain
-      break
-    }
+    regvalue = Facter::Util::Registry.hklm_read('SYSTEM\CurrentControlSet\Services\Tcpip\Parameters', 'Domain')
+    domain = regvalue if regvalue
+    if domain == ""
+      require 'facter/util/wmi'
+      Facter::Util::WMI.execquery("select DNSDomain from Win32_NetworkAdapterConfiguration where IPEnabled = True").each { |nic|
+        domain = nic.DNSDomain
+        break
+      }
+    end
     domain
   end
 end

data/lib/facter/hardwaremodel.rb

@@ -28,7 +28,34 @@ end
 Facter.add(:hardwaremodel) do
   confine :operatingsystem => :windows
   setcode do
-    require 'rbconfig'
-    RbConfig::CONFIG['host_cpu']
+    # The cryptic windows cpu architecture models are documented in these places:
+    # http://source.winehq.org/source/include/winnt.h#L568
+    # http://msdn.microsoft.com/en-us/library/windows/desktop/aa394373(v=vs.85).aspx
+    # http://msdn.microsoft.com/en-us/library/windows/desktop/windows.system.processorarchitecture.aspx
+    # Also, arm and neutral are included because they are valid for the upcoming
+    # windows 8 release.  --jeffweiss 23 May 2012
+    require 'facter/util/wmi'
+    model = ""
+    Facter::Util::WMI.execquery("select Architecture, Level from Win32_Processor").each do |cpu|
+      model =
+        case cpu.Architecture
+        when 11 then 'neutral'        # PROCESSOR_ARCHITECTURE_NEUTRAL
+        when 10 then 'i686'           # PROCESSOR_ARCHITECTURE_IA32_ON_WIN64
+        when 9 then 'x64'             # PROCESSOR_ARCHITECTURE_AMD64
+        when 8 then 'msil'            # PROCESSOR_ARCHITECTURE_MSIL
+        when 7 then 'alpha64'         # PROCESSOR_ARCHITECTURE_ALPHA64
+        when 6 then 'ia64'            # PROCESSOR_ARCHITECTURE_IA64
+        when 5 then 'arm'             # PROCESSOR_ARCHITECTURE_ARM
+        when 4 then 'shx'             # PROCESSOR_ARCHITECTURE_SHX
+        when 3 then 'powerpc'         # PROCESSOR_ARCHITECTURE_PPC
+        when 2 then 'alpha'           # PROCESSOR_ARCHITECTURE_ALPHA
+        when 1 then 'mips'            # PROCESSOR_ARCHITECTURE_MIPS
+        when 0 then "i#{cpu.Level}86" # PROCESSOR_ARCHITECTURE_INTEL
+        else 'unknown'            # PROCESSOR_ARCHITECTURE_UNKNOWN
+        end
+      break
+    end
+
+    model
   end
 end

data/lib/facter/ipaddress6.rb

@@ -65,7 +65,7 @@ end
 Facter.add(:ipaddress6) do
   confine :kernel => :windows
   setcode do
-    output = Facter::Util::Resolution.exec("#{ENV['SYSTEMROOT']}/system32/netsh interface ipv6 show address level=verbose")
+    output = Facter::Util::Resolution.exec("#{ENV['SYSTEMROOT']}/system32/netsh.exe interface ipv6 show address level=verbose")
 
     get_address_after_token(output, 'Address', true)
   end

data/lib/facter/lsbdistcodename.rb

@@ -13,6 +13,6 @@
 Facter.add(:lsbdistcodename) do
   confine :kernel => [ :linux, :"gnu/kfreebsd" ]
   setcode do
-    Facter::Util::Resolution.exec('lsb_release -c -s')
+    Facter::Util::Resolution.exec('lsb_release -c -s 2>/dev/null')
   end
 end

data/lib/facter/lsbdistdescription.rb

@@ -13,7 +13,7 @@
 Facter.add(:lsbdistdescription) do
   confine :kernel => [ :linux, :"gnu/kfreebsd" ]
   setcode do
-    if output = Facter::Util::Resolution.exec('lsb_release -d -s')
+    if output = Facter::Util::Resolution.exec('lsb_release -d -s 2>/dev/null')
       # the output may be quoted (at least it is on gentoo)
       output.sub(/^"(.*)"$/,'\1')
     end

data/lib/facter/lsbdistid.rb

@@ -13,6 +13,6 @@
 Facter.add(:lsbdistid) do
   confine :kernel => [ :linux, :"gnu/kfreebsd" ]
   setcode do
-    Facter::Util::Resolution.exec('lsb_release -i -s')
+    Facter::Util::Resolution.exec('lsb_release -i -s 2>/dev/null')
   end
 end

data/lib/facter/lsbdistrelease.rb

@@ -13,6 +13,6 @@
 Facter.add(:lsbdistrelease) do
   confine :kernel => [ :linux, :"gnu/kfreebsd" ]
   setcode do
-    Facter::Util::Resolution.exec('lsb_release -r -s')
+    Facter::Util::Resolution.exec('lsb_release -r -s 2>/dev/null')
   end
 end

data/lib/facter/lsbrelease.rb

@@ -13,6 +13,6 @@
 Facter.add(:lsbrelease) do
   confine :kernel => [ :linux, :"gnu/kfreebsd" ]
   setcode do
-    Facter::Util::Resolution.exec('lsb_release -v -s')
+    Facter::Util::Resolution.exec('lsb_release -v -s 2>/dev/null')
   end
 end

data/lib/facter/util/ip.rb

@@ -80,8 +80,8 @@ module Facter::Util::IP
     when 'HP-UX'
       output = %x{/bin/netstat -in | sed -e 1d}
     when 'windows'
-      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ip show interface|
-      output += %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ipv6 show interface|
+      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh.exe interface ip show interface|
+      output += %x|#{ENV['SYSTEMROOT']}/system32/netsh.exe interface ipv6 show interface|
     end
     output
   end
@@ -107,9 +107,9 @@ module Facter::Util::IP
     return get_single_interface_output(interface) unless Facter.value(:kernel) == 'windows'
 
     if label == 'ipaddress6'
-      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ipv6 show address \"#{interface}\"|
+      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh.exe interface ipv6 show address \"#{interface}\"|
     else
-      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh interface ip show address \"#{interface}\"|
+      output = %x|#{ENV['SYSTEMROOT']}/system32/netsh.exe interface ip show address \"#{interface}\"|
     end
     output
   end

data/lib/facter/util/registry.rb

@@ -0,0 +1,11 @@
+module Facter::Util::Registry
+  class << self
+    def hklm_read(key, value)
+      require 'win32/registry'
+      reg = Win32::Registry::HKEY_LOCAL_MACHINE.open(key)
+      rval = reg[value]
+      reg.close
+      rval
+    end
+  end
+end

data/lib/facter/util/resolution.rb

@@ -13,18 +13,102 @@ class Facter::Util::Resolution
 
   INTERPRETER = Facter::Util::Config.is_windows? ? "cmd.exe" : "/bin/sh"
 
-  def self.have_which
-    if ! defined?(@have_which) or @have_which.nil?
-      if Facter::Util::Config.is_windows?
-        @have_which = false
-      else
-        %x{which which >/dev/null 2>&1}
-        @have_which = $?.success?
+  # Returns the locations to be searched when looking for a binary. This
+  # is currently determined by the +PATH+ environment variable plus
+  # <tt>/sbin</tt> and <tt>/usr/sbin</tt> when run on unix
+  def self.search_paths
+    if Facter::Util::Config.is_windows?
+      ENV['PATH'].split(File::PATH_SEPARATOR)
+    else
+      # Make sure facter is usable even for non-root users. Most commands
+      # in /sbin (like ifconfig) can be run as non priviledged users as
+      # long as they do not modify anything - which we do not do with facter
+      ENV['PATH'].split(File::PATH_SEPARATOR) + [ '/sbin', '/usr/sbin' ]
+    end
+  end
+
+  # Determine the full path to a binary. If the supplied filename does not
+  # already describe an absolute path then different locations (determined
+  # by <tt>self.search_paths</tt>) will be searched for a match.
+  #
+  # Returns nil if no matching executable can be found otherwise returns
+  # the expanded pathname.
+  def self.which(bin)
+    if absolute_path?(bin)
+      return bin if File.executable?(bin)
+      if Facter::Util::Config.is_windows? and File.extname(bin).empty?
+        exts = ENV['PATHEXT']
+        exts = exts ? exts.split(File::PATH_SEPARATOR) : %w[.COM .EXE .BAT .CMD]
+        exts.each do |ext|
+          destext = bin + ext
+          if File.executable?(destext)
+            Facter.warnonce("Using Facter::Util::Resolution.which with an absolute path like #{bin} but no fileextension is deprecated. Please add the correct extension (#{ext})")
+            return destext
+          end
+        end
+      end
+    else
+      search_paths.each do |dir|
+        dest = File.join(dir, bin)
+        if Facter::Util::Config.is_windows?
+          dest.gsub!(File::SEPARATOR, File::ALT_SEPARATOR)
+          if File.extname(dest).empty?
+            exts = ENV['PATHEXT']
+            exts = exts ? exts.split(File::PATH_SEPARATOR) : %w[.COM .EXE .BAT .CMD]
+            exts.each do |ext|
+              destext = dest + ext
+              return destext if File.executable?(destext)
+            end
+          end
+        end
+        return dest if File.executable?(dest)
+      end
+    end
+    nil
+  end
+
+  # Determine in a platform-specific way whether a path is absolute. This
+  # defaults to the local platform if none is specified.
+  def self.absolute_path?(path, platform=nil)
+    # Escape once for the string literal, and once for the regex.
+    slash = '[\\\\/]'
+    name = '[^\\\\/]+'
+    regexes = {
+      :windows => %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i,
+      :posix   => %r!^/!,
+    }
+    platform ||= Facter::Util::Config.is_windows? ? :windows : :posix
+
+    !! (path =~ regexes[platform])
+  end
+
+  # Expand the executable of a commandline to an absolute path. The executable
+  # is the first word of the commandline. If the executable contains spaces,
+  # it has be but in double quotes to be properly recognized.
+  #
+  # Returns the commandline with the expanded binary or nil if the binary
+  # can't be found. If the path to the binary contains quotes, the whole binary
+  # is put in quotes.
+  def self.expand_command(command)
+    if match = /^"(.+?)"(?:\s+(.*))?/.match(command)
+      exe, arguments = match.captures
+      exe = which(exe) and [ "\"#{exe}\"", arguments ].compact.join(" ")
+    elsif match = /^'(.+?)'(?:\s+(.*))?/.match(command) and not Facter::Util::Config.is_windows?
+      exe, arguments = match.captures
+      exe = which(exe) and [ "'#{exe}'", arguments ].compact.join(" ")
+    else
+      exe, arguments = command.split(/ /,2)
+      if exe = which(exe)
+        # the binary was not quoted which means it contains no spaces. But the
+        # full path to the binary may do so.
+        exe = "\"#{exe}\"" if exe =~ /\s/ and Facter::Util::Config.is_windows?
+        exe = "'#{exe}'" if exe =~ /\s/ and not Facter::Util::Config.is_windows?
+        [ exe, arguments ].compact.join(" ")
       end
     end
-    @have_which
   end
 
+
   # Execute a program and return the output of that program.
   #
   # Returns nil if the program can't be found, or if there is a problem
@@ -33,34 +117,21 @@ class Facter::Util::Resolution
   def self.exec(code, interpreter = nil)
     Facter.warnonce "The interpreter parameter to 'exec' is deprecated and will be removed in a future version." if interpreter
 
-    # Try to guess whether the specified code can be executed by looking at the
-    # first word. If it cannot be found on the PATH defer on resolving the fact
-    # by returning nil.
-    # This only fails on shell built-ins, most of which are masked by stuff in
-    # /bin or of dubious value anyways. In the worst case, "sh -c 'builtin'" can
-    # be used to work around this limitation
-    #
-    # Windows' %x{} throws Errno::ENOENT when the command is not found, so we
-    # can skip the check there. This is good, since builtins cannot be found
-    # elsewhere.
-    if have_which and !Facter::Util::Config.is_windows?
-      path = nil
-      binary = code.split.first
-      if code =~ /^\//
-        path = binary
-      else
-        path = %x{which #{binary} 2>/dev/null}.chomp
-        # we don't have the binary necessary
-        return nil if path == "" or path.match(/Command not found\./)
-      end
-
-      return nil unless FileTest.exists?(path)
+    if expanded_code = expand_command(code)
+      # if we can find the binary, we'll run the command with the expanded path to the binary
+      code = expanded_code
+    else
+      # if we cannot find the binary return nil on posix. On windows we'll still try to run the
+      # command in case it is a shell-builtin. In case it is not, windows will raise Errno::ENOENT
+      return nil unless Facter::Util::Config.is_windows?
+      return nil if absolute_path?(code)
     end
 
     out = nil
 
     begin
       out = %x{#{code}}.chomp
+      Facter.warnonce 'Using Facter::Util::Resolution.exec with a shell built-in is deprecated. Most built-ins can be replaced with native ruby commands. If you really have to run a built-in, pass "cmd /c your_builtin" as a command' unless expanded_code
     rescue Errno::ENOENT => detail
       # command not found on Windows
       return nil