ohai 15.0.35 → 15.1.3

data/lib/ohai/plugins/network.rb

@@ -18,7 +18,7 @@
 
 Ohai.plugin(:NetworkAddresses) do
   require "ipaddress"
-  require "ohai/mixin/network_constants"
+  require_relative "../mixin/network_constants"
   include Ohai::Mixin::NetworkConstants
 
   provides "ipaddress", "ip6address", "macaddress"
@@ -135,9 +135,9 @@ Ohai.plugin(:NetworkAddresses) do
     results = {}
 
     network Mash.new unless network
-    network[:interfaces] = Mash.new unless network[:interfaces]
+    network[:interfaces] ||= Mash.new
     counters Mash.new unless counters
-    counters[:network] = Mash.new unless counters[:network]
+    counters[:network] ||= Mash.new
 
     # inet family is processed before inet6 to give ipv4 precedence
     Ohai::Mixin::NetworkConstants::FAMILIES.keys.sort.each do |family|

data/lib/ohai/plugins/openbsd/network.rb

@@ -22,9 +22,9 @@ Ohai.plugin(:Network) do
 
   collect_data(:openbsd) do
     network Mash.new unless network
-    network[:interfaces] = Mash.new unless network[:interfaces]
+    network[:interfaces] ||= Mash.new
     counters Mash.new unless counters
-    counters[:network] = Mash.new unless counters[:network]
+    counters[:network] ||= Mash.new
 
     so = shell_out("route -n get default")
     so.stdout.lines do |line|
@@ -52,11 +52,11 @@ Ohai.plugin(:Network) do
       end
       # call the family lladdr to match linux for consistency
       if line =~ /\s+lladdr (.+?)\s/
-        iface[cint][:addresses] = Mash.new unless iface[cint][:addresses]
+        iface[cint][:addresses] ||= Mash.new
         iface[cint][:addresses][$1] = { "family" => "lladdr" }
       end
       if line =~ /\s+inet ([\d.]+) netmask ([\da-fx]+)\s*\w*\s*([\d.]*)/
-        iface[cint][:addresses] = Mash.new unless iface[cint][:addresses]
+        iface[cint][:addresses] ||= Mash.new
         # convert the netmask to decimal for consistency
         netmask = "#{$2[2, 2].hex}.#{$2[4, 2].hex}.#{$2[6, 2].hex}.#{$2[8, 2].hex}"
         if $3.empty?
@@ -67,7 +67,7 @@ Ohai.plugin(:Network) do
         end
       end
       if line =~ /\s+inet6 ([a-f0-9\:]+)%?(\w*)\s+prefixlen\s+(\d+)\s*\w*\s*([\da-fx]*)/
-        iface[cint][:addresses] = Mash.new unless iface[cint][:addresses]
+        iface[cint][:addresses] ||= Mash.new
         if $4.empty?
           iface[cint][:addresses][$1] = { "family" => "inet6", "prefixlen" => $3 }
         else
