ohai 16.10.6 → 17.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 586f4b057af4307f5fb1abd420939bdb2320dade9b63723fbbcc58135a645a9b
-  data.tar.gz: b2c45c824a6ef7d69702f365f3e4d24bafe53b03afbfe0911e4bca8484556ad4
+  metadata.gz: 4d6aab3006a40779de433a6634b5be22fcb2ed1950c4b67d22eaa1fc18cc8993
+  data.tar.gz: ae3152a23474650f3d5c497ff8e966273a14656dc6d8f454ce4ac769a6259f1a
 SHA512:
-  metadata.gz: 1e9e3ef34974d09ee07eb5c492a9e80028ea8d80c6afa38e86921de16f6a1f85884bb032129fe8322b0bb1942d9447012f3f89f7d027591feecd82a8211a389a
-  data.tar.gz: 01fa6b22eee2fdfbead5f062efb6d346fc508b5b375edcddba0d56ed41c107b6a168e7532c573195b39f3a9b1ccdb24a67a3f914c056d2bedf88f1ac3e8aabe4
+  metadata.gz: 1d7331b209e4d513403cd87949ab0eb4f65a00597da848e22042c2658734cd999c9419ea2fa135e8fcb253eb69c97881324ccbb519198726ba445aec71cb8732
+  data.tar.gz: 6673a8e0fcdaa7cc26fddf35ef54fc88169bcccbecb9f00d85cfa3584661c0c4803869c86b71615f9f69a65dd45aefdd0e22bd6a3a426a34ab8180370312f49e

data/Gemfile

@@ -3,20 +3,20 @@ source "https://rubygems.org"
 
 gemspec
 
-# pull these gems from master of chef/chef so that we're testing against what we will release
-gem "chef-config", git: "https://github.com/chef/chef", branch: "chef-16", glob: "chef-config/chef-config.gemspec"
-gem "chef-utils", git: "https://github.com/chef/chef", branch: "chef-16", glob: "chef-utils/chef-utils.gemspec"
+# pull these gems from main of chef/chef so that we're testing against what we will release
+gem "chef-config", git: "https://github.com/chef/chef", branch: "main", glob: "chef-config/chef-config.gemspec"
+gem "chef-utils", git: "https://github.com/chef/chef", branch: "main", glob: "chef-utils/chef-utils.gemspec"
 
 # NOTE: do not submit PRs to add pry as a dep, add to your Gemfile.local
 group :development do
-  gem "chefstyle", "1.6.2"
+  gem "chefstyle", "2.1.3"
   gem "ipaddr_extensions"
   gem "rake", ">= 10.1.0"
   gem "rspec-collection_matchers", "~> 1.0"
   gem "rspec-core", "~> 3.0"
   gem "rspec-expectations", "~> 3.0"
   gem "rspec-mocks", "~> 3.0"
-  gem "rubocop-performance", "1.9.2"
+  gem "rubocop-performance", "1.12.0"
   gem "rubocop-rspec"
 end
 

data/lib/ohai/config.rb

@@ -26,7 +26,7 @@ module Ohai
   Config = ChefConfig::Config
 
   # Reopens ChefConfig::Config to add Ohai configuration settings.
-  # see: https://github.com/chef/chef/blob/master/lib/chef/config.rb
+  # see: https://github.com/chef/chef/blob/main/lib/chef/config.rb
   class Config
     config_context :ohai do
       default :disabled_plugins, []

