rouster 0.42 → 0.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d74bfb451922e3b85675d75df8eab08adcbb8f1
-  data.tar.gz: 8e16766740fb82932308c8e9ca1ff44e2ece3c70
+  metadata.gz: 76526d9f9fbaca98b3ea2bfad51a769f67df6647
+  data.tar.gz: 6f9bc1a95bec7be30e00eccb1cd0ca28c6d24a72
 SHA512:
-  metadata.gz: b5149f6ecef16db649b445602383708dc7a2f39b30dc8475edf408286dbe4c60105828af134d1a177e1c5a960e5e4515786798fe31fff351c9c1de604af1847c
-  data.tar.gz: c4b51b717eab079455f3cac15eab60d93c49403b8efe59c1886b0f300e8231143110140d99d3f62bac439cd792768386a5ddbc541a3f2aaa402f3e937feecbc9
+  metadata.gz: 345f5b6e4ef69a8a023e4bf3aebbb517e69a0ff7eee1f95b330bb1c373becfa1c231931f5c189099ec44acc355efe5a23b1c07cf057dc9cd6a297c7651343391
+  data.tar.gz: 92be5fcb79d74870bea301a722a539459656a89b9a7c139dba1c02e5fcbff5d12207f6dab4720952be5e58ab6606e27781885dfea29ffef1a117de757e713e56

data/.gitignore

@@ -4,3 +4,4 @@ doc/*
 *.swp
 *tmp*
 *.gem
+.rakeTasks

data/Rakefile

@@ -24,6 +24,10 @@ task :examples do
 	end
 end
 
+task :reek do
+  sh "reek lib/**/*.rb"
+end
+
 Rake::TestTask.new do |t|
   t.name = 'test'
   t.libs << 'lib'
@@ -44,3 +48,18 @@ Rake::TestTask.new do |t|
   t.test_files = FileList['test/functional/**/test_*.rb']
   t.verbose = true
 end
+
+Rake::TestTask.new do |t|
+  t.name = 'deltas'
+  t.libs << 'lib'
+  t.test_files = FileList['test/functional/deltas/test_*.rb']
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  t.name = 'puppet'
+  t.libs << 'lib'
+  t.test_files = FileList['test/puppet/test*.rb']
+  t.verbose = true
+end
+

data/Vagrantfile

@@ -1,7 +1,10 @@
 # stripped down example piab Vagrantfile for rouster
 
+#box_url = 'http://puppet-vagrant-boxes.puppetlabs.com/ubuntu-server-12042-x64-vbox4210.box'
+#box_name = 'ubuntu12'
 box_url  = 'http://puppet-vagrant-boxes.puppetlabs.com/centos-64-x64-vbox4210.box'
 box_name = 'centos6'
+
 boxes    = [:ppm, :app]
 
 Vagrant::Config.run do |config|
@@ -11,7 +14,7 @@ Vagrant::Config.run do |config|
       worker.vm.box            = box_name
       worker.vm.box_url        = box_url
       worker.vm.host_name      = box.to_s
-      worker.vm.network        :hostonly, sprintf('10.0.1.%s', rand(254))
+      worker.vm.network        :hostonly, sprintf('10.0.1.%s', rand(253).to_i + 2)
       worker.ssh.forward_agent = true
 
       if box.to_s.eql?('ppm') and File.directory?('../puppet')

data/lib/rouster.rb

@@ -11,9 +11,10 @@ require 'rouster/tests'
 class Rouster
 
   # sporadically updated version number
-  VERSION = 0.42
+  VERSION = 0.53
 
   # custom exceptions -- what else do we want them to include/do?
+  class ArgumentError        < StandardError; end # thrown by methods that take parameters from users
   class FileTransferError    < StandardError; end # thrown by get() and put()
   class InternalError        < StandardError; end # thrown by most (if not all) Rouster methods
   class ExternalError        < StandardError; end # thrown when external dependencies do not respond as expected
@@ -60,7 +61,8 @@ class Rouster
     @deltas = Hash.new
 
     @exitcode = nil
-    @ssh_info = nil # will be hash containing connection information
+    @ssh      = nil # hash containing the SSH connection object
+    @ssh_info = nil # hash containing connection information
 
     # set up logging
     require 'log4r/config'
@@ -75,17 +77,23 @@ class Rouster
       raise InternalError.new(sprintf('specified Vagrantfile [%s] does not exist', @vagrantfile))
     end
 
