ohai 7.2.0.alpha.0 → 7.2.0.rc.0

data/lib/ohai/plugins/root_group.rb

@@ -18,13 +18,13 @@
 Ohai.plugin(:RootGroup) do
   provides 'root_group'
 
+  require 'ohai/util/win32/group_helper' if RUBY_PLATFORM =~ /mswin|mingw32|windows/
+
   collect_data do
     case ::RbConfig::CONFIG['host_os']
     when /mswin|mingw32|windows/
-      # TODO: OHAI-491
-      # http://tickets.opscode.com/browse/OHAI-491
-      # The windows implementation of this plugin has been removed because of
-      # performance considerations (see: OHAI-490).
+      group = Ohai::Util::Win32::GroupHelper.windows_root_group_name
+      root_group group
     else
       root_group Etc.getgrgid(Etc.getpwnam('root').gid).name
     end

data/lib/ohai/plugins/solaris2/virtualization.rb

@@ -21,6 +21,12 @@
 Ohai.plugin(:Virtualization) do
   provides "virtualization"
 
+  def collect_solaris_guestid
+    command = '/usr/sbin/zoneadm list -p'
+    so = shell_out(command)
+    so.stdout.split(':').first
+  end
+
   collect_data(:solaris2) do
     virtualization Mash.new
 
@@ -75,6 +81,7 @@ Ohai.plugin(:Virtualization) do
           virtualization[:system] = 'zone'
           virtualization[:role] = 'guest'
           virtualization[:guest_uuid] = zones[first_zone]['uuid']
+          virtualization[:guest_id] = collect_solaris_guestid
         end
       elsif (zones.length > 1)
         virtualization[:system] = 'zone'

data/lib/ohai/system.rb

@@ -29,7 +29,7 @@ require 'ohai/provides_map'
 require 'ohai/hints'
 require 'mixlib/shellout'
 
-require 'yajl'
+require 'ffi_yajl'
 
 module Ohai
   class System
@@ -173,14 +173,14 @@ module Ohai
     # Serialize this object as a hash
     #
     def to_json
-      Yajl::Encoder.new.encode(@data)
+      FFI_Yajl::Encoder.new.encode(@data)
     end
 
     #
     # Pretty Print this object as JSON
     #
     def json_pretty_print(item=nil)
-      Yajl::Encoder.new(:pretty => true).encode(item || @data)
+      FFI_Yajl::Encoder.new(:pretty => true).encode(item || @data)
     end
 
     def attributes_print(a)

data/lib/ohai/util/win32.rb

@@ -0,0 +1,46 @@
+# Author:: Adam Edwards (<adamed@getchef.com>)
+#
+# Copyright:: Copyright (c) 2013-14 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.
+
+module Ohai
+  module Util
+    module Win32
+      if RUBY_PLATFORM =~ /mswin|mingw|windows/
+
+        require 'ffi'
+
+        extend FFI::Library
+
+        ffi_lib 'advapi32'
+
+        attach_function :lookup_account_sid,
+        :LookupAccountSidA,[ :pointer, :pointer, :pointer, :pointer, :pointer, :pointer, :pointer ], :long
+
+        attach_function :convert_string_sid_to_sid,
+        :ConvertStringSidToSidA,[ :pointer, :pointer ], :long
+
+        ffi_lib 'kernel32'
+
+        attach_function :local_free,
+        :LocalFree, [ :pointer ], :long
+
+        attach_function :get_last_error,
+        :GetLastError, [], :long
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# Author:: Adam Edwards (<adamed@getchef.com>)
+#
+# Copyright:: Copyright (c) 2013-14 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 'ohai/util/win32'
+
+module Ohai
+  module Util
+    class Win32::GroupHelper
+
+      # Per http://support.microsoft.com/kb/243330 SID: S-1-5-32-544 is the
+      # internal name for the Administrators group, which lets us work
+      # properly in environments with a renamed or localized name for the
+      # Administrators group
+      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
+
+        if convert_result == 0
+          raise "ERROR: failed to to convert sid string '#{BUILTIN_ADMINISTRATORS_SID}' to a Windows SID structure because Win32 API function ConvertStringSidToSid returned #{last_win32_error}."
+        end
+
+        administrators_group_name_buffer = 0.chr * 260
+        administrators_group_name_length = [administrators_group_name_buffer.length].pack('L')
+        domain_name_length_buffer = [260].pack('L')
+        sid_use_result = 0.chr * 4
+
+        # Use LookupAccountSid rather than WMI's Win32_Group class because WMI will attempt
+        # to include (unneeded) Active Directory groups by querying AD, which is a performance
+        # and reliability issue since AD might not be reachable. Additionally, in domains with
+        # thousands of groups, the WMI query is very slow,  on the order of minutes, even to
+        # get the first result. So we use LookupAccountSid which is a purely local lookup
+        # of the built-in group, with no need to access AD, and thus no failure modes related
+        # to network conditions or query performance.
+        lookup_boolean_result = Win32.lookup_account_sid(
+                                                         nil,
+                                                         administrators_sid_result.read_pointer,
+                                                         administrators_group_name_buffer,
+                                                         administrators_group_name_length,
+                                                         nil,
+                                                         domain_name_length_buffer,
+                                                         sid_use_result)
+
+        last_win32_error = Win32.get_last_error
+
+        Win32.local_free(administrators_sid_result.read_pointer)
+
+        if lookup_boolean_result == 0
+          raise "ERROR: failed to find root group (i.e. builtin\\administrators) for sid #{BUILTIN_ADMINISTRATORS_SID} because Win32 API function LookupAccountSid returned #{last_win32_error}."
+        end
+
+        administrators_group_name_buffer.strip
+      end
+    end
+  end
+end
+