data/lib/ohai/mixin/alibaba_metadata.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+#
+# Author:: Tim Smith (<tsmith@chef.io>)
+# 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 "net/http" unless defined?(Net::HTTP)
+
+module Ohai
+  module Mixin
+    #
+    # This code parses the Alibaba Instance Metadata API to provide details
+    # of the running instance.
+    #
+    # Note: As of 2021-02-07 there is only one API release so we're not implementing
+    # logic like the ec2 or azure mixins where we have to find the latest supported
+    # release
+    module AlibabaMetadata
+
+      ALI_METADATA_ADDR ||= "100.100.100.200"
+
+      def http_get(uri)
+        conn = Net::HTTP.start(ALI_METADATA_ADDR)
+        conn.read_timeout = 6
+        conn.keep_alive_timeout = 6
+        conn.get("/2016-01-01/#{uri}", { "User-Agent" => "chef-ohai/#{Ohai::VERSION}" })
+      end
+
+      def fetch_metadata(id = "")
+        response = http_get(id)
+        return nil unless response.code == "200"
+
+        if json?(response.body)
+          data = String(response.body)
+          parser = FFI_Yajl::Parser.new
+          parser.parse(data)
+        elsif response.body.include?("\n")
+          temp = {}
+          response.body.split("\n").each do |sub_attr|
+            temp[sanitize_key(sub_attr)] = fetch_metadata("#{id}/#{sub_attr}")
+          end
+          temp
+        else
+          response.body
+        end
+      end
+
+      # @param [String] data that might be JSON
+      #
+      # @return [Boolean] is the data JSON or not?
+      def json?(data)
+        data = String(data)
+        parser = FFI_Yajl::Parser.new
+        begin
+          parser.parse(data)
+          true
+        rescue FFI_Yajl::ParseError
+          false
+        end
+      end
+
+      # @param data [String]
+      #
+      # @return [Boolean] is there a trailing /?
+      def has_trailing_slash?(data)
+        !!( data =~ %r{/$} )
+      end
+
+      def sanitize_key(key)
+        key.gsub(%r{\-|/}, "_")
+      end
+    end
+  end
+end

data/lib/ohai/mixin/constant_helper.rb

@@ -23,7 +23,7 @@ module Ohai
     module ConstantHelper
 
       def remove_constants
-        new_object_constants = Object.constants - @object_pristine.constants
+        new_object_constants = Object.constants - @object_pristine.constants - [ :SortedSet ]
         new_object_constants.each do |constant|
           Object.send(:remove_const, constant) unless Object.const_get(constant).is_a?(Module)
         end

data/lib/ohai/mixin/ec2_metadata.rb

@@ -41,10 +41,32 @@ module Ohai
     module Ec2Metadata
 
       EC2_METADATA_ADDR ||= "169.254.169.254"
-      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-02-25 2014-11-05 2015-10-20 2016-04-19 2016-06-30 2016-09-02
-                                     2016-11-30 2018-08-17 2018-11-29 2019-10-01 2020-08-24 2020-11-01 }.freeze
+      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-02-25
+                                     2014-11-05
+                                     2015-10-20
+                                     2016-04-19
+                                     2016-06-30
+                                     2016-09-02
+                                     2018-03-28
+                                     2018-08-17
+                                     2018-09-24
+                                     2019-10-01
+                                     2020-10-27
+                                     2021-01-03
+                                     2021-03-23
+                                     2021-07-15 }.freeze
       EC2_ARRAY_VALUES ||= %w{security-groups local_ipv4s}.freeze
       EC2_ARRAY_DIR    ||= %w{network/interfaces/macs}.freeze
       EC2_JSON_DIR     ||= %w{iam}.freeze

data/lib/ohai/mixin/network_helper.rb

@@ -18,6 +18,8 @@
 # limitations under the License.
 #
 
+require "socket" unless defined?(Socket)
+
 module Ohai
   module Mixin
     module NetworkHelper
@@ -32,6 +34,30 @@ module Ohai
         [2, 4, 6].each { |n| dec = dec + "." + netmask[n..n + 1].to_i(16).to_s(10) }
         dec
       end
