ohai 8.10.0 → 8.11.1

data/lib/ohai/mixin/command.rb

@@ -16,14 +16,14 @@
 # limitations under the License.
 #
 
-require 'ohai/exception'
-require 'ohai/config'
-require 'ohai/log'
-require 'stringio'
-require 'tmpdir'
-require 'fcntl'
-require 'etc'
-require 'mixlib/shellout'
+require "ohai/exception"
+require "ohai/config"
+require "ohai/log"
+require "stringio"
+require "tmpdir"
+require "fcntl"
+require "etc"
+require "mixlib/shellout"
 
 module Ohai
   module Mixin
@@ -36,7 +36,8 @@ module Ohai
 
       module_function :shell_out
 
-      def run_command(args={})
+      def run_command(args = {})
+        Ohai::Log.warn("Ohai::Mixin::Command run_command is deprecated and will be removed in Ohai 9.0.0")
         if args.has_key?(:creates)
           if File.exists?(args[:creates])
             Ohai::Log.debug("Skipping #{args[:command]} - creates #{args[:creates]} exists.")
@@ -123,12 +124,13 @@ module Ohai
       # The original appears in external/open4.rb in its unmodified form.
       #
       # Thanks Ara!
-      def popen4(cmd, args={}, &b)
+      def popen4(cmd, args = {}, &b)
+        Ohai::Log.warn("Ohai::Mixin::Command popen4 is deprecated and will be removed in Ohai 9.0.0")
 
-	## Disable garbage collection to work around possible bug in MRI
-  # Ruby 1.8 suffers from intermittent segfaults believed to be due to GC while IO.select
-  # See OHAI-330 / CHEF-2916 / CHEF-1305
-	GC.disable
+        # Disable garbage collection to work around possible bug in MRI
+        # Ruby 1.8 suffers from intermittent segfaults believed to be due to GC while IO.select
+        # See OHAI-330 / CHEF-2916 / CHEF-1305
+        GC.disable
 
         # Waitlast - this is magic.
         #
@@ -189,7 +191,7 @@ module Ohai
               Process.uid = args[:user]
             end
 
-            args[:environment].each do |key,value|
+            args[:environment].each do |key, value|
               ENV[key] = value
             end
 
@@ -204,19 +206,19 @@ module Ohai
               else
                 exec(cmd)
               end
-              raise 'forty-two'
+              raise "forty-two"
             rescue Exception => e
               Marshal.dump(e, ps.last)
               ps.last.flush
             end
-            ps.last.close unless (ps.last.closed?)
+            ps.last.close unless ps.last.closed?
             exit!
           }
         ensure
           $VERBOSE = verbose
         end
 
-        [pw.first, pr.last, pe.last, ps.last].each{|fd| fd.close}
+        [pw.first, pr.last, pe.last, ps.last].each { |fd| fd.close }
 
         begin
           e = Marshal.load ps.first
@@ -325,15 +327,15 @@ module Ohai
               # have encoding methods.
               if "".respond_to?(:force_encoding) && defined?(Encoding)
                 o.string.force_encoding(Encoding.default_external)
-                o.string.encode!('UTF-8', :invalid => :replace, :undef => :replace, :replace => '?')
+                o.string.encode!("UTF-8", :invalid => :replace, :undef => :replace, :replace => "?")
                 e.string.force_encoding(Encoding.default_external)
-                e.string.encode!('UTF-8', :invalid => :replace, :undef => :replace, :replace => '?')
+                e.string.encode!("UTF-8", :invalid => :replace, :undef => :replace, :replace => "?")
               end
               b[cid, pi[0], o, e]
               results.last
             end
           ensure
-            pi.each{|fd| fd.close unless fd.closed?}
+            pi.each { |fd| fd.close unless fd.closed? }
           end
         else
           [cid, pw.last, pr.first, pe.first]
@@ -341,8 +343,8 @@ module Ohai
       rescue Errno::ENOENT
         raise Ohai::Exceptions::Exec, "command #{cmd} doesn't exist or is not in the PATH"
       ensure
