ohai 8.13.0 → 8.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 653220934f733f38ccf77e2995b60dafff3a8cb4
-  data.tar.gz: d853852c8a1bb4912970a3562e60c9a91636a5de
+  metadata.gz: 880a68c3c0a321e516f4ebd6fe4d8ea96dc4bd81
+  data.tar.gz: e6f7e6019d46c47e58cc642ba8104624bd5cfdd3
 SHA512:
-  metadata.gz: e03fdd75bfde725021994265b3ba2ed5474c9d37f5409886e4cc29656616bb7647e199db6efbea708e446391ca410692d69fcc95072ba3ca8a936dee6321b8e3
-  data.tar.gz: 36ed710e0d3813f796dbf2fd3b970583610e4731c8ed53e203de69cf1abc170aed18942ed999d571fd4547cac87f94e0d7c3071e5604020b49fa5ec6e938cafa
+  metadata.gz: 79c39d1fc907eda3130f429f3ca5f0b7511e5448e83188ef6d59148b36d8e661bcc550a8e61eb194259c32fe42e015e5ef49236cde4636af68f1ad6d744326c1
+  data.tar.gz: 967a82e37972b3d947c81612d983e52124479c419d4a1161a9bf8e825d61b40fbeea720ff9658981daa2a228d87d04eec2048dc44ec64752c4b763dba795abd1

data/Gemfile

@@ -5,7 +5,7 @@ gemspec
 group :development do
   gem "sigar", :platform => "ruby"
 
-  gem "chefstyle", "= 0.3.0"
+  gem "chefstyle", "= 0.3.1"
   # gem 'pry-byebug'
   # gem 'pry-stack_explorer'
 end

data/lib/ohai/common/dmi.rb

@@ -77,7 +77,7 @@ module Ohai
       def id_lookup(id)
         begin
           id = id.to_i
-          if (id >= 128) and (id <= 255)
+          if (id >= 128) && (id <= 255)
             id = "oem_data_#{id}"
           elsif DMI::IdToDescription.has_key?(id)
             id = DMI::IdToDescription[id]

data/lib/ohai/config.rb

@@ -105,7 +105,7 @@ module Ohai
     private
 
     def self.option_deprecated(option)