@@ -89,7 +89,7 @@ Ohai.plugin(:Network) do
     so.stdout.lines do |line|
       if line =~ /\((\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\) at ([a-fA-F0-9\:]+) on ([0-9a-zA-Z\.\:\-]+)/
         next unless iface[$3] # this should never happen
-        iface[$3][:arp] = Mash.new unless iface[$3][:arp]
+        iface[$3][:arp] ||= Mash.new
         iface[$3][:arp][$1] = $2.downcase
       end
     end
@@ -107,9 +107,9 @@ Ohai.plugin(:Network) do
       # em0     1500  <Link>      00:11:25:2d:90:be  3719557     0  3369969     0     0    0
       # $1                        $2                      $3    $4    $5       $6    $7   $8
       if line =~ /^([\w\.\*]+)\s+\d+\s+<Link>\s+([\w:]*)\s*(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)/
-        net_counters[$1] = Mash.new unless net_counters[$1]
-        net_counters[$1]["rx"] = Mash.new unless net_counters[$1]["rx"]
-        net_counters[$1]["tx"] = Mash.new unless net_counters[$1]["tx"]
+        net_counters[$1] ||= Mash.new
+        net_counters[$1]["rx"] ||= Mash.new
+        net_counters[$1]["tx"] ||= Mash.new
         net_counters[$1]["rx"]["packets"] = $3
         net_counters[$1]["rx"]["errors"] = $4
         net_counters[$1]["tx"]["packets"] = $5

data/lib/ohai/plugins/openstack.rb

@@ -17,8 +17,8 @@
 # limitations under the License.
 
 Ohai.plugin(:Openstack) do
-  require "ohai/mixin/ec2_metadata"
-  require "ohai/mixin/http_helper"
+  require_relative "../mixin/ec2_metadata"
+  require_relative "../mixin/http_helper"
   include Ohai::Mixin::Ec2Metadata
   include Ohai::Mixin::HttpHelper
 

data/lib/ohai/plugins/os.rb

@@ -20,7 +20,7 @@
 #
 
 Ohai.plugin(:OS) do
-  require "ohai/mixin/os"
+  require_relative "../mixin/os"
   provides "os", "os_version"
   depends "kernel"
 

data/lib/ohai/plugins/packages.rb

@@ -22,13 +22,11 @@ Ohai.plugin(:Packages) do
   provides "packages"
   depends "platform_family"
 
-  unless defined?(WINDOWS_ATTRIBUTE_ALIASES)
-    WINDOWS_ATTRIBUTE_ALIASES = {
-      "DisplayVersion" => "version",
-      "Publisher" => "publisher",
-      "InstallDate" => "installdate",
-    }.freeze
-  end
+  WINDOWS_ATTRIBUTE_ALIASES ||= {
+    "DisplayVersion" => "version",
+    "Publisher" => "publisher",
+    "InstallDate" => "installdate",
+  }.freeze
 
   collect_data(:linux) do
     packages Mash.new
@@ -104,7 +102,7 @@ Ohai.plugin(:Packages) do
   end
 
   collect_data(:windows) do
-    require "win32/registry"
+    require "win32/registry" unless defined?(Win32::Registry)
     packages Mash.new
     collect_programs_from_registry_key('Software\Microsoft\Windows\CurrentVersion\Uninstall')
     # on 64 bit systems, 32 bit programs are stored here

data/lib/ohai/plugins/passwd.rb

@@ -1,6 +1,6 @@
 
 Ohai.plugin(:Passwd) do
-  require "etc"
+  require "etc" unless defined?(Etc)
   provides "etc", "current_user"
   optional true
 

data/lib/ohai/plugins/scaleway.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 
 Ohai.plugin(:Scaleway) do
-  require "ohai/mixin/scaleway_metadata"
-  require "ohai/mixin/http_helper"
+  require_relative "../mixin/scaleway_metadata"
+  require_relative "../mixin/http_helper"
 
   include Ohai::Mixin::ScalewayMetadata
   include Ohai::Mixin::HttpHelper

data/lib/ohai/plugins/scsi.rb

@@ -21,7 +21,7 @@ Ohai.plugin(:Lsscsi) do
   provides "scsi"
   optional true
 
-  require "mixlib/shellout"
+  require "mixlib/shellout" unless defined?(Mixlib::ShellOut::DEFAULT_READ_TIMEOUT)
 
   collect_data(:linux) do
     devices = Mash.new

data/lib/ohai/plugins/softlayer.rb

@@ -19,7 +19,7 @@
 # limitations under the License.
 
 Ohai.plugin(:Softlayer) do
-  require "ohai/mixin/softlayer_metadata"
+  require_relative "../mixin/softlayer_metadata"
   include ::Ohai::Mixin::SoftlayerMetadata
 
   provides "softlayer"

data/lib/ohai/plugins/solaris2/dmi.rb

@@ -20,7 +20,7 @@ Ohai.plugin(:DMI) do
   provides "dmi"
 
   collect_data(:solaris2) do
-    require "ohai/common/dmi"
+    require_relative "../../common/dmi"
 
     # if we already have a "dmi" with keys (presumably from dmidecode), don't try smbios
     # note that a single key just means dmidecode exited with its version
@@ -142,7 +142,7 @@ Ohai.plugin(:DMI) do
           next
         end
 
-        dmi[dmi_record[:type]] = Mash.new unless dmi.key?(dmi_record[:type])
+        dmi[dmi_record[:type]] ||= Mash.new
         dmi[dmi_record[:type]][:all_records] = [] unless dmi[dmi_record[:type]].key?(:all_records)
         dmi_record[:position] = dmi[dmi_record[:type]][:all_records].length
         dmi[dmi_record[:type]][:all_records].push(Mash.new)

data/lib/ohai/plugins/solaris2/network.rb

@@ -95,18 +95,18 @@ Ohai.plugin(:Network) do
 
     iface = Mash.new
     network Mash.new unless network
-    network[:interfaces] = Mash.new unless network[:interfaces]
+    network[:interfaces] ||= Mash.new
     counters Mash.new unless counters
-    counters[:network] = Mash.new unless counters[:network]
+    counters[:network] ||= Mash.new
 
     so = shell_out("ifconfig -a")
     cint = nil
 
     so.stdout.lines do |line|
-      # regex: http://rubular.com/r/Iag7JLVTVe
-      if line =~ /^([0-9a-zA-Z\.\:\-]+): \S+ mtu (\d+) index (\d+)/
+      # regex: https://rubular.com/r/ZiIHbsnfiWPW1p
+      if line =~ /^([0-9a-zA-Z\.\:\-]+): \S+ mtu (\d+)(?: index (\d+))?/
         cint = $1
-        iface[cint] = Mash.new unless iface[cint]
+        iface[cint] ||= Mash.new
         iface[cint][:mtu] = $2
         iface[cint][:index] = $3
         if line =~ / flags\=\d+\<((ADDRCONF|ANYCAST|BROADCAST|CoS|DEPRECATED|DHCP|DUPLICATE|FAILED|FIXEDMTU|INACTIVE|L3PROTECT|LOOPBACK|MIP|MULTI_BCAST|MULTICAST|NOARP|NOFAILOVER|NOLOCAL|NONUD|NORTEXCH|NOXMIT|OFFLINE|PHYSRUNNING|POINTOPOINT|PREFERRED|PRIVATE|ROUTER|RUNNING|STANDBY|TEMPORARY|UNNUMBERED|UP|VIRTUAL|XRESOLV|IPv4|IPv6|,)+)\>\s/
@@ -122,15 +122,15 @@ Ohai.plugin(:Network) do
         end
       end
       if line =~ /\s+inet (\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) netmask (([0-9a-f]){1,8})\s*$/
-        iface[cint][:addresses] = Mash.new unless iface[cint][:addresses]
+        iface[cint][:addresses] ||= Mash.new
         iface[cint][:addresses][$1] = { "family" => "inet", "netmask" => $2.scanf("%2x" * 4) * "." }
       end
       if line =~ /\s+inet (\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}) netmask (([0-9a-f]){1,8}) broadcast (\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})/