+
+      # This does a forward and reverse lookup on the hostname to return what should be
+      # the FQDN for the host determined by name lookup (generally DNS).  If the forward
+      # lookup fails this will throw.  If the reverse lookup fails this will return the
+      # hostname back.  The behavior on failure of the reverse lookup is both vitally important
+      # to this API, and completely untested, so changes to this method (not recommended) need
+      # to be manually validated by hand by setting up a DNS server with a broken A record to
+      # an IP without a PTR record (e.g. any RFC1918 space not served by the configured DNS
+      # server), and the method should return the hostname and not the IP address.
+      #
+      def canonicalize_hostname(hostname)
+        Addrinfo.getaddrinfo(hostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname
+      end
+
+      def canonicalize_hostname_with_retries(hostname)
+        retries = 3
+        begin
+          canonicalize_hostname(hostname)
+        rescue
+          retries -= 1
+          retry if retries > 0
+          nil
+        end
+      end
     end
   end
 end

data/lib/ohai/mixin/os.rb

@@ -82,13 +82,13 @@ module Ohai
         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
+          transport_connection.os.name
         end
       end
 
       # @api private
       def nonruby_target?
-        transport_connection && !transport_connection.os.unix? && !transport_connection.os.windows
+        transport_connection && !transport_connection.os.unix? && !transport_connection.os.windows?
       end
 
       # @api private

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

@@ -24,14 +24,15 @@ Ohai.plugin(:Virtualization) do
     virtualization Mash.new
 
     lpar_no, lpar_name = shell_out("uname -L").stdout.split(nil, 2)
+    lpar_no = lpar_no.to_i
 
-    unless lpar_no.to_i == -1 || (lpar_no.to_i == 1 && lpar_name == "NULL")
+    unless lpar_no == -1 || (lpar_no == 1 && lpar_name == "NULL")
       virtualization[:lpar_no] = lpar_no
       virtualization[:lpar_name] = lpar_name
     end
 
-    wpar_no = shell_out("uname -W").stdout.strip
-    if wpar_no.to_i > 0
+    wpar_no = shell_out("uname -W").stdout.strip.to_i
+    if wpar_no > 0
       virtualization[:wpar_no] = wpar_no
     else
       # the below parses the output of lswpar in the long format

data/lib/ohai/plugins/alibaba.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+#
+# Author:: Tim Smith (<tsmith@chef.io>)
+# 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.
+
+# How we detect Alibaba from easiest to hardest & least reliable
+# 1. Ohai alibaba hint exists. This always works
+# 2. DMI sys_vendor data mentions alibaba.
+
+Ohai.plugin(:Alibaba) do
+  require_relative "../mixin/alibaba_metadata"
+  require_relative "../mixin/http_helper"
+
+  include Ohai::Mixin::AlibabaMetadata
+  include Ohai::Mixin::HttpHelper
+
+  provides "alibaba"
+
+  # look for alibaba string in dmi sys_vendor data within the sys tree.
+  # this works even if the system lacks dmidecode use by the Dmi plugin
+  # @return [Boolean] do we have Alibaba DMI data?
+  def has_ali_dmi?
+    if /Alibaba/.match?(file_val_if_exists("/sys/class/dmi/id/sys_vendor"))
+      logger.trace("Plugin Alibaba: has_ali_dmi? == true")
+      true
+    else
+      logger.trace("Plugin Alibaba: has_ali_dmi? == false")
+      false
+    end
+  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)
+    end
+  end
+
+  # a single check that combines all the various detection methods for Alibaba
+  # @return [Boolean] Does the system appear to be on Alibaba
+  def looks_like_alibaba?
+    return true if hint?("alibaba") || has_ali_dmi?
+  end
+
+  collect_data do
+    if looks_like_alibaba?
+      logger.trace("Plugin Alibaba: looks_like_alibaba? == true")
+      alibaba Mash.new
+      fetch_metadata.each do |k, v|
+        alibaba[k] = v
+      end
+    else
+      logger.trace("Plugin Alibaba: looks_like_alibaba? == false")
+      false
+    end
+  end
+end

data/lib/ohai/plugins/azure.rb

@@ -48,7 +48,7 @@ Ohai.plugin(:Azure) do
   # check for either the waagent or the unknown-245 DHCP option that Azure uses
   # http://blog.mszcool.com/index.php/2015/04/detecting-if-a-virtual-machine-runs-in-microsoft-azure-linux-windows-to-protect-your-software-when-distributed-via-the-azure-marketplace/
   def has_waagent?