-	# we disabled GC entering
-	GC.enable
+        # we disabled GC entering
+        GC.enable
       end
 
       module_function :popen4

data/lib/ohai/mixin/dmi_decode.rb

@@ -22,24 +22,24 @@ module ::Ohai::Mixin::DmiDecode
       case line
       when /Manufacturer: Microsoft/
         if dmi_data =~ /Product Name: Virtual Machine/
-          if dmi_data =~ /Version: (VS2005R2|6.0)/
-            return 'virtualpc'
-          elsif dmi_data =~ /Version: (7.0|Hyper-V)/
-            return 'hyperv'
+          if dmi_data =~ /Version: (7.0|Hyper-V)/
+            return "hyperv"
+          elsif dmi_data =~ /Version: (VS2005R2|6.0)/
+            return "virtualpc"
           elsif dmi_data =~ /Version: 5.0/
-            return 'virtualserver'
+            return "virtualserver"
           end
         end
       when /Manufacturer: VMware/
-        return 'vmware'
+        return "vmware"
       when /Manufacturer: Xen/
-        return 'xen'
+        return "xen"
       when /Product Name: VirtualBox/
-        return 'vbox'
+        return "vbox"
       when /Product Name: OpenStack/
-        return 'openstack'
+        return "openstack"
       when /Manufacturer: QEMU|Product Name: (KVM|RHEV)/
-        return 'kvm'
+        return "kvm"
       end
     end
     return nil

data/lib/ohai/mixin/ec2_metadata.rb

@@ -17,8 +17,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'net/http'
-require 'socket'
+require "net/http"
+require "socket"
 
 module Ohai
   module Mixin
@@ -41,14 +41,15 @@ module Ohai
     module Ec2Metadata
 
       EC2_METADATA_ADDR = "169.254.169.254" unless defined?(EC2_METADATA_ADDR)
-      EC2_SUPPORTED_VERSIONS = %w[ 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15
-                                   2008-02-01 2008-09-01 2009-04-04 2011-01-01 2011-05-01 2012-01-12 ]
+      EC2_SUPPORTED_VERSIONS = %w{ 1.0 2007-01-19 2007-03-01 2007-08-29 2007-10-10 2007-12-15
+                                   2008-02-01 2008-09-01 2009-04-04 2011-01-01 2011-05-01 2012-01-12
+                                   2014-11-05 2014-02-25 }
 
-      EC2_ARRAY_VALUES = %w(security-groups)
-      EC2_ARRAY_DIR    = %w(network/interfaces/macs)
-      EC2_JSON_DIR     = %w(iam)
+      EC2_ARRAY_VALUES = %w{security-groups}
+      EC2_ARRAY_DIR    = %w{network/interfaces/macs}
+      EC2_JSON_DIR     = %w{iam}
 
-      def can_metadata_connect?(addr, port, timeout=2)
+      def can_metadata_connect?(addr, port, timeout = 2)
         t = Socket.new(Socket::Constants::AF_INET, Socket::Constants::SOCK_STREAM, 0)
         saddr = Socket.pack_sockaddr_in(port, addr)
         connected = false
@@ -56,7 +57,7 @@ module Ohai
         begin
           t.connect_nonblock(saddr)
         rescue Errno::EINPROGRESS
-          r,w,e = IO::select(nil,[t],nil,timeout)
+          r, w, e = IO.select(nil, [t], nil, timeout)
           if !w.nil?
             connected = true
           else
@@ -70,27 +71,27 @@ module Ohai
           end
         rescue SystemCallError
         end
-        Ohai::Log.debug("can_metadata_connect? == #{connected}")
+        Ohai::Log.debug("ec2 metadata mixin: can_metadata_connect? == #{connected}")
         connected
       end
 
       def best_api_version
         response = http_client.get("/")
