ohai 16.5.4 → 16.8.1

data/lib/ohai/mixin/gce_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Ranjib Dey (<dey.ranjib@gmail.com>)
 # License:: Apache License, Version 2.0
@@ -21,8 +22,8 @@ module Ohai
     module GCEMetadata
 
       # Trailing dot to host is added to avoid DNS search path
-      GCE_METADATA_ADDR ||= "metadata.google.internal.".freeze
-      GCE_METADATA_URL ||= "/computeMetadata/v1/?recursive=true".freeze
+      GCE_METADATA_ADDR ||= "metadata.google.internal."
+      GCE_METADATA_URL ||= "/computeMetadata/v1/?recursive=true"
 
       # fetch the meta content with a timeout and the required header
       def http_get(uri)
@@ -71,7 +72,7 @@ module Ohai
       #
       # @return [Boolean] is there a trailing /?
       def has_trailing_slash?(data)
-        !! ( data =~ %r{/$} )
+        !!( data =~ %r{/$} )
       end
 
       def sanitize_key(key)

data/lib/ohai/mixin/http_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0

data/lib/ohai/mixin/network_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.

data/lib/ohai/mixin/os.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.
@@ -27,6 +28,71 @@ module Ohai
       #
       # @return [String] the OS
       def collect_os
+        if target_mode?
+          collect_os_target
+        else
+          collect_os_local
+        end
+      end
+
+      # This should exactly preserve the semantics of collect_os_local below, which is authoritative
+      # for the API and must adhere to pre-existing ohai semantics and not follow inspec's notion of
+      # os/family/hierarchy.
+      #
+      # Right or wrong the ohai `os` variable has matched the ruby `host_os` definition for the past
+      # 10+ years, preceding inspec/train's definitions and this is the documented correct API of
+      # these methods.  Mismatches between the ruby notion and the train version will be fixed as
+      # bugfixes in these methods and may not be considered semver violating even though they make
+      # break downstream consumers.  Please ensure that both methods produce the same results if
+      # you are on a platform which supports running ruby (train is considered authoritative for
+      # any "OS" which cannot run ruby -- server consoles, REST APIs, etc...)
+      #
+      # @api private
+      def collect_os_target
+        case
+        when transport_connection.os.aix?
+          "aix"
+        when transport_connection.os.darwin?
+          "darwin"
+        when transport_connection.os.linux?
+          "linux"
+        when transport_connection.os.family == "freebsd"
+          "freebsd"
+        when transport_connection.os.family == "openbsd"
+          "openbsd"
+        when transport_connection.os.family == "netbsd"
+          "netbsd"
+        when transport_connection.os.family == "dragonflybsd"
+          "dragonflybsd"
+        when transport_connection.os.solaris?
+          "solaris2"
+        when transport_connection.os.windows?
+          "windows"
+
+          #
+          # The purpose of the next two lines is that anything which runs Unix is presumed to be able to run ruby, and
+          # if it was not caught above, we MUST translate whatever train uses as the 'os' into the proper ruby host_os
+          # string.  If it is not unix and not caught above we assume it is something like a REST API which cannot run
+          # ruby.  If these assumptions are incorrect then it is a bug, which should be submitted to fix it, and the
+          # values should not be relied upon until that bug is fixed.  The train os is NEVER considered authoritative
+          # for any target which can run ruby.
+          #
+        when transport_connection.os.unix?
+          raise "Target mode unsupported on this Unix-like host, please update the collect_os_target case statement with the correct ruby host_os value."
+        else
+          # now we have something like an IPMI console that isn't Unix-like or Windows, presumably cannot run ruby, and
+          # so we just trust the train O/S information.
+          transport_connection.os
+        end
+      end
+
+      # @api private
+      def nonruby_target?
+        transport_connection && !transport_connection.os.unix? && !transport_connection.os.windows
+      end
+
+      # @api private
+      def collect_os_local
         case ::RbConfig::CONFIG["host_os"]
         when /aix(.+)$/
           "aix"
@@ -56,7 +122,7 @@ module Ohai
         end
       end
 
-      module_function :collect_os
+      extend self
     end
   end
 end

data/lib/ohai/mixin/scaleway_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Jonathan Amiez (<jonathan.amiez@gmail.com>)
 # License:: Apache License, Version 2.0
@@ -20,8 +21,8 @@ module Ohai
   module Mixin
     module ScalewayMetadata
 
