ohai 16.5.0 → 16.7.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8039a80535910fc0746573f29cbd7746fbe1ac34a46a2c98a93603ac7b4fb83e
-  data.tar.gz: cf27f4ca401a9c57674d2c10b72867ef1e423d85e3849fcf1cd9d318e87a8716
+  metadata.gz: 39d6064d1c93ab4dac377f1883213fad35872ee08ac0c2b97801b5d96da1a1df
+  data.tar.gz: 5837422d08995fd7057e84d496d85b11514bd51b6b0d391b282fb3612fb083bc
 SHA512:
-  metadata.gz: 54f972aa56f93adfa75ee164c2e505bc1a6b8dcdbc797e6cac6ccc8ea02e5fede2340f63b9529d7f4a3a6ab814543b46d65607c40b39d617602bfad009f183e6
-  data.tar.gz: 3453c0ef0e9c0e0dce7eebb258738c1fbcf0578a1894ab6eb7476385b5b0c9973d0dfc2c42be7c9ff544e33838aeeb8979daef1e0f6d331cffca7265643841ec
+  metadata.gz: d58037d84d3f6066b86561940dffe8b812d89ef6e75a7a0a8a843affccb7b6fc98e29795d2bd62ce48b396eefc71901423e198274d5474c95e1fb189101f4992
+  data.tar.gz: cc8c6cbd38084685fe8cb8dccdc3f5c469829b0798c562fb8803dc37d0c3aacf2a844781689ef0f3a5796929f43951d59b083531fea4ed08a46a07395bb8a06d

data/Gemfile

@@ -1,28 +1,28 @@
+# frozen_string_literal: true
 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", glob: "chef-config/chef-config.gemspec"
+gem "chef-utils", git: "https://github.com/chef/chef", 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", git: "https://github.com/chef/chefstyle.git", branch: "master"
-  gem "rubocop-performance", "1.8.0"
+  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 "rspec-collection_matchers", "~> 1.0"
-  gem "ipaddr_extensions"
-end
-
-group :docs do
-  gem "yard"
-  gem "redcarpet"
-  gem "github-markup"
+  gem "rubocop-performance", "1.9.0"
+  gem "rubocop-rspec"
 end
 
 group :debug do
   gem "pry"
   gem "pry-byebug"
-  gem "pry-stack_explorer", "~> 0.4.0" # pin until we drop ruby < 2.6
+  gem "pry-stack_explorer"
   gem "rb-readline"
-end
+end

data/bin/ohai

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
@@ -18,7 +19,7 @@
 #
 
 # if we're in a source code checkout, we want to run the code from that.
-$:.unshift File.expand_path("../../lib", __FILE__)
+$:.unshift File.expand_path("../lib", __dir__)
 require "ohai/application"
 
 Ohai::Application.new.run

data/lib/ohai.rb

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

data/lib/ohai/application.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Mathieu Sauve-Frankel <msf@kisoku.net>
 # Copyright:: Copyright (c) 2009 Mathieu Sauve-Frankel.
@@ -56,6 +57,15 @@ class Ohai::Application
     description: "Set the log file location, defaults to STDOUT - recommended for daemonizing",
     proc: nil
 
+  option :target,
+    short: "-t TARGET",
+    long: "--target TARGET",
+    description: "Target Ohai against a remote system or device",
+    proc: lambda { |target|
+      Ohai::Log.warn "-- EXPERIMENTAL -- Target mode activated -- EXPERIMENTAL --"
+      target
+    }
+
   option :help,
     short: "-h",
     long: "--help",
@@ -93,9 +103,39 @@ class Ohai::Application
 
     load_workstation_config
 
+    merge_configs
+
+    if config[:target]
+      Ohai::Config.target_mode.host = config[:target]
+      if URI.parse(Ohai::Config.target_mode.host).scheme
+        train_config = Train.unpack_target_from_uri(Ohai::Config.target_mode.host)
+        Ohai::Config.target_mode = train_config
+      end
+      Ohai::Config.target_mode.enabled = true
+      Ohai::Config.node_name = Ohai::Config.target_mode.host unless Ohai::Config.node_name
+    end
+
     Ohai::Log.init(Ohai.config[:log_location])
   end
 
