ohai 15.7.4 → 16.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3836d8ca7e3ae0f1beb6a8f4cd3ca01cc016b8803d01d7ff2aca39dd3622cdc1
-  data.tar.gz: c09ced6abcc3ee95ddb69f35a08f34291bbc7b8b9f4e855fd809e88f7fae5eed
+  metadata.gz: b01a821d5ffa3a329d434aa798b7e6396cd38329a5aed167cc9fa5d790e1e40b
+  data.tar.gz: 832b596c834b379cd996bdad0d097e38684be9e175fcd50d59fce4cebc04ec19
 SHA512:
-  metadata.gz: a8d390efe3e82e70e744249ef71e9087898c2dc1f6fcb76b08797d5079d8138a2c56fc11189ad785b6b8057dc1679ae4c2fa97318d6239a4dc4c286d01a483e5
-  data.tar.gz: 5a513712ac8a5173b2a31ce39b80777f6e7c08bab22d5e8642c906c2cad1545ecc5d4ea1702c04624bfcbf8f0ebdbe92be73f7efd01ab1c2da671601cbf9508b
+  metadata.gz: ad4cbe610a98f04f3525b4d025e7053712dbe7c9218d38e506dd6beb031ded0e5d969ede709a0b2fdf95cea747905d18b021eea7d29db25271f24792c439bc4b
+  data.tar.gz: 5359aff83afbfceb44068bc838ce4a8153e863a6684319a65b1164e48169e6ba406e38e537c4686d1102e4bfc29e1f783fe4bdc216654fd0d19af53d8c5fbbf0

data/Gemfile

@@ -13,10 +13,6 @@ group :development do
   gem "ipaddr_extensions"
 end
 
-group :ci do
-  gem "rspec_junit_formatter"
-end
-
 group :docs do
   gem "yard"
   gem "redcarpet"
@@ -26,6 +22,6 @@ end
 group :debug do
   gem "pry"
   gem "pry-byebug"
-  gem "pry-stack_explorer"
+  gem "pry-stack_explorer", "~> 0.4.0" # pin until we drop ruby < 2.6
   gem "rb-readline"
 end

data/lib/ohai/common/dmi.rb

@@ -111,6 +111,15 @@ module Ohai
         id
       end
 
+      SKIPPED_CONVENIENCE_KEYS = %w{
+        application_identifier
+        caption
+        creation_class_name
+        size
+        system_creation_class_name
+        record_id
+      }.freeze
+
       # create simplified convenience access keys for each record type
       # for single occurrences of one type, copy to top level all fields and values
       # for multiple occurrences of same type, copy to top level all fields and values that are common to all records
@@ -122,13 +131,12 @@ module Ohai
 
           records[:all_records].each do |record|
             record.each do |field, value|
-              next if value.is_a?(Mash)
-              next if field.to_s == "application_identifier"
-              next if field.to_s == "size"
-              next if field.to_s == "record_id"
+              next unless value.is_a?(String)
 
               translated = field.downcase.gsub(/[^a-z0-9]/, "_")
-              value      = value.strip
+              next if SKIPPED_CONVENIENCE_KEYS.include?(translated.to_s)
+
+              value = value.strip
               if in_common.key?(translated)
                 in_common[translated] = nil unless in_common[translated] == value
               else

data/lib/ohai/config.rb

@@ -39,7 +39,7 @@ module Ohai
       # causes all optional plugins to be run.
       default :run_all_plugins, false
       # optional plugins are the set of plugins that are marked optional but you wish to run.
-      default :optional_plugins, []
+      default(:optional_plugins, []).writes_value { |arr| arr.map(&:to_sym) }
       default :shellout_timeout, 30
     end
   end

data/lib/ohai/mash.rb

