facter 1.7.6 → 2.0.1.rc1

data/lib/facter/util/solaris_zones.rb

@@ -93,7 +93,7 @@ module Util
     #
     # @return [Hash] the parsed output of the zoneadm command
     def refresh
-      @zoneadm_output = Facter::Util::Resolution.exec(zoneadm_cmd)
+      @zoneadm_output = Facter::Core::Execution.exec(zoneadm_cmd)
       parse!
     end
 
@@ -103,11 +103,11 @@ module Util
     #
     # @api private
     def parse!
-      if @zoneadm_output
-        rows = @zoneadm_output.split("\n").collect { |line| line.split(':') }
-      else
+      if @zoneadm_output.empty?
         Facter.debug "Cannot parse zone facts, #{zoneadm_cmd} returned no output"
         rows = []
+      else
+        rows = @zoneadm_output.split("\n").collect { |line| line.split(':') }
       end
 
       @zone_hash = rows.inject({}) do |memo, fields|

data/lib/facter/util/uptime.rb

@@ -20,19 +20,24 @@ module Facter::Util::Uptime
   private
 
   def self.uptime_proc_uptime
-    if output = Facter::Util::Resolution.exec("/bin/cat #{uptime_file} 2>/dev/null")
+    output = Facter::Core::Execution.exec("/bin/cat #{uptime_file} 2>/dev/null")
+
+    if not output.empty?
       output.chomp.split(" ").first.to_i
     end
   end
 
   def self.uptime_sysctl
-    if output = Facter::Util::Resolution.exec("#{uptime_sysctl_cmd} 2>/dev/null")
+    output = Facter::Core::Execution.exec("#{uptime_sysctl_cmd} 2>/dev/null")
+    if not output.empty?
       compute_uptime(Time.at(output.match(/\d+/)[0].to_i))
     end
   end
 
   def self.uptime_executable
-    if output = Facter::Util::Resolution.exec("#{uptime_executable_cmd} 2>/dev/null")
+    output = Facter::Core::Execution.exec("#{uptime_executable_cmd} 2>/dev/null")
+
+    if not output.empty?
       up=0
       if output =~ /(\d+) day(?:s|\(s\))?,\s+(\d+):(\d+)/
         # Regexp handles Solaris, AIX, HP-UX, and Tru64.

data/lib/facter/util/values.rb

@@ -1,9 +1,75 @@
-# A util module for facter containing helper methods
 module Facter
   module Util
+    # A util module for facter containing helper methods
     module Values
       module_function
 
+      class DeepFreezeError < StandardError; end
+
+      # Duplicate and deeply freeze a given data structure
+      #
+      # @param value [Object] The structure to freeze
+      # @return [void]
+      def deep_freeze(value)
+        case value
+        when Numeric, Symbol, TrueClass, FalseClass, NilClass
+          # These are immutable values, we can safely ignore them
+          value
+        when String
+          value.dup.freeze
+        when Array
+          value.map do |entry|
+            deep_freeze(entry)
+          end.freeze
+        when Hash
+          value.inject({}) do |hash, (key, value)|
+            hash[deep_freeze(key)] = deep_freeze(value)
+            hash
+          end.freeze
+        else
+          raise DeepFreezeError, "Cannot deep freeze #{value}:#{value.class}"
+        end
+      end
+
+      class DeepMergeError < StandardError; end
+
+      # Perform a deep merge of two nested data structures.
+      #
+      # @param left [Object]
+      # @param right [Object]
+      # @param path [Array<String>] The traversal path followed when merging nested hashes
+      #
+      # @return [Object] The merged data structure.
+      def deep_merge(left, right, path = [], &block)
+        ret = nil
+
+        if left.is_a? Hash and right.is_a? Hash
+          ret = left.merge(right) do |key, left_val, right_val|
+            path.push(key)
+            merged = deep_merge(left_val, right_val, path)
+            path.pop
+            merged
+          end
+        elsif left.is_a? Array and right.is_a? Array
+          ret = left.dup.concat(right)
+        elsif right.nil?
+          ret = left
+        elsif left.nil?
+          ret = right
+        elsif left.nil? and right.nil?
+          ret = nil
+        else
+          msg = "Cannot merge #{left.inspect}:#{left.class} and #{right.inspect}:#{right.class}"
+          if not path.empty?
+            msg << " at root"
+            msg << path.map { |part| "[#{part.inspect}]" }.join
+          end
+          raise DeepMergeError, msg
+        end
+
+        ret
+      end
+
       def convert(value)
         value = value.to_s if value.is_a?(Symbol)
         value = value.downcase if value.is_a?(String)

