ohai 13.12.6 → 14.0.28

data/lib/ohai/plugins/libvirt.rb

@@ -0,0 +1,113 @@
+#
+# Author:: Benjamin Black (<bb@chef.io>)
+# Copyright:: Copyright (c) 2009-2016 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+# Note: This plugin requires libvirt-bin/libvirt-dev as well as the ruby-libvirt
+#       gem to be installed before it will properly parse data
+
+Ohai.plugin(:Libvirt) do
+  %w{ uri capabilities nodeinfo domains networks storage }.each do |info|
+    provides "libvirt/#{info}"
+    depends "virtualization"
+  end
+
+  def emu
+    @emu ||= (virtualization[:system].eql?("kvm") ? "qemu" : virtualization[:system])
+  end
+
+  def load_libvirt
+    require "libvirt" # this is the ruby-libvirt gem not the libvirt gem
+    logger.trace("Plugin Libvirt: Successfully loaded ruby-libvirt gem")
+  rescue LoadError
+    logger.trace("Plugin Libvirt: Can't load gem ruby-libvirt.")
+  end
+
+  def virtconn
+    @virt_connect ||= Libvirt.open_read_only("#{emu}:///system")
+  end
+
+  def get_node_data
+    node_data = Mash.new
+    ni = virtconn.node_get_info
+    %w{cores cpus memory mhz model nodes sockets threads}.each { |a| node_data[a] = ni.send(a) }
+    node_data
+  end
+
+  def get_domain_data
+    domain_data = Mash.new
+    virtconn.list_domains.each do |d|
+      dv = virtconn.lookup_domain_by_id d
+      domain_data[dv.name] = Mash.new
+      domain_data[dv.name][:id] = d
+      %w{os_type uuid}.each { |a| domain_data[dv.name][a] = dv.send(a) }
+      %w{cpu_time max_mem memory nr_virt_cpu state}.each { |a| domain_data[dv.name][a] = dv.info.send(a) }
+    end
+    domain_data
+  end
+
+  def get_network_data
+    network_data = Mash.new
+    virtconn.list_networks.each do |n|
+      nv = virtconn.lookup_network_by_name n
+      network_data[n] = Mash.new
+      %w{bridge_name uuid}.each { |a| network_data[n][a] = nv.send(a) }
+    end
+    network_data
+  end
+
+  def get_storage_data
+    storage_data = Mash.new
+    virtconn.list_storage_pools.each do |pool|
+      sp = virtconn.lookup_storage_pool_by_name pool
+      storage_data[pool] = Mash.new
+      %w{autostart uuid}.each { |a| storage_data[pool][a] = sp.send(a) }
+      %w{allocation available capacity state}.each { |a| storage_data[pool][a] = sp.info.send(a) }
+
+      storage_data[pool][:volumes] = Mash.new
+      sp.list_volumes.each do |v|
+        storage_data[pool][:volumes][v] = Mash.new
+        sv = sp.lookup_volume_by_name v
+        %w{key name path}.each { |a| storage_data[pool][:volumes][v][a] = sv.send(a) }
+        %w{allocation capacity type}.each { |a| storage_data[pool][:volumes][v][a] = sv.info.send(a) }
+      end
+    end
+    storage_data
+  end
+
+  collect_data do
+    if virtualization[:role].eql?("host")
+      load_libvirt
+      begin
+        libvirt_data = Mash.new
+        libvirt_data[:uri] = virtconn.uri
+        libvirt_data[:libvirt_version] = Libvirt.version(emu)[0].to_s
+        libvirt_data[:nodeinfo] = get_node_data
+        libvirt_data[:domains] = get_domain_data
+        libvirt_data[:networks] = get_network_data
+        libvirt_data[:storage] = get_storage_data
+        virtconn.close
+        libvirt libvirt_data
+      rescue NameError
+        logger.trace("Plugin Libvirt: Cannot load ruby-libvirt gem. Skipping...")
+      rescue Libvirt::ConnectionError
+        logger.trace("Plugin Libvirt: Failed to connect to #{emu}:///system. Skipping...")
+      end
+    else
+      logger.trace("Plugin Libvirt: Node is not a virtualization host. Skipping...")
+    end
+  end
+end

data/lib/ohai/plugins/linode.rb

@@ -24,7 +24,7 @@ Ohai.plugin(:Linode) do
   #
   # Returns true or false
   def has_linode_kernel?
-    if kernel_data = kernel
+    if ( kernel_data = kernel )
       kernel_data[:release].split("-").last =~ /linode/
     end
   end
@@ -43,7 +43,7 @@ Ohai.plugin(:Linode) do
   #
   # Alters linode mash with new interface based on name parameter
   def get_ip_address(name, eth)