-        iface[cint][:addresses] = Mash.new unless iface[cint][:addresses]
+        iface[cint][:addresses] ||= Mash.new
         iface[cint][:addresses][$1] = { "family" => "inet", "netmask" => $2.scanf("%2x" * 4) * ".", "broadcast" => $4 }
       end
       if line =~ /\s+inet6 ([a-f0-9\:]+)(\s*|(\%[a-z0-9]+)\s*)\/(\d+)\s*$/
-        iface[cint][:addresses] = Mash.new unless iface[cint][:addresses]
+        iface[cint][:addresses] ||= Mash.new
         iface[cint][:addresses][$1] = { "family" => "inet6", "prefixlen" => $4 }
       end
     end
@@ -141,7 +141,7 @@ Ohai.plugin(:Network) do
     so.stdout.lines do |line|
       if line =~ /([0-9a-zA-Z]+)\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\s+(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})\s+(\w+)?\s+([a-zA-Z0-9\.\:\-]+)/
         next unless iface[arpname_to_ifname(iface, $1)] # this should never happen, except on solaris because sun hates you.
-        iface[arpname_to_ifname(iface, $1)][:arp] = Mash.new unless iface[arpname_to_ifname(iface, $1)][:arp]
+        iface[arpname_to_ifname(iface, $1)][:arp] ||= Mash.new
         iface[arpname_to_ifname(iface, $1)][:arp][$2] = $5
       end
     end

data/lib/ohai/plugins/solaris2/virtualization.rb

@@ -19,7 +19,7 @@
 #
 
 Ohai.plugin(:Virtualization) do
-  require "ohai/mixin/dmi_decode"
+  require_relative "../../mixin/dmi_decode"
   include Ohai::Mixin::DmiDecode
   provides "virtualization"
   depends "dmi"

data/lib/ohai/plugins/uptime.rb

@@ -25,7 +25,7 @@
 #
 
 Ohai.plugin(:Uptime) do
