ohai 13.12.6 → 14.0.28

data/lib/ohai/plugins/windows/network.rb

@@ -36,7 +36,7 @@ Ohai.plugin(:Network) do
       wmi = WmiLite::Wmi.new
       data[:addresses] = wmi.instances_of("Win32_NetworkAdapterConfiguration")
 
-      # If we are running on windows nano or anothe roperating system from the future
+      # If we are running on windows nano or another operating system from the future
       # that does not populate the deprecated win32_* WMI classes, then we should
       # grab data from the newer MSFT_* classes
       return msft_adapter_data if data[:addresses].count == 0
@@ -81,11 +81,13 @@ Ohai.plugin(:Network) do
       i = adapter["index"] || adapter["InterfaceIndex"]
       iface_instance[i] = Mash.new
       adapter.wmi_ole_object.properties_.each do |p|
+        # skip wmi class name fields which make no sense in ohai
+        next if %w{creation_class_name system_creation_class_name}.include?(p.name.wmi_underscore)
         iface_instance[i][p.name.wmi_underscore.to_sym] = adapter[p.name.downcase]
       end
     end
 
-    iface_instance.keys.each do |i|
+    iface_instance.each_key do |i|
       if iface_instance[i][:name] && iface_config[i] && iface_config[i][:ip_address][0]
         cint = sprintf("0x%x", (iface_instance[i][:interface_index] || iface_instance[i][:index]) ).downcase
         iface[cint] = Mash.new

data/lib/ohai/plugins/zpools.rb

@@ -33,7 +33,7 @@ Ohai.plugin(:Zpools) do
     so.stdout.lines do |line|
       case line
       when /^([-_0-9A-Za-z]*)\s+([.0-9]+[MGTPE])\s+([.0-9]+[MGTPE])\s+([.0-9]+[MGTPE])\s+(\d+%)\s+([.0-9]+x)\s+([-_0-9A-Za-z]+)\s+(\d+|-)$/
-        Ohai::Log.debug("Plugin Zpools: Parsing zpool list line: #{line.chomp}")
+        logger.trace("Plugin Zpools: Parsing zpool list line: #{line.chomp}")
         pools[$1] = Mash.new
         pools[$1][:pool_size] = sanitize_value($2)
         pools[$1][:pool_allocated] = sanitize_value($3)
@@ -51,7 +51,7 @@ Ohai.plugin(:Zpools) do
     pools = gather_pool_info
 
     # Grab individual health for devices in the zpools
-    pools.keys.each do |pool|
+    pools.each_key do |pool|
       pools[pool][:devices] = Mash.new
 
       # Run "zpool status" as non-root user (adm) so that
@@ -70,7 +70,7 @@ Ohai.plugin(:Zpools) do
         # solaris: http://rubular.com/r/FqOBzUQQ4p
         # freebsd: http://rubular.com/r/RYkMNlytXl
         when /^\s+((sd|c|ad|da)[-_a-zA-Z0-9]+)\s+([-_a-zA-Z0-9]+)\s+(\d+)\s+(\d+)\s+(\d+)$/
-          Ohai::Log.debug("Plugin Zpools: Parsing zpool status line: #{line.chomp}")
+          logger.trace("Plugin Zpools: Parsing zpool status line: #{line.chomp}")
           pools[pool][:devices][$1] = Mash.new
           pools[pool][:devices][$1][:state] = $3
           pools[pool][:devices][$1][:errors] = Mash.new

data/lib/ohai/provides_map.rb

@@ -171,7 +171,7 @@ module Ohai
     # map, it will find all of the plugins that have at least one provided
     # attribute.
     def collect_plugins_in(provides_map, collected)
-      provides_map.keys.each do |plugin|
+      provides_map.each_key do |plugin|
         if plugin.eql?("_plugins")
           collected.concat(provides_map[plugin])
         else

data/lib/ohai/runner.rb