data/lib/facter/util/virtual.rb

@@ -4,7 +4,7 @@ module Facter::Util::Virtual
   ##
   # virt_what is a delegating helper method intended to make it easier to stub
   # the system call without affecting other calls to
-  # Facter::Util::Resolution.exec
+  # Facter::Core::Execution.exec
   #
   # Per https://bugzilla.redhat.com/show_bug.cgi?id=719611 when run as a
   # non-root user the virt-what command may emit an error message on stdout,
@@ -12,7 +12,7 @@ module Facter::Util::Virtual
   # method ensures stderr is redirected and that error messages are stripped
   # from stdout.
   def self.virt_what(command = "virt-what")
-    command = Facter::Util::Resolution.which(command)
+    command = Facter::Core::Execution.which(command)
     return unless command
 
     if Facter.value(:kernel) == 'windows'
@@ -20,15 +20,15 @@ module Facter::Util::Virtual
     else
       redirected_cmd = "#{command} 2>/dev/null"
     end
-    output = Facter::Util::Resolution.exec redirected_cmd
+    output = Facter::Core::Execution.exec redirected_cmd
     output.gsub(/^virt-what: .*$/, '') if output
   end
 
   ##
   # lspci is a delegating helper method intended to make it easier to stub the
-  # system call without affecting other calls to Facter::Util::Resolution.exec
+  # system call without affecting other calls to Facter::Core::Execution.exec
   def self.lspci(command = "lspci 2>/dev/null")
-    Facter::Util::Resolution.exec command
+    Facter::Core::Execution.exec command
   end
 
   def self.openvz?
@@ -40,7 +40,7 @@ module Facter::Util::Virtual
     return false unless self.openvz?
     return false unless FileTest.exists?( '/proc/self/status' )
 
-    envid = Facter::Util::Resolution.exec( 'grep "envID" /proc/self/status' )
+    envid = Facter::Core::Execution.exec( 'grep "envID" /proc/self/status' )
     if envid =~ /^envID:\s+0$/i
     return 'openvzhn'
     elsif envid =~ /^envID:\s+(\d+)$/i
@@ -56,7 +56,7 @@ module Facter::Util::Virtual
 
   def self.zone?
     return true if FileTest.directory?("/.SUNWnative")
-    z = Facter::Util::Resolution.exec("/sbin/zonename")
+    z = Facter::Core::Execution.exec("/sbin/zonename")
     return false unless z
     return z.chomp != 'global'
   end
@@ -92,7 +92,7 @@ module Facter::Util::Virtual
      txt = if FileTest.exists?("/proc/cpuinfo")
        File.read("/proc/cpuinfo")
      elsif ["FreeBSD", "OpenBSD"].include? Facter.value(:kernel)
-       Facter::Util::Resolution.exec("/sbin/sysctl -n hw.model")
+       Facter::Core::Execution.exec("/sbin/sysctl -n hw.model")
      end
      (txt =~ /QEMU Virtual CPU/) ? true : false
   end
@@ -123,11 +123,11 @@ module Facter::Util::Virtual
       when "FreeBSD" then "/sbin"
       when "GNU/kFreeBSD" then "/bin"
     end
-    Facter::Util::Resolution.exec("#{path}/sysctl -n security.jail.jailed") == "1"
+    Facter::Core::Execution.exec("#{path}/sysctl -n security.jail.jailed") == "1"
   end
 
   def self.hpvm?
-    Facter::Util::Resolution.exec("/usr/bin/getconf MACHINE_MODEL").chomp =~ /Virtual Machine/
+    Facter::Core::Execution.exec("/usr/bin/getconf MACHINE_MODEL").chomp =~ /Virtual Machine/
   end
 
   def self.zlinux?

data/lib/facter/util/xendomains.rb

@@ -2,7 +2,7 @@
 #
 module Facter::Util::Xendomains
   def self.get_domains