-  require "ohai/mixin/seconds_to_human"
+  require_relative "../mixin/seconds_to_human"
   provides "uptime", "uptime_seconds"
   provides "idletime", "idletime_seconds" # linux only
 

data/lib/ohai/plugins/virtualbox.rb

@@ -1,6 +1,8 @@
 #
-# Author:: "Tim Smith" <tsmith@chef.io>
-# Copyright:: Copyright (c) 2015-2016 Chef Software, Inc.
+# Author:: Tim Smith <tsmith@chef.io>
+# Author:: Joshua Colson <joshua.colson@gmail.com>
+# Copyright:: 2015-2019 Chef Software, Inc.
+# Copyright:: 2019 Joshua Colson
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -17,33 +19,176 @@
 #
 
 Ohai.plugin(:Virtualbox) do
+  depends "virtualization"
   provides "virtualbox"
 
-  collect_data do
-
-    so = shell_out("VBoxControl guestproperty enumerate")
+  # query virtualbox for each configured vm, as well as
+  # each guest's individual configuration settings
+  def vboxmanage_list_vms
+    vms = Mash.new
+    so_cmd = "VBoxManage list --sorted vms"
+    logger.trace(so_cmd)
+    so = shell_out(so_cmd)
 
     if so.exitstatus == 0
-      virtualbox Mash.new
-      virtualbox[:host] = Mash.new
-      virtualbox[:guest] = Mash.new
+      # parse the output
       so.stdout.lines.each do |line|
         case line
-        when /LanguageID, value: (\S*),/
-          virtualbox[:host][:language] = Regexp.last_match(1)
-        when /VBoxVer, value: (\S*),/
-          virtualbox[:host][:version] = Regexp.last_match(1)
-        when /VBoxRev, value: (\S*),/
-          virtualbox[:host][:revision] = Regexp.last_match(1)
-        when /GuestAdd\/VersionExt, value: (\S*),/
-          virtualbox[:guest][:guest_additions_version] = Regexp.last_match(1)
-        when /GuestAdd\/Revision, value: (\S*),/
-          virtualbox[:guest][:guest_additions_revision] = Regexp.last_match(1)
+        when /^"(\S*)" \{(\S*)\}$/
+          name = Regexp.last_match(1)
+          uuid = Regexp.last_match(2)
+          vms[name] = vboxmanage_vminfo(uuid)
         end
       end
     end
+    vms
   rescue Ohai::Exceptions::Exec
-    logger.trace('Plugin Virtualbox: Could not execute "VBoxControl guestproperty enumerate". Skipping data')
+    logger.trace("Plugin VboxHost: Could not run 'VBoxManage list --sorted vms'. Skipping data")
+  end
+
+  # query the vminfo for particular guest instance, normalizing
+  # the fields so that they're not enclosed in double-quotes (")
+  def vboxmanage_vminfo(machine_id)
+    vm = Mash.new
+
+    so_cmd = "VBoxManage showvminfo #{machine_id} --machinereadable"
+    logger.trace(so_cmd)
+    so = shell_out(so_cmd)
+
+    if so.exitstatus == 0
+      so.stdout.lines.each do |line|
+        line.chomp!
+        left, right = line.split("=")
+
+        # remove enclosing quotes, if needed
+        key = left.delete_prefix('"').delete_suffix('"')
+
+        # skip the name attribute since that is the parent key
+        next if key == "name"
+
+        vm[key.downcase] = right.delete_prefix('"').delete_suffix('"')
+      end
+    end
+    vm
+  rescue Ohai::Exceptions::Exec
+    logger.trace("Plugin VboxHost: Could not run '#{so_cmd}'. Skipping data")
+  end
+
+  # query virtualbox for a list of #{query_type} items
+  # these queries return a result set that is delimited by
+  # multiple successive newlines, with each block containing
+  # key/value pairs delimited by a colon (:) and column aligned
+  #
+  # the keys of each k/v pair are normalized to lowercase
+  def vboxmanage_list_blocks(query_type, name_key)
+    # ignore unrecognized query type
+    supported_queries = %w{
+      bridgedifs dhcpservers dvds hdds hostdvds
+      hostfloppies hostonlyifs natnets
+    }
+    return nil unless supported_queries.include? query_type
+    results = Mash.new
+
+    so_cmd = "VBoxManage list --sorted #{query_type}"
+    logger.trace(so_cmd)
+    so = shell_out(so_cmd)
+      # raise an exception if the command fails
+      # so.error!
+
+    if so.exitstatus == 0
+      # break the result into paragraph blocks, on successive newlines
+      so.stdout.each_line("") do |blk|
+        # remove the multiple newlines of each record
+        blk.chomp!.chomp!
+        # initialize a blank record hash
+        record = Mash.new
+        # parse the record block into key/value pairs
+        blk.each_line() do |line|
+          next unless line.include? ":"
+          # split the line into key/value pair
+          key, right = line.split(":", 2)
+
+          # strip the leading/trailing whitespace if the value is not nil
+          value = right.nil? ? "" : right.strip
+          record[key.downcase] = value
+        end
 
