ohai 14.3.0 → 14.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63dacc5848d269ab4c734b26cfd943b4918d5cdfbe640fce1b8b1804a9094198
-  data.tar.gz: '0885d6bbffe839c17f2683f75c11cae64b2177c2e12effeefa8abd09b5198a16'
+  metadata.gz: 1a0ff48c97fc8f901992098c99017a30e676368e4e7fb2ad1aa997bdcb88b49c
+  data.tar.gz: 0a5ba9acc9bc9dd07c4720fd295cde3738f35af3b3209b8427da966040bd0e23
 SHA512:
-  metadata.gz: 815b9e031ecece77af44c06828dadd7c95db98d651b8b732c4b5b8d95376676905cd48ea3ba02bb409f38d65ca796c1707df9b880cbcae09305c1638257a454b
-  data.tar.gz: dc225e37afcc613a73c6ed3f02b47718052263a43d7c66d2dbf763e9955ed60860d600f7f33b584a1fefa3a610e8524995fe08680eb74fa817871e0b2d14278b
+  metadata.gz: d646c6259b0d415ae8c30370e40e27f87ea3f3ebc10c730e98457f2020fe8c3222a2c611be3a46fa16a108070f6d0ecf761e30c002b6c2b4f39b10e5f32db976
+  data.tar.gz: 9475c71f49b3fadb9d9e1b5da81d2ae18ac984e37005b25d283a0bf093f22bba48cbeb574c22d3e11256751813391d2ce8e9ead474a6943eb39b968731e8255e

data/Rakefile

@@ -22,14 +22,3 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new(:style) do |task|
   task.options += ["--display-cop-names", "--no-color"]
 end
-
-begin
-  require "github_changelog_generator/task"
-
-  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

data/lib/ohai/application.rb

@@ -34,8 +34,11 @@ class Ohai::Application
   option :directory,
     short: "-d DIRECTORY",
     long: "--directory DIRECTORY",
-    description: "A directory to add to the Ohai plugin search path",
-    proc: lambda { |path| Ohai::Config.platform_specific_path(path) }
+    description: "A directory to add to the Ohai plugin search path. If passing multiple directories use this option more than once.",
+    proc: lambda { |path, path_array|
+      (path_array ||= []) << Ohai::Config.platform_specific_path(path)
+      path_array
+    }
 
   option :log_level,
     short: "-l LEVEL",

data/lib/ohai/config.rb

@@ -40,6 +40,7 @@ module Ohai
       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 :shellout_timeout, 30
     end
   end
 

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

@@ -108,11 +108,8 @@ module Ohai
         # @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|
-            if data_collector.key?(plat)
-              raise Ohai::Exceptions::IllegalPluginDefinition, "collect_data already defined on platform #{plat}"
-            else
-              data_collector[plat] = block
-            end
+            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
           end
         end
 

data/lib/ohai/mixin/command.rb

@@ -28,8 +28,8 @@ module Ohai
       # accept a command and any of the mixlib-shellout options
       def shell_out(cmd, **options)
         options = options.dup
-        # unless specified by the caller timeout after 30 seconds
-        options[:timeout] ||= 30
+        # unless specified by the caller timeout after configured timeout (default 30 seconds)
+        options[:timeout] ||= Ohai::Config.ohai[:shellout_timeout]
         unless RUBY_PLATFORM =~ /mswin|mingw32|windows/
           options[:env] = options.key?(:env) ? options[:env].dup : {}
           options[:env]["PATH"] ||= ((ENV["PATH"] || "").split(":") + %w{/usr/local/sbin /usr/local/bin /usr/sbin /usr/bin /sbin /bin}).join(":")

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