-    if eth_iface = network[:interfaces][eth]
+    if ( eth_iface = network[:interfaces][eth] )
       eth_iface[:addresses].each do |key, info|
         linode[name] = key if info["family"] == "inet"
       end
@@ -53,13 +53,13 @@ Ohai.plugin(:Linode) do
   collect_data do
     # Setup linode mash if it is a linode system
     if looks_like_linode?
-      Ohai::Log.debug("Plugin Linode: looks_like_linode? == true")
+      logger.trace("Plugin Linode: looks_like_linode? == true")
       linode Mash.new
       get_ip_address(:public_ip, :eth0)
       get_ip_address(:private_ip, "eth0:1")
       hint?("linode").each { |k, v| linode[k] = v } if hint?("linode").kind_of?(Hash)
     else
-      Ohai::Log.debug("Plugin Linode: looks_like_linode? == false")
+      logger.trace("Plugin Linode: looks_like_linode? == false")
     end
   end
 end

data/lib/ohai/plugins/linux/block_device.rb

@@ -20,23 +20,23 @@ Ohai.plugin(:BlockDevice) do
   provides "block_device"
 
   collect_data(:linux) do
-    if File.exists?("/sys/block")
+    if File.exist?("/sys/block")
       block = Mash.new
       Dir["/sys/block/*"].each do |block_device_dir|
         dir = File.basename(block_device_dir)
         block[dir] = Mash.new
         %w{size removable}.each do |check|
-          if File.exists?("/sys/block/#{dir}/#{check}")
+          if File.exist?("/sys/block/#{dir}/#{check}")
             File.open("/sys/block/#{dir}/#{check}") { |f| block[dir][check] = f.read_nonblock(1024).strip }
           end
         end
         %w{model rev state timeout vendor queue_depth}.each do |check|
-          if File.exists?("/sys/block/#{dir}/device/#{check}")
+          if File.exist?("/sys/block/#{dir}/device/#{check}")
             File.open("/sys/block/#{dir}/device/#{check}") { |f| block[dir][check] = f.read_nonblock(1024).strip }
           end
         end
         %w{rotational physical_block_size logical_block_size}.each do |check|
-          if File.exists?("/sys/block/#{dir}/queue/#{check}")
+          if File.exist?("/sys/block/#{dir}/queue/#{check}")
             File.open("/sys/block/#{dir}/queue/#{check}") { |f| block[dir][check] = f.read_nonblock(1024).strip }
           end
         end

data/lib/ohai/plugins/linux/cpu.rb

@@ -92,7 +92,7 @@ Ohai.plugin(:CPU) do
       cpu[:cores] = real_cpu.keys.length * cpu["0"]["cores"].to_i
     else
       begin
-        Ohai::Log.debug("Plugin CPU: Falling back to aggregate data from lscpu as real cpu & core data is missing in /proc/cpuinfo")
+        logger.trace("Plugin CPU: Falling back to aggregate data from lscpu as real cpu & core data is missing in /proc/cpuinfo")
         so = shell_out("lscpu")
         if so.exitstatus == 0
           lscpu_data = Mash.new
@@ -110,10 +110,10 @@ Ohai.plugin(:CPU) do
           cpu[:real] = lscpu_data[:sockets]
           cpu[:cores] = lscpu_data[:sockets] * lscpu_data[:cores]
         else
-          Ohai::Log.debug("Plugin CPU: Error executing lscpu. CPU data may not be available.")
+          logger.trace("Plugin CPU: Error executing lscpu. CPU data may not be available.")
         end
       rescue Ohai::Exceptions::Exec # util-linux isn't installed most likely
-        Ohai::Log.debug("Plugin CPU: Error executing lscpu. util-linux may not be installed.")
+        logger.trace("Plugin CPU: Error executing lscpu. util-linux may not be installed.")
       end
     end
   end

data/lib/ohai/plugins/linux/filesystem.rb

@@ -20,7 +20,6 @@
 
 Ohai.plugin(:Filesystem) do
   provides "filesystem"
-  provides "filesystem2"
 
   def find_device(name)
     %w{/dev /dev/mapper}.each do |dir|
@@ -134,7 +133,7 @@ Ohai.plugin(:Filesystem) do
       unless Ohai.config[:plugin][:filesystem][:allow_partial_data]
         raise e
       end
-      Ohai::Log.warn("Plugin Filesystem: df binary is not available. Some data will not be available.")
+      logger.warn("Plugin Filesystem: df binary is not available. Some data will not be available.")
     end
 
     # Grab mount information from /bin/mount