@@ -1,201 +1,21 @@
-# Copyright (c) 2009 Dan Kubb
-
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-# ---
-# ---
-
-# Some portions of blank.rb and mash.rb are verbatim copies of software
-# licensed under the MIT license. That license is included below:
-
-# Copyright (c) 2005-2008 David Heinemeier Hansson
-
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-# This class has dubious semantics and we only have it so that people can write
-# params[:key] instead of params['key'].
-class Mash < Hash
-
-  # @param constructor [Object] The default value for the mash.
-  # If constructor is a Hash, a new mash will be created based on the keys of the hash and
-  # no default value will be set.
-  def initialize(constructor = {})
-    if constructor.is_a?(Hash)
-      super()
-      update(constructor)
-    else
-      super(constructor)
-    end
-  end
-
-  # @param key [Object] The default value for the mash.
-  # If key is a Symbol and it is a key in the mash, then the default value will be set to
-  # the value matching the key.
-  def default(key = nil)
-    if key.is_a?(Symbol) && include?(key = key.to_s)
-      self[key]
-    else
-      super
-    end
-  end
-
-  alias_method :regular_writer, :[]= unless method_defined?(:regular_writer)
-  alias_method :regular_update, :update unless method_defined?(:regular_update)
-
-  # @param key [Object] The key to set.
-  # @param value [Object] The value to set the key to.
-  #
-  # @see Mash#convert_key
-  # @see Mash#convert_value
-  def []=(key, value)
-    regular_writer(convert_key(key), convert_value(value))
-  end
-
-  # @param other_hash [Hash]
-  #   A hash to update values in the mash with. The keys and the values will be
-  #   converted to Mash format.
-  #
-  # @return [Mash] The updated mash.
-  def update(other_hash)
-    other_hash.each_pair { |key, value| regular_writer(convert_key(key), convert_value(value)) }
-    self
-  end
-
-  alias_method :merge!, :update
-
-  # @param key [Object] The key to check for. This will be run through convert_key.
-  #
-  # @return [Boolean] True if the key exists in the mash.
-  def key?(key)
-    super(convert_key(key))
-  end
-
-  # def include? def has_key? def member?
-  alias_method :include?, :key?
-  alias_method :has_key?, :key?
-  alias_method :member?, :key?
-
-  # @param key [Object] The key to fetch. This will be run through convert_key.
-  # @param extras [Array] Default value.
-  #
-  # @return [Object] The value at key or the default value.
-  def fetch(key, *extras)
-    super(convert_key(key), *extras)
-  end
-
-  # @param indices [Array] The keys to retrieve values for. These will be run through +convert_key+.
-  #
-  # @return [Array] The values at each of the provided keys
-  def values_at(*indices)
-    indices.collect { |key| self[convert_key(key)] }
-  end
-
-  # @param hash [Hash] The hash to merge with the mash.
-  #
-  # @return [Mash] A new mash with the hash values merged in.
-  def merge(hash)
-    dup.update(hash)
-  end
-
-  # @param key [Object] The key to delete from the mash.
-  def delete(key)
-    super(convert_key(key))
-  end
-
-  # @param keys [Array<String, Symbol>] The mash keys to exclude.
-  #
-  # @return [Mash] A new mash without the selected keys.
-  #
-  # @example
-  #   { :one => 1, :two => 2, :three => 3 }.except(:one)
-  #     #=> { "two" => 2, "three" => 3 }
-  def except(*keys)
-    super(*keys.map { |k| convert_key(k) })
-  end
-
-  # Used to provide the same interface as Hash.
-  #
-  # @return [Mash] This mash unchanged.
-  def stringify_keys!; self end
-
-  # @return [Hash] The mash as a Hash with symbolized keys.
-  def symbolize_keys
-    h = Hash.new(default)
-    each { |key, val| h[key.to_sym] = val }
-    h
-  end
-
-  # @return [Hash] The mash as a Hash with string keys.
-  def to_hash
-    Hash.new(default).merge(self)
-  end
-
-  # Convert a Hash into a Mash. The input Hash's default value is maintained
-  # @return [Mash]
-  def self.from_hash(hash)
-    mash = Mash.new(hash)
-    mash.default = hash.default
-    mash
-  end
-
-  protected
-
-  # @param key [Object] The key to convert.
-  # @return [Object] The converted key. If the key was a symbol, it will be converted to a string.
-  #
-  # @api private
-  def convert_key(key)
-    key.is_a?(Symbol) ? key.to_s : key
-  end
-
-  # @param value [Object] The value to convert.
-  #
-  # @return [Object]
-  #   The converted value. A Hash or an Array of hashes, will be converted to
-  #   their Mash equivalents.
-  #
-  # @api private
-  def convert_value(value)
-    if value.class == Hash
-      Mash.from_hash(value)
-    elsif value.is_a?(Array)
-      value.collect { |e| convert_value(e) }
-    else
-      value
-    end
-  end
-end
+#
+# 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/mash" unless defined?(ChefUtils::Mash)
+
+# For historical reasons we inject Mash directly into the top level class namespace
+Mash = ChefUtils::Mash unless defined?(Mash)

