ohai 8.26.1 → 13.0.0

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

@@ -1,6 +1,8 @@
 #
+# Author:: Phil Dibowitz (<phil@ipom.com>)
 # Author:: Benjamin Black (<bb@chef.io>)
 # Copyright:: Copyright (c) 2009-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) 2015 Facebook, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -18,46 +20,90 @@
 
 Ohai.plugin(:Filesystem) do
   provides "filesystem"
+  provides "filesystem2"
+
+  def generate_device_view(fs)
+    view = {}
+    fs.each_value do |entry|
+      view[entry[:device]] = Mash.new unless view[entry[:device]]
+      entry.each do |key, val|
+        next if %w{device mount}.include?(key)
+        view[entry[:device]][key] = val
+      end
+      if entry[:mount]
+        view[entry[:device]][:mounts] = [] unless view[entry[:device]][:mounts]
+        view[entry[:device]][:mounts] << entry[:mount]
+      end
+    end
+    view
+  end
+
+  def generate_mountpoint_view(fs)
+    view = {}
+    fs.each_value do |entry|
+      next unless entry[:mount]
+      view[entry[:mount]] = Mash.new unless view[entry[:mount]]
+      entry.each do |key, val|
+        next if %w{mount device}.include?(key)
+        view[entry[:mount]][key] = val
+      end
+      if entry[:device]
+        view[entry[:mount]][:devices] = [] unless view[entry[:mount]][:devices]
+        view[entry[:mount]][:devices] << entry[:device]
+      end
+    end
+    view
+  end
 
   collect_data(:darwin) do
     fs = Mash.new
-
     block_size = 0
+    # on new versions of OSX, -i is default, on old versions it's not, so
+    # specifying it gets consistent output
     so = shell_out("df -i")
-    so.stdout.lines do |line|
+    so.stdout.each_line do |line|
       case line
       when /^Filesystem\s+(\d+)-/
         block_size = $1.to_i
         next
       when /^(.+?)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+\%)\s+(\d+)\s+(\d+)\s+(\d+%)\s+(.+)$/
-        filesystem = $1
-        fs[filesystem] = Mash.new
-        fs[filesystem][:block_size] = block_size
-        # To match linux, these should be strings, but we don't want
-        # to break back compat so we'll leave them as they are. In filesystem2
-        # we make them consistent.
-        fs[filesystem][:kb_size] = $2.to_i / (1024 / block_size)
-        fs[filesystem][:kb_used] = $3.to_i / (1024 / block_size)
-        fs[filesystem][:kb_available] = $4.to_i / (1024 / block_size)
-        fs[filesystem][:percent_used] = $5
-        fs[filesystem][:inodes_used] = $6
-        fs[filesystem][:inodes_available] = $7
-        fs[filesystem][:total_inodes] = ($6.to_i + $7.to_i).to_s
-        fs[filesystem][:mount] = $9
+        key = "#{$1},#{$9}"
+        fs[key] = Mash.new
+        fs[key][:block_size] = block_size
+        fs[key][:device] = $1
+        fs[key][:kb_size] = ($2.to_i / (1024 / block_size)).to_s
+        fs[key][:kb_used] = ($3.to_i / (1024 / block_size)).to_s
+        fs[key][:kb_available] = ($4.to_i / (1024 / block_size)).to_s
+        fs[key][:percent_used] = $5
+        fs[key][:inodes_used] = $6
+        fs[key][:inodes_available] = $7
+        fs[key][:total_inodes] = ($6.to_i + $7.to_i).to_s
+        fs[key][:inodes_percent_used] = $8
+        fs[key][:mount] = $9
       end
     end
 
     so = shell_out("mount")
     so.stdout.lines do |line|
       if line =~ /^(.+?) on (.+?) \((.+?), (.+?)\)$/
-        filesystem = $1
-        fs[filesystem] = Mash.new unless fs.has_key?(filesystem)
-        fs[filesystem][:mount] = $2
-        fs[filesystem][:fs_type] = $3
-        fs[filesystem][:mount_options] = $4.split(/,\s*/)
+        key = "#{$1},#{$2}"
+        fs[key] = Mash.new unless fs.has_key?(key)
+        fs[key][:mount] = $2
+        fs[key][:fs_type] = $3
+        fs[key][:mount_options] = $4.split(/,\s*/)
       end
     end
 