-        if response.code == '404'
-          Ohai::Log.debug("Received HTTP 404 from metadata server while determining API version, assuming 'latest'")
+        if response.code == "404"
+          Ohai::Log.debug("ec2 metadata mixin: Received HTTP 404 from metadata server while determining API version, assuming 'latest'")
           return "latest"
-        elsif response.code != '200'
+        elsif response.code != "200"
           raise "Unable to determine EC2 metadata version (returned #{response.code} response)"
         end
         # Note: Sorting the list of versions may have unintended consequences in
         # non-EC2 environments. It appears to be safe in EC2 as of 2013-04-12.
         versions = response.body.split("\n")
         versions = response.body.split("\n").sort
-        until (versions.empty? || EC2_SUPPORTED_VERSIONS.include?(versions.last)) do
+        until versions.empty? || EC2_SUPPORTED_VERSIONS.include?(versions.last)
           pv = versions.pop
-          Ohai::Log.debug("EC2 shows unsupported metadata version: #{pv}") unless pv == 'latest'
+          Ohai::Log.debug("ec2 metadata mixin: EC2 shows unsupported metadata version: #{pv}") unless pv == "latest"
         end
-        Ohai::Log.debug("EC2 metadata version: #{versions.last}")
+        Ohai::Log.debug("ec2 metadata mixin: EC2 metadata version: #{versions.last}")
         if versions.empty?
           raise "Unable to determine EC2 metadata version (no supported entries found)"
         end
@@ -98,7 +99,7 @@ module Ohai
       end
 
       def http_client
-        Net::HTTP.start(EC2_METADATA_ADDR).tap {|h| h.read_timeout = 600}
+        Net::HTTP.start(EC2_METADATA_ADDR).tap { |h| h.read_timeout = 30 }
       end
 
       # Get metadata for a given path and API version
@@ -112,26 +113,26 @@ module Ohai
         path = "/#{api_version}/meta-data/#{id}"
         response = http_client.get(path)
         case response.code
-        when '200'
+        when "200"
           response.body
-        when '404'
-          Ohai::Log.debug("Encountered 404 response retreiving EC2 metadata path: #{path} ; continuing.")
+        when "404"
+          Ohai::Log.debug("ec2 metadata mixin: Encountered 404 response retreiving EC2 metadata path: #{path} ; continuing.")
           nil
         else
           raise "Encountered error retrieving EC2 metadata (#{path} returned #{response.code} response)"
         end
       end
 
-      def fetch_metadata(id='', api_version=nil)
+      def fetch_metadata(id = "", api_version = nil)
         api_version ||= best_api_version
-        return Hash.new if api_version.nil?
+        return {} if api_version.nil?
 
-        metadata = Hash.new
+        metadata = {}
         retrieved_metadata = metadata_get(id, api_version)
         if retrieved_metadata
           retrieved_metadata.split("\n").each do |o|
             key = expand_path("#{id}#{o}")
-            if key[-1..-1] != '/'
+            if key[-1..-1] != "/"
               metadata[metadata_key(key)] =
                 if EC2_ARRAY_VALUES.include? key
                   retr_meta = metadata_get(key, api_version)
@@ -139,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) and not key.eql?("/")
               name = key[0..-2]
               sym = metadata_key(name)
               if EC2_ARRAY_DIR.include?(name)
@@ -147,7 +148,7 @@ module Ohai
               elsif EC2_JSON_DIR.include?(name)
                 metadata[sym] = fetch_json_dir_metadata(key, api_version)
               else
-                fetch_metadata(key, api_version).each{|k,v| metadata[k] = v}
+                fetch_metadata(key, api_version).each { |k, v| metadata[k] = v }
               end
             end
           end
@@ -161,10 +162,10 @@ module Ohai
         if retrieved_metadata
           retrieved_metadata.split("\n").each do |o|
             key = expand_path(o)
-            if key[-1..-1] != '/'
+            if key[-1..-1] != "/"
               retr_meta = metadata_get("#{id}#{key}", api_version)