@@ -23,13 +23,15 @@ require "benchmark"
 module Ohai
   class Runner
 
-    attr_reader :failed_plugins
+    attr_reader :failed_plugins, :logger
     # safe_run: set to true if this runner will run plugins in
     # safe-mode. default false.
     def initialize(controller, safe_run = false)
       @provides_map = controller.provides_map
       @safe_run = safe_run
       @failed_plugins = []
+      @logger = controller.logger.with_child
+      @logger.metadata = { subsystem: "runner" }
     end
 
     # Runs plugins and any un-run dependencies.
@@ -42,32 +44,27 @@ module Ohai
         end
 
         begin
-          case plugin.version
-          when :version7
+          if plugin.version == :version7
             run_v7_plugin(plugin)
-          when :version6
-            run_v6_plugin(plugin)
           else
             raise Ohai::Exceptions::InvalidPlugin, "Invalid plugin version #{plugin.version} for plugin #{plugin}"
           end
-        rescue Ohai::Exceptions::Error
+        rescue Ohai::Exceptions::Error # rubocop: disable Lint/ShadowedException
           raise
         rescue SystemExit # abort or exit from plug-in should exit Ohai with failure code
           raise
         rescue Exception, Errno::ENOENT => e
-          Ohai::Log.debug("Plugin #{plugin.name} threw exception #{e.inspect} #{e.backtrace.join("\n")}")
+          logger.trace("Plugin #{plugin.name} threw exception #{e.inspect} #{e.backtrace.join("\n")}")
         end
       end
-      Ohai::Log.debug("Plugin #{plugin.name} took #{elapsed.total} seconds to run.")
-    end
-
-    def run_v6_plugin(plugin)
-      return true if plugin.has_run?
-
-      @safe_run ? plugin.safe_run : plugin.run
+      logger.trace("Plugin #{plugin.name} took #{elapsed.total} seconds to run.")
     end
 
     def run_v7_plugin(plugin)
+      return true if plugin.optional? &&
+          !Ohai.config[:run_all_plugins] &&
+          !Ohai.config[:optional_plugins].include?(plugin.name)
+
       visited = [ plugin ]
       until visited.empty?
         next_plugin = visited.pop

data/lib/ohai/system.rb

@@ -37,10 +37,10 @@ module Ohai
     attr_accessor :data
     attr_reader :config
     attr_reader :provides_map
-    attr_reader :v6_dependency_solver
+    attr_reader :logger
 
     # the cli flag is used to determine if we're being constructed by
-    # something like chef-client (which doesn't not set this flag) and
+    # something like chef-client (which doesn't set this flag) and
     # which sets up its own loggers, or if we're coming from Ohai::Application
     # and therefore need to configure Ohai's own logger.
     def initialize(config = {})
@@ -48,13 +48,14 @@ module Ohai
       @plugin_path = ""
       @config = config
       @failed_plugins = []
+      @logger = config[:logger] || Ohai::Log.with_child
+      @logger.metadata = { system: "ohai", version: Ohai::VERSION }
       reset_system
     end
 
     def reset_system
       @data = Mash.new
       @provides_map = ProvidesMap.new
-      @v6_dependency_solver = Hash.new
 
       configure_ohai
       configure_logging if @cli
@@ -87,32 +88,19 @@ module Ohai
     end
 
     def run_plugins(safe = false, attribute_filter = nil)
-      # First run all the version 6 plugins
-      @v6_dependency_solver.values.each do |v6plugin|
-        @runner.run_plugin(v6plugin)
-      end
-
-      # Users who are migrating from ohai 6 may give one or more Ohai 6 plugin
-      # names as the +attribute_filter+. In this case we return early because
-      # the v7 plugin provides map will not have an entry for this plugin.
-      if attribute_filter && Array(attribute_filter).all? { |filter_item| have_v6_plugin?(filter_item) }
-        return true
-      end
-
-      # Then run all the version 7 plugins
       begin
         @provides_map.all_plugins(attribute_filter).each do |plugin|
           @runner.run_plugin(plugin)
         end
       rescue Ohai::Exceptions::AttributeNotFound, Ohai::Exceptions::DependencyCycle => e