+  # @api private
+  def config_file_defaults
+    Ohai::Config.save(true)
+  end
+
+  # @api private
+  def config_file_settings
+    Ohai::Config.save(false)
+  end
+
+  # See lib/chef/knife.rb in the chef/chef github repo
+  #
+  # @api private
+  def merge_configs
+    config.replace(config_file_defaults.merge(default_config).merge(config_file_settings).merge(config))
+    Ohai::Config.merge!(config) # make them both the same
+  end
+
   # Passes config and attributes arguments to Ohai::System then prints the results.
   # Called by the run method after config / logging have been initialized
   #

data/lib/ohai/common/dmi.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Kurt Yoder (ktyopscode@yoderhome.com)
 # Copyright:: Copyright (c) 2010 Kurt Yoder
@@ -76,11 +77,11 @@ module Ohai
       # away some of the less useful IDs
       ID_TO_CAPTURE = [ 0, 1, 2, 3, 4, 6, 11 ].freeze
 
-      # the whitelisted DMI IDs. This is combination of the defaults + any additional
+      # the allowlisted DMI IDs. This is combination of the defaults + any additional
       # IDs defined in the :additional_dmi_ids config
       #
       # @return [Array] the list of DMI IDs to capture
-      def whitelisted_ids
+      def allowlisted_ids
         if Ohai.config[:additional_dmi_ids]
           if [ Integer, Array ].include?(Ohai.config[:additional_dmi_ids].class)
             return ID_TO_CAPTURE + Array(Ohai.config[:additional_dmi_ids])
@@ -91,6 +92,10 @@ module Ohai
         ID_TO_CAPTURE
       end
 
+      ##
+      # @deprecated Use the `allowlisted_ids` method instead.
+      alias whitelisted_ids allowlisted_ids
+
       # the human readable description from a DMI ID
       #
       # @param id [String, Integer] the ID to lookup
@@ -152,7 +157,7 @@ module Ohai
         end
       end
 
-      module_function :id_lookup, :convenience_keys, :whitelisted_ids
+      module_function :id_lookup, :convenience_keys, :allowlisted_ids, :whitelisted_ids
     end
   end
 end

data/lib/ohai/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Claire McQuin (<claire@chef.io>)
@@ -27,14 +28,13 @@ module Ohai
   # Reopens ChefConfig::Config to add Ohai configuration settings.
   # see: https://github.com/chef/chef/blob/master/lib/chef/config.rb
   class Config
-
     config_context :ohai do
       default :disabled_plugins, []
       default :hints_path, [ ChefConfig::Config.platform_specific_path("/etc/chef/ohai/hints") ]
       default :log_level, :auto
       default :log_location, STDERR
       default :plugin, ( Ohai::PluginConfig.new { |h, k| h[k] = Ohai::PluginConfig.new } )
-      default :plugin_path, [ File.expand_path(File.join(File.dirname(__FILE__), "plugins")), ChefConfig::Config.platform_specific_path("/etc/chef/ohai/plugins") ]
+      default :plugin_path, [ File.expand_path(File.join(__dir__, "plugins")), ChefConfig::Config.platform_specific_path("/etc/chef/ohai/plugins") ]
       default :critical_plugins, []
       # causes all optional plugins to be run.
       default :run_all_plugins, false

data/lib/ohai/dsl.rb

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

data/lib/ohai/dsl/plugin.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Claire McQuin (<claire@chef.io>)
@@ -22,6 +23,7 @@ require_relative "../mixin/os"
 require_relative "../mixin/shell_out"
 require_relative "../mixin/seconds_to_human"
 require_relative "../mixin/which"
+require_relative "../mixin/train_helpers"
 require_relative "../hints"
 
 module Ohai
@@ -86,10 +88,12 @@ module Ohai
       include Ohai::Mixin::ShellOut
       include Ohai::Mixin::SecondsToHuman
       include Ohai::Mixin::Which
+      include Ohai::Mixin::TrainHelpers
 
       attr_reader :data
       attr_reader :failed
       attr_reader :logger
+      attr_accessor :transport_connection
 
       def initialize(data, logger)
         @data = data
@@ -98,6 +102,10 @@ module Ohai
         @failed = false
       end
 