-      <<-EOM.chomp!.gsub("\n", " ")
+      <<-EOM.chomp!.tr("\n", " ")
 Ohai::Config[:#{option}] is set. Ohai::Config[:#{option}] is deprecated and will
 be removed in future releases of ohai. Use ohai.#{option} in your configuration
 file to configure :#{option} for ohai.
@@ -113,7 +113,7 @@ EOM
     end
 
     def self.option_might_be_deprecated(option)
-      option_deprecated(option) + <<-EOM.chomp!.gsub("\n", " ")
+      option_deprecated(option) + <<-EOM.chomp!.tr("\n", " ")
  If your configuration file is used with other applications which configure
 :#{option}, and you have not configured Ohai::Config[:#{option}], you may
 disregard this warning.

data/lib/ohai/dsl/plugin.rb

@@ -117,7 +117,7 @@ module Ohai
 
       def each(&block)
         @data.each do |key, value|
-          block.call(key, value)
+          yield(key, value)
         end
       end
 

data/lib/ohai/loader.rb

@@ -173,7 +173,7 @@ For more information visit here: docs.chef.io/ohai_custom.html")
 
     def load_v7_plugin_class(contents, plugin_path)
       plugin_class = eval(contents, TOPLEVEL_BINDING, plugin_path)
-      unless plugin_class.kind_of?(Class) and plugin_class < Ohai::DSL::Plugin
+      unless plugin_class.kind_of?(Class) && plugin_class < Ohai::DSL::Plugin
         raise Ohai::Exceptions::IllegalPluginDefinition, "Plugin file cannot contain any statements after the plugin definition"
       end
       plugin_class.sources << plugin_path

data/lib/ohai/mixin/command.rb

@@ -28,10 +28,23 @@ require "mixlib/shellout"
 module Ohai
   module Mixin
     module Command
-      def shell_out(cmd)
-        m = Mixlib::ShellOut.new(cmd)
-        m.run_command
-        m
+      # DISCLAIMER: Logging only works in the context of a plugin!!
+      # accept a command and any of the mixlib-shellout options
+      def shell_out(cmd, **options)
+        # unless specified by the caller timeout after 30 seconds
+        options[:timeout] ||= 30
+        so = Mixlib::ShellOut.new(cmd, options)
+        begin
+          so.run_command
+          Ohai::Log.debug("Plugin #{self.name} ran '#{cmd}' and returned #{so.exitstatus}")
+          so
+        rescue Errno::ENOENT => e
+          Ohai::Log.debug("Plugin #{self.name} ran '#{cmd}' and failed #{e.inspect}")
+          raise Ohai::Exceptions::Exec, e
+        rescue Mixlib::ShellOut::CommandTimeout => e
+          Ohai::Log.debug("Plugin #{self.name} ran '#{cmd}' and timed out after #{options[:timeout]} seconds")
+          raise Ohai::Exceptions::Exec, e
+        end
       end
 
       module_function :shell_out
@@ -70,7 +83,7 @@ module Ohai
 
           args[:returns] ||= 0
           args[:no_status_check] ||= false
-          if status.exitstatus != args[:returns] and not args[:no_status_check]
+          if status.exitstatus != args[:returns] && (not args[:no_status_check])
             raise Ohai::Exceptions::Exec, "#{args[:command_string]} returned #{status.exitstatus}, expected #{args[:returns]}"
           else
             Ohai::Log.debug("Ran #{args[:command_string]} (#{args[:command]}) returned #{status.exitstatus}")

data/lib/ohai/mixin/ec2_metadata.rb

@@ -140,7 +140,7 @@ module Ohai
                 else
                   metadata_get(key, api_version)
                 end
-            elsif not key.eql?(id) and not key.eql?("/")
+            elsif (not key.eql?(id)) && (not key.eql?("/"))
               name = key[0..-2]
               sym = metadata_key(name)
               if EC2_ARRAY_DIR.include?(name)

data/lib/ohai/plugins/aix/os.rb

@@ -25,6 +25,6 @@ Ohai.plugin(:OS) do
 
   collect_data(:aix) do
     os collect_os
-    os_version kernel[:version]
+    os_version shell_out("oslevel -s").stdout.strip
   end
 end

data/lib/ohai/plugins/c.rb

@@ -23,74 +23,64 @@ Ohai.plugin(:C) do
 
   depends "languages"
 
+  def collect(cmd, &block)
+    so = shell_out(cmd)
+    yield(so) if so.exitstatus == 0
+  rescue Ohai::Exceptions::Exec
+    # ignore
+  end
+
   collect_data do
     c = Mash.new
 
     #gcc
-    begin
-      so = shell_out("gcc -v")
-      if so.exitstatus == 0
-        description = so.stderr.split($/).last
-        output = description.split
-        if output.length >= 3
-          c[:gcc] = Mash.new
-          c[:gcc][:version] = output[2]
-          c[:gcc][:description] = description
-        end
+    collect("gcc -v") do |so|
+      description = so.stderr.split($/).last
+      output = description.split
+      if output.length >= 3
+        c[:gcc] = Mash.new
+        c[:gcc][:version] = output[2]
+        c[:gcc][:description] = description
       end
-    rescue Errno::ENOENT
     end
 
     #glibc
     ["/lib/libc.so.6", "/lib64/libc.so.6"].each do |glibc|
-      begin
-        so = shell_out( Ohai.abs_path( glibc ))
-        if so.exitstatus == 0
-          description = so.stdout.split($/).first
-          if description =~ /(\d+\.\d+\.?\d*)/
-            c[:glibc] = Mash.new
-            c[:glibc][:version] = $1
-            c[:glibc][:description] = description
-          end
-          break
+      collect( Ohai.abs_path( glibc )) do |so|
+        description = so.stdout.split($/).first
+        if description =~ /(\d+\.\d+\.?\d*)/
+          c[:glibc] = Mash.new
+          c[:glibc][:version] = $1
+          c[:glibc][:description] = description
         end
-      rescue Errno::ENOENT
-      end
+      end unless c[:glibc]
     end
 
     #ms cl
-    begin
-      so = shell_out("cl /?")
-      if so.exitstatus == 0
-        description = so.stderr.lines.first.chomp
-        if description =~ /Compiler Version ([\d\.]+)/
-          c[:cl] = Mash.new
-          c[:cl][:version] = $1
-          c[:cl][:description] = description
-        end
+    collect("cl /?") do |so|
+      description = so.stderr.lines.first.chomp
+      if description =~ /Compiler Version ([\d\.]+)/
+        c[:cl] = Mash.new
+        c[:cl][:version] = $1
+        c[:cl][:description] = description
       end
-    rescue Errno::ENOENT
     end
 
     #ms vs
-    begin
-      so = shell_out("devenv.com /?")
-      if so.exitstatus == 0
-        lines = so.stdout.split($/)
-        description = lines[0].length == 0 ? lines[1] : lines[0]
-        if description =~ /Visual Studio Version ([\d\.]+)/
-          c[:vs] = Mash.new
-          c[:vs][:version] = $1.chop
-          c[:vs][:description] = description
-        end
+    collect("devenv.com /?") do |so|
+      lines = so.stdout.split($/)
+      description = lines[0].length == 0 ? lines[1] : lines[0]
+      if description =~ /Visual Studio Version ([\d\.]+)/
+        c[:vs] = Mash.new
+        c[:vs][:version] = $1.chop
+        c[:vs][:description] = description
       end
-    rescue Errno::ENOENT
     end
 
     #ibm xlc
     begin
       so = shell_out("xlc -qversion")
-      if so.exitstatus == 0 or (so.exitstatus >> 8) == 249
+      if so.exitstatus == 0 || (so.exitstatus >> 8) == 249
         description = so.stdout.split($/).first
         if description =~ /V(\d+\.\d+)/
           c[:xlc] = Mash.new
@@ -98,36 +88,28 @@ Ohai.plugin(:C) do
           c[:xlc][:description] = description.strip
         end
       end
-    rescue Errno::ENOENT
+    rescue Ohai::Exceptions::Exec
     end
 
     #sun pro
-    begin
-      so = shell_out("cc -V -flags")
-      if so.exitstatus == 0
-        output = so.stderr.split
-        if so.stderr =~ /^cc: Sun C/ && output.size >= 4
-          c[:sunpro] = Mash.new
-          c[:sunpro][:version] = output[3]
-          c[:sunpro][:description] = so.stderr.chomp
-        end
+    collect("cc -V -flags") do |so|
+      output = so.stderr.split
+      if so.stderr =~ /^cc: Sun C/ && output.size >= 4
+        c[:sunpro] = Mash.new
+        c[:sunpro][:version] = output[3]
+        c[:sunpro][:description] = so.stderr.chomp
       end
-    rescue Errno::ENOENT
     end
 
     #hpux cc
-    begin
-      so = shell_out("what /opt/ansic/bin/cc")
-      if so.exitstatus == 0
-        description = so.stdout.split($/).select { |line| line =~ /HP C Compiler/ }.first
-        if description
-          output = description.split
-          c[:hpcc] = Mash.new
-          c[:hpcc][:version] = output[1] if output.size >= 1
-          c[:hpcc][:description] = description.strip
-        end
+    collect("what /opt/ansic/bin/cc") do |so|
+      description = so.stdout.split($/).select { |line| line =~ /HP C Compiler/ }.first
+      if description
+        output = description.split
+        c[:hpcc] = Mash.new
+        c[:hpcc][:version] = output[1] if output.size >= 1
+        c[:hpcc][:description] = description.strip
       end
-    rescue Errno::ENOENT
     end
 
     languages[:c] = c if c.keys.length > 0

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

@@ -30,7 +30,7 @@ Ohai.plugin(:Memory) do
     inactive = 0
     vm_stat = shell_out("vm_stat").stdout
     vm_stat_match = /page size of (\d+) bytes/.match(vm_stat)
-    page_size = if vm_stat_match and vm_stat_match[1]
+    page_size = if vm_stat_match && vm_stat_match[1]
                   vm_stat_match[1].to_i
                 else
                   4096

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

@@ -61,8 +61,8 @@ Ohai.plugin(:Network) do
 
   def scope_lookup(scope)
     return "Node" if scope.eql?("::1")
-    return "Link" if scope.match(/^fe80\:/)
-    return "Site" if scope.match(/^fec0\:/)
+    return "Link" if scope =~ /^fe80\:/
+    return "Site" if scope =~ /^fec0\:/
     "Global"
   end
 
@@ -73,7 +73,7 @@ Ohai.plugin(:Network) do
   def locate_interface(ifaces, ifname, mac)
     return ifname unless ifaces[ifname].nil?
     # oh well, time to go hunting!
-    return ifname.chop if ifname.match /\*$/
+    return ifname.chop if ifname =~ /\*$/
     ifaces.keys.each do |ifc|
       ifaces[ifc][:addresses].keys.each do |addr|
         return ifc if addr.eql? mac

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

@@ -26,7 +26,7 @@ Ohai.plugin(:Platform) do
       when /^ProductName:\s+(.+)$/
         macname = $1
         macname.downcase!
-        macname.gsub!(" ", "_")
+        macname.tr!(" ", "_")
         platform macname
       when /^ProductVersion:\s+(.+)$/
         platform_version $1

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

@@ -53,7 +53,7 @@ SPUSBData
 SPWWANData
 SPAirPortData},
         "full" => [
-                   "SPHardwareDataType"
+                   "SPHardwareDataType",
                   ],
       }
 