@@ -0,0 +1,30 @@
+#
+# Author:: Stuart Preston (<stuart@chef.io>)
+# Copyright:: Copyright (c) 2018, 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.
+#
+
+Ohai.plugin :SystemEnclosure do
+  provides "system_enclosure"
+
+  collect_data(:windows) do
+    require "wmi-lite/wmi"
+    system_enclosure Mash.new
+    wmi = WmiLite::Wmi.new
+    wmi_object = wmi.first_of("Win32_SystemEnclosure").wmi_ole_object
+    system_enclosure[:manufacturer] = wmi_object.invoke("manufacturer")
+    system_enclosure[:serialnumber] = wmi_object.invoke("serialnumber")
+  end
+end

data/lib/ohai/system.rb

@@ -176,9 +176,13 @@ module Ohai
     def configure_ohai
       Ohai.config.merge!(@config)
 
-      if Ohai.config[:directory] &&
-          !Ohai.config[:plugin_path].include?(Ohai.config[:directory])
-        Ohai.config[:plugin_path] << Ohai.config[:directory]
+      # add any additional CLI passed directories to the plugin path excluding duplicates
+      unless Ohai.config[:directory].nil?
+        # make sure the directory config is an array since it could be a string set in client.rb
+        Array(Ohai.config[:directory]).each do |dir|
+          next if Ohai.config[:plugin_path].include?(dir)
+          Ohai.config[:plugin_path] << dir
+        end
       end
 
       logger.debug("Running Ohai with the following configuration: #{Ohai.config.configuration}")

data/lib/ohai/version.rb

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

data/ohai.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency "systemu", "~> 2.6.4"
   s.add_dependency "ffi-yajl", "~> 2.2"
-  s.add_dependency "mixlib-cli"
+  s.add_dependency "mixlib-cli", ">= 1.7.0" # 1.7+ needed to support passing multiple options
   s.add_dependency "mixlib-config", "~> 2.0"
   s.add_dependency "mixlib-log", "~> 2.0", ">= 2.0.1"
   s.add_dependency "mixlib-shellout", "~> 2.0"

data/spec/unit/dsl/plugin_spec.rb

@@ -519,21 +519,20 @@ describe Ohai::DSL::Plugin::VersionVII do
     end
 
     it "fails a platform has already been defined in the same plugin" do
-      expect do
-        Ohai.plugin(:Test) do
-          collect_data {}
-          collect_data {}
-        end
-      end.to raise_error(Ohai::Exceptions::IllegalPluginDefinition, /collect_data already defined/)
+      Ohai.plugin(:Test) { collect_data {} }
+      expect(Ohai::Log).to receive(:warn).with(/collect_data already defined on platform/).twice
+      Ohai.plugin(:Test) do
+        collect_data {}
+        collect_data {}
+      end
     end
 
     it "fails if a platform has already been defined in another plugin file" do
       Ohai.plugin(:Test) { collect_data {} }
-      expect do
-        Ohai.plugin(:Test) do
-          collect_data {}
-        end
-      end.to raise_error(Ohai::Exceptions::IllegalPluginDefinition, /collect_data already defined/)
+      expect(Ohai::Log).to receive(:warn).with(/collect_data already defined on platform/)
+      Ohai.plugin(:Test) do
+        collect_data {}
+      end
     end
   end
 

data/spec/unit/loader_spec.rb

@@ -130,7 +130,7 @@ EOF
 
       describe "when the plugin defines collect_data on the same platform more than once" do
         it "shoud log an illegal plugin definition warning" do