-    if file_exist?("/usr/sbin/waagent") || dir_exist?('C:\WindowsAzure')
+    if file_exist?("/usr/sbin/waagent") || dir_exist?("C:\\WindowsAzure")
       logger.trace("Plugin Azure: Found waagent used by Azure.")
       true
     end

data/lib/ohai/plugins/c.rb

@@ -85,14 +85,12 @@ Ohai.plugin(:C) do
 
   def collect_glibc
     # glibc
-    ["/lib/libc.so.6", "/lib64/libc.so.6"].each do |glibc|
-      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
+    collect("ldd --version") 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
     end
   end

data/lib/ohai/plugins/chef.rb

@@ -20,10 +20,20 @@
 Ohai.plugin(:Chef) do
   provides "chef_packages/chef"
 
+  def chef_effortless?
+    # Determine if client is being run as a Habitat package.
+    if Chef::CHEF_ROOT.include?("hab/pkgs/chef/chef")
+      # Determine if client is running in zero mode which would show it is using the Effortless pattern.
+      # Explicitly set response to true or nil, not false
+      ChefConfig::Config["chef_server_url"].include?("chefzero://")
+    end
+  end
+
   collect_data(:default, :target) do
     begin
       require "chef/version"
-    rescue Gem::LoadError
+      require "chef-config/config" unless defined?(ChefConfig::Config)
+    rescue LoadError
       logger.trace("Plugin Chef: Unable to load the chef gem to determine the version")
       # this catches when you've done a major version bump of ohai, but
       # your chef gem is incompatible, so we can't load it in the same VM
@@ -35,5 +45,6 @@ Ohai.plugin(:Chef) do
     chef_packages[:chef] = Mash.new
     chef_packages[:chef][:version] = Chef::VERSION
     chef_packages[:chef][:chef_root] = Chef::CHEF_ROOT
+    chef_packages[:chef][:chef_effortless] = chef_effortless?
   end
 end

data/lib/ohai/plugins/cloud.rb

@@ -18,6 +18,7 @@
 Ohai.plugin(:Cloud) do
   provides "cloud"
 
+  depends "alibaba"
   depends "ec2"
   depends "gce"
   depends "rackspace"
@@ -118,7 +119,22 @@ Ohai.plugin(:Cloud) do
     end
   end
 
-  #---------------------------------------
+  #--------------------------------------
+  # Alibaba Cloud
+  #--------------------------------------
+
+  def on_alibaba?
+    alibaba != nil
+  end
+
+  def get_alibaba_values
+    @cloud_attr_obj.add_ipv4_addr(alibaba["meta_data"]["eipv4"], :public)
+    @cloud_attr_obj.add_ipv4_addr(alibaba["meta_data"]["private_ipv4"], :private)
+    @cloud_attr_obj.local_hostname = alibaba["meta_data"]["hostname"]
+    @cloud_attr_obj.provider = "alibaba"
+  end
+
+  #--------------------------------------
   # Google Compute Engine (gce)
   #--------------------------------------
 
@@ -133,9 +149,9 @@ Ohai.plugin(:Cloud) do
       end
     end.flatten.compact
 
-    private_ips = gce["instance"]["networkInterfaces"].collect do |interface|
+    private_ips = gce["instance"]["networkInterfaces"].filter_map do |interface|
       interface["ip"]
-    end.compact
+    end
 
     public_ips.each { |ipaddr| @cloud_attr_obj.add_ipv4_addr(ipaddr, :public) }
     private_ips.each { |ipaddr| @cloud_attr_obj.add_ipv4_addr(ipaddr, :private) }
@@ -334,6 +350,7 @@ Ohai.plugin(:Cloud) do
     get_azure_values if on_azure?
     get_digital_ocean_values if on_digital_ocean?
     get_softlayer_values if on_softlayer?
+    get_alibaba_values if on_alibaba?
 
     cloud @cloud_attr_obj.cloud_mash
   end