data/lib/ohai/plugins/digital_ocean.rb

@@ -43,7 +43,7 @@ Ohai.plugin(:DigitalOcean) do
     address_hash = Mash.new({
       "ip_address" => ip.address,
       "type" => private_address?(ip.address) ? "private" : "public",
-    },)
+    })
 
     if ip.ipv4?
       address_hash["netmask"] = details[:netmask]

data/lib/ohai/plugins/ec2.rb

@@ -2,6 +2,7 @@
 # Author:: Tim Dysinger (<tim@dysinger.net>)
 # Author:: Benjamin Black (<bb@chef.io>)
 # Author:: Christopher Brown (<cb@chef.io>)
+# Author:: Tim Smith (<tsmith@chef.io>)
 # Copyright:: Copyright (c) 2009-2016 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -17,6 +18,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# 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 data mentions amazon. This catches HVM instances in a VPC
+# 4. Kernel data mentioned Amazon. This catches Windows HVM & paravirt instances
+
 require "ohai/mixin/ec2_metadata"
 require "base64"
 
@@ -25,65 +32,59 @@ Ohai.plugin(:EC2) do
 
   provides "ec2"
 
-  depends "network/interfaces"
   depends "dmi"
-
-  # look for ec2metadata which is included on paravirt / hvm AMIs
-  def has_ec2metadata_bin?
-    if File.exist?("/usr/bin/ec2metadata")
-      Ohai::Log.debug("ec2 plugin: has_ec2metadata_bin? == true")
-      true
-    else
-      Ohai::Log.debug("ec2 plugin: has_ec2metadata_bin? == false")
-      false
-    end
-  end
-
-  # look for arp address that non-VPC hosts will have
-  def has_xen_mac?
-    network[:interfaces].values.each do |iface|
-      unless iface[:arp].nil?
-        if iface[:arp].value?("fe:ff:ff:ff:ff:ff")
-          # using MAC addresses from ARP is unreliable because they could time-out from the table
-          # fe:ff:ff:ff:ff:ff is actually a sign of Xen, not specifically EC2
-          deprecation_message <<-EOM
-ec2 plugin: Detected EC2 by the presence of fe:ff:ff:ff:ff:ff in the ARP table. This method is unreliable and will be removed in a future version of ohai. Bootstrap using knife-ec2 or create "/etc/chef/ohai/hints/ec2.json" instead.
-EOM
-          Ohai::Log.warn(deprecation_message)
-          Ohai::Log.debug("ec2 plugin: has_xen_mac? == true")
-          return true
-        end
-      end
-    end
-    Ohai::Log.debug("ec2 plugin: has_xen_mac? == false")
-    false
-  end
+  depends "kernel"
 
   # look for amazon string in dmi bios data