-        Ohai::Log.error("Encountered error while running plugins: #{e.inspect}")
+        logger.error("Encountered error while running plugins: #{e.inspect}")
         raise
       end
       critical_failed = Ohai::Config.ohai[:critical_plugins] & @runner.failed_plugins
       unless critical_failed.empty?
         msg = "The following Ohai plugins marked as critical failed: #{critical_failed}"
         if @cli
-          Ohai::Log.error(msg)
+          logger.error(msg)
           exit(true)
         else
           raise Ohai::Exceptions::CriticalPluginFailure, "#{msg}. Failing Chef run."
@@ -125,64 +113,13 @@ module Ohai
 
     def run_additional_plugins(plugin_path)
       @loader.load_additional(plugin_path).each do |plugin|
-        Ohai::Log.debug "Running plugin #{plugin}"
+        logger.trace "Running plugin #{plugin}"
         @runner.run_plugin(plugin)
       end
 
       freeze_strings!
     end
 
-    def have_v6_plugin?(name)
-      @v6_dependency_solver.values.any? { |v6plugin| v6plugin.name == name }
-    end
-
-    def pathify_v6_plugin(plugin_name)
-      path_components = plugin_name.split("::")
-      File.join(path_components) + ".rb"
-    end
-
-    #
-    # Below APIs are from V6.
-    # Make sure that you are not breaking backwards compatibility
-    # if you are changing any of the APIs below.
-    #
-    def require_plugin(plugin_ref, force = false)
-      plugins = [ ]
-      # This method is only callable by version 6 plugins.
-      # First we check if there exists a v6 plugin that fulfills the dependency.
-      if @v6_dependency_solver.has_key? pathify_v6_plugin(plugin_ref)
-        # Note that: partial_path looks like Plugin::Name
-        # keys for @v6_dependency_solver are in form 'plugin/name.rb'
-        plugins << @v6_dependency_solver[pathify_v6_plugin(plugin_ref)]
-      else
-        # While looking up V7 plugins we need to convert the plugin_ref to an attribute.
-        attribute = plugin_ref.gsub("::", "/")
-        begin
-          plugins = @provides_map.find_providers_for([attribute])
-        rescue Ohai::Exceptions::AttributeNotFound
-          Ohai::Log.debug("Can not find any v7 plugin that provides #{attribute}")
-          plugins = [ ]
-        end
-      end
-
-      if plugins.empty?
-        raise Ohai::Exceptions::DependencyNotFound, "Can not find a plugin for dependency #{plugin_ref}"
-      else
-        plugins.each do |plugin|
-          begin
-            @runner.run_plugin(plugin)
-          rescue SystemExit, Interrupt
-            raise
-          rescue Ohai::Exceptions::DependencyCycle, Ohai::Exceptions::AttributeNotFound => e
-            Ohai::Log.error("Encountered error while running plugins: #{e.inspect}")
-            raise
-          rescue Exception, Errno::ENOENT => e
-            Ohai::Log.debug("Plugin #{plugin.name} threw exception #{e.inspect} #{e.backtrace.join("\n")}")
-          end
-        end
-      end
-    end
-
     # Re-runs plugins that provide the attributes specified by
     # +attribute_filter+. If +attribute_filter+ is not given, re-runs all
     # plugins.
@@ -244,7 +181,7 @@ module Ohai
         Ohai.config[:plugin_path] << Ohai.config[:directory]
       end
 
-      Ohai::Log.debug("Running Ohai with the following configuration: #{Ohai.config.configuration}")
+      logger.debug("Running Ohai with the following configuration: #{Ohai.config.configuration}")
     end
 
     def configure_logging