-      SCALEWAY_METADATA_ADDR ||= "169.254.42.42".freeze
-      SCALEWAY_METADATA_URL ||= "/conf?format=json".freeze
+      SCALEWAY_METADATA_ADDR ||= "169.254.42.42"
+      SCALEWAY_METADATA_URL ||= "/conf?format=json"
 
       # @return [Net::HTTP] net/http object without timeout set to 6
       def http_client

data/lib/ohai/mixin/seconds_to_human.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.

data/lib/ohai/mixin/shell_out.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Tim Smith (<tsmith@chef.io>)

data/lib/ohai/mixin/softlayer_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Alexey Karpik <alexey.karpik@rightscale.com>
 # Author:: Peter Schroeter <peter.schroeter@rightscale.com>
@@ -22,7 +23,7 @@ require "uri" unless defined?(URI)
 
 # https://softlayer.github.io/reference/services/SoftLayer_Resource_Metadata/
 module ::Ohai::Mixin::SoftlayerMetadata
-  SOFTLAYER_API_QUERY_URL ||= "https://api.service.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata".freeze
+  SOFTLAYER_API_QUERY_URL ||= "https://api.service.softlayer.com/rest/v3.1/SoftLayer_Resource_Metadata"
 
   # fetch metadata items and build out hash of data
   #

data/lib/ohai/mixin/string.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: James Gartrell (<jgartrel@gmail.com>)
 # Copyright:: Copyright (c) Chef Software Inc.

data/lib/ohai/mixin/train_helpers.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+#
+# Copyright:: Copyright (c) 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.
+
+require "chef-utils/dsl/train_helpers" unless defined?(ChefUtils::DSL::TrainHelpers)
+require_relative "chef_utils_wiring" unless defined?(Ohai::Mixin::ChefUtilsWiring)
+
+module Ohai
+  module Mixin
+    module TrainHelpers
+      include ChefUtils::DSL::TrainHelpers
+      include ChefUtilsWiring
+
+      # anything added to this file temporarily should be pushed back up
+      # into ChefUtils::DSL::TrainHelpers
+
+      # XXX: this needs better support directly in train
+      def dir_glob(path)
+        shell_out!("ls -d #{path}").stdout.split
+      end
+    end
+  end
+end

data/lib/ohai/mixin/which.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0

data/lib/ohai/plugin_config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Joshua Timberman <joshua@chef.io>
 # Author:: Isa Farnik (<isa@chef.io>)
@@ -23,10 +24,12 @@ Ohai.plugin(:Kernel) do
   collect_data(:aix) do
     kernel Mash.new
 
-    kernel[:name] =    shell_out("uname -s").stdout.split($/)[0].downcase
-    kernel[:release] = shell_out("uname -r").stdout.split($/)[0]
-    kernel[:version] = shell_out("uname -v").stdout.split($/)[0]
-    kernel[:machine] = shell_out("uname -p").stdout.split($/)[0]
+    uname_so = shell_out("uname -rvp").stdout.split
+
+    kernel[:name] =    "aix" # this is here for historical reasons, but it's always aix
+    kernel[:release] = uname_so[0]
+    kernel[:version] = uname_so[1]
+    kernel[:machine] = uname_so[2]
     kernel[:bits] =    shell_out("getconf KERNEL_BITMODE").stdout.strip
 
     modules = Mash.new

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Joshua Timberman <joshua@chef.io>
 # Author:: Isa Farnik (<isa@chef.io>)
@@ -24,10 +25,10 @@ Ohai.plugin(:Memory) do
     memory Mash.new
     memory[:swap] = Mash.new
 
-    meminfo = shell_out("svmon -G -O unit=MB,summary=longreal | grep '[0-9]'").stdout
+    meminfo = shell_out("svmon -G -O unit=KB,summary=longreal | grep '[0-9]'").stdout
     total_in_mb, _u, free_in_mb = meminfo.split
-    memory[:total] = "#{total_in_mb.to_i * 1024}kB"
-    memory[:free] = "#{free_in_mb.to_i * 1024}kB"
+    memory[:total] = "#{total_in_mb.to_i}kB"
+    memory[:free] = "#{free_in_mb.to_i}kB"
 
     swap_info = shell_out("swap -s").stdout.split # returns swap info in 4K blocks
     memory[:swap]["total"] = "#{swap_info[2].to_i * 4}kB"

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Kaustubh Deorukhkar (<kaustubh@clogeny.com>)
 # Author:: Prabhu Das (<prabhu.das@clogeny.com>)
