ohai 13.12.6 → 14.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2169a6aec003fe099183763483cfd37d07dcf5dc2851c88e007319ab6ec6f64
-  data.tar.gz: c238454b9d6d1516200adab45a351f89a4b5115ab27bddfe8bccd0c0bf3f1fa4
+  metadata.gz: 5a1f5745602a7d261d2346fe002fc0a4dc7fbd4416e762fe32f0bbf90023e3a8
+  data.tar.gz: 7b0c9a614a3317d7efb17e046d886057974b9af94805eaa41e38652abfee6786
 SHA512:
-  metadata.gz: d48ac20acb31d3caa0b5be3df33cc4a12bcfcc3eaca0a8dd8d4e7b0ead1020c8bfc62eafae73f28c457ee3f466abf73139c6dbe336eb0aad568ac56a2dc447df
-  data.tar.gz: bff03881401a6faf59cc6dddc888ec47823d00641452fb53f0093d588c0a99343294ba65fd6c296a180fedb5827b56bdd1d3b939b961c22202afec157b4e3038
+  metadata.gz: fecf7d1a694d21150317858122036b1b88c3914ee6c1ac6559b8cd2af99c68befbceb8ed823eb1baa732357582eb2eee050b183099d27b81872e4efb74ee8a8e
+  data.tar.gz: 2bf44d42fe0ddd207ac2fbaa9d054efc9d80087d6a32d90b4fba5befbfe30efa29267b415fd2585c6cea673e4fca45187dfe990c98288a28bf925f74f9923324

data/Gemfile

@@ -4,7 +4,7 @@ gemspec
 
 # NOTE: do not submit PRs to add pry as a dep, add to your Gemfile.local
 group :development do
-  gem "chefstyle", "= 0.6.0"
+  gem "chefstyle"
   gem "rake", ">= 10.1.0"
   gem "rspec-core", "~> 3.0"
   gem "rspec-expectations", "~> 3.0"
@@ -17,17 +17,8 @@ group :ci do
   gem "rspec_junit_formatter"
 end
 
-group :docs do
-  gem "yard"
-  gem "redcarpet"
-  gem "github-markup"
-end
-
-group :debug do
-  gem "pry"
-  gem "pry-byebug"
-  gem "pry-stack_explorer"
-  gem "rb-readline"
+group :changelog do
+  gem "github_changelog_generator", git: "https://github.com/chef/github-changelog-generator"
 end
 
 instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]

data/README.md

@@ -11,7 +11,7 @@ Ohai will print out a JSON data blob for all the known data about your system. W
 Chef distributes ohai as a RubyGem. This README is for developers who want to modify the Ohai source code. For users who want to write plugins for Ohai, see the docs:
 
 - General documentation: <https://docs.chef.io/ohai.html>
-- Writing Ohai Plugins documentation: <https://docs.chef.io/ohai_custom.html>
+- Custom plugin documentation: <https://docs.chef.io/ohai_custom.html>
 
 ## Development Environment:
 
@@ -37,16 +37,11 @@ Ohai has some Rake tasks for doing various things.
 
 ```
 rake -T
-rake build               # Build ohai-$VERSION.gem into the pkg directory
-rake clean               # Remove any temporary products
-rake clobber             # Remove any generated files
-rake docs                # Generate YARD Documentation
-rake install             # Build and install ohai-$VERSION.gem into system gems
-rake install:local       # Build and install ohai-$VERSION.gem into system gems without network access
-rake release[remote]     # Create tag $VERSION and build and push ohai-$VERSION.gem to rubygems.org
-rake spec                # Run RSpec code examples
-rake style               # Run Chefstyle tests
-rake style:auto_correct  # Auto-correct RuboCop offenses
+rake build          # Build the gem file ohai-$VERSION.gem
+rake install        # install the gem locally
+rake install:local  # install the gem locally without network access
+rake release        # Create tag $VERSION, build gem, and push to Rubygems
+rake spec           # Run RSpec tests
 
 ($VERSION is the current version, from the GemSpec in Rakefile)
 ```