-    filesystem fs
+    by_pair = fs
+    by_device = generate_device_view(fs)
+    by_mountpoint = generate_mountpoint_view(fs)
+
+    fs_data = Mash.new
+    fs_data["by_device"] = by_device
+    fs_data["by_mountpoint"] = by_mountpoint
+    fs_data["by_pair"] = by_pair
+
+    filesystem fs_data
+    filesystem2 fs_data
   end
 end

data/lib/ohai/plugins/digital_ocean.rb

@@ -1,4 +1,5 @@
 #
+# Author:: Dylan Page (<dpage@digitalocean.com>)
 # Author:: Stafford Brunk (<stafford.brunk@gmail.com>)
 # License:: Apache License, Version 2.0
 #
@@ -14,65 +15,46 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require "ohai/util/ip_helper"
+require "ohai/mixin/do_metadata"
+require "ohai/mixin/http_helper"
 
 Ohai.plugin(:DigitalOcean) do
-  include Ohai::Util::IpHelper
-
-  DIGITALOCEAN_FILE = "/etc/digitalocean" unless defined?(DIGITALOCEAN_FILE)
+  include Ohai::Mixin::DOMetadata
+  include Ohai::Mixin::HttpHelper
 
   provides "digital_ocean"
-  depends "network/interfaces"
 
-  def extract_droplet_ip_addresses
-    addresses = Mash.new({ "v4" => [], "v6" => [] })
-    network[:interfaces].each_value do |iface|
-      iface[:addresses].each do |address, details|
-        next if details[:family] == "lladdr" || loopback?(address)
+  depends "dmi"
 
-        ip = IPAddress(address)
-        type = digital_ocean_address_type(ip)
-        address_hash = build_address_hash(ip, details)
-        addresses[type] << address_hash
+  # look for digitalocean string in dmi bios data
+  def has_do_dmi?
+    begin
+      # detect a vendor of "DigitalOcean"
+      if dmi[:bios][:all_records][0][:Vendor] == "DigitalOcean"
+        Ohai::Log.debug("Plugin DigitalOcean: has_do_dmi? == true")
+        return true
       end
+    rescue NoMethodError
+      # dmi[:bios][:all_records][0][:Vendor] may not exist
     end
-    addresses
-  end
-
-  def build_address_hash(ip, details)
-    address_hash = Mash.new({
-      "ip_address" => ip.address,
-      "type" => private_address?(ip.address) ? "private" : "public",
-    })
-
-    if ip.ipv4?
-      address_hash["netmask"] = details[:netmask]
-    elsif ip.ipv6?
-      address_hash["cidr"] = ip.prefix
-    end
-    address_hash
-  end
-
-  def digital_ocean_address_type(ip)
-    ip.ipv4? ? "v4" : "v6"
+    Ohai::Log.debug("Plugin DigitalOcean: has_do_dmi? == false")
+    return false
   end
 
   def looks_like_digital_ocean?
-    hint?("digital_ocean") || File.exist?(DIGITALOCEAN_FILE)
+    return true if hint?("digital_ocean")
+    return true if has_do_dmi? && can_socket_connect?(Ohai::Mixin::DOMetadata::DO_METADATA_ADDR, 80)
+    return false
   end
 
   collect_data do
     if looks_like_digital_ocean?
       Ohai::Log.debug("Plugin Digitalocean: looks_like_digital_ocean? == true")
       digital_ocean Mash.new
-      hint = hint?("digital_ocean") || {}
-      hint.each { |k, v| digital_ocean[k] = v unless k == "ip_addresses" }
-
-      # Extract actual ip addresses
-      # The networks sub-hash is structured similarly to how
-      # Digital Ocean's v2 API structures things:
-      # https://developers.digitalocean.com/#droplets
-      digital_ocean[:networks] = extract_droplet_ip_addresses
+      fetch_metadata.each do |k, v|
+        next if k == "vendor_data" # this may have sensitive data we shouldn't store
+        digital_ocean[k] = v
+      end
     else
       Ohai::Log.debug("Plugin Digitalocean: No hints present for and doesn't look like digitalocean")
       false

data/lib/ohai/plugins/dmi.rb

@@ -44,86 +44,90 @@ Ohai.plugin(:DMI) do
     dmi_record = nil
     field = nil
 