-              metadata[metadata_key(key)] = retr_meta ? retr_meta : ''
-            elsif not key.eql?('/')
+              metadata[metadata_key(key)] = retr_meta ? retr_meta : ""
+            elsif not key.eql?("/")
               metadata[key[0..-2]] = fetch_dir_metadata("#{id}#{key}", api_version)
             end
           end
@@ -173,18 +174,18 @@ module Ohai
       end
 
       def fetch_json_dir_metadata(id, api_version)
-        metadata = Hash.new
+        metadata = {}
         retrieved_metadata = metadata_get(id, api_version)
         if retrieved_metadata
           retrieved_metadata.split("\n").each do |o|
             key = expand_path(o)
-            if key[-1..-1] != '/'
+            if key[-1..-1] != "/"
               retr_meta = metadata_get("#{id}#{key}", api_version)
-              data = retr_meta ? retr_meta : ''
+              data = retr_meta ? retr_meta : ""
               json = StringIO.new(data)
               parser = FFI_Yajl::Parser.new
               metadata[metadata_key(key)] = parser.parse(json)
-            elsif not key.eql?('/')
+            elsif not key.eql?("/")
               metadata[key[0..-2]] = fetch_json_dir_metadata("#{id}#{key}", api_version)
             end
           end
@@ -192,7 +193,7 @@ module Ohai
         end
       end
 
-      def fetch_userdata()
+      def fetch_userdata
         api_version = best_api_version
         return nil if api_version.nil?
         response = http_client.get("/#{api_version}/user-data/")
@@ -202,15 +203,15 @@ module Ohai
       private
 
       def expand_path(file_name)
-        path = file_name.gsub(/\=.*$/, '/')
+        path = file_name.gsub(/\=.*$/, "/")
         # ignore "./" and "../"
-        path.gsub(%r{/\.\.?(?:/|$)}, '/').
-          sub(%r{^\.\.?(?:/|$)}, '').
-          sub(%r{^$}, '/')
+        path.gsub(%r{/\.\.?(?:/|$)}, "/").
+          sub(%r{^\.\.?(?:/|$)}, "").
+          sub(%r{^$}, "/")
       end
 
       def metadata_key(key)