data/lib/ohai/util/file_helper.rb

@@ -26,11 +26,11 @@ module Ohai
         paths.each do |path|
           filename = File.join(path, cmd)
           if File.executable?(filename)
-            Ohai::Log.debug("Plugin #{name}: found #{cmd} at #{filename}")
+            logger.trace("Plugin #{name}: found #{cmd} at #{filename}")
             return filename
           end
         end
-        Ohai::Log.debug("Plugin #{name}: did not find #{cmd}")
+        logger.trace("Plugin #{name}: did not find #{cmd}")
         false
       end
     end

data/lib/ohai/util/win32/group_helper.rb

@@ -29,8 +29,6 @@ module Ohai
       BUILTIN_ADMINISTRATORS_SID = "S-1-5-32-544"
 
       def self.windows_root_group_name
-        administrators_group_name_result = nil
-
         administrators_sid_result = FFI::MemoryPointer.new(:pointer)
         convert_result = Win32.convert_string_sid_to_sid(BUILTIN_ADMINISTRATORS_SID, administrators_sid_result)
         last_win32_error = Win32.get_last_error

data/lib/ohai/version.rb

@@ -18,5 +18,5 @@
 
 module Ohai
   OHAI_ROOT = File.expand_path(File.dirname(__FILE__))
-  VERSION = "13.12.6"
+  VERSION = "14.0.28"
 end

data/ohai.gemspec

@@ -5,6 +5,7 @@ require "ohai/version"
 Gem::Specification.new do |s|
   s.name = "ohai"
   s.version = Ohai::VERSION
+  s.platform = Gem::Platform::RUBY
   s.summary = "Ohai profiles your system and emits JSON"
   s.description = s.summary
   s.license = "Apache-2.0"
@@ -12,19 +13,19 @@ Gem::Specification.new do |s|
   s.email = "adam@chef.io"
   s.homepage = "https://docs.chef.io/ohai.html"
 
-  s.required_ruby_version = ">= 2.3"
+  s.required_ruby_version = ">= 2.4"
 
   s.add_dependency "systemu", "~> 2.6.4"
   s.add_dependency "ffi-yajl", "~> 2.2"
-  s.add_dependency "mixlib-cli", "< 2.0" # 2.0 requires Ruby 2.5+
+  s.add_dependency "mixlib-cli"
   s.add_dependency "mixlib-config", "~> 2.0"
-  s.add_dependency "mixlib-log", ">= 1.7.1", "< 2.0"
+  s.add_dependency "mixlib-log", "~> 2.0", ">= 2.0.1"
   s.add_dependency "mixlib-shellout", "~> 2.0"
   s.add_dependency "plist", "~> 3.1"
   s.add_dependency "ipaddress"
   s.add_dependency "wmi-lite", "~> 1.0"
   s.add_dependency "ffi", "~> 1.9"
-  s.add_dependency "chef-config", ">= 12.5.0.alpha.1", "< 14"
+  s.add_dependency "chef-config", ">= 12.8", "< 15"
   # Note for ohai developers: If chef-config causes you grief, try:
   #     bundle install --with development
   # this should work as long as chef is a development dependency in Gemfile.
@@ -34,5 +35,5 @@ Gem::Specification.new do |s|
   s.executables = %w{ohai}
 
   s.require_path = "lib"
-  s.files = %w{LICENSE README.md Gemfile Rakefile} + Dir.glob("*.gemspec") + Dir.glob("{lib,spec}/**/*")
+  s.files = %w{LICENSE README.md Gemfile Rakefile} + Dir.glob("*.gemspec") + Dir.glob("{docs,lib,spec}/**/*")
 end

data/spec/functional/plugins/root_group_spec.rb

@@ -24,9 +24,9 @@ describe Ohai::System, "root_group plugin" do
   let(:plugin) { get_plugin("root_group") }
 
   describe "windows platform", :windows_only do