-    if xm_list = Facter::Util::Resolution.exec('/usr/sbin/xm list 2>/dev/null')
+    if xm_list = Facter::Core::Execution.exec('/usr/sbin/xm list 2>/dev/null')
       domains = xm_list.split("\n").reject { |line| line =~ /^(Name|Domain-0)/ }
       domains.map { |line| line.split(/\s/)[0] }.join(',')
     end

data/lib/facter/version.rb

@@ -1,54 +1,53 @@
 module Facter
   if not defined? FACTERVERSION then
-    FACTERVERSION = '1.7.6'
+    FACTERVERSION = '2.0.1-rc1'
   end
 
-  ##
-  # version is a public API method intended to always provide a fast and
-  # lightweight way to determine the version of Facter.
+  # Returns the running version of Facter.
   #
-  # The intent is that software external to Facter be able to determine the
-  # Facter version with no side-effects.  The expected use is:
+  # @comment The intent is that software external to Facter be able to
+  #   determine the Facter version with no side-effects.  The expected
+  #   use is:
   #
   #     require 'facter/version'
   #     version = Facter.version
   #
-  # This function has the following ordering precedence.  This precedence list
-  # is designed to facilitate automated packaging tasks by simply writing to
-  # the VERSION file in the same directory as this source file.
+  #   This function has the following ordering precedence.  This precedence list
+  #   is designed to facilitate automated packaging tasks by simply writing to
+  #   the VERSION file in the same directory as this source file.
   #
-  #  1. If a version has been explicitly assigned using the Facter.version=
-  #     method, return that version.
-  #  2. If there is a VERSION file, read the contents, trim any
-  #     trailing whitespace, and return that version string.
-  #  3. Return the value of the Facter::FACTERVERSION constant hard-coded into
-  #     the source code.
+  #    1. If a version has been explicitly assigned using the Facter.version=
+  #       method, return that version.
+  #    2. If there is a VERSION file, read the contents, trim any
+  #       trailing whitespace, and return that version string.
+  #    3. Return the value of the Facter::FACTERVERSION constant hard-coded into
+  #       the source code.
   #
-  # If there is no VERSION file, the method must return the version string of
-  # the nearest parent version that is an officially released version.  That is
-  # to say, if a branch named 3.1.x contains 25 patches on top of the most
-  # recent official release of 3.1.1, then the version method must return the
-  # string "3.1.1" if no "VERSION" file is present.
+  #   If there is no VERSION file, the method must return the version string of
+  #   the nearest parent version that is an officially released version.  That is
+  #   to say, if a branch named 3.1.x contains 25 patches on top of the most
+  #   recent official release of 3.1.1, then the version method must return the
+  #   string "3.1.1" if no "VERSION" file is present.
   #
-  # By design the version identifier is _not_ intended to vary during the life
-  # a process.  There is no guarantee provided that writing to the VERSION file
-  # while a Puppet process is running will cause the version string to be
-  # updated.  On the contrary, the contents of the VERSION are cached to reduce
-  # filesystem accesses.
+  #   By design the version identifier is _not_ intended to vary during the life of
+  #   a process.  There is no guarantee provided that writing to the VERSION file
+  #   while a Puppet process is running will cause the version string to be
+  #   updated.  On the contrary, the contents of the VERSION are cached to reduce
+  #   filesystem accesses.
   #
-  # The VERSION file is intended to be used by package maintainers who may be
-  # applying patches or otherwise changing the software version in a manner
-  # that warrants a different software version identifier.  The VERSION file is
-  # intended to be managed and owned by the release process and packaging
-  # related tasks, and as such should not reside in version control.  The
-  # FACTERVERSION constant is intended to be version controlled in history.
+  #   The VERSION file is intended to be used by package maintainers who may be
+  #   applying patches or otherwise changing the software version in a manner
+  #   that warrants a different software version identifier.  The VERSION file is
+  #   intended to be managed and owned by the release process and packaging
+  #   related tasks, and as such should not reside in version control.  The
+  #   FACTERVERSION constant is intended to be version controlled in history.
   #
-  # Ideally, this behavior will allow package maintainers to precisely specify
-  # the version of the software they're packaging as in the following example:
+  #   Ideally, this behavior will allow package maintainers to precisely specify
+  #   the version of the software they're packaging as in the following example:
   #
