ohai 8.7.0 → 8.8.0

data/lib/ohai/system.rb

@@ -211,7 +211,7 @@ module Ohai
       Ohai.config.merge!(@config)
 
       if Ohai.config[:directory] &&
-          !Ohai.config[:plugin_path].include?(Ohai::Config[:directory])
+          !Ohai.config[:plugin_path].include?(Ohai.config[:directory])
         Ohai.config[:plugin_path] << Ohai.config[:directory]
       end
     end

data/lib/ohai/version.rb

@@ -18,5 +18,5 @@
 
 module Ohai
   OHAI_ROOT = File.expand_path(File.dirname(__FILE__))
-  VERSION = '8.7.0'
+  VERSION = '8.8.0'
 end

data/ohai.gemspec

@@ -0,0 +1,50 @@
+
+$:.unshift File.expand_path('../lib', __FILE__)
+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"
+  s.author = "Adam Jacob"
+  s.email = "adam@chef.io"
+  s.homepage = "https://docs.chef.io/ohai.html"
+
+  s.required_ruby_version = ">= 2.0.0"
+
+  s.add_dependency "mime-types", "~> 3.0"
+  s.add_dependency "systemu", "~> 2.6.4"
+  s.add_dependency "ffi-yajl", "~> 2.2"
+  s.add_dependency "mixlib-cli"
+  s.add_dependency "mixlib-config", "~> 2.0"
+  s.add_dependency "mixlib-log"
+  s.add_dependency "mixlib-shellout", "~> 2.0"
+  s.add_dependency "ipaddress"
+  s.add_dependency "wmi-lite", "~> 1.0"
+  s.add_dependency "ffi", "~> 1.9"
+  # 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.
+  #
+  # Chef depends on ohai and chef-config. Ohai depends on chef-config. The
+  # version of chef-config that chef depends on is whatver version chef
+  # happens to be on master. This will need to be updated again once work on
+  # Chef 13 starts, otherwise builds will break.
+  s.add_dependency "chef-config", ">= 12.5.0.alpha.1", "< 13"
+
+  s.add_dependency "rake", "~> 10.1"
+  s.add_development_dependency "rspec-core", "~> 3.0"
+  s.add_development_dependency "rspec-expectations", "~> 3.0"
+  s.add_development_dependency "rspec-mocks", "~> 3.0"
+  s.add_development_dependency "rspec-collection_matchers", "~> 1.0"
+  s.add_development_dependency "rspec_junit_formatter"
+
+  s.bindir = "bin"
+  s.executables = %w(ohai)
+
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.md Gemfile Rakefile) + Dir.glob("*.gemspec") + Dir.glob("{docs,lib,spec}/**/*")
+end

data/spec/functional/loader_spec.rb

@@ -0,0 +1,53 @@
+#
+# Copyright:: Copyright (c) 2015 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"
+
+RSpec.describe "Ohai::Loader" do
+  let(:loader) { Ohai::Loader.new(Ohai::System.new) }
+
+  describe "#load_all" do
+    context "when the plugin path contains backslash characters", :windows_only do
+      let(:plugin_directory) { Dir.mktmpdir("plugins") }
+      let(:plugin_path) { plugin_directory.gsub("/", "\\") }
+
+      before(:each) do
+        Ohai.config[:plugin_path] = plugin_path
+
+        plugin_content = <<-EOF
+Ohai.plugin(:Foo) do
+  provides 'foo'
+end
+EOF
+        File.open(File.join(plugin_directory, "foo.rb"), 'w+') do |f|
+          f.write(plugin_content)
+        end
+      end
+
+      after(:each) do
+        FileUtils.rm_rf(plugin_directory)
+      end
+
+      it "loads all the plugins" do
+        loader.load_all
+        loaded_plugins = loader.instance_variable_get(:@v7_plugin_classes)
+        loaded_plugins_names = loaded_plugins.map { |plugin| plugin.name }
+        expect(loaded_plugins_names).to eq(["Ohai::NamedPlugin::Foo"])
+      end
+    end
+  end
+end

data/spec/unit/loader_spec.rb

@@ -22,17 +22,13 @@ require File.expand_path(File.dirname(__FILE__) + '/../spec_helper.rb')
 describe Ohai::Loader do
   extend IntegrationSupport
 