data/lib/ohai/version.rb

@@ -18,5 +18,5 @@
 
 module Ohai
   OHAI_ROOT = File.expand_path(File.dirname(__FILE__))
-  VERSION = '7.2.0.alpha.0'
+  VERSION = '7.2.0.rc.0'
 end

data/spec/functional/plugins/root_group_spec.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Adam Edwards (<adamed@getchef.com>)
+#
+# Copyright:: Copyright (c) 2014 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, 'root_group plugin' do
+  let(:plugin) { get_plugin("root_group") }
+
+  describe 'windows platform', :windows_only do
+    let (:wmi) {  wmi = WmiLite::Wmi.new }
+
+    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
+      # something to watch if you run this test in such an environment.
+      groups = wmi.query("select * from Win32_Group where sid = 'S-1-5-32-544'")
+      groups.length.should == 1
+      administrators_group = groups[0]['name'].downcase
+      plugin.run
+      expect(plugin[:root_group].downcase).to be == administrators_group
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require 'rspec'
+require 'rspec/collection_matchers'
 
 # require 'pry-debugger'
 # require 'pry-stack_explorer'
@@ -8,6 +9,7 @@ $:.unshift(File.dirname(__FILE__) + '/../lib')
 
 require 'spec/support/platform_helpers'
 require 'spec/support/integration_helper'
+require 'wmi-lite'
 require 'ohai'
 Ohai::Config[:log_level] = :error
 
@@ -84,7 +86,17 @@ def it_should_check_from_deep_mash(plugin, mash, attribute, from, value)
 end
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+
+  config.raise_errors_for_deprecations!
+
+  # `expect` should be preferred for new tests or when refactoring old tests,
+  # but we're not going to do a "big bang" change at this time.
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
 
   config.filter_run :focus => true
 

data/spec/unit/dsl/plugin_spec.rb

@@ -22,7 +22,7 @@ require File.expand_path("../../../spec_helper.rb", __FILE__)
 shared_examples "Ohai::DSL::Plugin" do
   context "#initialize" do
     it "should set has_run? to false" do
-      plugin.has_run?.should be_false
+      plugin.has_run?.should be false
     end
 
     it "should set the correct plugin version" do
@@ -48,7 +48,7 @@ shared_examples "Ohai::DSL::Plugin" do
 
       it "should set has_run? to true" do
         plugin.run
-        plugin.has_run?.should be_true
+        plugin.has_run?.should be true
       end
     end
 
@@ -69,7 +69,7 @@ shared_examples "Ohai::DSL::Plugin" do
 
       it "should set has_run? to true" do
         plugin.run
-        plugin.has_run?.should be_true
+        plugin.has_run?.should be true
       end
     end
   end

data/spec/unit/plugins/darwin/memory_spec.rb

@@ -0,0 +1,64 @@
+#
+# Author:: Patrick Collins (<pat@burned.com>)
+# Copyright:: Copyright (c) 2013 Opscode, 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, "Darwin Memory Plugin" do
+  before(:each) do
+    darwin_memsize = <<-DARWIN_MEMSIZE
+17179869184
+    DARWIN_MEMSIZE
+    darwin_vm_stat = <<-DARWIN_VM_STAT
+Mach Virtual Memory Statistics: (page size of 4096 bytes)
+Pages free:                        2155305.
+Pages active:                       924164.
+Pages inactive:                     189127.
+Pages speculative:                  531321.
+Pages wired down:                   391749.
+"Translation faults":             14107520.
+Pages copy-on-write:                810071.
+Pages zero filled:                 6981505.
+Pages reactivated:                    1397.
+Pageins:                            630064.
+Pageouts:                                0.
+Object cache: 12 hits of 139872 lookups (0% hit rate)
+    DARWIN_VM_STAT
+
+    @plugin = get_plugin("darwin/memory")
+    @plugin.stub(:collect_os).and_return(:darwin)
+    @plugin.stub(:shell_out).with("sysctl -n hw.memsize").and_return(mock_shell_out(0, darwin_memsize, ""))
+    @plugin.stub(:shell_out).with("vm_stat").and_return(mock_shell_out(0, darwin_vm_stat, ""))
+    @plugin.run
+  end
+
+  it "should set memory[:total] to 16384MB" do
+    @plugin[:memory][:total].should == '16384MB'
+  end
+
+  it "should set memory[:active] to 5140MB" do
+    @plugin[:memory][:active].should == '5140MB'
+  end
+
+  it "should set memory[:inactive] to 738MB" do
+    @plugin[:memory][:inactive].should == '738MB'
+  end
+
+  it "should set memory[:free] to 10504MB" do
+    @plugin[:memory][:free].should == '10504MB'
+  end
+end

