ohai 14.5.4 → 14.6.2

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

@@ -34,13 +34,7 @@ Ohai.plugin(:Hardware) do
       next
     end
 
-    begin
-      require "plist"
-    rescue LoadError => e
-      # In case the plist gem isn't present, skip this plugin.
-      logger.trace("Plugin Hardware: Can't load gem: #{e}. Cannot continue.")
-      next
-    end
+    require "plist"
 
     hw_hash = system_profiler("SPHardwareDataType")
     hw_hash[0]["_items"][0].delete("_name")

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

@@ -20,13 +20,12 @@ Ohai.plugin(:SystemProfile) do
   provides "system_profile"
 
   collect_data(:darwin) do
-    begin
-      require "plist"
+    require "plist"
 
-      system_profile Array.new
-      items = Array.new
-      detail_level = {
-        "mini" => %w{
+    system_profile Array.new
+    items = Array.new
+    detail_level = {
+      "mini" => %w{
 SPParallelATAData
 SPAudioData
 SPBluetoothData
@@ -52,21 +51,22 @@ SPThunderboltData
 SPUSBData
 SPWWANData
 SPAirPortData},
-        "full" => [
-                   "SPHardwareDataType",
-                  ],
-      }
+      "full" => [
+                 "SPHardwareDataType",
+                ],
+    }
 
-      detail_level.each do |level, data_types|
-        so = shell_out("system_profiler -xml -detailLevel #{level} #{data_types.join(' ')}")
-        Plist.parse_xml(so.stdout).each do |e|
-          items << e
-        end
+    detail_level.each do |level, data_types|
+      so = shell_out("system_profiler -xml -detailLevel #{level} #{data_types.join(' ')}")
+      Plist.parse_xml(so.stdout).each do |e|
+        # delete some bogus timing data and then keep the rest
+        e.delete("_SPCompletionInterval")
+        e.delete("_SPResponseTime")
+        e.delete("_SPCommandLineArguments")
+        items << e
       end
-
-      system_profile ( items.sort_by { |h| h["_dataType"] } ) # rubocop: disable Lint/ParenthesesAsGroupedExpression
-    rescue LoadError => e
-      logger.trace("Can't load gem: #{e})")
     end
+
+    system_profile ( items.sort_by { |h| h["_dataType"] } ) # rubocop: disable Lint/ParenthesesAsGroupedExpression
   end
 end

data/lib/ohai/plugins/filesystem.rb

@@ -1,6 +1,11 @@
 #
 # Author:: Phil Dibowitz <phil@ipom.com>
 # Author:: Adam Jacob <adam@chef.io>
+# Author:: Kurt Yoder (ktyopscode@yoderhome.com)
+# Author:: Deepali Jagtap (<deepali.jagtap@clogeny.com>)
+# Author:: Prabhu Das (<prabhu.das@clogeny.com>)
+# Author:: Isa Farnik (<isa@chef.io>)
+# Author:: James Gartrell (<jgartrel@gmail.com>)
 # Copyright:: Copyright (c) 2008-2017 Chef Software, Inc.
 # Copyright:: Copyright (c) 2015 Facebook, Inc.
 # License:: Apache License, Version 2.0
@@ -99,27 +104,58 @@ Ohai.plugin(:Filesystem) do
     view
   end
 
+  def generate_deprecated_solaris_view(fs, old_zfs)
+    view = generate_deprecated_view(fs)
+    old_zfs.each do |fsname, attributes|
+      view[fsname] ||= Mash.new
+      view[fsname][:fs_type] = "zfs"
+      view[fsname][:mount] = attributes[:values][:mountpoint] if attributes[:values].key?("mountpoint")
+      view[fsname][:device] = fsname
+      view[fsname][:zfs_values] = attributes[:values]
+      view[fsname][:zfs_sources] = attributes[:sources]
+      # parents will already be here
+      # but we want to nuke "zfs_properties"
+      view[fsname].delete("zfs_properties")
+    end
+    view
+  end
+
+  def parse_common_df(out)
+    fs = {}
+    out.each_line do |line|
+      case line
+      when /^Filesystem\s+1024-blocks/
+        next
+      when /^(.+?)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+\%)\s+(.+)$/
+        key = "#{$1},#{$6}"
+        fs[key] = Mash.new
+        fs[key][:device] = $1
+        fs[key][:kb_size] = $2
+        fs[key][:kb_used] = $3
+        fs[key][:kb_available] = $4
+        fs[key][:percent_used] = $5
+        fs[key][:mount] = $6
+      end
+    end
+    fs
+  end
+
+  def run_with_check(bin, &block)
+    yield
+  rescue Ohai::Exceptions::Exec => e
+    unless Ohai.config[:plugin][:filesystem][:allow_partial_data]
+      raise e
+    end
+    logger.warn("Plugin Filesystem: #{bin} binary is not available. Some data will not be available.")
+  end
+
   collect_data(:linux) do
     fs = Mash.new
 
     # Grab filesystem data from df
