ohai 16.4.12 → 16.7.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a41b8cc8fc0d00fb8816f241f080d183be4b5b4019be40a6e6ab5603d4ab5c5
-  data.tar.gz: adc92d0dcb0c5a5490aa842cd513c761fe984dc6a4aeb5cafdbc7cc8f705d61f
+  metadata.gz: 57f034c4995360aa8eb45d92d95ddee35d307411506e57be5a55b9a5e58b52f3
+  data.tar.gz: dcffcadad6b0a1038b1715397ec2e9ee54000d42ac7cf3f2229e7bbe42e69395
 SHA512:
-  metadata.gz: dd143425b3e1bcd9ef730496e890f41107f9676185bede8b8a8ce2a26cb4f007326d9023121396526c85426f9d07de36a7a5d448e76ad3efe1dcbb0c6fffa186
-  data.tar.gz: 2b93a5ed54f74514be768879bbac6b068c697b09d735258d7716800c2367bad16522b9124a202b9824eb627b45021ab8404ae803f43109a3e5531aec35518f58
+  metadata.gz: 9198da99387e9dfcc99350cba0a7e1e95f2a1e1de7fecf4ecf76b311d38352214b1f76179aa20bcd42f0017f7a8c5d9e73f251c016eb9e8c83d4e0be234da0a8
+  data.tar.gz: bbd44815894afe658ab51d54088589f4c66d62a5099a81c93c48801a8aa454f9c8af38498b667a2fe51088889145a5b05cf376860459c4889453a088c066f9f5

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.7.1"
+  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.8.1"
+  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,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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,7 +1,8 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Claire McQuin (<claire@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -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,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/dsl/plugin.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
 # Author:: Claire McQuin (<claire@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,10 +20,11 @@
 #
 
 require_relative "../mixin/os"
-require_relative "../mixin/command"
+require_relative "../mixin/shell_out"
 require_relative "../mixin/seconds_to_human"
+require_relative "../mixin/which"
+require_relative "../mixin/train_helpers"
 require_relative "../hints"
-require_relative "../util/file_helper"
 
 module Ohai
 
@@ -83,13 +85,15 @@ module Ohai
     class Plugin
 
       include Ohai::Mixin::OS
-      include Ohai::Mixin::Command
+      include Ohai::Mixin::ShellOut
       include Ohai::Mixin::SecondsToHuman
-      include Ohai::Util::FileHelper
+      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
 

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

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -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

data/lib/ohai/exception.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/hints.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Serdar Sutay (<serdar@chef.io>)
-# Copyright:: Copyright (c) 2013-2016 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/loader.rb

@@ -1,6 +1,6 @@
 #
 # Author:: Claire McQuin (<claire@chef.io>)
-# Copyright:: Copyright (c) 2013-2019, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/log.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Adam Jacob (<adam@chef.io>)
-# Copyright:: Copyright (c) 2008-2017, Chef Software Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

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,6 +1,7 @@
+# frozen_string_literal: true
 #
 # Author:: Tim Smith (<tsmith@chef.io>)
-# Copyright:: 2017-2020 Chef Software, Inc.
+# Copyright:: Copyright (c) Chef Software Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -31,7 +32,7 @@ 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

data/lib/ohai/mixin/chef_utils_wiring.rb

@@ -0,0 +1,52 @@
+# 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_relative "../config"
+require "singleton" unless defined?(Singleton)
+
+module Ohai
+  module Mixin
+    # Common Dependency Injection wiring for ChefUtils-related modules
+    module ChefUtilsWiring
+      private
+
+      def __config
+        Ohai::Config
+      end
+
+      def __log
+        logger
+      end
+
+      def __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
+end