data/lib/ohai/mixin/azure_metadata.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Tim Smith (<tsmith@chef.io>)
-# Copyright:: Copyright 2017 Chef Software, Inc.
+# Copyright:: 2017-2020 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,30 +19,86 @@ require "net/http" unless defined?(Net::HTTP)
 
 module Ohai
   module Mixin
+    #
+    # This code parses the Azure Instance Metadata API to provide details
+    # of the running instance.
+    #
+    # The code probes the instance metadata endpoint for
+    # available versions, determines the most advanced version known to
+    # work and executes the metadata retrieval using that version.
+    #
+    # If no compatible version is found, an empty hash is returned.
+    #
     module AzureMetadata
 
       AZURE_METADATA_ADDR ||= "169.254.169.254".freeze
-      AZURE_METADATA_URL ||= "/metadata/instance?api-version=2017-08-01".freeze
 
-      # fetch the meta content with a timeout and the required header
+      # it's important that the newer versions are at the end of this array so we can skip sorting it
+      AZURE_SUPPORTED_VERSIONS ||= %w{ 2017-04-02 2017-08-01 2017-12-01 2018-02-01 2018-04-02
+                                   2018-10-01 2019-02-01 2019-03-11 2019-04-30 2019-06-01
+                                   2019-06-04 2019-08-01 2019-08-15 2019-11-01 }.freeze
+
+      def best_api_version
+        @api_version ||= begin
+          logger.trace("Mixin AzureMetadata: Fetching http://#{AZURE_METADATA_ADDR}/metadata/instance to determine the latest supported metadata release")
+          response = http_get("/metadata/instance")
+          if response.code == "404"
+            logger.trace("Mixin AzureMetadata: Received HTTP 404 from metadata server while determining API version, assuming #{AZURE_SUPPORTED_VERSIONS.last}")
+            return AZURE_SUPPORTED_VERSIONS.last
+          elsif response.code != "400" # 400 is actually what we want
+            raise "Mixin AzureMetadata: Unable to determine Azure metadata version (returned #{response.code} response)"
+          end
+
+          # azure returns a list of the 3 latest versions it supports
+          versions = parse_json(response.body).fetch("newest-versions", [])
+          versions.sort!
+
+          until versions.empty? || AZURE_SUPPORTED_VERSIONS.include?(versions.last)
+            pv = versions.pop
+            logger.trace("Mixin AzureMetadata: Azure metadata version #{pv} is not present in the versions provided by the Azure Instance Metadata service")
+          end
+
+          if versions.empty?
+            logger.debug "Mixin AzureMetadata: The short list of supported versions provided by Azure Instance Metadata service doesn't match any known versions to Ohai. Using the latest supported release known to Ohai instead: #{AZURE_SUPPORTED_VERSIONS.last}"
+            return AZURE_SUPPORTED_VERSIONS.last
+          end
+
+          logger.trace("Mixin AzureMetadata: Latest supported Azure metadata version: #{versions.last}")
+          versions.last
+        end
+      end
+
+      # fetch the meta content with a timeout and the required header and a read timeout of 6s
+      #
+      # @param [String] the relative uri to fetch from the Azure Metadata Service URL
+      #
+      # @return [Net::HTTP]
       def http_get(uri)
         conn = Net::HTTP.start(AZURE_METADATA_ADDR)
         conn.read_timeout = 6
         conn.get(uri, { "Metadata" => "true" })
       end
 