-  before(:each) do
-    @plugin_data = Mash.new
-    @provides_map = Ohai::ProvidesMap.new
-
-    @ohai = double('Ohai::System', :data => @plugin_data, :provides_map => @provides_map)
-    @loader = Ohai::Loader.new(@ohai)
-  end
+  let(:loader) { Ohai::Loader.new(ohai) }
+  let(:ohai) { double('Ohai::System', :data => Mash.new, :provides_map => provides_map) }
+  let(:provides_map) { Ohai::ProvidesMap.new }
 
   describe "#initialize" do
-    it "should return an Ohai::Loader object" do
-      loader = Ohai::Loader.new(@ohai)
+    it "returns an Ohai::Loader object" do
+      loader = Ohai::Loader.new(ohai)
       expect(loader).to be_a_kind_of(Ohai::Loader)
     end
   end
@@ -56,43 +52,45 @@ EOF
 
     describe "load_plugin() method" do
       describe "when loading a v7 plugin" do
-        before(:each) do
-          @plugin = @loader.load_plugin(path_to("zoo.rb"))
-        end          
+        let(:plugin) { loader.load_plugin(path_to("zoo.rb")) }
 
-        it "should save the plugin according to its attribute" do          
-          expect(@provides_map.map.keys).to include("seals")
+        it "saves the plugin according to its attribute" do
+          plugin
+          expect(provides_map.map.keys).to include("seals")
         end
 
-        it "should save a single plugin source" do
-          expect(@plugin.source).to eql([path_to("zoo.rb")])
+        it "saves a single plugin source" do
+          expect(plugin.source).to eql([path_to("zoo.rb")])
         end
 
-        it "should save all plugin sources" do
-          @loader.load_plugin(path_to("zoo_too.rb"))
-          expect(@plugin.source).to eql([path_to("zoo.rb"), path_to("zoo_too.rb")])
+        it "saves all plugin sources" do
+          plugin
+          loader.load_plugin(path_to("zoo_too.rb"))
+          expect(plugin.source).to eql([path_to("zoo.rb"), path_to("zoo_too.rb")])
         end
       end
 
       describe "when loading a v6 plugin" do
+        let(:plugin) { loader.load_plugin(path_to("lake.rb"), path_to(".")) }
+
         before(:each) do
           expect(Ohai::Log).to receive(:warn).with(/\[DEPRECATION\]/)
-          @plugin = @loader.load_plugin(path_to("lake.rb"), path_to("."))
         end
 
-        it "should not add this plugin's provided attributes to the provides map" do
-          expect(@provides_map.map).to be_empty
+        it "does not add this plugin's provided attributes to the provides map" do
+          plugin
+          expect(provides_map.map).to be_empty
         end
 
-        it "should save the plugin's source" do
-          expect(@plugin.source).to eql(path_to("lake.rb"))
+        it "saves the plugin's source" do
+          expect(plugin.source).to eql(path_to("lake.rb"))
         end
       end
 
-      it "should log a warning if a plugin doesn't exist" do
+      it "logs a warning if a plugin doesn't exist" do
         expect(Ohai::Log).to receive(:warn).with(/Unable to open or read plugin/)
-        @loader.load_plugin(path_to("rainier.rb"), path_to("."))
-        expect(@provides_map.map).to be_empty
+        loader.load_plugin(path_to("rainier.rb"), path_to("."))
+        expect(provides_map.map).to be_empty
       end
     end
   end
@@ -146,79 +144,79 @@ EOF
 
     describe "load_plugin() method" do
       describe "when the plugin uses Ohai.plugin instead of Ohai.plugins" do