-          expect(loader.logger).to receive(:warn).with(/Plugin Definition Error: <#{path_to("illegal_def.rb")}>:/)
+          expect(Ohai::Log).to receive(:warn).with(/collect_data already defined on platform/)
           loader.load_plugin(path_to("illegal_def.rb"))
         end
 

data/spec/unit/plugins/windows/system_enclosure_spec.rb

@@ -0,0 +1,45 @@
+#
+# Author:: Stuart Preston (<stuart@chef.io>)
+# Copyright:: Copyright (c) 2018, 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 "../../../spec_helper.rb"
+
+describe Ohai::System, "System Enclosure", :windows_only do
+  before do
+    require "wmi-lite/wmi"
+    @plugin = get_plugin("windows/system_enclosure")
+    manufacturer = double("WIN32OLE", name: "manufacturer", value: "My Fake Manufacturer")
+    serialnumber = double("WIN32OLE", name: "serialnumber", value: "1234123412341234")
+    property_map = [ manufacturer, serialnumber ]
+
+    wmi_ole_object = double( "WIN32OLE", properties_: property_map)
+    allow(wmi_ole_object).to receive(:invoke).with(manufacturer.name).and_return(manufacturer.value)
+    allow(wmi_ole_object).to receive(:invoke).with(serialnumber.name).and_return(serialnumber.value)
+    wmi_object = WmiLite::Wmi::Instance.new(wmi_ole_object)
+    expect_any_instance_of(WmiLite::Wmi).to receive(:first_of).with(("Win32_SystemEnclosure")).and_return(wmi_object)
+  end
+
+  it "should return the manufacturer" do
+    @plugin.run
+    expect(@plugin["system_enclosure"]["manufacturer"]).to eql("My Fake Manufacturer")
+  end
+
+  it "should return a serial number" do
+    @plugin.run
+    expect(@plugin["system_enclosure"]["serialnumber"]).to eql("1234123412341234")
+  end
+end

data/spec/unit/system_spec.rb

@@ -38,7 +38,7 @@ describe "Ohai::System" do
     it "merges provided configuration options into the ohai config context" do
       config = {
         disabled_plugins: [ :Foo, :Baz ],
-        directory: "/some/extra/plugins",
+        directory: ["/some/extra/plugins"],
         critical_plugins: [ :Foo, :Bar ],
       }
       Ohai::System.new(config)
@@ -47,13 +47,24 @@ describe "Ohai::System" do
       end
     end
 
-    context "when directory is configured" do
+    context "when a single directory is configured as a string" do
       let(:directory) { "/some/fantastic/plugins" }
 
       it "adds directory to plugin_path" do
         Ohai.config[:directory] = directory
         Ohai::System.new({ invoked_from_cli: true })
-        expect(Ohai.config[:plugin_path]).to include(directory)
+        expect(Ohai.config[:plugin_path]).to include("/some/fantastic/plugins")
+      end
+    end
+
+    context "when multiple directories are configured" do
+      let(:directory) { ["/some/fantastic/plugins", "/some/other/plugins"] }
+
+      it "adds directories to plugin_path" do
+        Ohai.config[:directory] = directory
+        Ohai::System.new({ invoked_from_cli: true })
+        expect(Ohai.config[:plugin_path]).to include("/some/fantastic/plugins")
+        expect(Ohai.config[:plugin_path]).to include("/some/other/plugins")
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ohai
 version: !ruby/object:Gem::Version
-  version: 14.3.0
+  version: 14.4.0
 platform: ruby
 authors:
 - Adam Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-09 00:00:00.000000000 Z
+date: 2018-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: mixlib-config
   requirement: !ruby/object:Gem::Requirement
@@ -336,6 +336,7 @@ files:
 - lib/ohai/plugins/windows/memory.rb
 - lib/ohai/plugins/windows/network.rb
 - lib/ohai/plugins/windows/platform.rb
+- lib/ohai/plugins/windows/system_enclosure.rb
 - lib/ohai/plugins/windows/virtualization.rb
 - lib/ohai/plugins/zpools.rb
 - lib/ohai/provides_map.rb
@@ -513,6 +514,7 @@ files:
 - spec/unit/plugins/windows/fips_spec.rb
 - spec/unit/plugins/windows/kernel_spec.rb
 - spec/unit/plugins/windows/memory_spec.rb
+- spec/unit/plugins/windows/system_enclosure_spec.rb
 - spec/unit/plugins/windows/uptime_spec.rb
 - spec/unit/plugins/windows/virtualization_spec.rb
 - spec/unit/plugins/zpools_spec.rb
@@ -541,7 +543,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ohai profiles your system and emits JSON