-  #     $ git describe > lib/facter/VERSION
-  #     $ ruby -r facter -e 'puts Facter.version'
-  #     1.6.14-6-g66f2c99
+  #       $ git describe > lib/facter/VERSION
+  #       $ ruby -r facter -e 'puts Facter.version'
+  #       1.6.14-6-g66f2c99
   #
   # @api public
   #
@@ -62,17 +61,21 @@ module Facter
     @facter_version ||= FACTERVERSION
   end
 
+  # Sets the Facter version
+  #
+  # @return [void]
+  #
+  # @api private
   def self.version=(version)
     @facter_version = version
   end
 
-  ##
-  # read_version_file reads the content of the "VERSION" file that lives in the
+  # This reads the content of the "VERSION" file that lives in the
   # same directory as this source code file.
   #
   # @api private
   #
-  # @return [String] for example: "1.6.14-6-gea42046" or nil if the VERSION
+  # @return [String] the version -- for example: "1.6.14-6-gea42046" or nil if the VERSION
   #   file does not exist.
   def self.read_version_file(path)
     if File.exists?(path)

data/lib/facter/virtual.rb

@@ -55,13 +55,12 @@ end
 Facter.add("virtual") do
   confine :kernel => 'SunOS'
   has_weight 10
+  self.timeout = 6
+
   setcode do
     next "zone" if Facter::Util::Virtual.zone?
 
-    resolver = Facter::Util::Resolution.new('prtdiag')
-    resolver.timeout = 6
-    resolver.setcode('prtdiag')
-    output = resolver.value
+    output = Facter::Core::Execution.exec('prtdiag')
     if output
       lines = output.split("\n")
       next "parallels"  if lines.any? {|l| l =~ /Parallels/ }
@@ -92,7 +91,7 @@ Facter.add("virtual") do
   confine :kernel => 'OpenBSD'
   has_weight 10
   setcode do
-    output = Facter::Util::Resolution.exec('sysctl -n hw.product 2>/dev/null')
+    output = Facter::Core::Execution.exec('sysctl -n hw.product 2>/dev/null')
     if output
       lines = output.split("\n")
       next "parallels"  if lines.any? {|l| l =~ /Parallels/ }
@@ -133,7 +132,7 @@ Facter.add("virtual") do
     end
 
     # Parse dmidecode
-    output = Facter::Util::Resolution.exec('dmidecode 2> /dev/null')
+    output = Facter::Core::Execution.exec('dmidecode 2> /dev/null')
     if output
       lines = output.split("\n")
       next "parallels"  if lines.any? {|l| l =~ /Parallels/ }
@@ -146,7 +145,7 @@ Facter.add("virtual") do
     end
 
     # Sample output of vmware -v `VMware Server 1.0.5 build-80187`
-    output = Facter::Util::Resolution.exec("vmware -v")
+    output = Facter::Core::Execution.exec("vmware -v")
     if output
       mdata = output.match /(\S+)\s+(\S+)/
       next "#{mdata[1]}_#{mdata[2]}".downcase if mdata

data/lib/facter/zfs_version.rb

@@ -2,9 +2,9 @@ require 'facter'
 
 Facter.add('zfs_version') do
   setcode do
-    if Facter::Util::Resolution.which('zfs')
-      zfs_v = Facter::Util::Resolution.exec('zfs upgrade -v')
-      zfs_version = zfs_v.scan(/^\s+(\d+)\s+/m).flatten.last unless zfs_v.nil?
+    if Facter::Core::Execution.which('zfs')
+      zfs_v = Facter::Core::Execution.exec('zfs upgrade -v')
+      zfs_version = zfs_v.scan(/^\s+(\d+)\s+/m).flatten.last unless zfs_v.empty?
     end
   end
 end

data/lib/facter/zpool_version.rb

@@ -2,9 +2,9 @@ require 'facter'
 
 Facter.add('zpool_version') do
   setcode do
-    if Facter::Util::Resolution.which('zpool')
-      zpool_v = Facter::Util::Resolution.exec('zpool upgrade -v')
-      zpool_version = zpool_v.match(/ZFS pool version (\d+)./).captures.first unless zpool_v.nil?
+    if Facter::Core::Execution.which('zpool')
+      zpool_v = Facter::Core::Execution.exec('zpool upgrade -v')
+      zpool_version = zpool_v.match(/ZFS pool version (\d+)./).captures.first unless zpool_v.empty?
     end
   end
 end