-        it "should log an unsupported operation warning" do
+        it "logs an unsupported operation warning" do
           expect(Ohai::Log).to receive(:warn).with(/Plugin Method Error: <#{path_to("extra_s.rb")}>:/)
-          @loader.load_plugin(path_to("extra_s.rb"))
+          loader.load_plugin(path_to("extra_s.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("extra_s.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("extra_s.rb")) }.not_to raise_error
         end
       end
 
       describe "when the plugin tries to call an unexisting method" do
         it "shoud log an unsupported operation warning" do
           expect(Ohai::Log).to receive(:warn).with(/Plugin Method Error: <#{path_to("no_method.rb")}>:/)
-          @loader.load_plugin(path_to("no_method.rb"))
+          loader.load_plugin(path_to("no_method.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("no_method.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("no_method.rb")) }.not_to raise_error
         end
       end
 
       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(Ohai::Log).to receive(:warn).with(/Plugin Definition Error: <#{path_to("illegal_def.rb")}>:/)
-          @loader.load_plugin(path_to("illegal_def.rb"))
+          loader.load_plugin(path_to("illegal_def.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("illegal_def.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("illegal_def.rb")) }.not_to raise_error
         end
       end
 
       describe "when an unexpected error is encountered" do
-        it "should log a warning" do
+        it "logs a warning" do
           expect(Ohai::Log).to receive(:warn).with(/Plugin Error: <#{path_to("unexpected_error.rb")}>:/)
-          @loader.load_plugin(path_to("unexpected_error.rb"))
+          loader.load_plugin(path_to("unexpected_error.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("unexpected_error.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("unexpected_error.rb")) }.not_to raise_error
         end
       end
 
       describe "when the plugin name symbol has bad syntax" do
-        it "should log a syntax error warning" do
+        it "logs a syntax error warning" do
           expect(Ohai::Log).to receive(:warn).with(/Plugin Syntax Error: <#{path_to("bad_symbol.rb")}>:/)
-          @loader.load_plugin(path_to("bad_symbol.rb"))
+          loader.load_plugin(path_to("bad_symbol.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("bad_symbol.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("bad_symbol.rb")) }.not_to raise_error
         end
       end
 
       describe "when the plugin forgets an 'end'" do
-        it "should log a syntax error warning" do
+        it "logs a syntax error warning" do
           expect(Ohai::Log).to receive(:warn).with(/Plugin Syntax Error: <#{path_to("no_end.rb")}>:/)
-          @loader.load_plugin(path_to("no_end.rb"))
+          loader.load_plugin(path_to("no_end.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("no_end.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("no_end.rb")) }.not_to raise_error
         end
       end
 
       describe "when the plugin has an invalid name" do
-        it "should log an invalid plugin name warning" do
+        it "logs an invalid plugin name warning" do
           expect(Ohai::Log).to receive(:warn).with(/Plugin Name Error: <#{path_to("bad_name.rb")}>:/)
-          @loader.load_plugin(path_to("bad_name.rb"))
+          loader.load_plugin(path_to("bad_name.rb"))
         end
 
-        it "should not raise an error" do
-          expect{ @loader.load_plugin(path_to("bad_name.rb")) }.not_to raise_error
+        it "does not raise an error" do
+          expect{ loader.load_plugin(path_to("bad_name.rb")) }.not_to raise_error
         end
       end
     end

data/spec/unit/plugins/aix/kernel_spec.rb

@@ -26,6 +26,7 @@ describe Ohai::System, "AIX kernel plugin" do
     allow(@plugin).to receive(:shell_out).with("uname -v").and_return(mock_shell_out(0, "6", nil))
     allow(@plugin).to receive(:shell_out).with("uname -p").and_return(mock_shell_out(0, "powerpc", nil))
     allow(@plugin).to receive(:shell_out).with("genkex -d").and_return(mock_shell_out(0, "    Text address     Size     Data address     Size File\nf1000000c0338000    77000 f1000000c0390000    1ec8c /usr/lib/drivers/cluster\n         6390000    20000          63a0000      ba8 /usr/lib/drivers/if_en", nil))
+    allow(@plugin).to receive(:shell_out).with("getconf KERNEL_BITMODE").and_return(mock_shell_out(0, "64", nil))
     @plugin.run
   end
 
@@ -45,6 +46,10 @@ describe Ohai::System, "AIX kernel plugin" do
     expect(@plugin[:kernel][:machine]).to eq("powerpc")
   end
 
+  it "getconf KERNEL_BITMODE detects the kernel's bittiness" do
+    expect(@plugin[:kernel][:bits]).to eq("64")
+  end
+
   it "detects the modules" do
     expect(@plugin[:kernel][:modules]["/usr/lib/drivers/cluster"]["text"]).to eq({ "address" => "f1000000c0338000", "size" => "77000" })
     expect(@plugin[:kernel][:modules]["/usr/lib/drivers/cluster"]["data"]).to eq({ "address" => "f1000000c0390000", "size" => "1ec8c" })

data/spec/unit/plugins/bsd/filesystem_spec.rb

@@ -0,0 +1,126 @@
+#
+# Author:: Matthew Kent (<mkent@magoazul.com>)
+# Author:: Tim Smith (<tsmith@chef.io>)
+# Copyright:: Copyright (c) 2011-2015 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 File.expand_path(File.dirname(__FILE__) + '/../../../spec_helper.rb')
+
+describe Ohai::System, "BSD filesystem plugin" do
+  let(:plugin) { get_plugin("bsd/filesystem") }
+  before(:each) do
+    allow(plugin).to receive(:collect_os).and_return(:freebsd)
+
+    allow(plugin).to receive(:shell_out).with("df").and_return(mock_shell_out(0, "", ""))
+    allow(plugin).to receive(:shell_out).with("df -iP").and_return(mock_shell_out(0, "", ""))
+    allow(plugin).to receive(:shell_out).with("mount -l").and_return(mock_shell_out(0, "", ""))
+  end
+
+  describe "when gathering filesystem usage data from df" do
+    before(:each) do
+      @stdout = <<-DF
+Filesystem  1K-blocks    Used   Avail Capacity  Mounted on
+/dev/ada0p2   9637788 3313504 5553264    37%    /
+devfs               1       1       0   100%    /dev
+DF
+      allow(plugin).to receive(:shell_out).with("df").and_return(mock_shell_out(0, @stdout, ""))
+
+      @inode_stdout = <<-DFi
+Filesystem  512-blocks    Used   Avail Capacity iused  ifree %iused  Mounted on
+/dev/ada0p2   15411832 5109256 9069632    36%  252576 790750   24%   /
+devfs                2       2       0   100%       0      0  100%   /dev
+DFi
+      allow(plugin).to receive(:shell_out).with("df -iP").and_return(mock_shell_out(0, @inode_stdout, ""))
+    end
+
+    it "should run df and df -iP" do
+      expect(plugin).to receive(:shell_out).ordered.with("df").and_return(mock_shell_out(0, @stdout, ""))
+      expect(plugin).to receive(:shell_out).ordered.with("df -iP").and_return(mock_shell_out(0, @inode_stdout, ""))
+      plugin.run
+    end
+
+    it "should set kb_size to value from df" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:kb_size]).to eq("9637788")
+    end
+
+    it "should set kb_used to value from df" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:kb_used]).to eq("3313504")
+    end
+
+    it "should set kb_available to value from df" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:kb_available]).to eq("5553264")
+    end
+
+    it "should set percent_used to value from df" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:percent_used]).to eq("37%")
+    end
+
+    it "should set mount to value from df" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:mount]).to eq("/")
+    end
+
+    it "should set total_inodes to value from df -iP" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:total_inodes]).to eq("1043326")
+    end
+
+    it "should set inodes_used to value from df -iP" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:inodes_used]).to eq("252576")
+    end
+
+    it "should set inodes_available to value from df -iP" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:inodes_available]).to eq("790750")
+    end
+  end
+
+  describe "when gathering mounted filesystem data from mount" do
+    before(:each) do
+      @stdout = <<-MOUNT
+/dev/ada0p2 on / (ufs, local, journaled soft-updates)
+devfs on /dev (devfs, local, multilabel)
+MOUNT
+      allow(plugin).to receive(:shell_out).with("mount -l").and_return(mock_shell_out(0, @stdout, ""))
+    end
+
+    it "should run mount" do
+      expect(plugin).to receive(:shell_out).with("mount -l").and_return(mock_shell_out(0, @stdout, ""))
+      plugin.run
+    end
+
+    it "should set mount to value from mount" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:mount]).to eq("/")
+    end
+
+    it "should set fs_type to value from mount" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:fs_type]).to eq("ufs")
+    end
+
+    it "should set mount_options to an array of values from mount" do
+      plugin.run
+      expect(plugin[:filesystem]["/dev/ada0p2"][:mount_options]).to eq(["local", "journaled soft-updates"])
+    end
+  end
+
+end