(#13535) Fix uptime; use uptime instead of who -b

Without this patch applied the uptime fact value is often wrong on some
flavors of Unix.  In particular, the value may be negative or simply
incorrect.

This is a problem because the Facter value does not contained the truth
of our reality.  This makes it difficult to model reality inside of
Puppet.

This patch fixes the problem by replacing the unreliable who -b method
and the Solaris kstat method with a simple call to the
"uptime" command.

This patch also adds RSpec tests for new method and remove RSpec tests
for removed methods.  Delete now-unused fixture file who_b_boottime.

Reviewed-by: Jeff McCune <jeff@puppetlabs.com>

Author: alex-harvey-z3q

lib/facter/util/uptime.rb

@@ -4,7 +4,7 @@
 #
 module Facter::Util::Uptime
   def self.get_uptime_seconds_unix
-    uptime_proc_uptime or uptime_sysctl or uptime_kstat or uptime_who_dash_b
+    uptime_proc_uptime or uptime_sysctl or uptime_executable
   end
 
   def self.get_uptime_seconds_win
@@ -31,15 +31,30 @@ def self.uptime_sysctl
     end
   end
 
-  def self.uptime_kstat
-    if output = Facter::Util::Resolution.exec("#{uptime_kstat_cmd} 2>/dev/null")
-      compute_uptime(Time.at(output.chomp.split(/\s/).last.to_i))
-    end
-  end
-
-  def self.uptime_who_dash_b
-    if output = Facter::Util::Resolution.exec("#{uptime_who_cmd} 2>/dev/null")
-      compute_uptime(Time.parse(output))
+  def self.uptime_executable
+    if output = Facter::Util::Resolution.exec("#{uptime_executable_cmd} 2>/dev/null")
+      up=0
+      if output =~ /(\d+) day(?:s|\(s\))?,\s+(\d+):(\d+)/
+        # Regexp handles Solaris, AIX, HP-UX, and Tru64.
+        # 'day(?:s|\(s\))?' says maybe 'day', 'days',
+        #   or 'day(s)', and don't set $2.
+        up=86400*$1.to_i + 3600*$2.to_i + 60*$3.to_i
+      elsif output =~ /(\d+) day(?:s|\(s\))?,\s+(\d+) hr(?:s|\(s\))?,/
+        up=86400*$1.to_i + 3600*$2.to_i
+      elsif output =~ /(\d+) day(?:s|\(s\))?,\s+(\d+) min(?:s|\(s\))?,/
+        up=86400*$1.to_i + 60*$2.to_i
+      elsif output =~ /(\d+) day(?:s|\(s\))?,/
+        up=86400*$1.to_i
+      elsif output =~ /up\s+(\d+):(\d+),/
+        # must anchor to 'up' to avoid matching time of day
+        # at beginning of line.
+        up=3600*$1.to_i + 60*$2.to_i
+      elsif output =~ /(\d+) hr(?:s|\(s\))?,/
+        up=3600*$1.to_i
+      elsif output =~ /(\d+) min(?:s|\(s\))?,/
+        up=60*$1.to_i
+      end
+      up
     end
   end
 
@@ -55,11 +70,7 @@ def self.uptime_sysctl_cmd
     'sysctl -n kern.boottime'
   end
 
-  def self.uptime_kstat_cmd
-    'kstat -p unix:::boot_time'
-  end
-
-  def self.uptime_who_cmd
-    'who -b'
+  def self.uptime_executable_cmd
+    "uptime"
   end
 end

spec/fixtures/unit/util/uptime/who_b_boottime

@@ -41,31 +41,72 @@
 
       describe "nor is 'sysctl kern.boottime'" do
         before :each do
-          Facter::Util::Uptime.stubs(:uptime_sysctl_cmd).returns("cat \"#{@nonexistent_file}\"")
+          Facter::Util::Uptime.stubs(:uptime_proc_uptime).returns(false)
+          Facter::Util::Uptime.stubs(:uptime_sysctl).returns(false)
+          Facter.fact(:kernel).stubs(:value).returns('SunOS')
         end
 
-        it "should use 'kstat -p unix:::boot_time'" do
-          kstat_output_file = my_fixture('kstat_boot_time') # unix:0:system_misc:boot_time    1236919980
-          Facter::Util::Uptime.stubs(:uptime_kstat_cmd).returns("cat \"#{kstat_output_file}\"")
-          Time.stubs(:now).returns Time.at(1236923580) #one hour later
-          Facter::Util::Uptime.get_uptime_seconds_unix.should == 60 * 60
-        end
-
-        describe "nor is 'kstat -p unix:::boot_time'" do
-          before :each do
-            Facter::Util::Uptime.stubs(:uptime_kstat_cmd).returns("cat \"#{@nonexistent_file}\"")
-          end
+        describe "should use 'uptime' command" do
+          # Note about uptime variations.
+          # Solaris (I have examined 5.6, 5.7, 5.8, 5.9, 5.10 & 5.11) and HP-UX (11.00, 11.11, 11.23, 11.31) have time
+          #   right justified at at 8 characters, and two spaces before 'up'.
+          # Solaris differs from all other Unices (and Linux) in that the plural/singular case of minutes/hours/days are
+          #   written min(s)/hr(s)/day(s) instead of min/mins/hr/hrs etc., e.g. 1 min(s), 2 min(s) as opposed to
+          #   1 min, 2 mins, etc.
+          # AIX (4.3.3, 5.2, 5.3, 6.1) differs from other SysV Unices in that times are padded with a leading 0 in the
+          #   hour column where necessary, and have AM/PM in uppercase, and there are three spaces before 'up'.
+          # Tru64 (4.0, 5.1) differs from other SysV Unices in that times are in 24 hour format, and there are no
+          #   leading spaces.
+          # Linux (RHEL, uptime version 2.0.7) differs from the SysV Unices in that only minutes before the first hour
+          #   are written as 1 min, 2 min, 3 min etc. and after that full hours are rendered 1:00 or 21:00.  Time of
+          #   day was written 5:37pm and right-justified at 8 characters, with 2 spaces before 'up'.  A figure in
+          #   whole days was written as 3 days, 0 min.
+          # By version 2.0.17 the time of day was rewritten in 24hr time with seconds, right-justified at 9 characters.
+          # By version 3.2.7 one of the spaces before 'up' had been removed.
+          test_cases = [
+            ['  4:42pm  up 1 min(s),  0 users,  load average: 0.95, 0.25, 0.09',                                         1*60],
+            ['13:16  up 58 mins,  2 users,  load average: 0.00, 0.02, 0.05',                                            58*60],
+            ['13:18  up 1 hr,  1 user,  load average: 0.58, 0.23, 0.14',                                      1*60*60        ],
+            [' 10:14pm  up 3 hr(s),  0 users,  load average: 0.00, 0.00, 0.00',                               3*60*60        ],
+            ['14:18  up 2 hrs,  0 users,  load average: 0.33, 0.27, 0.29',                                    2*60*60        ],
+            ['  9:01pm  up  1:47,  0 users,  load average: 0.00, 0.00, 0.00',                                 1*60*60 + 47*60],
+            ['13:19  up  1:01,  1 user,  load average: 0.10, 0.26, 0.21',                                     1*60*60 +  1*60],
+            ['10:49  up 22:31,  0 users,  load average: 0.26, 0.34, 0.27',                                   22*60*60 + 31*60],
+            ['12:18  up 1 day,  0 users,  load average: 0.74, 0.20, 0.10',                      1*24*60*60                   ],
+            ['  2:48pm  up 1 day(s),  0 users,  load average: 0.21, 0.20, 0.17',                1*24*60*60                   ],
+            ['12:18  up 2 days,  0 users,  load average: 0.50, 0.27, 0.16',                     2*24*60*60                   ],
+            ['  1:56pm  up 25 day(s),  2 users,  load average: 0.59, 0.56, 0.50',              25*24*60*60                   ],
+            ['  1:29pm  up 485 days,  0 users,  load average: 0.00, 0.01, 0.01',              485*24*60*60                   ],
+            [' 18:11:24  up 69 days, 0 min,  0 users,  load average: 0.00, 0.00, 0.00',        69*24*60*60                   ],
+            ['12:19  up 1 day, 1 min,  0 users,  load average: 0.07, 0.16, 0.13',               1*24*60*60            +  1*60],
+            ['  3:23pm  up 25 day(s), 27 min(s),  2 users,  load average: 0.49, 0.45, 0.46',   25*24*60*60            + 27*60],
+            ['  02:42PM   up 1 day, 39 mins,  0 users,  load average: 1.49, 1.74, 1.80',        1*24*60*60            + 39*60],
+            [' 18:13:13  up 245 days, 44 min,  1 user,  load average: 0.00, 0.00, 0.00',      245*24*60*60            + 44*60],
+            ['  6:09pm  up 350 days, 2 min,  1 user,  load average: 0.02, 0.03, 0.00',        350*24*60*60            +  2*60],
+            ['  1:07pm  up 174 day(s), 16 hr(s),  0 users,  load average: 0.05, 0.04, 0.03',  174*24*60*60 + 16*60*60        ],
+            ['  02:34PM   up 621 days, 18 hrs,  0 users,  load average: 2.67, 2.52, 2.56',    621*24*60*60 + 18*60*60        ],
+            ['  3:30am  up 108 days, 1 hr,  31 users,  load average: 0.39, 0.40, 0.41',       108*24*60*60 +  1*60*60        ],
+            ['13:18  up 1 day, 1 hr,  0 users,  load average: 0.78, 0.33, 0.18',                1*24*60*60 +  1*60*60        ],
+            ['14:18  up 1 day, 2 hrs,  0 users,  load average: 1.17, 0.48, 0.41',               1*24*60*60 +  2*60*60        ],
+            ['15:56  up 152 days, 17 hrs,  0 users,  load average: 0.01, 0.06, 0.07',         152*24*60*60 + 17*60*60        ],
+            ['  5:37pm  up 25 days, 21:00,  0 users,  load average: 0.01, 0.02, 0.00',         25*24*60*60 + 21*60*60        ],
+            ['  8:59pm  up 94 day(s),  3:17,  46 users,  load average: 0.66, 0.67, 0.70',      94*24*60*60 +  3*60*60 + 17*60],
+            ['  3:01pm  up 4496 day(s), 21:19,  32 users,  load average: 0.61, 0.62, 0.62',  4496*24*60*60 + 21*60*60 + 19*60],
+            ['  02:42PM   up 41 days,   2:38,  0 users,  load average: 0.38, 0.70, 0.55',      41*24*60*60 +  2*60*60 + 38*60],
+            [' 18:13:29  up 25 days, 21:36,  0 users,  load average: 0.00, 0.00, 0.00',        25*24*60*60 + 21*60*60 + 36*60],
+            [' 13:36:05 up 118 days,  1:15,  1 user,  load average: 0.00, 0.00, 0.00',        118*24*60*60 +  1*60*60 + 15*60]
+          ]
 
-          it "should use 'who -b'" do
-            who_b_output_file = my_fixture('who_b_boottime') # Aug 1 14:13
-            Facter::Util::Uptime.stubs(:uptime_who_cmd).returns("cat \"#{who_b_output_file}\"")
-            Time.stubs(:now).returns Time.parse("Aug 01 15:13") # one hour later
-            Facter::Util::Uptime.get_uptime_seconds_unix.should == 60 * 60
+          test_cases.each do |uptime, expected|
+            it "should return #{expected} for #{uptime}" do
+              Facter::Util::Resolution.stubs(:exec).with('uptime 2>/dev/null').returns(uptime)
+              Facter.fact(:uptime_seconds).value.should == expected
+            end
           end
 
-          describe "nor is 'who -b'" do
+          describe "nor is 'uptime' command" do
             before :each do
-              Facter::Util::Uptime.stubs(:uptime_who_cmd).returns("cat \"#{@nonexistent_file}\"")
+              Facter::Util::Uptime.stubs(:uptime_executable_cmd).returns("cat \"#{@nonexistent_file}\"")
             end
 
             it "should return nil" do