-      def fetch_metadata
-        logger.trace("Mixin AzureMetadata: Fetching metadata from host #{AZURE_METADATA_ADDR} at #{AZURE_METADATA_URL}")
-        response = http_get(AZURE_METADATA_URL)
+      # parse JSON data from a String to a Hash
+      #
+      # @param [String] response_body json as string to parse
+      #
+      # @return [Hash]
+      def parse_json(response_body)
+        data = String(response_body)
+        parser = FFI_Yajl::Parser.new
+        parser.parse(data)
+      rescue FFI_Yajl::ParseError
+        logger.warn("Mixin AzureMetadata: Metadata response is NOT valid JSON")
+        nil
+      end
+
+      def fetch_metadata(api_version = nil)
+        metadata_url = "/metadata/instance?api-version=#{best_api_version}"
+        logger.trace("Mixin AzureMetadata: Fetching metadata from host #{AZURE_METADATA_ADDR} at #{metadata_url}")
+        response = http_get(metadata_url)
         if response.code == "200"
-          begin
-            data = StringIO.new(response.body)
-            parser = FFI_Yajl::Parser.new
-            parser.parse(data)
-          rescue FFI_Yajl::ParseError
-            logger.warn("Mixin AzureMetadata: Metadata response is NOT valid JSON")
-            nil
-          end
+          parse_json(response.body)
         else
           logger.warn("Mixin AzureMetadata: Received response code #{response.code} requesting metadata")
           nil

data/lib/ohai/mixin/ec2_metadata.rb

@@ -160,7 +160,7 @@ module Ohai
             if key[-1..-1] != "/"
               retr_meta = metadata_get("#{id}#{key}", api_version)
               data = retr_meta ? retr_meta : ""
-              json = StringIO.new(data)
+              json = String(data)
               parser = FFI_Yajl::Parser.new
               metadata[metadata_key(key)] = parser.parse(json)
             elsif not key.eql?("/")

data/lib/ohai/mixin/gce_metadata.rb

@@ -39,7 +39,7 @@ module Ohai
         return nil unless response.code == "200"
 
         if json?(response.body)
-          data = StringIO.new(response.body)
+          data = String(response.body)
           parser = FFI_Yajl::Parser.new
           parser.parse(data)
         elsif has_trailing_slash?(id) || (id == "")
@@ -57,7 +57,7 @@ module Ohai
       #
       # @return [Boolean] is the data JSON or not?
       def json?(data)
-        data = StringIO.new(data)
+        data = String(data)
         parser = FFI_Yajl::Parser.new
         begin
           parser.parse(data)

data/lib/ohai/plugins/c.rb

@@ -36,10 +36,10 @@ Ohai.plugin(:C) do
     so = shell_out("/usr/bin/xcode-select -p")
     if so.exitstatus == 0
       logger.trace("Plugin C: Xcode Command Line Tools found.")
-      return true
+      true
     else
       logger.trace("Plugin C: Xcode Command Line Tools not found.")
-      return false
+      false
     end
   rescue Ohai::Exceptions::Exec
     logger.trace("Plugin C: xcode-select binary could not be found. Skipping data.")

data/lib/ohai/plugins/cpu.rb

@@ -364,7 +364,7 @@ Ohai.plugin(:CPU) do
           cpu["cpustates"][value] += 1
         when /core_id/
           cpu[instance]["core_id"] = value
-           # Detect hyperthreading/multithreading
+          # Detect hyperthreading/multithreading
           cpucores.push(value) if cpucores.index(value).nil?
         when /family|fpu_type|model|stepping|vendor_id/
           cpu[instance][key] = value