data/spec/fixtures/unit/netmask/darwin_10_8_5.txt

@@ -0,0 +1,30 @@
+lo0: flags=8049<UP,LOOPBACK,RUNNING,MULTICAST> mtu 16384
+	options=3<RXCSUM,TXCSUM>
+	inet6 fe80::1%lo0 prefixlen 64 scopeid 0x1
+	inet 127.0.0.1 netmask 0xff000000
+	inet6 ::1 prefixlen 128
+gif0: flags=8010<POINTOPOINT,MULTICAST> mtu 1280
+stf0: flags=0<> mtu 1280
+en0: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+	ether 28:cf:e9:1a:8a:2d
+	inet6 fe80::2acf:e9ff:fe1a:8a2d%en0 prefixlen 64 scopeid 0x5
+	inet 10.16.141.17 netmask 0xfffffc00 broadcast 10.16.143.255
+	media: autoselect
+	status: active
+p2p0: flags=8843<UP,BROADCAST,RUNNING,SIMPLEX,MULTICAST> mtu 2304
+	ether 0a:cf:e9:1a:8a:2d
+	media: autoselect
+	status: inactive
+vmnet1: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+	ether 00:50:56:c0:00:01
+	inet 192.168.51.1 netmask 0xffffff00 broadcast 192.168.51.255
+vmnet8: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+	ether 00:50:56:c0:00:08
+	inet 172.16.138.1 netmask 0xffffff00 broadcast 172.16.138.255
+en3: flags=8863<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu 1500
+	options=4<VLAN_MTU>
+	ether 70:11:24:8c:33:df
+	inet6 fe80::7211:24ff:fe8c:33df%en3 prefixlen 64 scopeid 0x7
+	inet 10.16.16.205 netmask 0xfffffc00 broadcast 10.16.19.255
+	media: autoselect (100baseTX <full-duplex>)
+	status: active

data/spec/unit/application_spec.rb

@@ -8,7 +8,7 @@ describe Facter::Application do
       Facter::Application.parse(['architecture', 'kernel']).should == {}
     end
 
-    [:yaml, :json, :trace].each do |option_key|
+    [:yaml, :json].each do |option_key|
       it "sets options[:#{option_key}] when given --#{option_key}" do
         options = Facter::Application.parse(["--#{option_key}"])
         options[option_key].should be_true
@@ -31,6 +31,13 @@ describe Facter::Application do
       end
     end
 
+    it "enables tracing when given --trace" do
+      Facter.trace(false)
+      Facter::Application.parse(['--trace'])
+      Facter.should be_trace
+      Facter.trace(false)
+    end
+
     ['-t', '--timing'].each do |option|
       it "enables timing when given #{option}" do
         Facter.timing(false)
@@ -52,5 +59,43 @@ describe Facter::Application do
       Facter::Application.parse(argv)
       argv.should == ['uptime', 'virtual']
     end
+
+    after(:all) do
+      Facter.debugging(false)
+      Facter.timing(false)
+      Facter.trace(false)
+    end
+  end
+
+  describe "formatting facts" do
+    before do
+      Facter.stubs(:to_hash)
+      Facter.stubs(:value)
+      Facter::Application.stubs(:puts)
+    end
+
+    it "delegates YAML formatting" do
+      Facter::Util::Formatter.expects(:format_yaml)
+      Facter::Application.stubs(:exit).with(0)
+      Facter::Application.run(['--yaml'])
+    end
+
+    it "delegates JSON formatting", :if => Facter.json? do
+      Facter::Util::Formatter.expects(:format_json)
+      Facter::Application.stubs(:exit).with(0)
+      Facter::Application.run(['--json'])
+    end
+
+    it "delegates plaintext formatting" do
+      Facter::Util::Formatter.expects(:format_plaintext)
+      Facter::Application.stubs(:exit).with(0)
+      Facter::Application.run(['--plaintext'])
+    end
+
+    it "defaults to plaintext" do
+      Facter::Util::Formatter.expects(:format_plaintext)
+      Facter::Application.stubs(:exit).with(0)
+      Facter::Application.run([])
+    end
   end
 end