@@ -154,7 +153,7 @@ Ohai.plugin(:Filesystem) do
       unless Ohai.config[:plugin][:filesystem][:allow_partial_data]
         raise e
       end
-      Ohai::Log.warn("Plugin Filesystem: mount binary is not available. Some data will not be available.")
+      logger.warn("Plugin Filesystem: mount binary is not available. Some data will not be available.")
     end
 
     # We used to try to decide if we wanted to run lsblk or blkid
@@ -197,10 +196,10 @@ Ohai.plugin(:Filesystem) do
           keys_to_update << key
         end
 
-        keys_to_update.each do |key|
+        keys_to_update.each do |k|
           [:fs_type, :uuid, :label].each do |subkey|
             if parsed[subkey] && !parsed[subkey].empty?
-              fs[key][subkey] = parsed[subkey]
+              fs[k][subkey] = parsed[subkey]
             end
           end
         end
@@ -250,6 +249,5 @@ Ohai.plugin(:Filesystem) do
 
     # Set the filesystem data
     filesystem fs_data
-    filesystem2 fs_data
   end
 end

data/lib/ohai/plugins/linux/lsb.rb

@@ -22,7 +22,7 @@ Ohai.plugin(:LSB) do
   collect_data(:linux) do
     lsb Mash.new
 
-    if File.exists?("/usr/bin/lsb_release")
+    if File.exist?("/usr/bin/lsb_release")
       # From package redhat-lsb on Fedora/Redhat, lsb-release on Debian/Ubuntu
       so = shell_out("lsb_release -a")
       so.stdout.lines do |line|
@@ -39,7 +39,7 @@ Ohai.plugin(:LSB) do
           lsb[:id] = line
         end
       end
-    elsif File.exists?("/etc/lsb-release")
+    elsif File.exist?("/etc/lsb-release")
       # Old, non-standard Debian support
       File.open("/etc/lsb-release").each do |line|
         case line
@@ -54,7 +54,7 @@ Ohai.plugin(:LSB) do
         end
       end
     else
-      Ohai::Log.debug("Plugin LSB: Skipping LSB, cannot find /etc/lsb-release or /usr/bin/lsb_release")
+      logger.trace("Plugin LSB: Skipping LSB, cannot find /etc/lsb-release or /usr/bin/lsb_release")
     end
   end
 end

data/lib/ohai/plugins/linux/lspci.rb

@@ -20,6 +20,7 @@
 Ohai.plugin(:Lspci) do
   depends "platform"
   provides "pci"
+  optional true
 
   collect_data(:linux) do
     devices = Mash.new
@@ -50,7 +51,7 @@ Ohai.plugin(:Lspci) do
       next if dev.nil?
       case dev[0]
       when "Device" # There are two different Device tags