-    raise InternalError.new() if @name.nil?
+    raise InternalError.new('name of Vagrant VM not specified') if @name.nil?
 
     return if opts[:unittest].eql?(true) # quick return if we're a unit test
 
+    # this is breaking test/functional/test_caching.rb test_ssh_caching (if the VM was not running when the test started)
+    # it slows down object instantiation, but is a good test to ensure the machine name is valid..
     begin
       self.status()
-    rescue Rouster::LocalExecutionError
-      raise InternalError.new()
+    rescue Rouster::LocalExecutionError => e
+      raise InternalError.new(sprintf('caught non-0 exitcode from status(): %s', e.message))
     end
 
-    ## TODO ensure 'vagrant' is in path
+    begin
+      self._run('which vagrant')
+    rescue
+      raise ExternalError.new('vagrant not found in path')
+    end
 
     @log.debug('SSH key discovery and viability tests..')
     if @sshkey.nil?
@@ -107,12 +115,7 @@ class Rouster
     end
 
     if @sshtunnel
-      unless self.status.eql?('running')
-        @log.info(sprintf('upping machine[%s] in order to open SSH tunnel', @name))
-        self.up()
-      end
-
-      self.connect_ssh_tunnel()
+      self.up()
     end
 
     @log.info('Rouster object successfully instantiated')
@@ -142,7 +145,7 @@ class Rouster
   # if :sshtunnel is passed to the object during instantiation, the tunnel is created here as well
   def up
     @log.info('up()')
-    self._run(sprintf('cd %s; vagrant up %s', File.dirname(@vagrantfile), @name))
+    self.vagrant(sprintf('up %s', @name))
 
     @ssh_info = nil # in case the ssh-info has changed, a la destroy/rebuild
     self.connect_ssh_tunnel() if @sshtunnel
@@ -153,7 +156,8 @@ class Rouster
   # runs `vagrant destroy <name>` from the Vagrantfile path
   def destroy
     @log.info('destroy()')
-    self._run(sprintf('cd %s; vagrant destroy -f %s', File.dirname(@vagrantfile), @name))
+    disconnect_ssh_tunnel
+    self.vagrant(sprintf('destroy -f %s', @name))
   end
 
   ##
@@ -174,11 +178,14 @@ class Rouster
     end
 
     @log.info('status()')
-    self._run(sprintf('cd %s; vagrant status %s', File.dirname(@vagrantfile), @name))
+    self.vagrant(sprintf('status %s', @name))
 
     # else case here is handled by non-0 exit code