-    so = shell_out("dmidecode")
-    # ==== EXAMPLE RECORD: ====
-    #Handle 0x0000, DMI type 0, 24 bytes
-    #BIOS Information
-    #        Vendor: American Megatrends Inc.
-    #        Version: 080012
-    # ... similar lines trimmed
-    #        Characteristics:
-    #                ISA is supported
-    #                PCI is supported
-    # ... similar lines trimmed
-    so.stdout.lines do |line|
-      next if blank_line.match(line)
-      line = line.encode(line.encoding, :universal_newline => true)
-
-      if dmidecode_version = dmidecode_version_line.match(line)
-        dmi[:dmidecode_version] = dmidecode_version[1]
-
-      elsif smbios_version = smbios_version_line.match(line)
-        dmi[:smbios_version] = smbios_version[1]
-
-      elsif structures = structures_line.match(line)
-        dmi[:structures] = Mash.new
-        dmi[:structures][:count] = structures[1]
-        dmi[:structures][:size] = structures[2]
-
-      elsif table_location = table_location_line.match(line)
-        dmi[:table_location] = table_location[1]
-
-      elsif handle = handle_line.match(line)
-        # Don't overcapture for now (OHAI-260)
-        unless Ohai::Common::DMI::ID_TO_CAPTURE.include?(handle[2].to_i)
-          dmi_record = nil
-          next
-        end
-
-        dmi_record = { :type => Ohai::Common::DMI.id_lookup(handle[2]) }
-
-        dmi[dmi_record[:type]] = Mash.new unless dmi.has_key?(dmi_record[:type])
-        dmi[dmi_record[:type]][:all_records] = [] unless dmi[dmi_record[:type]].has_key?(:all_records)
-        dmi_record[:position] = dmi[dmi_record[:type]][:all_records].length
-        dmi[dmi_record[:type]][:all_records].push(Mash.new)
-        dmi[dmi_record[:type]][:all_records][dmi_record[:position]][:record_id] = handle[1]
-        dmi[dmi_record[:type]][:all_records][dmi_record[:position]][:size] = handle[2]
-        field = nil
-
-      elsif type = type_line.match(line)
-        if dmi_record.nil?
-          Ohai::Log.debug("Plugin DMI: unexpected data line found before header; discarding:\n#{line}")
-          next
-        end
-        dmi[dmi_record[:type]][:all_records][dmi_record[:position]][:application_identifier] = type[1]
-
-      elsif data = data_line.match(line)
-        if dmi_record.nil?
-          Ohai::Log.debug("Plugin DMI: unexpected data line found before header; discarding:\n#{line}")
-          next
-        end
-        dmi[dmi_record[:type]][:all_records][dmi_record[:position]][data[1]] = data[2]
-        field = data[1]
+    begin
+      so = shell_out("dmidecode")
+      # ==== EXAMPLE RECORD: ====
+      #Handle 0x0000, DMI type 0, 24 bytes
+      #BIOS Information
+      #        Vendor: American Megatrends Inc.
+      #        Version: 080012
+      # ... similar lines trimmed
+      #        Characteristics:
+      #                ISA is supported
+      #                PCI is supported
+      # ... similar lines trimmed
+      so.stdout.lines do |line|
+        next if blank_line.match(line)
+        line = line.encode(line.encoding, :universal_newline => true)
+
+        if dmidecode_version = dmidecode_version_line.match(line)
+          dmi[:dmidecode_version] = dmidecode_version[1]
+
+        elsif smbios_version = smbios_version_line.match(line)
+          dmi[:smbios_version] = smbios_version[1]
+
+        elsif structures = structures_line.match(line)
+          dmi[:structures] = Mash.new
+          dmi[:structures][:count] = structures[1]
+          dmi[:structures][:size] = structures[2]
+
+        elsif table_location = table_location_line.match(line)
+          dmi[:table_location] = table_location[1]
+
+        elsif handle = handle_line.match(line)
+          # Don't overcapture for now (OHAI-260)
+          unless Ohai::Common::DMI::ID_TO_CAPTURE.include?(handle[2].to_i)
+            dmi_record = nil
+            next
+          end
+
+          dmi_record = { :type => Ohai::Common::DMI.id_lookup(handle[2]) }
+
+          dmi[dmi_record[:type]] = Mash.new unless dmi.has_key?(dmi_record[:type])
+          dmi[dmi_record[:type]][:all_records] = [] unless dmi[dmi_record[:type]].has_key?(:all_records)
+          dmi_record[:position] = dmi[dmi_record[:type]][:all_records].length
+          dmi[dmi_record[:type]][:all_records].push(Mash.new)
+          dmi[dmi_record[:type]][:all_records][dmi_record[:position]][:record_id] = handle[1]
+          dmi[dmi_record[:type]][:all_records][dmi_record[:position]][:size] = handle[2]
+          field = nil
+
+        elsif type = type_line.match(line)
+          if dmi_record .nil?
+            Ohai::Log.debug("Plugin DMI: unexpected data line found before header; discarding:\n#{line}")
+            next
+          end
+          dmi[dmi_record[:type]][:all_records][dmi_record[:position]][:application_identifier] = type[1]
+
+        elsif data = data_line.match(line)
+          if dmi_record .nil?
+            Ohai::Log.debug("Plugin DMI: unexpected data line found before header; discarding:\n#{line}")
+            next
+          end
+          dmi[dmi_record[:type]][:all_records][dmi_record[:position]][data[1]] = data[2]
+          field = data[1]
+
+        elsif extended_data = extended_data_line.match(line)
+          if dmi_record .nil?
+            Ohai::Log.debug("Plugin DMI: unexpected extended data line found before header; discarding:\n#{line}")
+            next
+          end
+          if field .nil?
+            Ohai::Log.debug("Plugin DMI: unexpected extended data line found outside data section; discarding:\n#{line}")
+            next
+          end
+          # overwrite "raw" value with a new Mash
+          dmi[dmi_record[:type]][:all_records][dmi_record[:position]][field] = Mash.new unless dmi[dmi_record[:type]][:all_records][dmi_record[:position]][field].class.to_s == "Mash"
+          dmi[dmi_record[:type]][:all_records][dmi_record[:position]][field][extended_data[1]] = nil
+
+        else
+          Ohai::Log.debug("Plugin DMI: unrecognized output line; discarding:\n#{line}")
 