-        key.gsub(/\-|\//, '_')
+        key.gsub(/\-|\//, "_")
       end
 
     end

data/lib/ohai/mixin/gce_metadata.rb

@@ -14,8 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'net/http'
-require 'socket'
+require "net/http"
+require "socket"
 
 module Ohai
   module Mixin
@@ -25,7 +25,7 @@ module Ohai
       GCE_METADATA_ADDR = "metadata.google.internal." unless defined?(GCE_METADATA_ADDR)
       GCE_METADATA_URL = "/computeMetadata/v1beta1/?recursive=true" unless defined?(GCE_METADATA_URL)
 
-      def can_metadata_connect?(addr, port, timeout=2)
+      def can_metadata_connect?(addr, port, timeout = 2)
         t = Socket.new(Socket::Constants::AF_INET, Socket::Constants::SOCK_STREAM, 0)
         saddr = Socket.pack_sockaddr_in(port, addr)
         connected = false
@@ -33,7 +33,7 @@ module Ohai
         begin
           t.connect_nonblock(saddr)
         rescue Errno::EINPROGRESS
-          r,w,e = IO::select(nil,[t],nil,timeout)
+          r, w, e = IO.select(nil, [t], nil, timeout)
           if !w.nil?
             connected = true
           else
@@ -52,10 +52,10 @@ module Ohai
       end
 
       def http_client
-        Net::HTTP.start(GCE_METADATA_ADDR).tap {|h| h.read_timeout = 6}
+        Net::HTTP.start(GCE_METADATA_ADDR).tap { |h| h.read_timeout = 6 }
       end
 
-      def fetch_metadata(id='')
+      def fetch_metadata(id = "")
         uri = "#{GCE_METADATA_URL}/#{id}"
         response = http_client.get(uri)
         return nil unless response.code == "200"
@@ -64,8 +64,8 @@ module Ohai
           data = StringIO.new(response.body)
           parser = FFI_Yajl::Parser.new
           parser.parse(data)
-        elsif  has_trailing_slash?(id) or (id == '')
-          temp={}
+        elsif has_trailing_slash?(id) or (id == "")
+          temp = {}
           response.body.split("\n").each do |sub_attr|
             temp[sanitize_key(sub_attr)] = fetch_metadata("#{id}#{sub_attr}")
           end
@@ -95,7 +95,7 @@ module Ohai
       end
 
       def sanitize_key(key)
-        key.gsub(/\-|\//, '_')
+        key.gsub(/\-|\//, "_")
       end
     end
   end

data/lib/ohai/mixin/network_constants.rb

@@ -22,7 +22,7 @@ module Ohai
     module NetworkConstants
       FAMILIES = {
         "inet" => "default",
-        "inet6" => "default_inet6"
+        "inet6" => "default_inet6",
       }
 
       # From sigar: include/sigar.h sigar_net_route_t

data/lib/ohai/mixin/os.rb

@@ -17,14 +17,14 @@
 # limitations under the License.
 #
 
-require 'rbconfig'
+require "rbconfig"
 
 module Ohai
   module Mixin
     module OS
 
       def collect_os
-        case ::RbConfig::CONFIG['host_os']
+        case ::RbConfig::CONFIG["host_os"]
         when /aix(.+)$/
           return "aix"
         when /darwin(.+)$/
@@ -51,7 +51,7 @@ module Ohai
           # subsystems.
           return "windows"
         else
-          return ::RbConfig::CONFIG['host_os']
+          return ::RbConfig::CONFIG["host_os"]
         end
       end
 

data/lib/ohai/mixin/seconds_to_human.rb

@@ -44,5 +44,3 @@ module Ohai
     end
   end
 end
-
-

data/lib/ohai/mixin/softlayer_metadata.rb

@@ -17,20 +17,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'net/https'
-require 'uri'
+require "net/https"
+require "uri"
 
 # http://sldn.softlayer.com/reference/services/SoftLayer_Resource_Metadata
 module ::Ohai::Mixin::SoftlayerMetadata
-  SOFTLAYER_API_QUERY_URL = 'https://api.service.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata' unless defined?(SOFTLAYER_API_QUERY_URL)
+  SOFTLAYER_API_QUERY_URL = "https://api.service.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata" unless defined?(SOFTLAYER_API_QUERY_URL)
 
   def fetch_metadata
-    metadata  = {
-      'public_fqdn'   => fetch_metadata_item("getFullyQualifiedDomainName.txt"),
-      'local_ipv4'    => fetch_metadata_item("getPrimaryBackendIpAddress.txt"),
-      'public_ipv4'   => fetch_metadata_item("getPrimaryIpAddress.txt"),
-      'region'        => fetch_metadata_item("getDatacenter.txt"),
-      'instance_id'   => fetch_metadata_item("getId.txt")
+    metadata = {
+      "public_fqdn"   => fetch_metadata_item("getFullyQualifiedDomainName.txt"),
+      "local_ipv4"    => fetch_metadata_item("getPrimaryBackendIpAddress.txt"),
+      "public_ipv4"   => fetch_metadata_item("getPrimaryIpAddress.txt"),
+      "region"        => fetch_metadata_item("getDatacenter.txt"),
+      "instance_id"   => fetch_metadata_item("getId.txt"),
     }
   end
 
@@ -51,7 +51,7 @@ module ::Ohai::Mixin::SoftlayerMetadata
     net.use_ssl = true
     net.ca_file = ca_file_location
     res = net.get(u.request_uri)
-    if res.code.to_i.between?(200,299)
+    if res.code.to_i.between?(200, 299)
       res.body
     else
       ::Ohai::Log.error("Unable to fetch item #{full_url}: status (#{res.code}) body (#{res.body})")