-    begin
+    run_with_check("df") do
       so = shell_out("df -P")
-      so.stdout.each_line do |line|
-        case line
-        when /^Filesystem\s+1024-blocks/
-          next
-        when /^(.+?)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+\%)\s+(.+)$/
-          key = "#{$1},#{$6}"
-          fs[key] = Mash.new
-          fs[key][:device] = $1
-          fs[key][:kb_size] = $2
-          fs[key][:kb_used] = $3
-          fs[key][:kb_available] = $4
-          fs[key][:percent_used] = $5
-          fs[key][:mount] = $6
-        end
-      end
+      fs.merge!(parse_common_df(so.stdout))
 
       # Grab filesystem inode data from df
       so = shell_out("df -iP")
@@ -138,15 +174,10 @@ Ohai.plugin(:Filesystem) do
           fs[key][:mount] = $6
         end
       end
-    rescue Ohai::Exceptions::Exec => e
-      unless Ohai.config[:plugin][:filesystem][:allow_partial_data]
-        raise e
-      end
-      logger.warn("Plugin Filesystem: df binary is not available. Some data will not be available.")
     end
 
     # Grab mount information from /bin/mount
-    begin
+    run_with_check("mount") do
       so = shell_out("mount")
       so.stdout.each_line do |line|
         if line =~ /^(.+?) on (.+?) type (.+?) \((.+?)\)$/
@@ -158,11 +189,6 @@ Ohai.plugin(:Filesystem) do
           fs[key][:mount_options] = $4.split(",")
         end
       end
-    rescue Ohai::Exceptions::Exec
-      unless Ohai.config[:plugin][:filesystem][:allow_partial_data]
-        raise e
-      end
-      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
@@ -187,28 +213,30 @@ Ohai.plugin(:Filesystem) do
       # setting the timeout here for `lsblk` and `blkid` commands to 60
       # this is to allow machines with large amounts of attached LUNs
       # to respond back to the command successfully
-      so = shell_out(cmd, timeout: 60)
-      so.stdout.each_line do |line|
-        parsed = parse_line(line, cmdtype)
-        next if parsed.nil?
-        # lsblk lists each device once, so we need to update all entries
-        # in the hash that are related to this device
-        keys_to_update = []
-        fs.each_key do |key|
-          keys_to_update << key if key.start_with?("#{parsed[:dev]},")
-        end
+      run_with_check(cmdtype) do
+        so = shell_out(cmd, timeout: 60)
+        so.stdout.each_line do |line|
+          parsed = parse_line(line, cmdtype)
+          next if parsed.nil?
+          # lsblk lists each device once, so we need to update all entries
+          # in the hash that are related to this device
+          keys_to_update = []
+          fs.each_key do |key|
+            keys_to_update << key if key.start_with?("#{parsed[:dev]},")
+          end
 
-        if keys_to_update.empty?
-          key = "#{parsed[:dev]},"
-          fs[key] = Mash.new
-          fs[key][:device] = parsed[:dev]
-          keys_to_update << key
-        end
+          if keys_to_update.empty?
+            key = "#{parsed[:dev]},"
+            fs[key] = Mash.new
+            fs[key][:device] = parsed[:dev]
+            keys_to_update << key
+          end
 
-        keys_to_update.each do |k|
-          [:fs_type, :uuid, :label].each do |subkey|
-            if parsed[subkey] && !parsed[subkey].empty?
-              fs[k][subkey] = parsed[subkey]
+          keys_to_update.each do |k|
+            [:fs_type, :uuid, :label].each do |subkey|
+              if parsed[subkey] && !parsed[subkey].empty?
+                fs[k][subkey] = parsed[subkey]
+              end
             end
           end
         end
@@ -264,51 +292,40 @@ Ohai.plugin(:Filesystem) do
     fs = Mash.new
 
     # Grab filesystem data from df
-    so = shell_out("df")
-    so.stdout.lines do |line|
-      case line
-      when /^Filesystem/
-        next
-      when /^(\S+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+\%)\s+(\S+)$/
-        key = "#{$1},#{$6}"
-        fs[key] = Mash.new
-        fs[key][:device] = $1
-        fs[key][:kb_size] = $2
-        fs[key][:kb_used] = $3
-        fs[key][:kb_available] = $4
-        fs[key][:percent_used] = $5
-        fs[key][:mount] = $6
-      end
-    end
+    run_with_check("df") do
+      so = shell_out("df")
+      fs.merge!(parse_common_df(so.stdout))
 