-        if tmp = dev[1].match(/(#{hh}:#{hh}.#{h})/)
+        if ( tmp = dev[1].match(/(#{hh}:#{hh}.#{h})/) )
           # We have a device id
           d_id = tmp[0] # From now on we will need this id
           devices[d_id] = Mash.new

data/lib/ohai/plugins/linux/machineid.rb

@@ -22,10 +22,10 @@ Ohai.plugin(:Machineid) do
   collect_data(:linux) do
     mid = nil
 
-    if File.exists?("/etc/machine-id")
-      mid = File.read("/etc/machine-id").chomp
-    elsif File.exists?("/var/lib/dbus/machine-id")
-      mid = File.read("/var/lib/dbus/machine-id").chomp
+    if ::File.exist?("/etc/machine-id")
+      mid = ::File.read("/etc/machine-id").chomp
+    elsif ::File.exist?("/var/lib/dbus/machine-id")
+      mid = ::File.read("/var/lib/dbus/machine-id").chomp
     end
 
     if mid

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

@@ -55,7 +55,7 @@ Ohai.plugin(:Network) do
       if line =~ /^([a-f0-9\:\.]+)\s+dev\s+([^\s]+)\s+lladdr\s+([a-fA-F0-9\:]+)/
         interface = iface[$2]
         unless interface
-          Ohai::Log.warn("neighbor list has entries for unknown interface #{interface}")
+          logger.warn("neighbor list has entries for unknown interface #{interface}")
           next
         end
         interface[neigh_attr] = Mash.new unless interface[neigh_attr]
@@ -76,7 +76,7 @@ Ohai.plugin(:Network) do
     so = shell_out("ip -o -f #{family[:name]} route show table #{default_route_table}")
     so.stdout.lines do |line|
       line.strip!
-      Ohai::Log.debug("Plugin Network: Parsing #{line}")
+      logger.trace("Plugin Network: Parsing #{line}")
       if line =~ /\\/
         parts = line.split('\\')
         route_dest = parts.shift.strip
@@ -91,13 +91,13 @@ Ohai.plugin(:Network) do
         if route_ending =~ /\bdev\s+([^\s]+)\b/
           route_int = $1
         else
-          Ohai::Log.debug("Plugin Network: Skipping route entry without a device: '#{line}'")
+          logger.trace("Plugin Network: Skipping route entry without a device: '#{line}'")
           next
         end
         route_int = "venet0:0" if is_openvz? && !is_openvz_host? && route_int == "venet0" && iface["venet0:0"]
 
         unless iface[route_int]
-          Ohai::Log.debug("Plugin Network: Skipping previously unseen interface from 'ip route show': #{route_int}")
+          logger.trace("Plugin Network: Skipping previously unseen interface from 'ip route show': #{route_int}")
           next
         end
 
@@ -115,7 +115,7 @@ Ohai.plugin(:Network) do
           addr = iface[route_int][:addresses]
           unless addr.nil? || addr.has_key?(route_entry[:src]) ||
               addr.values.all? { |a| a["family"] != family[:name] }
-            Ohai::Log.debug("Plugin Network: Skipping route entry whose src does not match the interface IP")
+            logger.trace("Plugin Network: Skipping route entry whose src does not match the interface IP")
             next
           end
         end
@@ -155,7 +155,7 @@ Ohai.plugin(:Network) do
       so = shell_out("#{ethtool_binary_path} #{tmp_int}")
       so.stdout.lines do |line|
         line.chomp!
-        Ohai::Log.debug("Plugin Network: Parsing ethtool output: #{line}")
+        logger.trace("Plugin Network: Parsing ethtool output: #{line}")
         line.lstrip!
         k, v = line.split(": ")
         next unless keys.include? k
@@ -176,7 +176,7 @@ Ohai.plugin(:Network) do
     iface.each_key do |tmp_int|
       next unless iface[tmp_int][:encapsulation] == "Ethernet"
       so = shell_out("#{ethtool_binary_path} -g #{tmp_int}")
-      Ohai::Log.debug("Plugin Network: Parsing ethtool output: #{so.stdout}")
+      logger.trace("Plugin Network: Parsing ethtool output: #{so.stdout}")
       type = nil
       iface[tmp_int]["ring_params"] = {}
       so.stdout.lines.each do |line|
@@ -486,7 +486,7 @@ Ohai.plugin(:Network) do
     else
       default_route_table = configuration(:default_route_table)
     end
-    Ohai::Log.debug("Plugin Network: default route table is '#{default_route_table}'")
+    logger.trace("Plugin Network: default route table is '#{default_route_table}'")
 
     # Match the lead line for an interface from iproute2
     # 3: eth0.11@eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP
@@ -533,14 +533,14 @@ Ohai.plugin(:Network) do
                            else
                              "default_#{family[:name]}_interface"
                            end
-          Ohai::Log.debug("Plugin Network: Unable to determine '#{attribute_name}' as no default routes were found for that interface family")
+          logger.trace("Plugin Network: Unable to determine '#{attribute_name}' as no default routes were found for that interface family")
         else
           network["#{default_prefix}_interface"] = default_route[:dev]
-          Ohai::Log.debug("Plugin Network: #{default_prefix}_interface set to #{default_route[:dev]}")
+          logger.trace("Plugin Network: #{default_prefix}_interface set to #{default_route[:dev]}")
 
           # setting gateway to 0.0.0.0 or :: if the default route is a link level one
           network["#{default_prefix}_gateway"] = default_route[:via] ? default_route[:via] : family[:default_route].chomp("/0")
-          Ohai::Log.debug("Plugin Network: #{default_prefix}_gateway set to #{network["#{default_prefix}_gateway"]}")
+          logger.trace("Plugin Network: #{default_prefix}_gateway set to #{network["#{default_prefix}_gateway"]}")
 
           # deduce the default route the user most likely cares about to pick {ip,mac,ip6}address below
           favored_route = favored_default_route(routes, iface, default_route, family)
@@ -553,20 +553,20 @@ Ohai.plugin(:Network) do
             if family[:name] == "inet"
               ipaddress favored_route[:src]
               m = get_mac_for_interface(iface, favored_route[:dev])
-              Ohai::Log.debug("Plugin Network: Overwriting macaddress #{macaddress} with #{m} from interface #{favored_route[:dev]}") if macaddress
+              logger.trace("Plugin Network: Overwriting macaddress #{macaddress} with #{m} from interface #{favored_route[:dev]}") if macaddress
               macaddress m
             elsif family[:name] == "inet6"
               # this rarely does anything since we rarely have src for ipv6, so this usually falls back on the network plugin
               ip6address favored_route[:src]
               if macaddress
-                Ohai::Log.debug("Plugin Network: Not setting macaddress from ipv6 interface #{favored_route[:dev]} because macaddress is already set")
+                logger.trace("Plugin Network: Not setting macaddress from ipv6 interface #{favored_route[:dev]} because macaddress is already set")
               else
                 macaddress get_mac_for_interface(iface, favored_route[:dev])
               end
             end
           else
-            Ohai::Log.debug("Plugin Network: Unable to deduce the favored default route for family '#{family[:name]}' despite finding a default route, and is not setting ipaddress/ip6address/macaddress. the network plugin may provide fallbacks.")
-            Ohai::Log.debug("Plugin Network: This potential default route was excluded: #{default_route}")
+            logger.trace("Plugin Network: Unable to deduce the favored default route for family '#{family[:name]}' despite finding a default route, and is not setting ipaddress/ip6address/macaddress. the network plugin may provide fallbacks.")
+            logger.trace("Plugin Network: This potential default route was excluded: #{default_route}")
           end
         end
       end # end families.each
@@ -576,7 +576,7 @@ Ohai.plugin(:Network) do
         route_result = so.stdout.split($/).grep( /^0.0.0.0/ )[0].split( /[ \t]+/ )
         network[:default_gateway], network[:default_interface] = route_result.values_at(1, 7)
       rescue Ohai::Exceptions::Exec
-        Ohai::Log.debug("Plugin Network: Unable to determine default interface")
+        logger.trace("Plugin Network: Unable to determine default interface")
       end
 
       so = shell_out("ifconfig -a")

data/lib/ohai/plugins/linux/platform.rb

@@ -24,14 +24,8 @@ Ohai.plugin(:Platform) do
     contents[/^Red Hat/i] ? "redhat" : contents[/(\w+)/i, 1].downcase
   end
 
-  # Amazon Linux AMI release 2013.09
-  # Amazon Linux 2
-  # Fedora release 28 (Twenty Eight)
-  # CentOS release 5.8 (Final)
-  # CentOS release 6.7 (Final)
-  # Red Hat Enterprise Linux Server release 7.5 (Maipo)
   def get_redhatish_version(contents)
-    contents[/Rawhide/i] ? contents[/((\d+) \(Rawhide\))/i, 1].downcase : contents[/(release)? ([\d\.]+)/, 2]
+    contents[/Rawhide/i] ? contents[/((\d+) \(Rawhide\))/i, 1].downcase : contents[/release ([\d\.]+)/, 1]
   end
 
   #
@@ -87,7 +81,7 @@ Ohai.plugin(:Platform) do
     release_contents = File.read("/etc/cumulus/etc.replace/os-release")
     release_contents.match(/VERSION_ID=(.*)/)[1]
   rescue NoMethodError, Errno::ENOENT, Errno::EACCES # rescue regex failure, file missing, or permission denied
-    Ohai::Log.warn("Detected Cumulus Linux, but /etc/cumulus/etc/replace/os-release could not be parsed to determine platform_version")
+    logger.warn("Detected Cumulus Linux, but /etc/cumulus/etc/replace/os-release could not be parsed to determine platform_version")
     nil
   end
 
@@ -100,7 +94,7 @@ Ohai.plugin(:Platform) do
     release_contents = File.read("/etc/f5-release")
     release_contents.match(/BIG-IP release (\S*)/)[1] # http://rubular.com/r/O8nlrBVqSb
   rescue NoMethodError, Errno::ENOENT, Errno::EACCES # rescue regex failure, file missing, or permission denied
-    Ohai::Log.warn("Detected F5 Big-IP, but /etc/f5-release could not be parsed to determine platform_version")
+    logger.warn("Detected F5 Big-IP, but /etc/f5-release could not be parsed to determine platform_version")
     nil
   end
 
@@ -291,7 +285,7 @@ Ohai.plugin(:Platform) do
     # We have to do this for compatibility reasons, or older OS releases might get different
     # "platform" or "platform_version" attributes (e.g. SLES12, RHEL7).
     elsif File.exist?("/etc/os-release")
-      platform os_release_info["ID"] == "sles" ? "suse" : os_release_info["ID"] # SLES is wrong. We call it SUSE
+      platform os_release_info["ID"]
       platform_version os_release_info["VERSION_ID"]
       # platform_family also does not need to be hardcoded anymore.
       # This would be the correct way, but we stick with "determine_platform_family" for compatibility reasons.