@@ -70,7 +65,7 @@ For information on contributing to this project see <https://github.com/chef/che
 Ohai - system information application
 
 - Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io))
-- Copyright:: Copyright (c) 2008-2018 Chef Software, Inc.
+- Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
 - License:: Apache License, Version 2.0
 
 ```text

data/Rakefile

@@ -1,4 +1,6 @@
 require "bundler/gem_tasks"
+require "date"
+require "ohai/version"
 
 begin
   require "rspec/core/rake_task"
@@ -9,34 +11,25 @@ begin
 rescue LoadError
   desc "rspec is not installed, this task is disabled"
   task :spec do
-    abort "rspec is not installed. bundle install first to make sure all dependencies are installed."
+    abort "rspec is not installed. `(sudo) gem install rspec` to run unit tests"
   end
 end
 
-begin
-  require "chefstyle"
-  require "rubocop/rake_task"
-  desc "Run Chefstyle tests"
-  RuboCop::RakeTask.new(:style) do |task|
-    task.options += ["--display-cop-names", "--no-color"]
-  end
-rescue LoadError
-  puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed."
+task :default => :spec
+
+require "chefstyle"
+require "rubocop/rake_task"
+RuboCop::RakeTask.new(:style) do |task|
+  task.options += ["--display-cop-names", "--no-color"]
 end
 
 begin
-  require "yard"
-  YARD::Rake::YardocTask.new(:docs)
-rescue LoadError
-  puts "yard is not available. bundle install first to make sure all dependencies are installed."
-end
+  require "github_changelog_generator/task"
 
-task :console do
-  require "irb"
-  require "irb/completion"
-  require "ohai"
-  ARGV.clear
-  IRB.start
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.future_release = Ohai::VERSION
+    config.max_issues = 0
+    config.add_issues_wo_labels = false
+  end
+rescue LoadError
 end
-
-task default: [:style, :spec]

data/docs/man/man1/ohai.1

@@ -0,0 +1,97 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "OHAI" "1" "Ohai 7.0.0" "" "ohai"
+.SH NAME
+ohai \- The man page for the ohai command line tool.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.sp
+Ohai is a tool that is used to detect attributes on a node, and then provide these attributes to the chef\-client at the start of every chef\-client run. Ohai is required by the chef\-client and must be present on a node. (Ohai is installed on a node as part of the chef\-client install process.)
+.sp
+The types of attributes Ohai collects include (but are not limited to):
+.INDENT 0.0
+.IP \(bu 2
+Platform details
+.IP \(bu 2
+Network usage
+.IP \(bu 2
+Memory usage
+.IP \(bu 2
+Processor usage
+.IP \(bu 2
+Kernel data
+.IP \(bu 2
+Host names
+.IP \(bu 2
+Fully qualified domain names
+.IP \(bu 2
+Other configuration details
+.UNINDENT
+.sp
+Attributes that are collected by Ohai are automatic attributes, in that these attributes are used by the chef\-client to ensure that these attributes remain unchanged after the chef\-client is done configuring the node.
+.sp
+ohai is the command\-line interface for Ohai, a tool that is used to detect attributes on a node, and then provide these attributes to the chef\-client at the start of every chef\-client run.
+.SH OPTIONS
+.sp
+This command has the following syntax:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ohai OPTION
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This tool has the following options:
+.INDENT 0.0
+.TP
+.B \fBATTRIBUTE_NAME ATTRIBUTE NAME ...\fP
+Use to have Ohai show only output for named attributes.
+.TP
+.B \fB\-d PATH\fP, \fB\-\-directory PATH\fP
+The directory in which Ohai plugins are located. For example: \fB/etc/ohai/plugins\fP\&.
+.TP
+.B \fB\-h\fP, \fB\-\-help\fP
+Shows help for the command.
+.TP
+.B \fB\-l LEVEL\fP, \fB\-\-log_level LEVEL\fP
+The level of logging that will be stored in a log file.
+.TP
+.B \fB\-L LOGLOCATION\fP, \fB\-\-logfile c\fP
+The location in which log file output files will be saved. If this location is set to something other than \fBSTDOUT\fP, standard output logging will still be performed (otherwise there would be no output other than to a file).
+.TP
+.B \fB\-v\fP, \fB\-\-version\fP
+The version of Ohai\&.
+.UNINDENT
+.SH AUTHOR
+Opscode
+.\" Generated by docutils manpage writer.
+.

data/lib/ohai/application.rb

@@ -66,6 +66,14 @@ class Ohai::Application
     :proc         => lambda { |v| puts "Ohai: #{::Ohai::VERSION}" },
     :exit         => 0
 
+  def initialize
+    super
+
+    # Always switch to a readable directory. Keeps subsequent Dir.chdir() {}
+    # from failing due to permissions when launched as a less privileged user.
+    Dir.chdir("/")
+  end
+
   def run
     elapsed = Benchmark.measure do
       configure_ohai
@@ -84,11 +92,8 @@ class Ohai::Application
   end
 
   def run_application
-    # Always switch to a readable directory. Keeps subsequent Dir.chdir() {}
-    # from failing due to permissions when launched as a less privileged user.
-    Dir.chdir("/")
-
     config[:invoked_from_cli] = true
+    config[:logger] = Ohai::Log.with_child
     ohai = Ohai::System.new(config)
     ohai.all_plugins(@attributes)
 

data/lib/ohai/common/dmi.rb

@@ -72,22 +72,10 @@ module Ohai
         127 => "end_of_table_marker",
       }
 
-      # list of IDs to collect from config or default to a sane list that prunes
-      # away some of the less useful IDs
+      # list of IDs to collect, otherwise we generate pages of hashes about cache chip size and whatnot
+      # See OHAI-260. When we can give the user a choice, this will be a default.
       ID_TO_CAPTURE = [ 0, 1, 2, 3, 4, 6, 11 ]
 
-      # return the list of DMI IDs to capture
-      def whitelisted_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])
-          else
-            Ohai::Log.warn("The DMI plugin additional_dmi_ids config must be an array of IDs!")
-          end
-        end
-        ID_TO_CAPTURE
-      end
-
       # look up DMI ID
       def id_lookup(id)
         id = id.to_i
@@ -97,7 +85,7 @@ module Ohai
           id = DMI::ID_TO_DESCRIPTION[id]
         else
           Ohai::Log.debug("unrecognized header id; falling back to 'unknown'")
-          id = "unknown_dmi_id_#{id}"
+          id = "unknown"
         end
       rescue
         Ohai::Log.debug("failed to look up id #{id}, returning unchanged")
@@ -134,7 +122,7 @@ module Ohai
         end
       end
 
-      module_function :id_lookup, :convenience_keys, :whitelisted_ids
+      module_function :id_lookup, :convenience_keys
     end
   end
 end

data/lib/ohai/config.rb

@@ -33,9 +33,13 @@ module Ohai
       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, ( 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 :critical_plugins, []
+      # 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, []
     end
   end
 

data/lib/ohai/dsl.rb

@@ -18,5 +18,4 @@
 #
 
 require "ohai/dsl/plugin"
-require "ohai/dsl/plugin/versionvi"
 require "ohai/dsl/plugin/versionvii"

data/lib/ohai/dsl/plugin.rb

@@ -32,15 +32,8 @@ module Ohai
       name.is_a?(Symbol) && name.to_s.match(/^[^A-Z]|_/).nil?
     end
 
-    # dealing with ruby 1.8
-    if Module.method(:const_defined?).arity == 1
-      def self.strict_const_defined?(const)
-        const_defined?(const)
-      end
-    else
-      def self.strict_const_defined?(const)
-        const_defined?(const, false)
-      end
+    def self.strict_const_defined?(const)
+      const_defined?(const, false)
     end
   end
 
@@ -49,6 +42,7 @@ module Ohai
 
     plugin = nil
 
+    # avoid already initialized constant warnings if already defined
     if NamedPlugin.strict_const_defined?(name)
       plugin = NamedPlugin.const_get(name)
       plugin.class_eval(&block)
@@ -86,9 +80,11 @@ module Ohai
 
       attr_reader :data
       attr_reader :failed
+      attr_reader :logger
 
-      def initialize(data)
+      def initialize(data, logger)
         @data = data
+        @logger = logger.with_child({ subsystem: "plugin", plugin: name })
         @has_run = false
         @failed = false
       end
@@ -97,7 +93,7 @@ module Ohai
         @has_run = true
 
         if Ohai.config[:disabled_plugins].include?(name)
-          Ohai::Log.debug("Skipping disabled plugin #{name}")
+          logger.trace("Skipping disabled plugin #{name}")
         else
           run_plugin
         end
@@ -161,9 +157,9 @@ module Ohai
         # Will raise a TypeError if we hit a subattribute that is not a
         # Hash, Mash, or Array.
         keys = [name] + attrs
-        attribute = keys[0..-2].inject(@data) do |attrs, key|
-          attrs[key] ||= Mash.new
-          attrs[key]
+        attribute = keys[0..-2].inject(@data) do |atts, key|
+          atts[key] ||= Mash.new
+          atts[key]
         end
 
         # Set the subattribute to the value.
@@ -188,8 +184,8 @@ module Ohai
         raise e
       rescue => e
         @failed = true
-        Ohai::Log.debug("Plugin #{name} threw #{e.inspect}")
-        e.backtrace.each { |line| Ohai::Log.debug( line ) }
+        logger.trace("Plugin #{name} threw #{e.inspect}")
+        e.backtrace.each { |line| logger.trace( line ) }
       end
 
       def method_missing(name, *args)

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

@@ -24,8 +24,8 @@ module Ohai
         attr_reader :version
         attr_reader :source
 
-        def initialize(data)
-          super(data)
+        def initialize(data, logger)
+          super(data, logger)
           @source = self.class.sources
           @version = :version7
         end
@@ -66,6 +66,14 @@ module Ohai
           end
         end
 
+        def self.optional(opt = true)
+          @optional = opt
+        end
+
+        def self.optional?
+          !!@optional
+        end
+
         def self.collect_data(platform = :default, *other_platforms, &block)
           [platform, other_platforms].flatten.each do |plat|
             if data_collector.has_key?(plat)
@@ -89,16 +97,20 @@ module Ohai
           elsif collector.has_key?(:default)
             instance_eval(&collector[:default])
           else
-            Ohai::Log.debug("Plugin #{name}: No data to collect. Skipping...")
+            logger.trace("Plugin #{name}: No data to collect. Skipping...")
           end
         end
 
+        def optional?
+          self.class.optional?
+        end
+
         def provides(*paths)
-          Ohai::Log.warn("[UNSUPPORTED OPERATION] \'provides\' is no longer supported in a \'collect_data\' context. Please specify \'provides\' before collecting plugin data. Ignoring command \'provides #{paths.join(", ")}")
+          logger.warn("[UNSUPPORTED OPERATION] \'provides\' is no longer supported in a \'collect_data\' context. Please specify \'provides\' before collecting plugin data. Ignoring command \'provides #{paths.join(", ")}")
         end
 
         def require_plugin(*args)
-          Ohai::Log.warn("[UNSUPPORTED OPERATION] \'require_plugin\' is no longer supported. Please use \'depends\' instead.\nIgnoring plugin(s) #{args.join(", ")}")
+          logger.warn("[UNSUPPORTED OPERATION] \'require_plugin\' is no longer supported. Please use \'depends\' instead.\nIgnoring plugin(s) #{args.join(", ")}")
         end
 
         def configuration(option, *options)