ohai 8.20.0 → 8.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09b47a615ee064d16781e8ce7a847d71035d535a
-  data.tar.gz: fd200214865bb27d7ebce651d06798ac8d1b401a
+  metadata.gz: 9adc486c591d6c788a28df54f4b3019649143fbf
+  data.tar.gz: 84178b71f088420c0f8aa6162bb8c16ab6ec117c
 SHA512:
-  metadata.gz: 42971e6add7b1e917f52bd5d416d622555c03764ae6c7e8090cf945ab77e0fba561719c7e8c4210169f164b2967a68df5cda3d6c5ed8ce87522a618466bf22de
-  data.tar.gz: b34aa2275ff4f580d1c37de0234a92ff7a0e6b1a98161e38e8c0ebbe4f7c0fa9aef36c1dcccc21a42a7deb99d920e9830214932ef6720adf247a81b17752772e
+  metadata.gz: ed8f9a5cc316288abffcde24a126b76de94e9160c4c1a4220881759700fdb60ee2a9cb8808f8bd621b8be903b881aa5d62d384e059c3e15b18d652a2f7060d3c
+  data.tar.gz: c8720f2368a29fab4f218f4035992d07a3b02370a6e121edd5cb0bf9198bf54e7e7c99aea6d1d0238b5e2905d1237ded01cba89d64f793cce6473b72562af432

data/README.md

@@ -1,84 +1,72 @@
 # ohai