data/spec/unit/plugins/ec2_spec.rb

@@ -12,7 +12,7 @@
 #
 # 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 CONDIT"Net::HTTP Response"NS OF ANY KIND, either express or implied.
+# 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.
 #
@@ -157,6 +157,27 @@ describe Ohai::System, "plugin ec2" do
 
       @plugin[:ec2].should_not be_nil
     end
+
+    it "should complete the run despite unavailable metadata" do
+      @http_client.should_receive(:get).
+        with("/2012-01-12/meta-data/").
+        and_return(double("Net::HTTP Response", :body => "metrics/", :code => "200"))
+      @http_client.should_receive(:get).
+        with("/2012-01-12/meta-data/metrics/").
+        and_return(double("Net::HTTP Response", :body => "vhostmd", :code => "200"))
+      @http_client.should_receive(:get).
+        with("/2012-01-12/meta-data/metrics/vhostmd").
+        and_return(double("Net::HTTP Response", :body => "", :code => "404"))
+      @http_client.should_receive(:get).
+        with("/2012-01-12/user-data/").
+        and_return(double("Net::HTTP Response", :body => "By the pricking of my thumb...", :code => "200"))
+
+      @plugin.run
+
+      @plugin[:ec2].should_not be_nil
+      @plugin[:ec2]['metrics'].should be_nil
+      @plugin[:ec2]['metrics_vhostmd'].should be_nil
+    end
   end
 
   describe "with ec2 mac and metadata address connected" do

data/spec/unit/plugins/gce_spec.rb

@@ -72,7 +72,7 @@ describe Ohai::System, "plugin gce" do
       File.stub(:exist?).with('/etc/chef/ohai/hints/gce.json').and_return(false)
       File.stub(:exist?).with('C:\chef\ohai\hints/gce.json').and_return(false)
 
-      # Raise Errno::ENOENT to simulate the scenario in which metadata server 
+      # Raise Errno::ENOENT to simulate the scenario in which metadata server
       # can not be connected
       t = double("connection")
       t.stub(:connect_nonblock).and_raise(Errno::ENOENT)

data/spec/unit/plugins/joyent_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+
+describe Ohai::System, "plugin joyent" do
+  before(:each) do
+    @plugin = get_plugin('joyent')
+  end
+
+  describe "without joyent" do
+    before(:each) do
+      @plugin.stub(:is_smartos?).and_return(false)
+    end
+
+    it "should NOT create joyent" do
+      @plugin.run
+      @plugin[:joyent].should be_nil
+    end
+  end
+
+  describe "with joyent" do
+    before(:each) do
+      @plugin.stub(:is_smartos?).and_return(true)
+      @plugin[:virtualization] = Mash.new
+      @plugin[:virtualization][:guest_uuid] = "global"
+    end
+
+    it "should create joyent" do
+      @plugin.run
+      @plugin[:joyent].should_not be_nil
+    end
+
+    describe "under global zone" do
+      before(:each) do
+        @plugin.run
+      end
+
+      it "should ditect global zone" do
+        @plugin[:joyent][:sm_uuid].should eql 'global'
+      end
+
+      it "should NOT create sm_id" do
+        @plugin[:joyent][:sm_id].should be_nil
+      end
+    end
+
+    describe "under smartmachine" do
+      before(:each) do
+        @plugin[:virtualization][:guest_uuid] = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx'
+        @plugin[:virtualization][:guest_id] = '30'
+        @plugin.stub(:collect_product_file).and_return(["Name: Joyent Instance", "Image: base64 13.4.2", "Documentation: http://wiki.joyent.com/jpc2/SmartMachine+Base"])
+        @plugin.stub(:collect_pkgsrc).and_return('http://pkgsrc.joyent.com/packages/SmartOS/2013Q4/x86_64/All')
+        @plugin.run
+      end
+
+      it "should retrive zone uuid" do
+        @plugin[:joyent][:sm_uuid].should eql 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx'
+      end
+
+      it "should collect sm_id" do
+        @plugin[:joyent][:sm_id].should eql '30'
+      end
+
+      it "should collect images" do
+        @plugin[:joyent][:sm_image_id].should_not be_nil
+        @plugin[:joyent][:sm_image_ver].should_not be_nil
+      end
+
+      it "should collect pkgsrc" do
+        @plugin[:joyent][:sm_pkgsrc].should eql 'http://pkgsrc.joyent.com/packages/SmartOS/2013Q4/x86_64/All'
+      end
+    end
+  end
+end
+