-      elsif extended_data = extended_data_line.match(line)
-        if dmi_record.nil?
-          Ohai::Log.debug("Plugin DMI: unexpected extended data line found before header; discarding:\n#{line}")
-          next
-        end
-        if field.nil?
-          Ohai::Log.debug("Plugin DMI: unexpected extended data line found outside data section; discarding:\n#{line}")
-          next
         end
-        # overwrite "raw" value with a new Mash
-        dmi[dmi_record[:type]][:all_records][dmi_record[:position]][field] = Mash.new unless dmi[dmi_record[:type]][:all_records][dmi_record[:position]][field].class.to_s == "Mash"
-        dmi[dmi_record[:type]][:all_records][dmi_record[:position]][field][extended_data[1]] = nil
-
-      else
-        Ohai::Log.debug("Plugin DMI: unrecognized output line; discarding:\n#{line}")
-
       end
-    end
 
-    Ohai::Common::DMI.convenience_keys(dmi)
+      Ohai::Common::DMI.convenience_keys(dmi)
+    rescue Ohai::Exceptions::Exec
+      Ohai::Log.debug('Plugin DMI: Could not shell_out "dmidecode". Skipping data')
+    end
   end
 end

data/lib/ohai/plugins/ec2.rb

@@ -21,93 +21,66 @@
 # How we detect EC2 from easiest to hardest & least reliable
 # 1. Ohai ec2 hint exists. This always works
 # 2. Xen hypervisor UUID starts with 'ec2'. This catches Linux HVM & paravirt instances
-# 3. DMI bios version data mentions amazon. This catches HVM instances in a VPC on the Xen based hypervisor
-# 3. DMI bios vendor data mentions amazon. This catches HVM instances in a VPC on the non-Xen based hypervisor
+# 3. DMI data mentions amazon. This catches HVM instances in a VPC
 # 4. Kernel data mentioned Amazon. This catches Windows HVM & paravirt instances
 
-Ohai.plugin(:EC2) do
-  require "ohai/mixin/ec2_metadata"
-  require "base64"
+require "ohai/mixin/ec2_metadata"
+require "ohai/mixin/http_helper"
+require "base64"
 
+Ohai.plugin(:EC2) do
   include Ohai::Mixin::Ec2Metadata
+  include Ohai::Mixin::HttpHelper
 
   provides "ec2"
 
-  # look for amazon string in dmi vendor bios data within the sys tree.
-  # this works even if the system lacks dmidecode use by the Dmi plugin
-  # this gets us detection of new Xen-less HVM instances that are within a VPC
-  # @return [Boolean] do we have Amazon DMI data?
-  def has_ec2_amazon_dmi?
-    # detect a version of '4.2.amazon'
-    if file_val_if_exists("/sys/class/dmi/id/bios_vendor") =~ /Amazon/
-      Ohai::Log.debug("Plugin EC2: has_ec2_amazon_dmi? == true")
-      true
-    else
-      Ohai::Log.debug("Plugin EC2: has_ec2_amazon_dmi? == false")
-      false
-    end
-  end
+  depends "dmi"
+  depends "kernel"
 