-    let (:wmi) { wmi = WmiLite::Wmi.new }
+    let(:wmi) { WmiLite::Wmi.new }
 
-    it 'should return the system\'s administrators (root) group' do
+    it "should return the system's administrators (root) group" do
       # Notethat the Win32_Group WMI provider can be slow if your
       # system is domain-joined and has hundreds of thousands of
       # groups in Active Directory -- not a typical test scenario, but

data/spec/functional/plugins/windows/uptime_spec.rb

@@ -49,33 +49,4 @@ describe Ohai::System, "Windows plugin uptime" do
       expect(uptime_plugin[:uptime]).to eq("22 hours 18 minutes 51 seconds")
     end
   end
-
-  context "for older version of Windows" do
-    let(:uptime_plugin) do
-      get_plugin("uptime").tap do |plugin|
-        plugin[:platform_version] = "5.0.2195"
-      end
-    end
-
-    let(:wmi) do
-      double("wmi", { :first_of =>
-        { "systemuptime" => "785345" },
-      })
-    end
-
-    before(:each) do
-      allow(uptime_plugin).to receive(:collect_os).and_return(:windows)
-      allow(WmiLite::Wmi).to receive(:new).and_return(wmi)
-    end
-
-    it "should set uptime_seconds to uptime" do
-      uptime_plugin.run
-      expect(uptime_plugin[:uptime_seconds]).to be == 785345
-    end
-
-    it "should set uptime to a human readable value" do
-      uptime_plugin.run
-      expect(uptime_plugin[:uptime]).to eq("9 days 02 hours 09 minutes 05 seconds")
-    end
-  end
 end

data/spec/unit/dsl/plugin_spec.rb

@@ -62,8 +62,8 @@ shared_examples "Ohai::DSL::Plugin" do
         plugin.run
       end
 
-      it "logs a message to debug" do
-        expect(Ohai::Log).to receive(:debug).with(/Skipping disabled plugin TestPlugin/)
+      it "logs a message to trace" do
+        expect(plugin.logger).to receive(:trace).with(/Skipping disabled plugin TestPlugin/)
         plugin.run
       end
 
@@ -382,8 +382,9 @@ shared_examples "Ohai::DSL::Plugin" do
 end
 
 describe Ohai::DSL::Plugin::VersionVII do
+  let(:logger) { Ohai::Log }
   it "does not modify the plugin name when the plugin is named correctly" do
-    plugin = Ohai.plugin(:FunkyVALIDpluginName) {}.new({})
+    plugin = Ohai.plugin(:FunkyVALIDpluginName) {}.new({}, logger)
     expect(plugin.name).to eql(:FunkyVALIDpluginName)
   end
 
@@ -435,13 +436,13 @@ describe Ohai::DSL::Plugin::VersionVII do
     end
 
     it "collects attributes across multiple plugin files" do
-      plugin = Ohai.plugin(:Test) { provides("one") }
+      plugin = Ohai.plugin(:Test) { provides("one") } # rubocop: disable Lint/UselessAssignment
       plugin = Ohai.plugin(:Test) { provides("two", "three") }
       expect(plugin.provides_attrs).to eql(%w{one two three})
     end
 
     it "collects unique attributes" do
-      plugin = Ohai.plugin(:Test) { provides("one") }
+      plugin = Ohai.plugin(:Test) { provides("one") } # rubocop: disable Lint/UselessAssignment
       plugin = Ohai.plugin(:Test) { provides("one", "two") }
       expect(plugin.provides_attrs).to eql(%w{one two})
     end
@@ -468,13 +469,13 @@ describe Ohai::DSL::Plugin::VersionVII do
     end
 
     it "collects dependencies across multiple plugin files" do