-[![Build Status Master](https://travis-ci.org/chef/ohai.svg?branch=master)](https://travis-ci.org/chef/ohai)
-[![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/ohai?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/ohai/branch/master)
-[![Gem Version](https://badge.fury.io/rb/ohai.svg)](https://badge.fury.io/rb/ohai)
 
+[![Build Status Master](https://travis-ci.org/chef/ohai.svg?branch=master)](https://travis-ci.org/chef/ohai) [![Build Status Master](https://ci.appveyor.com/api/projects/status/github/chef/ohai?branch=master&svg=true&passingText=master%20-%20Ok&pendingText=master%20-%20Pending&failingText=master%20-%20Failing)](https://ci.appveyor.com/project/Chef/ohai/branch/master) [![Gem Version](https://badge.fury.io/rb/ohai.svg)](https://badge.fury.io/rb/ohai)
 
-# DESCRIPTION:
+## Description
 
-Ohai detects data about your operating system. It can be used
-standalone, but its primary purpose is to provide node data to Chef.
+Ohai detects data about your operating system. It can be used standalone, but its primary purpose is to provide node data to Chef.
 
-Ohai will print out a JSON data blob for all the known data about your
-system. When used with Chef, that data is reported back via node
-attributes.
+Ohai will print out a JSON data blob for all the known data about your system. When used with Chef, that data is reported back via node attributes.
 
-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:
+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
-* Custom plugin documentation: https://docs.chef.io/ohai_custom.html
+- General documentation: <https://docs.chef.io/ohai.html>
+- Custom plugin documentation: <https://docs.chef.io/ohai_custom.html>
 
-# DEVELOPMENT:
+## Development Environment:
 
-Before working on the code, if you plan to contribute your changes, you
-should read the contributing guidelines:
-
-* https://github.com/chef/ohai/blob/master/CONTRIBUTING.md
-
-The basic process for contributing is:
-
-1. Fork this repo on GitHub.
-2. Create a feature branch for your work.
-3. Make your change, including tests.
-4. Submit a pull request.
-
-# ENVIRONMENT:
-
-Ohai's development dependencies should be installed with bundler. Just
-run `bundle install` in the root of the repo.
+Ohai's development dependencies should be installed with bundler. Just run `bundle install` in the root of the repo.
 
 ## Spec Testing:
 
 We use RSpec for unit/spec tests. To run the full suite, run:
 
-    bundle exec rake spec
+```
+bundle exec rake spec
+```
 
 You can run individual test files by running the rspec executable:
 
-    bundle exec rspec spec/unit/FILE.rb
+```
+bundle exec rspec spec/unit/FILE.rb
+```
 
 ## Rake Tasks
 
 Ohai has some Rake tasks for doing various things.
 
-    rake -T
-    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)
+```
+rake -T
+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)
+```
 
-# LINKS:
+## Links:
 
 Source:
 
-* https://github.com/chef/ohai/tree/master
+- <https://github.com/chef/ohai/tree/master>
 
 Issues:
 
-* https://github.com/chef/ohai/issues
+- <https://github.com/chef/ohai/issues>
+
+## Contributing
+
+For information on contributing to this project see <https://github.com/chef/chef/blob/master/CONTRIBUTING.md>
 
-# LICENSE:
+## License
 
 Ohai - system information application
 
-* Author:: Adam Jacob (<adam@chef.io>)
-* Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
-* License:: Apache License, Version 2.0
+- Author:: Adam Jacob ([adam@chef.io](mailto:adam@chef.io))
+- Copyright:: Copyright (c) 2008-2016 Chef Software, Inc.
+- License:: Apache License, Version 2.0
 
 ```text
 Licensed under the Apache License, Version 2.0 (the "License");

data/lib/ohai/plugins/shard.rb

@@ -0,0 +1,82 @@
+#
+# Author:: Phil Dibowitz <phil@ipom.com>
+# Copyright:: Copyright (c) 2016 Facebook, 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 "digest/md5"
+
+Ohai.plugin(:ShardSeed) do
+  depends "hostname", "dmi", "machine_id", "machinename"
+  provides "shard_seed"
+
+  def get_dmi_property(dmi, thing)
+    %w{system base_board chassis}.each do |section|
+      unless dmi[section][thing].strip.empty?
+        return dmi[section][thing]
+      end
+    end
+  end
+
+  def default_sources
+    [:machinename, :serial, :uuid]
+  end
+
+  # Common sources go here. Put sources that need to be different per-platform
+  # under their collect_data block.
+  def create_seed(&block)
+    sources = Ohai.config[:plugin][:shard_seed][:sources] || default_sources
+    data = ""
+    sources.each do |src|
+      data << case src
+              when :fqdn
+                fqdn
+              when :hostname
+                hostname
+              when :machine_id
+                machine_id
+              when :machinename
+                machinename
+              else
+                yield(src)
+              end
+    end
+    shard_seed Digest::MD5.hexdigest(data)[0...7].to_i(16)
+  end
+
+  collect_data(:darwin) do
+    create_seed do |src|
+      case src
+      when :serial
+        hardware["serial_number"]
+      when :uuid
+        hardware["platform_UUID"]
+      end
+    end
+  end
+
+  collect_data(:linux) do
+    create_seed do |src|
+      case src
+      when :serial
+        get_dmi_property(dmi, :serial_number)
+      when :uuid
+        get_dmi_property(dmi, :uuid)
+      else
+        raise "No such shard_seed source: #{src}"
+      end
+    end
+  end
+end

data/lib/ohai/plugins/uptime.rb

@@ -29,6 +29,7 @@ require "ohai/mixin/seconds_to_human"
 Ohai.plugin(:Uptime) do
   provides "uptime", "uptime_seconds"
   provides "idletime", "idletime_seconds" # linux only
+  depends "platform_version"
 
   def collect_uptime(path)
     # kern.boottime: { sec = 1232765114, usec = 823118 } Fri Jan 23 18:45:14 2009
@@ -96,7 +97,12 @@ Ohai.plugin(:Uptime) do
   collect_data(:windows) do
     require "wmi-lite/wmi"
     wmi = WmiLite::Wmi.new
-    uptime_seconds wmi.first_of("Win32_PerfFormattedData_PerfOS_System")["systemuptime"].to_i
+    if platform_version.to_f >= 6.0 ## for newer version of Windows starting from Windows Server 2008 ##
+      last_boot_up_time = wmi.first_of("Win32_OperatingSystem")["lastbootuptime"]
+      uptime_seconds Time.new.to_i - Time.parse(last_boot_up_time).to_i
+    else ## for older version of Windows starting from Windows Server 2003 ##
+      uptime_seconds wmi.first_of("Win32_PerfFormattedData_PerfOS_System")["systemuptime"].to_i
+    end
     uptime seconds_to_human(uptime_seconds)
   end
 

data/lib/ohai/version.rb

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

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

@@ -0,0 +1,81 @@
+#
+# Author:: Aliasgar Batterywala (<aliasgar.batterywala@msystechnologies.com>)
+# Copyright:: Copyright (c) 2016 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, "Windows plugin uptime" do
+
+  context "for newer version of Windows" do
+    let(:uptime_plugin) do
+      get_plugin("uptime").tap do |plugin|
+        plugin[:platform_version] = "6.3.9600"
+      end
+    end
+
+    let(:wmi) do
+      double("wmi", { :first_of =>
+        { "lastbootuptime" => "20160912103128.597219+0000" },
+      })
+    end
+
+    before(:each) do
+      allow(uptime_plugin).to receive(:collect_os).and_return(:windows)
+      allow(WmiLite::Wmi).to receive(:new).and_return(wmi)
+      allow(Time).to receive_message_chain(:new, :to_i).and_return(1473756619)
+    end
+
+    it "should set uptime_seconds to uptime" do
+      uptime_plugin.run
+      expect(uptime_plugin[:uptime_seconds]).to be == 80331
+    end
+
+    it "should set uptime to a human readable value" do
+      uptime_plugin.run
+      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/plugins/shard_spec.rb

@@ -0,0 +1,60 @@
+#
+# Author:: Davide Cavalca <dcavalca@fb.com>
+# Copyright:: Copyright (c) 2016 Facebook
+# 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 "digest/md5"
+require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper.rb")
+
+describe Ohai::System, "shard plugin" do
+  let(:plugin) { get_plugin("shard") }
+  let(:fqdn) { "somehost004.someregion.somecompany.com" }
+  let(:uuid) { "48555CF4-5BB1-21D9-BC4C-E8B73DDE5801" }
+  let(:serial) { "234du3m4i498xdjr2" }
+  let(:machine_id) { "0a1f869f457a4c8080ab19faf80af9cc" }
+  let(:machinename) { "somehost004" }
+
+  before(:each) do
+    allow(plugin).to receive(:collect_os).and_return(:linux)
+    plugin["machinename"] = machinename
+    plugin["machine_id"] = machine_id
+    plugin["fqdn"] = fqdn
+    plugin["dmi"] = { "system" => {} }
+    plugin["dmi"]["system"]["uuid"] = uuid
+    plugin["dmi"]["system"]["serial_number"] = serial
+    allow(plugin).to receive(:collect_os).and_return(:linux)
+  end
+
+  it "should provide a shard with a default-safe set of sources" do
+    plugin.run
+    result = Digest::MD5.hexdigest(
+      "#{machinename}#{serial}#{uuid}"
+    )[0...7].to_i(16)
+    expect(plugin[:shard_seed]).to eq(result)
+  end
+
+  it "should provide a shard with a configured source" do
+    Ohai.config[:plugin][:shard_seed][:sources] = [:fqdn]
+    plugin.run
+    result = Digest::MD5.hexdigest(fqdn)[0...7].to_i(16)
+    expect(plugin[:shard_seed]).to eq(result)
+  end
+
+  it "fails on an unrecognized source" do
+    Ohai.config[:plugin][:shard_seed][:sources] = [:GreatGooglyMoogly]
+    expect { plugin.run }.to raise_error(RuntimeError)
+  end
+end

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

@@ -0,0 +1,88 @@
+#
+# Author:: Aliasgar Batterywala (<aliasgar.batterywala@msystechnologies.com>)
+# Copyright:: Copyright (c) 2016 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, "Windows plugin uptime" do
+
+  let(:wmi) { double("wmi", { :first_of => "" }) }
+
+  before(:each) do
+    allow(WmiLite::Wmi).to receive(:new).and_return(wmi)
+  end
+
+  ## Windows newer versions category here includes server OS starting from Windows Server 2008 ##
+  shared_context "WMI class for newer versions of Windows platform" do
+    before do
+      allow(uptime_plugin).to receive(:collect_os).and_return(:windows)
+    end
+
+    it "uses Win32_OperatingSystem WMI class to fetch the system's uptime" do
+      expect(wmi).to receive(:first_of).with("Win32_OperatingSystem")
+      expect(Time).to receive(:new)
+      expect(Time).to receive(:parse)
+      expect(uptime_plugin).to receive(:seconds_to_human)
+      uptime_plugin.run
+    end
+  end
+
+  ## Windows older versions category here includes server OS starting from Windows Server 2003 ##
+  shared_context "WMI class for older versions of Windows platform" do
+    before do
+      allow(uptime_plugin).to receive(:collect_os).and_return(:windows)
+    end
+
+    it "uses Win32_PerfFormattedData_PerfOS_System WMI class to fetch the system's uptime" do
+      expect(wmi).to receive(:first_of).with("Win32_PerfFormattedData_PerfOS_System")
+      expect(Time).to_not receive(:new)
+      expect(Time).to_not receive(:parse)
+      expect(uptime_plugin).to receive(:seconds_to_human)
+      uptime_plugin.run
+    end
+  end
+
+  context "platform is Windows Server 2008 R2" do
+    let(:uptime_plugin) do
+      get_plugin("uptime").tap do |plugin|
+        plugin[:platform_version] = "6.1.7601"
+      end
+    end
+
+    include_context "WMI class for newer versions of Windows platform"
+  end
+
+  context "platform is Windows Server 2003 R2" do
+    let(:uptime_plugin) do
+      get_plugin("uptime").tap do |plugin|
+        plugin[:platform_version] = "5.2.3790"
+      end
+    end
+
+    include_context "WMI class for older versions of Windows platform"
+  end
+
+  context "platform is Windows Server 2012" do
+    let(:uptime_plugin) do
+      get_plugin("uptime").tap do |plugin|
+        plugin[:platform_version] = "6.2.9200"
+      end
+    end
+
+    include_context "WMI class for newer versions of Windows platform"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ohai
 version: !ruby/object:Gem::Version
-  version: 8.20.0
+  version: 8.21.0
 platform: ruby
 authors:
 - Adam Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: systemu
@@ -429,6 +429,7 @@ files:
 - lib/ohai/plugins/ruby.rb
 - lib/ohai/plugins/rust.rb
 - lib/ohai/plugins/scala.rb
+- lib/ohai/plugins/shard.rb
 - lib/ohai/plugins/shells.rb
 - lib/ohai/plugins/sigar/cpu.rb
 - lib/ohai/plugins/sigar/filesystem.rb
@@ -499,6 +500,7 @@ files:
 - spec/functional/loader_spec.rb
 - spec/functional/plugins/powershell_spec.rb
 - spec/functional/plugins/root_group_spec.rb
+- spec/functional/plugins/windows/uptime_spec.rb
 - spec/ohai_spec.rb
 - spec/rcov.opts
 - spec/spec.opts
@@ -610,6 +612,7 @@ files:
 - spec/unit/plugins/ruby_spec.rb
 - spec/unit/plugins/rust_spec.rb
 - spec/unit/plugins/scala_spec.rb
+- spec/unit/plugins/shard_spec.rb
 - spec/unit/plugins/shells_spec.rb
 - spec/unit/plugins/sigar/network_route_spec.rb
 - spec/unit/plugins/softlayer_spec.rb
@@ -630,6 +633,7 @@ files:
 - spec/unit/plugins/windows/cpu_spec.rb
 - spec/unit/plugins/windows/fips_spec.rb
 - spec/unit/plugins/windows/memory_spec.rb
+- spec/unit/plugins/windows/uptime_spec.rb
 - spec/unit/plugins/windows/virtualization_spec.rb
 - spec/unit/provides_map_spec.rb
 - spec/unit/runner_spec.rb
@@ -656,7 +660,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: Ohai profiles your system and emits JSON