@@ -21,7 +22,7 @@
 Ohai.plugin(:Network) do
   require_relative "../../mixin/network_helper"
 
-  provides "network", "counters/network", "macaddress"
+  provides "network", "network/interfaces", "counters/network", "macaddress"
 
   include Ohai::Mixin::NetworkHelper
 
@@ -37,46 +38,44 @@ Ohai.plugin(:Network) do
     # => state up/down (ifconfig/lsattr)
     # => arp (arp -an)
 
-    iface = Mash.new
+    ifaces = Mash.new
 
     network Mash.new unless network
-    network[:interfaces] ||= Mash.new
 
     # We unfortunately have to do things a bit different here, if ohai is running
     # within a WPAR. For instance, the WPAR isn't aware of some of its own networking
-    # minutia such as default gateway/route.
+    # minutia such as default gateway/route. lpars return 0 here. wpars return > 0
     unless shell_out("uname -W").stdout.to_i > 0
       # :default_interface, :default_gateway - route -n get 0
-      so = shell_out("netstat -rn |grep default")
-      so.stdout.lines.each do |line|
-        items = line.split(" ")
-        if items[0] == "default"
-          network[:default_gateway] = items[1]
-          network[:default_interface] = items[5]
-        end
-      end
+      default_line = shell_out("netstat -rn")
+        .stdout
+        .each_line
+        .detect { |l| l.start_with?("default") }
+        .split
+      network[:default_gateway] = default_line[1]
+      network[:default_interface] = default_line[5]
     end
 
-    # Splits the ifconfig output to 1 line per interface
-    if_so = shell_out("ifconfig -a")
-    if_so.stdout.gsub(/\n(\w+\d+)/, '___\1').split("___").each do |intraface|
-      splat = intraface.split(":")
-      interface = splat[0]
-      line = splat[1..-1][0]
-      iface[interface] = Mash.new
-      iface[interface][:state] = (line.include?("<UP,") ? "up" : "down")
-
-      intraface.lines.each do |lin|
-        case lin
+    # Splits the ifconfig output into arrays of interface strings
+    shell_out("ifconfig -a").stdout.split(/\n(?=\w)/).each do |int_lines|
+      int_name, int_data = int_lines.split(":", 2)
+
+      ifaces[int_name] = Mash.new
+      ifaces[int_name][:addresses] ||= Mash.new
+      ifaces[int_name][:state] = (int_data.include?("<UP,") ? "up" : "down")
+
+      int_data.each_line do |line|
+        case line
         when /flags=\S+<(\S+)>/
-          iface[interface][:flags] = $1.split(",")
-          iface[interface][:metric] = $1 if lin =~ /metric\s(\S+)/
+          ifaces[int_name][:flags] = $1.split(",")
+          ifaces[int_name][:metric] = $1 if line =~ /metric\s(\S+)/
         else
           # We have key value pairs.
-          if lin =~ %r{inet (\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})(/(\d{1,2}))?}
-            tmp_addr, tmp_prefix = $1, $3
+          if line =~ %r{inet (\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})(/(\d{1,2}))?}
+            tmp_addr = $1
+            tmp_prefix = $3
             if tmp_prefix.nil?
-              netmask = hex_to_dec_netmask($1) if lin =~ /netmask\s0x(\S+)\s/
+              netmask = hex_to_dec_netmask($1) if line =~ /netmask\s0x(\S+)\s/
               unless netmask
                 tmp_prefix ||= "32"
                 netmask = IPAddr.new("255.255.255.255").mask(tmp_prefix.to_i).to_s
@@ -85,57 +84,51 @@ Ohai.plugin(:Network) do
               netmask = IPAddr.new("255.255.255.255").mask(tmp_prefix.to_i).to_s
             end
 
-            iface[interface][:addresses] ||= Mash.new
-            iface[interface][:addresses][tmp_addr] = { "family" => "inet", "prefixlen" => tmp_prefix }
-            iface[interface][:addresses][tmp_addr][:netmask] = netmask
+            ifaces[int_name][:addresses][tmp_addr] = { "family" => "inet", "prefixlen" => tmp_prefix }
+            ifaces[int_name][:addresses][tmp_addr][:netmask] = netmask
 