+      def target_mode?
+        !!@transport_connection
+      end
+
       def run
         @has_run = true
 
@@ -210,7 +218,7 @@ module Ohai
       def safe_get_attribute(*keys)
         keys.inject(@data) do |attrs, key|
           unless attrs.nil? || attrs.is_a?(Array) || attrs.is_a?(Hash)
-            raise TypeError.new("Expected Hash but got #{attrs.class}.")
+            raise TypeError, "Expected Hash but got #{attrs.class}."
           end
 
           attrs[key]

data/lib/ohai/dsl/plugin/versionvii.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.
@@ -46,7 +47,8 @@ module Ohai
           :version7
         end
 
-        # the source of the plugin on disk. This is an array since a plugin may exist for multiple platforms and this would include each of those platform specific file paths
+        # The source of the plugin on disk. This is an array since a plugin may exist for multiple
+        # oses and this would include each of those os specific file paths
         #
         # @return [Array]
         def self.sources
@@ -61,7 +63,7 @@ module Ohai
           @depends_attrs ||= []
         end
 
-        # A block per platform for actually performing data collection constructed
+        # A block per os for actually performing data collection constructed
         # by the collect_data method
         #
         # @return [Mash]
@@ -101,15 +103,16 @@ module Ohai
           !!@optional
         end
 
-        # define data collection methodology per platform
+        # define data collection methodology per os
         #
-        # @param platform [Symbol] the platform to collect data for
-        # @param other_platforms [Array] additional platforms to collect data for
-        # @param block [block] the actual code to collect data for the specified platforms
-        def self.collect_data(platform = :default, *other_platforms, &block)
-          [platform, other_platforms].flatten.each do |plat|
-            Ohai::Log.warn("collect_data already defined on platform '#{plat}' for #{self}, last plugin seen will be used") if data_collector.key?(plat)
-            data_collector[plat] = block
+        # @param os [Array<Symbol>] the list of oses to collect data for
+        # @param block [block] the actual code to collect data for the specified os
+        #
+        def self.collect_data(*os_list, &block)
+          os_list = [ :default ] if os_list.empty?
+          os_list.flatten.each do |os|
+            Ohai::Log.warn("collect_data already defined on os '#{os}' for #{self}, last plugin seen will be used") if data_collector.key?(os)
+            data_collector[os] = block
           end
         end
 
@@ -120,12 +123,22 @@ module Ohai
 
         def run_plugin
           collector = self.class.data_collector
-          platform = collect_os
-
-          if collector.key?(platform)
-            instance_eval(&collector[platform])
-          elsif collector.key?(:default)
+          os = collect_os
+
+          # :default - means any remote or local unix or windows host
+          # :target  - means any remote API which is not unix/windows or otherwise rubyable (cisco switches, IPMI console, HTTP API, etc)
+          #
+          # Do not be confused by the fact that collectors tagged :target do not run against e.g. target-mode ubuntu boxes, that is not
+          # what :target is intended for.  Also, do not be confused by the fact that collectors tagged :default do not run by default against
+          # pure-target mode targets like switches.  That is all intended behavior, the names are problematic.  The :default nomenclature was
+          # invented 10 years before target mode and we are stuck with it.
+          #
+          if collector.key?(os)
+            instance_eval(&collector[os])
+          elsif collector.key?(:default) && !nonruby_target?
             instance_eval(&collector[:default])
+          elsif collector.key?(:target) && nonruby_target?
+            instance_eval(&collector[:target])
           else
             logger.trace("Plugin #{name}: No data to collect. Skipping...")
           end
@@ -182,8 +195,6 @@ module Ohai
           # key? to avoid falsely instantiating a configuration hash.
           if Ohai.config[:plugin].key?(snake_case_name)
             Ohai.config[:plugin][snake_case_name]
-          else
-            nil
           end
         end
       end

data/lib/ohai/exception.rb

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

data/lib/ohai/hints.rb

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

data/lib/ohai/log.rb

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

data/lib/ohai/mash.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/azure_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Tim Smith (<tsmith@chef.io>)
 # Copyright:: Copyright (c) Chef Software Inc.
@@ -31,12 +32,12 @@ module Ohai
     #
     module AzureMetadata
 