+        # insert the record into the list of results
+        if record.key? name_key.downcase
+          name = record.delete(name_key.downcase)
+          results[name] = record
+        end
+      end
+    end
+    results
+  rescue Ohai::Exceptions::Exec
+    logger.trace("Plugin VboxHost: Could not run '#{so_cmd}'. Skipping data")
+  end
+
+  collect_data(:default) do
+    case virtualization.dig("systems", "vbox")
+    when "guest"
+      logger.trace("Plugin Virtualbox: Node detected as vbox guest. Collecting guest data.")
+      begin
+        so = shell_out("VBoxControl guestproperty enumerate")
+
+        if so.exitstatus == 0
+          virtualbox Mash.new
+          virtualbox[:host] = Mash.new
+          virtualbox[:guest] = Mash.new
+          so.stdout.lines.each do |line|
+            case line
+            when /LanguageID, value: (\S*),/
+              virtualbox[:host][:language] = Regexp.last_match(1)
+            when /VBoxVer, value: (\S*),/
+              virtualbox[:host][:version] = Regexp.last_match(1)
+            when /VBoxRev, value: (\S*),/
+              virtualbox[:host][:revision] = Regexp.last_match(1)
+            when /GuestAdd\/VersionExt, value: (\S*),/
+              virtualbox[:guest][:guest_additions_version] = Regexp.last_match(1)
+            when /GuestAdd\/Revision, value: (\S*),/
+              virtualbox[:guest][:guest_additions_revision] = Regexp.last_match(1)
+            end
+          end
+        end
+      rescue Ohai::Exceptions::Exec
+        logger.trace('Plugin Virtualbox: Could not execute "VBoxControl guestproperty enumerate". Skipping data collection.')
+      end
+    when "host"
+      logger.trace("Plugin Virtualbox: Node detected as vbox host. Collecting host data.")
+      virtualbox Mash.new
+      begin
+        # get a list of virtualbox guest vms
+        virtualbox["guests"] = vboxmanage_list_vms
+
+        # get a list of virtualbox virtual hard disk drives
+        virtualbox["hdds"] = vboxmanage_list_blocks("hdds", "Location")
+
+        # get a list of virtualbox virtual dvd drives
+        virtualbox["dvds"] = vboxmanage_list_blocks("dvds", "Location")
+
+        # get a list of virtualbox host dvd drives
+        virtualbox["hostdvds"] = vboxmanage_list_blocks("hostdvds", "Name")
+
+        # get a list of virtualbox host floppy drives
+        virtualbox["hostfloppies"] = vboxmanage_list_blocks("hostfloppies", "Name")
+
+        # get a list of virtualbox hostonly network interfaces
+        virtualbox["hostonlyifs"] = vboxmanage_list_blocks("hostonlyifs", "Name")
+
+        # get a list of virtualbox bridged network interfaces
+        virtualbox["bridgedifs"] = vboxmanage_list_blocks("bridgedifs", "Name")
+
+        # get a list of virtualbox dhcp servers
+        virtualbox["dhcpservers"] = vboxmanage_list_blocks("dhcpservers", "NetworkName")
+
+        # get a list of virtualbox nat networks
+        virtualbox["natnets"] = vboxmanage_list_blocks("natnets", "NetworkName")
+      rescue Ohai::Exceptions::Exec
+        logger.trace("Plugin VboxHost: Could not collect data for VirtualBox host. Skipping data")
+      end
+    else
+      logger.trace("Plugin Virtualbox: Not on a Virtualbox host or guest. Skipping plugin.")
+    end
   end
 end