-  # this only works on hvm instances as paravirt instances have no dmi data
+  # this gets us detection of HVM instances that are within a VPC
   def has_ec2_dmi?
     begin
       # detect a version of '4.2.amazon'
       if dmi[:bios][:all_records][0][:Version] =~ /amazon/
         Ohai::Log.debug("ec2 plugin: has_ec2_dmi? == true")
-        true
+        return true
       end
     rescue NoMethodError
-      Ohai::Log.debug("ec2 plugin: has_ec2_dmi? == false")
-      false
+      # dmi[:bios][:all_records][0][:Version] may not exist
+    end
+    Ohai::Log.debug("ec2 plugin: has_ec2_dmi? == false")
+    return false
+  end
+
+  # 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.exist?("/sys/hypervisor/uuid")
+      if ::File.read("/sys/hypervisor/uuid") =~ /^ec2/
+        Ohai::Log.debug("ec2 plugin: has_ec2_xen_uuid? == true")
+        return true
+      end
     end
+    Ohai::Log.debug("ec2 plugin: has_ec2_xen_uuid? == false")
+    return false
   end
 
-  # rackspace systems look like ec2 so instead of timing out dig a bit deeper
-  def looks_like_rackspace?
-    return true if File.exist?("/usr/bin/rackspace-monitoring-agent")
+  # looks for the Amazon.com Organization in Windows Kernel data
+  # this gets us detection of Windows systems
+  def has_amazon_org?
+    begin
+      # detect an Organization of 'Amazon.com'
+      if kernel[:os_info][:organization] =~ /Amazon/
+        Ohai::Log.debug("ec2 plugin: has_amazon_org? == true")
+        return true
+      end
+    rescue NoMethodError
+      # kernel[:os_info][:organization] may not exist
+    end
+    Ohai::Log.debug("ec2 plugin: has_amazon_org? == false")
+    return false
   end
 
   def looks_like_ec2?
     return true if hint?("ec2")
 
     # Even if it looks like EC2 try to connect first
-    if has_ec2_dmi? || has_xen_mac? || (has_ec2metadata_bin? && !looks_like_rackspace?)
+    if has_ec2_xen_uuid? || has_ec2_dmi? || has_amazon_org?
       return true if can_metadata_connect?(Ohai::Mixin::Ec2Metadata::EC2_METADATA_ADDR, 80)
     end
   end
@@ -100,7 +101,7 @@ EOM
         next if k == "iam" && !hint?("iam")
         ec2[k] = v
       end
-      ec2[:userdata] = self.fetch_userdata
+      ec2[:userdata] = fetch_userdata
       # ASCII-8BIT is equivalent to BINARY in this case
       if ec2[:userdata] && ec2[:userdata].encoding.to_s == "ASCII-8BIT"
         Ohai::Log.debug("ec2 plugin: Binary UserData Found. Storing in base64")