-    if self.get_output().match(/^#{@name}\s*(.*\s?\w+)\s(.+)$/)
-      # $1 = name, $2 = provider
+    if self.get_output().match(/^#{@name}\s*(.*\s?\w+)\s\((.+)\)$/)
+      # vagrant 1.2+, $1 = status, $2 = provider
+      status = $1
+    elsif self.get_output().match(/^#{@name}\s+(.+)$/)
+      # vagrant 1.2-, $1 = status
       status = $1
     end
 
@@ -198,7 +205,8 @@ class Rouster
   # runs `vagrant suspend <name>` from the Vagrantfile path
   def suspend
     @log.info('suspend()')
-    self._run(sprintf('cd %s; vagrant suspend %s', File.dirname(@vagrantfile), @name))
+    disconnect_ssh_tunnel()
+    self.vagrant(sprintf('suspend %s', @name))
   end
 
   ## internal methods
@@ -293,6 +301,80 @@ class Rouster
     res
   end
 
+  ##
+  # sandbox_available?
+  #
+  # returns true or false after attempting to find out if the sandbox
+  # subcommand is available
+  def sandbox_available?
+    if @cache.has_key?(:sandbox_available?)
+      @log.debug(sprintf('using cached sandbox_available?[%s]', @cache[:sandbox_available?]))
+      return @cache[:sandbox_available?]
+    end
+
+    @log.info('sandbox_available()')
+    self._run(sprintf('cd %s; vagrant', File.dirname(@vagrantfile))) # calling 'vagrant' without parameters to determine available faces
+
+    sandbox_available = false
+    if self.get_output().match(/^\s+sandbox$/)
+      sandbox_available = true
+    end
+
+    @cache[:sandbox_available?] = sandbox_available
+    @log.debug(sprintf('caching sandbox_available?[%s]', @cache[:sandbox_available?]))
+    @log.error('sandbox support is not available, please install the "sahara" gem first, https://github.com/jedi4ever/sahara') unless sandbox_available
+
+    return sandbox_available
+  end
+
+  ##
+  # sandbox_on
+  # runs `vagrant sandbox on` from the Vagrantfile path
+  def sandbox_on
+    if self.sandbox_available?
+      return self.vagrant(sprintf('sandbox on %s', @name))
+    else
+      raise ExternalError.new('sandbox plugin not installed')
+    end
+  end
+
+  ##
+  # sandbox_off
+  # runs `vagrant sandbox off` from the Vagrantfile path
+  def sandbox_off
+    if self.sandbox_available?
+      return self.vagrant(sprintf('sandbox off %s', @name))
+    else
+      raise ExternalError.new('sandbox plugin not installed')
+    end
+  end
+
+  ##
+  # sandbox_rollback
+  # runs `vagrant sandbox rollback` from the Vagrantfile path
+  def sandbox_rollback
+    if self.sandbox_available?
+      self.disconnect_ssh_tunnel
+      self.vagrant(sprintf('sandbox rollback %s', @name))
+      self.connect_ssh_tunnel
+    else
+      raise ExternalError.new('sandbox plugin not installed')
+    end
+  end
+
+  ##
+  # sandbox_commit
+  # runs `vagrant sandbox commit` from the Vagrantfile path
+  def sandbox_commit
+    if self.sandbox_available?
+      self.disconnect_ssh_tunnel
+      self.vagrant(sprintf('sandbox commit %s', @name))
+      self.connect_ssh_tunnel
+    else
+      raise ExternalError.new('sandbox plugin not installed')
+    end
+  end
+
   ##
   # get_ssh_info
   #
@@ -304,10 +386,11 @@ class Rouster
     h = Hash.new()
 
     if @ssh_info.class.eql?(Hash)
+      @log.debug('using cached SSH info')
       h = @ssh_info
     else
 
-      res = self._run(sprintf('cd %s; vagrant ssh-config %s', File.dirname(@vagrantfile), @name))
+      res = self.vagrant(sprintf('ssh-config %s', @name))
 
       res.split("\n").each do |line|
         if line.match(/HostName (.*?)$/)
@@ -317,8 +400,14 @@ class Rouster
         elsif line.match(/Port (\d*?)$/)
           h[:ssh_port] = $1
         elsif line.match(/IdentityFile (.*?)$/)
-          # TODO what to do if the user has specified @sshkey ?
-          h[:identity_file] = $1
+          key = $1
+          unless @sshkey.eql?(key)
+            h[:identity_file] = key
+          else
+            @log.info(sprintf('using specified key[%s] instead of discovered key[%s]', @sshkey, key))
+            h[:identity_file] = @sshkey
+          end
+
         end
       end
 
@@ -337,16 +426,29 @@ class Rouster
   def connect_ssh_tunnel
     @log.debug('opening SSH tunnel..')
 
-    if self.status.eql?('running')
+    status = self.status()
+    if status.eql?('running')
       self.get_ssh_info()
       @ssh = Net::SSH.start(@ssh_info[:hostname], @ssh_info[:user], :port => @ssh_info[:ssh_port], :keys => [@sshkey], :paranoid => false)
     else
-      raise InternalError.new('VM is not running, unable open SSH tunnel')
+      raise InternalError.new(sprintf('VM is not running[%s], unable open SSH tunnel', status))
     end
 
     @ssh
   end
 
+  ##
+  # disconnect_ssh_tunnel
+  #
+  # shuts down the persistent Net::SSH tunnel
+  #
+  def disconnect_ssh_tunnel
+    @log.debug('closing SSH tunnel..')
+
+    @ssh.shutdown! unless @ssh.nil?
+    @ssh = nil
+  end
+
   ##
   # os_type
   #
@@ -367,6 +469,8 @@ class Rouster
         res =:solaris
       when /Ubuntu/i
         res = :ubuntu
+      when /Debian/i
+        res = :debian
       else
         if self.is_file?('/etc/redhat-release')
           res = :redhat
@@ -389,20 +493,21 @@ class Rouster
   # * [local_file] - full or relative path (based on $PWD) of file to download to
   #
   # if no local_file is specified, will be downloaded to $PWD with the same shortname as it had in the VM
+  #
+  # returns true on successful download, false if the file DNE and raises a FileTransferError.. well, you know
   def get(remote_file, local_file=nil)
     # TODO what happens when we pass a wildcard as remote_file?
 
     local_file = local_file.nil? ? File.basename(remote_file) : local_file
     @log.debug(sprintf('scp from VM[%s] to host[%s]', remote_file, local_file))
 
-    # TODO should we do a self.file?(remote_file) test before trying to download?
-
     begin
       @ssh.scp.download!(remote_file, local_file)
     rescue => e
       raise FileTransferError.new(sprintf('unable to get[%s], exception[%s]', remote_file, e.message()))
     end
 
+    return true
   end
 
   ##
@@ -471,7 +576,7 @@ class Rouster
     case os_type
       when :osx
         self.run('shutdown -r now')
-      when :redhat, :ubuntu
+      when :redhat, :ubuntu, :debian
         self.run('/sbin/shutdown -rf now')
       when :solaris
         self.run('shutdown -y -i5 -g0')
@@ -479,18 +584,20 @@ class Rouster
         raise InternalError.new(sprintf('unsupported OS[%s]', @ostype))
     end
 
+    @ssh, @ssh_info = nil # severing the SSH tunnel, getting ready in case this box is brought back up on a different port
+
     if wait
       inc = wait.to_i / 10
       0..wait.each do |e|
         @log.debug(sprintf('waiting for reboot: round[%s], step[%s], total[%s]', e, inc, wait))
-        true if self.is_available_via_ssh?()
+        return true if self.is_available_via_ssh?()
         sleep inc
       end
 
-      false
+      return false
     end
 
-    @ssh, @ssh_info = nil, nil
+    return true
   end
 
   ##
@@ -504,7 +611,7 @@ class Rouster
   # parameters
   # * <command> - command to be run
   def _run(command)
-    tmp_file = sprintf('/tmp/rouster.%s.%s', Time.now.to_i, $$)
+    tmp_file = sprintf('/tmp/rouster-cmd_output.%s.%s', Time.now.to_i, $$)
     cmd      = sprintf('%s > %s 2> %s', command, tmp_file, tmp_file) # this is a holdover from Salesforce::Vagrant, can we use '2&>1' here?
     res      = `#{cmd}` # what does this actually hold?
 
@@ -524,6 +631,22 @@ class Rouster
     output
   end
 
+  ##
+  # vagrant
+  #
+  # abstraction layer to call vagrant faces
+  #
+  # parameters
+  # * <face> - vagrant face to call (include arguments)
+  def vagrant(face)
+    if self.is_passthrough?
+      @log.info(sprintf('calling [vagrant %s] on a passthrough host is a noop', face))
+      return nil
+    end
+
+    self._run(sprintf('cd %s; vagrant %s', File.dirname(@vagrantfile), face))
+  end
+
   ##
   # get_output
   #
@@ -561,7 +684,6 @@ class Rouster
   # * [filename] - filename you are looking for
   # * [levels]   - number of directory levels to examine, default is 10
   def traverse_up(startdir=Dir.pwd, filename=nil, levels=10)
-    # TODO not sure this signature is exactly right..
     raise InternalError.new('must specify a filename') if filename.nil?
 
     @log.debug(sprintf('traverse_up() looking for [%s] in [%s], up to [%s] levels', filename, startdir, levels)) unless @log.nil?

data/lib/rouster/deltas.rb

@@ -1,11 +1,9 @@
 require sprintf('%s/../../%s', File.dirname(File.expand_path(__FILE__)), 'path_helper')
 
-# deltas.rb - get information about groups, packages, services and users inside a Vagrant VM
+# deltas.rb - get information about crontabs, groups, packages, ports, services and users inside a Vagrant VM
 require 'rouster'
 require 'rouster/tests'
 
-# TODO use @cache_timeout to invalidate data cached here
-
 class Rouster
 
   ##
@@ -33,13 +31,22 @@ class Rouster
   def get_crontab(user='root', cache=true)
 
     if cache and self.deltas[:crontab].class.eql?(Hash)
-      if self.deltas[:crontab].has_key?(user)
+
+      if self.cache_timeout and self.cache_timeout.is_a?(Integer) and (Time.now.to_i - self.cache[:crontab]) > self.cache_timeout
+        @log.debug(sprintf('invalidating [crontab] cache, was [%s] old, allowed [%s]', (Time.now.to_i - self.cache[:crontab]), self.cache_timeout))
+        self.deltas.delete(:crontab)
+      end
+
+      if self.deltas.has_key?(:crontab) and self.deltas[:crontab].has_key?(user)
+        @log.debug(sprintf('using cached [crontab] from [%s]', self.cache[:crontab]))
         return self.deltas[:crontab][user]
+      elsif self.deltas.has_key?(:crontab) and user.eql?('*')
+        @log.debug(sprintf('using cached [crontab] from [%s]', self.cache[:crontab]))
+        return self.deltas[:crontab]
       else
         # noop fallthrough to gather data to cache
       end
-    elsif cache and self.deltas[:crontab].class.eql?(Hash) and user.eql?('*')
-      return self.deltas[:crontab]
+
     end
 
     i = 0
@@ -62,6 +69,7 @@ class Rouster
       end
 
       raw.split("\n").each do |line|
+        next if line.match(/^#/)
         elements = line.split("\s")
 
         res[u] ||= Hash.new
@@ -72,13 +80,15 @@ class Rouster
         res[u][i][:dom]     = elements[2]
         res[u][i][:mon]     = elements[3]
         res[u][i][:dow]     = elements[4]
-        res[u][i][:command] = elements[5..elements.size].join(" ")
+        res[u][i][:command] = elements[5..elements.size].join(' ')
       end
 
       i += 1
     end
 
     if cache
+      @log.debug(sprintf('caching [crontab] at [%s]', Time.now.asctime))
+
       if ! user.eql?('*')
         self.deltas[:crontab] ||= Hash.new
         self.deltas[:crontab][user] ||= Hash.new
@@ -87,6 +97,9 @@ class Rouster
         self.deltas[:crontab] ||= Hash.new
         self.deltas[:crontab] = res
       end
+
+      self.cache[:crontab] = Time.now.to_i
+
     end
 
     return user.eql?('*') ? res : res[user]
@@ -105,9 +118,19 @@ class Rouster
   #
   # parameters
   # * [cache] - boolean controlling whether data retrieved/parsed is cached, defaults to true
-  def get_groups(cache=true)
+  # * [deep]  - boolean controlling whether get_users() is called in order to correctly populate res[group][:users]
+  def get_groups(cache=true, deep=true)
+
     if cache and ! self.deltas[:groups].nil?
-      return self.deltas[:groups]
+
+      if self.cache_timeout and self.cache_timeout.is_a?(Integer) and (Time.now.to_i - self.cache[:groups]) > self.cache_timeout
+        @log.debug(sprintf('invalidating [groups] cache, was [%s] old, allowed [%s]', (Time.now.to_i - self.cache[:groups]), self.cache_timeout))
+        self.deltas.delete(:groups)
+      else
+        @log.debug(sprintf('using cached [groups] from [%s]', self.cache[:groups]))
+        return self.deltas[:groups]
+      end
+
     end
 
     res = Hash.new()
@@ -121,6 +144,8 @@ class Rouster
 
       group = data[0]
       gid   = data[2]
+
+      # this works in some cases, deep functionality picks up the others
       users = data[3].nil? ? ['NONE'] : data[3].split(',')
 
       res[group] = Hash.new() # i miss autovivification
@@ -128,11 +153,45 @@ class Rouster
       res[group][:users] = users
     end
 
+    groups = res
+
+    if deep
+      users = self.get_users(cache)
+
+      known_valid_gids = groups.keys.map { |g| groups[g][:gid] } # no need to calculate this in every loop
+
+      # TODO better, much better -- since the number of users/groups is finite and usually small, this is a low priority
+      users.each_key do |user|
+        # iterate over each user to get their gid
+        gid = users[user][:gid]
+
+        unless known_valid_gids.member?(gid)
+          @log.warn(sprintf('found user[%s] with unknown GID[%s], known GIDs[%s]', user, gid, known_valid_gids))
+          next
+        end
+
+        ## do this more efficiently
+        groups.each_key do |group|
+          # iterate over each group to find the matching gid
+          if gid.eql?(groups[group][:gid])
+            if groups[group][:users].eql?(['NONE'])
+              groups[group][:users] = []
+            end
+            groups[group][:users] << user unless groups[group][:users].member?(user)
+          end
+
+        end
+
+      end
+    end
+
     if cache
-      self.deltas[:groups] = res
+      @log.debug(sprintf('caching [groups] at [%s]', Time.now.asctime))
+      self.deltas[:groups] = groups
+      self.cache[:groups]  = Time.now.to_i
     end
 
-    res
+    groups
   end
 
   ##
@@ -158,7 +217,15 @@ class Rouster
   # raises InternalError if unsupported operating system
   def get_packages(cache=true, deep=true)
     if cache and ! self.deltas[:packages].nil?
-      return self.deltas[:packages]
+
+      if self.cache_timeout and self.cache_timeout.is_a?(Integer) and (Time.now.to_i - self.cache[:packages]) > self.cache_timeout
+        @log.debug(sprintf('invalidating [packages] cache, was [%s] old, allowed [%s]', (Time.now.to_i - self.cache[:packages]), self.cache_timeout))
+        self.deltas.delete(:packages)
+      else
+        @log.debug(sprintf('using cached [packages] from [%s]', self.cache[:packages]))
+        return self.deltas[:packages]
+      end
+
     end
 
     res = Hash.new()
@@ -169,53 +236,62 @@ class Rouster
 
       raw = self.run('pkgutil --pkgs')
       raw.split("\n").each do |line|
+        version = '?'
 
         if deep
           # can get install time, volume and location as well
           local_res = self.run(sprintf('pkgutil --pkg-info=%s', line))
-          local     = $1 if local_res.match(/version\:\s+(.*?)$/)
-        else
-          local = '?'
+          version = $1 if local_res.match(/version\:\s+(.*?)$/)
         end
 
-        res[line] = local
+        res[line] = version
       end
 
     elsif os.eql?(:solaris)
       raw = self.run('pkginfo')
       raw.split("\n").each do |line|
         next if line.match(/(.*?)\s+(.*?)\s(.*)$/).empty?
+        name    = $2
+        version = '?'
 
         if deep
-          local_res = self.run(sprintf('pkginfo -l %s', $2))
-          local     = $1 if local_res.match(/VERSION\:\s+(.*?)$/i)
-        else
-          local = '?'
+          local_res = self.run(sprintf('pkginfo -l %s', name))
+          version   = $1 if local_res.match(/VERSION\:\s+(.*?)$/i)
         end
 
-        res[$2] = local
+        res[name] = version
       end
 
-    elsif os.eql?(:ubuntu)
+    elsif os.eql?(:ubuntu) or os.eql?(:debian)
       raw = self.run('dpkg --get-selections')
       raw.split("\n").each do |line|
         next if line.match(/^(.*?)\s/).nil?
+        name    = $1
+        version = '?'
 
         if deep
-          local_res = self.run(sprintf('dpkg -s %s', $1))
-          local     = $1 if local_res.match(/Version\:\s(.*?)$/)
-        else
-          local = '?'
+          local_res = self.run(sprintf('dpkg -s %s', name))
+          version   = $1 if local_res.match(/Version\:\s(.*?)$/)
         end
 
-        res[$1] = local
+        res[name] = version
       end
 
     elsif os.eql?(:redhat)
       raw = self.run('rpm -qa')
       raw.split("\n").each do |line|
         next if line.match(/(.*?)-(\d*\..*)/).nil? # ht petersen.allen
-        res[$1] = $2
+        #next if line.match(/(.*)-(\d+\.\d+.*)/).nil? # another alternate, but still not perfect
+        name    = $1
+        version = '?' # we could use $2, but we don't trust it
+
+        if deep
+          local_res = self.run(sprintf('rpm -qi %s', line))
+          name    = $1 if local_res.match(/Name\s+:\s(\S*)/)
+          version = $1 if local_res.match(/Version\s+:\s(\S*)/)
+        end
+
+        res[name] = version
       end
 
     else
@@ -223,7 +299,9 @@ class Rouster
     end
 
     if cache
+      @log.debug(sprintf('caching [packages] at [%s]', Time.now.asctime))
       self.deltas[:packages] = res
+      self.cache[:packages]  = Time.now.to_i
     end
 
     res
@@ -245,7 +323,7 @@ class Rouster
   # * [cache] - boolean controlling whether data retrieved/parsed is cached, defaults to true
   #
   # supported OS
-  # * RedHat - runs `netstat -ln` -- TODO will this work on other operating systems too?
+  # * RedHat, Ubuntu - runs `netstat -ln`
   #
   # raises InternalError if unsupported operating system
   def get_ports(cache=false)
@@ -253,13 +331,19 @@ class Rouster
     # TODO improve ipv6 support
 
     if cache and ! self.deltas[:ports].nil?
-      return self.deltas[:ports]
+      if self.cache_timeout and self.cache_timeout.is_a?(Integer) and (Time.now.to_i - self.cache[:ports]) > self.cache_timeout
+        @log.debug(sprintf('invalidating [ports] cache, was [%s] old, allowed [%s]', (Time.now.to_i - self.cache[:ports]), self.cache_timeout))
+        self.deltas.delete(:ports)
+      else
+        @log.debug(sprintf('using cached [ports] from [%s]', self.cache[:ports]))
+        return self.deltas[:ports]
+      end
     end
 
     res = Hash.new()
     os  = self.os_type()
 
-    if os.eql?(:redhat)
+    if os.eql?(:redhat) or os.eql?(:ubuntu) or os.eql?(:debian)
 
       raw = self.run('netstat -ln')
 
@@ -278,13 +362,14 @@ class Rouster
         res[protocol][port][:address][address] = state
 
       end
-
     else
       raise InternalError.new(sprintf('unable to get port information from VM operating system[%s]', os))
     end
 
     if cache
+      @log.debug(sprintf('caching [ports] at [%s]', Time.now.asctime))
       self.deltas[:ports] = res
+      self.cache[:ports]  = Time.now.to_i
     end
 
     res
@@ -295,11 +380,12 @@ class Rouster
   #
   # runs an OS appropriate command to gather service information, returns hash:
   # {
-  #   serviceN => mode # running|stopped|unsure
+  #   serviceN => mode # exists|installed|operational|running|stopped|unsure
   # }
   #
   # parameters
-  # * [cache] - boolean controlling whether data retrieved/parsed is cached, defaults to true
+  # * [cache]    - boolean controlling whether data retrieved/parsed is cached, defaults to true
+  # * [humanize] - boolean controlling whether data retrieved is massaged into simplified names or returned mostly as retrieved
   #
   # supported OS
   # * OSX - runs `launchctl list`
@@ -307,15 +393,27 @@ class Rouster
   # * Solaris - runs `svcs`
   # * Ubuntu - runs `service --status-all`
   #
-  # raises InternalError if unsupported operating system
-  def get_services(cache=true)
+  # notes
+  # * raises InternalError if unsupported operating system
+  # * OSX, Solaris and Ubuntu/Debian will only return running|stopped|unsure, the exists|installed|operational modes are RHEL/CentOS only
+  def get_services(cache=true, humanize=true)
     if cache and ! self.deltas[:services].nil?
-      return self.deltas[:services]
+
+      if self.cache_timeout and self.cache_timeout.is_a?(Integer) and (Time.now.to_i - self.cache[:services]) > self.cache_timeout
+        @log.debug(sprintf('invalidating [services] cache, was [%s] old, allowed [%s]', (Time.now.to_i - self.cache[:services]), self.cache_timeout))
+        self.deltas.delete(:services)
+      else
+        @log.debug(sprintf('using cached [services] from [%s]', self.cache[:services]))
+        return self.deltas[:services]
+      end
+
     end
 
     res = Hash.new()
+    os  = self.os_type
 
-    os = self.os_type
+    allowed_modes = %w(exists installed operational running stopped unsure)
+    failover_mode = 'unsure'
 
     if os.eql?(:osx)
 
@@ -326,10 +424,12 @@ class Rouster
         service = $2
         mode    = $1
 
-        if mode.match(/^\d/)
-          mode = 'running'
-        else
-          mode = 'stopped'
+        if humanize # should we do this with a .freeze instead?
+          if mode.match(/^\d/)
+            mode = 'running'
+          else
+            mode = 'stopped'
+          end
         end
 
         res[service] = mode
@@ -337,26 +437,36 @@ class Rouster
 
     elsif os.eql?(:solaris)
 
-      raw = self.run('svcs')
+      raw = self.run('svcs -a')
       raw.split("\n").each do |line|
         next if line.match(/(.*?)\s+(?:.*?)\s+(.*?)$/).nil?
 
         service = $2
         mode    = $1
 
-        if mode.match(/online/)
-          mode = 'running'
-        elsif mode.match(/legacy_run/)
-          mode = 'running'
-        elsif mode.match(//)
-          mode = 'stopped'
+        if humanize
+          if mode.match(/^online/)
+            mode = 'running'
+          elsif mode.match(/^legacy_run/)
+            mode = 'running'
+          elsif mode.match(/^disabled/)
+            mode = 'stopped'
+          end
+
+          if service.match(/^svc:\/.*\/(.*?):.*/)
+            # turning 'svc:/network/cswpuppetd:default' into 'cswpuppetd'
+            service = $1
+          elsif service.match(/^lrc:\/.*?\/.*\/(.*)/)
+            # turning 'lrc:/etc/rcS_d/S50sk98Sol' into 'S50sk98Sol'
+            service = $1
+          end
         end
 
         res[service] = mode
 
       end
 
-    elsif os.eql?(:ubuntu)
+    elsif os.eql?(:ubuntu) or os.eql?(:debian)
 
       raw = self.run('service --status-all 2>&1')
       raw.split("\n").each do |line|
@@ -364,9 +474,11 @@ class Rouster
         mode    = $1
         service = $2
 
-        mode = 'stopped' if mode.match('-')
-        mode = 'running' if mode.match('\+')
-        mode = 'unsure'  if mode.match('\?')
+        if humanize
+          mode = 'stopped' if mode.match('-')
+          mode = 'running' if mode.match('\+')
+          mode = 'unsure'  if mode.match('\?')
+        end
 
         res[service] = mode
       end
@@ -375,9 +487,51 @@ class Rouster
 
       raw = self.run('/sbin/service --status-all')
       raw.split("\n").each do |line|
-        # TODO tighten this up
-        next if line.match(/^([^\s\:]*).*\s(\w*)(?:\.?){3}$/).nil?
-        res[$1] = $2
+
+        if humanize
+
+          if line.match(/^(\w+?)\sis\s(.*)$/)
+            # <service> is <state>
+            res[$1] = $2
+
+            if $2.match(/^not/)
+              # this catches 'Kdump is not operational'
+              res[$1] = 'stopped'
+            end
+
+          elsif line.match(/^(\w+?)\s\(pid.*?\)\sis\s(\w+)$/)
+            # <service> (pid <pid> [pid]) is <state>...
+            res[$1] = $2
+          elsif line.match(/^(\w+?)\sis\s(\w+)\.*$/) # not sure this is actually needed
+            @log.debug('triggered supposedly unnecessary regex')
+            # <service> is <state>. whatever
+            res[$1] = $2
+          elsif line.match(/^(\w+?)\:.*?(\w+)$/)
+            # <service>: whatever <state>
+            res[$1] = $2
+          elsif line.match(/^(\w+)\s(\w+).*$/)
+            # <process> <state> whatever
+            res[$1] = $2
+          else
+            # original regex implementation, if we didn't match anything else, failover to this
+            next if line.match(/^([^\s:]*).*\s(\w*)(?:\.?){3}$/).nil?
+            res[$1] = $2
+          end
+
+        else
+          next if line.match(/^([^\s:]*).*\s(\w*)(?:\.?){3}$/).nil?
+          res[$1] = $2
+        end
+
+      end
+
+      # issue #63 handling
+      if humanize
+        res.each_pair do |k,v|
+          next if allowed_modes.member?(v)
+          @log.debug(sprintf('replacing service[%s] status of [%s] with [%s] for uniformity', k, v, failover_mode))
+          res[k] = failover_mode
+        end
       end
 
     else
@@ -385,7 +539,9 @@ class Rouster
     end
 
     if cache
+      @log.debug(sprintf('caching [services] at [%s]', Time.now.asctime))
       self.deltas[:services] = res
+      self.cache[:services]  = Time.now.to_i
     end
 
     res
@@ -408,7 +564,15 @@ class Rouster
   # * [cache] - boolean controlling whether data retrieved/parsed is cached, defaults to true
   def get_users(cache=true)
     if cache and ! self.deltas[:users].nil?
-      return self.deltas[:users]
+
+      if self.cache_timeout and self.cache_timeout.is_a?(Integer) and (Time.now.to_i - self.cache[:users]) > self.cache_timeout
+        @log.debug(sprintf('invalidating [users] cache, was [%s] old, allowed [%s]', (Time.now.to_i - self.cache[:users]), self.cache_timeout))
+        self.deltas.delete(:users)
+      else
+        @log.debug(sprintf('using cached [users] from [%s]', self.cache[:users]))
+        return self.deltas[:users]
+      end
+
     end
 
     res = Hash.new()
@@ -430,10 +594,12 @@ class Rouster
     end
 
     if cache
+      @log.debug(sprintf('caching [users] at [%s]', Time.now.asctime))
       self.deltas[:users] = res
+      self.cache[:users]  = Time.now.to_i
     end
 
     res
   end
 
-end
+end