-            if lin =~ /broadcast\s(\S+)\s/
-              iface[interface][:addresses][tmp_addr][:broadcast] = $1
+            if line =~ /broadcast\s(\S+)\s/
+              ifaces[int_name][:addresses][tmp_addr][:broadcast] = $1
             end
-          elsif lin =~ %r{inet6 ([a-f0-9\:]+)%?([\d]*)/?(\d*)?}
-            # TODO do we have more properties on inet6 in aix? broadcast
-            iface[interface][:addresses] ||= Mash.new
-            iface[interface][:addresses][$1] = { "family" => "inet6", "zone_index" => $2, "prefixlen" => $3 }
+          elsif line =~ %r{inet6 ([a-f0-9\:]+)%?(\d*)/?(\d*)?}
+            # TODO: do we have more properties on inet6 in aix? broadcast
+            ifaces[int_name][:addresses] ||= Mash.new
+            ifaces[int_name][:addresses][$1] = { "family" => "inet6", "zone_index" => $2, "prefixlen" => $3 }
           else
-            # load all key-values, example "tcp_sendspace 131072 tcp_recvspace 131072 rfc1323 1"
-            properties = lin.split
-            n = properties.length / 2 - 1
-            (0..n).each do |i|
-              iface[interface][properties[i * 2]] = properties[(i * 2 + 1)]
+            # add all key value data into the interface mash
+            # for example "tcp_sendspace 131072 tcp_recvspace 131072 rfc1323 1"
+            # has keys tcp_sendspace, tcp_recvspace, and rfc1323
+            line.split.each_slice(2) do |key, value|
+              ifaces[int_name][key] = value
             end
           end
         end
       end
 
       # Query macaddress
-      e_so = shell_out("entstat -d #{interface} | grep \"Hardware Address\"")
-      iface[interface][:addresses] ||= Mash.new
-      e_so.stdout.lines.each do |l|
-        if l =~ /Hardware Address: (\S+)/
-          iface[interface][:addresses][$1.upcase] = { "family" => "lladdr" }
-          macaddress $1.upcase unless shell_out("uname -W").stdout.to_i > 0
-        end
+      shell_out("entstat -d #{int_name}").stdout =~ /Hardware Address: (\S+)/
+      if $1
+        ifaces[int_name][:addresses][$1.upcase] = { "family" => "lladdr" }
+        macaddress $1.upcase unless shell_out("uname -W").stdout.to_i > 0
       end
     end # ifconfig stdout
 
     # Query routes information
     %w{inet inet6}.each do |family|
-      so_n = shell_out("netstat -nrf #{family}")
-      so_n.stdout.lines.each do |line|
+      shell_out("netstat -nrf #{family}").stdout.each_line do |line|
         if line =~ /(\S+)\s+(\S+)\s+(\S+)\s+(\d+)\s+(\d+)\s+(\S+)/
           interface = $6
-          iface[interface][:routes] = [] unless iface[interface][:routes]
-          iface[interface][:routes] << Mash.new( destination: $1, family: family,
-                                                 via: $2, flags: $3)
+          ifaces[interface][:routes] ||= []
+          ifaces[interface][:routes] << Mash.new( destination: $1, family: family,
+                                                  via: $2, flags: $3)
         end
       end
     end
 
     # List the arp entries in system.
-    so = shell_out("arp -an")
     count = 0
-    so.stdout.lines.each do |line|
-      network[:arp] ||= Mash.new
+    network[:arp] ||= Mash.new
+    shell_out("arp -an").stdout.each_line do |line|
       if line =~ /\s*(\S+) \((\S+)\) at ([a-fA-F0-9\:]+) \[(\w+)\] stored in bucket/
         network[:arp][count] ||= Mash.new
         network[:arp][count][:remote_host] = $1
@@ -144,6 +137,6 @@ Ohai.plugin(:Network) do
         count += 1
       end
     end
-    network["interfaces"] = iface
+    network["interfaces"] = ifaces
   end
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Joshua Timberman <joshua@chef.io>
 # Author:: Isa Farnik (<isa@chef.io>)
@@ -22,8 +23,8 @@ Ohai.plugin(:Platform) do
   depends "kernel"
 
   collect_data(:aix) do
-    platform kernel[:name]
+    platform "aix"
+    platform_family "aix"
     platform_version [kernel[:version], kernel[:release]].join(".")
-    platform_family platform
   end
 end