-      plugin = Ohai.plugin(:Test) { depends("one") }
+      plugin = Ohai.plugin(:Test) { depends("one") } # rubocop: disable Lint/UselessAssignment
       plugin = Ohai.plugin(:Test) { depends("two", "three") }
       expect(plugin.depends_attrs).to eql(%w{one two three})
     end
 
     it "collects unique attributes" do
-      plugin = Ohai.plugin(:Test) { depends("one") }
+      plugin = Ohai.plugin(:Test) { depends("one") } # rubocop: disable Lint/UselessAssignment
       plugin = Ohai.plugin(:Test) { depends("one", "two") }
       expect(plugin.depends_attrs).to eql(%w{one two})
     end
@@ -538,16 +539,16 @@ describe Ohai::DSL::Plugin::VersionVII do
 
   describe "#provides (deprecated)" do
     it "logs a warning" do
-      plugin = Ohai::DSL::Plugin::VersionVII.new(Mash.new)
-      expect(Ohai::Log).to receive(:warn).with(/\[UNSUPPORTED OPERATION\]/)
+      plugin = Ohai.plugin(:Test).new(Mash.new, logger)
+      expect_any_instance_of(Mixlib::Log::Child).to receive(:warn).with(/\[UNSUPPORTED OPERATION\]/)
       plugin.provides("attribute")
     end
   end
 
   describe "#require_plugin (deprecated)" do
     it "logs a warning" do
-      plugin = Ohai::DSL::Plugin::VersionVII.new(Mash.new)
-      expect(Ohai::Log).to receive(:warn).with(/\[UNSUPPORTED OPERATION\]/)
+      plugin = Ohai.plugin(:Test).new(Mash.new, logger)
+      expect_any_instance_of(Mixlib::Log::Child).to receive(:warn).with(/\[UNSUPPORTED OPERATION\]/)
       plugin.require_plugin("plugin")
     end
   end
@@ -555,7 +556,7 @@ describe Ohai::DSL::Plugin::VersionVII do
   describe "#configuration" do
     let(:plugin) do
       klass = Ohai.plugin(camel_name) {}
-      klass.new({})
+      klass.new({}, logger)
     end
 
     shared_examples_for "plugin config lookup" do
@@ -627,40 +628,7 @@ describe Ohai::DSL::Plugin::VersionVII do
 
   it_behaves_like "Ohai::DSL::Plugin" do
     let(:ohai) { Ohai::System.new }
-    let(:plugin) { Ohai::DSL::Plugin::VersionVII.new(ohai.data) }
+    let(:plugin) { Ohai.plugin(:Test).new(ohai.data, ohai.logger) }
     let(:version) { :version7 }
   end
 end
-
-describe Ohai::DSL::Plugin::VersionVI do
-  describe "#version" do
-    it "saves the plugin version as :version6" do
-      plugin = Class.new(Ohai::DSL::Plugin::VersionVI) {}
-      expect(plugin.version).to eql(:version6)
-    end
-  end
-
-  describe "#provides" do
-    let(:ohai) { Ohai::System.new }
-
-    it "logs a debug message when provides is used" do
-      allow(Ohai::Log).to receive(:debug)
-      expect(Ohai::Log).to receive(:debug).with(/Skipping provides/)
-      plugin = Ohai::DSL::Plugin::VersionVI.new(ohai, "/some/plugin/path.rb", "/some/plugin")
-      plugin.provides("attribute")
-    end
-
-    it "does not update the provides map for version 6 plugins." do
-      plugin = Ohai::DSL::Plugin::VersionVI.new(ohai, "/some/plugin/path.rb", "/some/plugin")
-      plugin.provides("attribute")
-      expect(ohai.provides_map.map).to be_empty
-    end
-
-  end
-
-  it_behaves_like "Ohai::DSL::Plugin" do
-    let(:ohai) { Ohai::System.new }
-    let(:plugin) { Ohai::DSL::Plugin::VersionVI.new(ohai, "/some/plugin/path.rb", "/some/plugin") }
-    let(:version) { :version6 }
-  end
-end