-      AZURE_METADATA_ADDR ||= "169.254.169.254".freeze
+      AZURE_METADATA_ADDR ||= "169.254.169.254"
 
       # 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
+                                       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

data/lib/ohai/mixin/chef_utils_wiring.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
@@ -16,6 +17,7 @@
 #
 
 require_relative "../config"
+require "singleton" unless defined?(Singleton)
 
 module Ohai
   module Mixin
@@ -32,7 +34,18 @@ module Ohai
       end
 
       def __transport_connection
-        #        Chef.run_context&.transport_connection
+        transport_connection
+      end
+
+      # because of target mode we cache the PATH to avoid massive amounts of `echo $PATH` remote queries
+      #
+      def __env_path
+        PathCache.instance.path_cache ||= super
+      end
+
+      class PathCache
+        include Singleton
+        attr_accessor :path_cache
       end
     end
   end

data/lib/ohai/mixin/command.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 $stderr.puts "WARN: Ohai::Mixin::Command is deprecated, please use Ohai::Mixin::ShellOut or remove if the reference is unnecessary"
 require_relative "shell_out"
 Ohai::Mixin::Command = Ohai::Mixin::ShellOut unless defined?(Ohai::Mixin::Command)

data/lib/ohai/mixin/constant_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/dmi_decode.rb

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

data/lib/ohai/mixin/do_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 # Author:: Dylan Page (<dpage@digitalocean.com>)
 # License:: Apache License, Version 2.0
@@ -20,8 +21,8 @@ module Ohai
   module Mixin
     module DOMetadata
 
-      DO_METADATA_ADDR ||= "169.254.169.254".freeze
-      DO_METADATA_URL ||= "/metadata/v1.json".freeze
+      DO_METADATA_ADDR ||= "169.254.169.254"
+      DO_METADATA_URL ||= "/metadata/v1.json"
 
       def http_client
         Net::HTTP.start(DO_METADATA_ADDR).tap { |h| h.read_timeout = 6 }

data/lib/ohai/mixin/ec2_metadata.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # Author:: Tim Dysinger (<tim@dysinger.net>)
 # Author:: Benjamin Black (<bb@chef.io>)
@@ -39,10 +40,10 @@ module Ohai
     #
     module Ec2Metadata
 
-      EC2_METADATA_ADDR ||= "169.254.169.254".freeze
+      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 }.freeze
+                                     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 }.freeze
       EC2_ARRAY_VALUES ||= %w{security-groups local_ipv4s}.freeze
       EC2_ARRAY_DIR    ||= %w{network/interfaces/macs}.freeze
       EC2_JSON_DIR     ||= %w{iam}.freeze
@@ -57,7 +58,7 @@ module Ohai
           elsif response.code != "200"
             raise "Mixin EC2: Unable to determine EC2 metadata version (returned #{response.code} response)"
           end
-          # Note: Sorting the list of versions may have unintended consequences in
+          # 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").sort
           until versions.empty? || EC2_SUPPORTED_VERSIONS.include?(versions.last)
@@ -118,7 +119,7 @@ module Ohai
                 else
                   metadata_get(key, best_api_version)
                 end
-            elsif (not key.eql?(id)) && (not key.eql?("/"))
+            elsif (!key.eql?(id)) && (!key.eql?("/"))
               name = key[0..-2]
               sym = metadata_key(name)
               if EC2_ARRAY_DIR.include?(name)
@@ -142,8 +143,8 @@ module Ohai
             key = expand_path(o)
             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 || ""
+            elsif !key.eql?("/")
               metadata[key[0..-2]] = fetch_dir_metadata("#{id}#{key}", api_version)
             end
           end
@@ -159,11 +160,11 @@ module Ohai
             key = expand_path(o)
             if key[-1..-1] != "/"
               retr_meta = metadata_get("#{id}#{key}", api_version)
-              data = retr_meta ? retr_meta : ""
+              data = retr_meta || ""
               json = String(data)
               parser = FFI_Yajl::Parser.new
               metadata[metadata_key(key)] = parser.parse(json)
-            elsif not key.eql?("/")
+            elsif !key.eql?("/")
               metadata[key[0..-2]] = fetch_json_dir_metadata("#{id}#{key}", api_version)
             end
           end