-  # look for amazon string in dmi bios version data within the sys tree.
-  # this works even if the system lacks dmidecode use by the Dmi plugin
+  # look for amazon string in dmi bios data
   # this gets us detection of HVM instances that are within a VPC
-  # @return [Boolean] do we have Amazon DMI data?
-  def has_ec2_xen_dmi?
+  def has_ec2_dmi?
     # detect a version of '4.2.amazon'
-    if file_val_if_exists("/sys/class/dmi/id/bios_version") =~ /amazon/
-      Ohai::Log.debug("Plugin EC2: has_ec2_xen_dmi? == true")
-      true
+    if get_attribute(:dmi, :bios, :all_records, 0, :Version) =~ /amazon/
+      Ohai::Log.debug("Plugin EC2: has_ec2_dmi? == true")
+      return true
     else
-      Ohai::Log.debug("Plugin EC2: has_ec2_xen_dmi? == false")
-      false
+      Ohai::Log.debug("Plugin EC2: has_ec2_dmi? == false")
+      return false
     end
   end
 
-  # looks for a xen UUID that starts with ec2 from within the Linux sys tree
-  # @return [Boolean] do we have a Xen UUID or not?
+  # looks for a xen UUID that starts with ec2
+  # this gets us detection of Linux HVM and Paravirt hosts
   def has_ec2_xen_uuid?
-    if file_val_if_exists("/sys/hypervisor/uuid") =~ /^ec2/
-      Ohai::Log.debug("Plugin EC2: has_ec2_xen_uuid? == true")
-      return true
-    end
-    Ohai::Log.debug("Plugin EC2: has_ec2_xen_uuid? == false")
-    false
-  end
-
-  # looks at the identifying number WMI value to see if it starts with ec2.
-  # this is actually the same value we're looking at in has_ec2_xen_uuid? on
-  # linux hosts
-  # @return [Boolean] do we have a Xen Identifying Number or not?
-  def has_ec2_identifying_number?
-    if RUBY_PLATFORM =~ /mswin|mingw32|windows/
-      require "wmi-lite/wmi"
-      wmi = WmiLite::Wmi.new
-      if wmi.first_of("Win32_ComputerSystemProduct")["identifyingnumber"] =~ /^ec2/
-        Ohai::Log.debug("Plugin EC2: has_ec2_identifying_number? == true")
+    if ::File.exist?("/sys/hypervisor/uuid")
+      if ::File.read("/sys/hypervisor/uuid") =~ /^ec2/
+        Ohai::Log.debug("Plugin EC2: has_ec2_xen_uuid? == true")
         return true
       end
-    else
-      Ohai::Log.debug("Plugin EC2: has_ec2_identifying_number? == false")
-      false
     end
+    Ohai::Log.debug("Plugin EC2: has_ec2_xen_uuid? == false")
+    return false
   end
 
-  # return the contents of a file if the file exists
-  # @param path[String] abs path to the file
-  # @return [String] contents of the file if it exists
-  def file_val_if_exists(path)
-    if ::File.exist?(path)
-      ::File.read(path)
+  # looks for the Amazon.com Organization in Windows Kernel data
+  # this gets us detection of Windows systems
+  def has_amazon_org?
+    # detect an Organization of 'Amazon.com'
+    if get_attribute(:kernel, :os_info, :organization) =~ /Amazon/
+      Ohai::Log.debug("Plugin EC2: has_amazon_org? == true")
+      return true
+    else
+      Ohai::Log.debug("Plugin EC2: has_amazon_org? == false")
+      return false
     end
   end
 
-  # a single check that combines all the various detection methods for EC2
-  # @return [Boolean] Does the system appear to be on EC2
   def looks_like_ec2?
     return true if hint?("ec2")
 
     # Even if it looks like EC2 try to connect first
-    if has_ec2_xen_uuid? || has_ec2_amazon_dmi? || has_ec2_xen_dmi? || has_ec2_identifying_number?
+    if has_ec2_xen_uuid? || has_ec2_dmi? || has_amazon_org?
       return true if can_socket_connect?(Ohai::Mixin::Ec2Metadata::EC2_METADATA_ADDR, 80)
     end
   end