-    # inode parsing from 'df -iP'
-    so = shell_out("df -iP")
-    so.stdout.lines do |line|
-      case line
-      when /^Filesystem/ # skip the header
-        next
-      when /^(\S+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\%\s+(\d+)\s+(\d+)\s+(\d+)%\s+(\S+)$/
-        key = "#{$1},#{$9}"
-        fs[key] ||= Mash.new
-        fs[key][:device] = $1
-        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
+      so = shell_out("df -iP")
+      so.stdout.lines do |line|
+        case line
+        when /^Filesystem/ # skip the header
+          next
+        when /^(\S+)\s+(\d+)\s+(\d+)\s+(\d+)\s+(\d+)\%\s+(\d+)\s+(\d+)\s+(\d+)%\s+(\S+)$/
+          key = "#{$1},#{$9}"
+          fs[key] ||= Mash.new
+          fs[key][:device] = $1
+          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
     end
 
     # Grab mount information from mount
-    so = shell_out("mount -l")
-    so.stdout.lines do |line|
-      if line =~ /^(.+?) on (.+?) \((.+?), (.+?)\)$/
-        key = "#{$1},#{$2}"
-        fs[key] ||= Mash.new
-        fs[key][:device] = $1
-        fs[key][:mount] = $2
-        fs[key][:fs_type] = $3
-        fs[key][:mount_options] = $4.split(/,\s*/)
+    run_with_check("mount") do
+      so = shell_out("mount -l")
+      so.stdout.lines do |line|
+        if line =~ /^(.+?) on (.+?) \((.+?), (.+?)\)$/
+          key = "#{$1},#{$2}"
+          fs[key] ||= Mash.new
+          fs[key][:device] = $1
+          fs[key][:mount] = $2
+          fs[key][:fs_type] = $3
+          fs[key][:mount_options] = $4.split(/,\s*/)
+        end
       end
     end
 
@@ -333,37 +350,41 @@ Ohai.plugin(:Filesystem) do
     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.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+(.+)$/
-        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
+    run_with_check("df") do
+      so = shell_out("df -i")
+      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+(.+)$/
+          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
     end
 
-    so = shell_out("mount")
-    so.stdout.lines do |line|
-      if line =~ /^(.+?) on (.+?) \((.+?), (.+?)\)$/
-        key = "#{$1},#{$2}"
-        fs[key] = Mash.new unless fs.key?(key)
-        fs[key][:mount] = $2
-        fs[key][:fs_type] = $3
-        fs[key][:mount_options] = $4.split(/,\s*/)
+    run_with_check("mount") do
+      so = shell_out("mount")
+      so.stdout.lines do |line|
+        if line =~ /^(.+?) on (.+?) \((.+?), (.+?)\)$/
+          key = "#{$1},#{$2}"
+          fs[key] = Mash.new unless fs.key?(key)
+          fs[key][:mount] = $2
+          fs[key][:fs_type] = $3
+          fs[key][:mount_options] = $4.split(/,\s*/)
+        end
       end
     end
 
@@ -378,4 +399,194 @@ Ohai.plugin(:Filesystem) do
 
     filesystem fs_data
   end
+
+  collect_data(:solaris2) do
+    fs = Mash.new
+
+    # Grab filesystem data from df
+    run_with_check("df") do
+      so = shell_out("df -Pka")
+      fs.merge!(parse_common_df(so.stdout))
+
+      # Grab file system type from df (must be done separately)
+      so = shell_out("df -na")
+      so.stdout.lines do |line|
+        next unless line =~ /^(.+?)\s*: (\S+)\s*$/
+        mount = $1
+        fs.each do |key, fs_attributes|
+          next unless fs_attributes[:mount] == mount
+          fs[key][:fs_type] = $2
+        end
+      end
+    end
+
+    # Grab mount information from /bin/mount
+    run_with_check("mount") do
+      so = shell_out("mount")
+      so.stdout.lines do |line|
+        next unless line =~ /^(.+?) on (.+?) (.+?) on (.+?)$/
+        key = "#{$2},#{$1}"
+        fs[key] = Mash.new unless fs.key?(key)
+        fs[key][:mount] = $1
+        fs[key][:mount_time] = $4 # $4 must come before "split", else it becomes nil
+        fs[key][:mount_options] = $3.split("/")
+      end
+    end
+
+    # Grab any zfs data from "zfs get"
+    zfs = Mash.new
+    old_zfs = Mash.new
+    zfs_get = "zfs get -p -H all"
+    run_with_check("zfs") do
+      so = shell_out(zfs_get)
+      so.stdout.lines do |line|
+        next unless line =~ /^([^\s]+)\s+([^\s]+)\s+([^\s]+)\s+([^\s]+)$/
+        filesystem = $1
+        property = $2
+        value = $3
+        source = $4.chomp
+        zfs[filesystem] ||= Mash.new
+        # if this fs doesn't exist, put in the bare minimum
+        zfs[filesystem][property] = {
+          value: value,
+          source: source,
+        }
+        # needed for old v1 view
+        old_zfs[filesystem] ||= Mash.new
+        old_zfs[filesystem][:values] ||= Mash.new
+        old_zfs[filesystem][:sources] ||= Mash.new
+        old_zfs[filesystem][:values][property] = value
+        old_zfs[filesystem][:values][property] = value
+        old_zfs[filesystem][:sources][property] = source
+      end
+    end
+
+    zfs.each do |fsname, attributes|
+      mountpoint = attributes[:mountpoint][:value] if attributes[:mountpoint]
+      key = "#{fsname},#{mountpoint}"
+      fs[key] ||= Mash.new
+      fs[key][:fs_type] = "zfs"
+      fs[key][:mount] = mountpoint if mountpoint
+      fs[key][:device] = fsname
+      fs[key][:zfs_properties] = attributes
+      # find all zfs parents
+      parents = fsname.split("/")
+      zfs_parents = []
+      (0..parents.length - 1).to_a.each do |parent_index|
+        next_parent = parents[0..parent_index].join("/")
+        zfs_parents.push(next_parent)
+      end
+      zfs_parents.pop
+      fs[key][:zfs_parents] = zfs_parents
+      fs[key][:zfs_zpool] = (zfs_parents.length == 0)
+    end
+
+    # create views
+    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
+
+    # Set the filesystem data - Solaris didn't do the conversion when everyone
+    # else did, so 15 will have both be the new API and 16 will drop the old API
+    filesystem generate_deprecated_solaris_view(fs, old_zfs)
+    filesystem2 fs_data
+  end
+
+  collect_data(:aix) do
+    def parse_df_or_mount(shell_out)
+      oldie = Mash.new
+
+      shell_out.lines.each do |line|
+        fields = line.split
+        case line
+        # headers and horizontal rules to skip
+        when /^\s*(node|---|^Filesystem\s+1024-blocks)/
+          next
+        # strictly a df entry
+        when /^(.+?)\s+([0-9-]+)\s+([0-9-]+)\s+([0-9-]+)\s+([0-9-]+\%*)\s+(.+)$/
+          if $1 == "Global"
+            dev = "#{$1}:#{$6}"
+          else
+            dev = $1
+          end
+          mountpoint = $6
+          key = "#{dev},#{mountpoint}"
+          oldie[key] ||= Mash.new
+          oldie[key][:kb_size] = $2
+          oldie[key][:kb_used] = $3
+          oldie[key][:kb_available] = $4
+          oldie[key][:percent_used] = $5
+          oldie[key][:mount] = mountpoint
+          oldie[key][:device] = dev
+        # an entry starting with 'G' or / (E.G. /tmp or /var)
+        when /^\s*(G.*?|\/\w)/
+          if fields[0] == "Global"
+            dev = fields[0] + ":" + fields[1]
+          else
+            dev = fields[0]
+          end
+          mountpoint = fields[1]
+          key = "#{dev},#{mountpoint}"
+          oldie[key] ||= Mash.new
+          oldie[key][:mount] = mountpoint
+          oldie[key][:fs_type] = fields[2]
+          oldie[key][:mount_options] = fields[6].split(",")
+          oldie[key][:device] = dev
+        # entries occupying the 'Node' column parsed here
+        else
+          dev = fields[0] + ":" + fields[1]
+          mountpoint = fields[2]
+          key = "#{dev},#{mountpoint}"
+          oldie[key] ||= Mash.new
+          oldie[key][:mount] = mountpoint
+          oldie[key][:device] = dev
+          oldie[key][:fs_type] = fields[3]
+          oldie[key][:mount_options] = fields[7].split(",")
+        end
+      end
+      oldie
+    end
+
+    def collect_old_version(shell_outs)
+      mount_hash = parse_df_or_mount shell_outs[:mount]
+      df_hash    = parse_df_or_mount shell_outs[:df_Pk]
+
+      mount_hash.each do |key, hash|
+        df_hash[key].merge!(hash) if df_hash.key?(key)
+      end
+
+      mount_hash.merge(df_hash)
+    end
+
+    # Cache the command output
+    shell_outs = Mash.new
+
+    run_with_check("mount") do
+      shell_outs[:mount] = shell_out("mount").stdout
+    end
+
+    run_with_check("df") do
+      shell_outs[:df_Pk] = shell_out("df -Pk").stdout
+    end
+
+    fs = collect_old_version(shell_outs)
+    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
+
+    # Set the filesystem data - AIX didn't do the conversion when everyone
+    # else did, so 15 will have both be the new API and 16 will drop the old API
+    filesystem generate_deprecated_view(fs)
+    filesystem2 fs_data
+  end
 end