ohai 6.24.2 → 7.0.0.rc.0

data/lib/ohai.rb

@@ -19,4 +19,4 @@
 require 'ohai/version'
 require 'ohai/config'
 require 'ohai/system'
-
+require 'ohai/exception'

data/lib/ohai/application.rb

@@ -27,11 +27,6 @@ class Ohai::Application
     :long        => "--directory DIRECTORY",
     :description => "A directory to add to the Ohai search path"
 
-  option :file,
-    :short       => "-f FILE",
-    :long        => "--file FILE",
-    :description => "A file to run Ohai against"
-
   option :log_level,
     :short        => "-l LEVEL",
     :long         => "--log_level LEVEL",
@@ -56,7 +51,7 @@ class Ohai::Application
   option :version,
     :short        => "-v",
     :long         => "--version",
-    :description  => "Show chef version",
+    :description  => "Show Ohai version",
     :boolean      => true,
     :proc         => lambda {|v| puts "Ohai: #{::Ohai::VERSION}"},
     :exit         => 0
@@ -77,6 +72,7 @@ class Ohai::Application
 
   def configure_ohai
     @attributes = parse_options
+    @attributes = nil if @attributes.empty?
 
     Ohai::Config.merge!(config)
     if Ohai::Config[:directory]
@@ -91,12 +87,9 @@ class Ohai::Application
 
   def run_application
     ohai = Ohai::System.new
-    if Ohai::Config[:file]
-      ohai.from_file(Ohai::Config[:file])
-    else
-      ohai.all_plugins
-    end
-    if @attributes.length > 0
+    ohai.all_plugins(@attributes)
+
+    if @attributes
       @attributes.each do |a|
         puts ohai.attributes_print(a)
       end

data/lib/ohai/common/dmi.rb

@@ -0,0 +1,126 @@
+#
+# Author:: Kurt Yoder (ktyopscode@yoderhome.com)
+# Copyright:: Copyright (c) 2010 Kurt Yoder
+# 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 Common
+    module DMI
+      # List of IDs and what they translate to
+      # from 'man 8 dmidecode'
+      # all-lowercase, all non-alphanumeric converted to '_'
+      # 128-255 are 'oem_data_[id]'
+      # Everything else is 'unknown'
+      IdToDescription = {
+        0 =>   'bios',
+        1 =>   'system',
+        2 =>   'base_board',
+        3 =>   'chassis',
+        4 =>   'processor',
+        5 =>   'memory_controller',
+        6 =>   'memory_module',
+        7 =>   'cache',
+        8 =>   'port_connector',
+        9 =>   'system_slots',
+        10 =>  'on_board_devices',
+        11 =>  'oem_strings',
+        12 =>  'system_configuration_options',
+        13 =>  'bios_language',
+        14 =>  'group_associations',
+        15 =>  'system_event_log',
+        16 =>  'physical_memory_array',
+        17 =>  'memory_device',
+        18 =>  '32_bit_memory_error',
+        19 =>  'memory_array_mapped_address',
+        20 =>  'memory_device_mapped_address',
+        21 =>  'built_in_pointing_device',
+        22 =>  'portable_battery',
+        23 =>  'system_reset',
+        24 =>  'hardware_security',
+        25 =>  'system_power_controls',
+        26 =>  'voltage_probe',
+        27 =>  'cooling_device',
+        28 =>  'temperature_probe',
+        29 =>  'electrical_current_probe',
+        30 =>  'out_of_band_remote_access',
+        31 =>  'boot_integrity_services',
+        32 =>  'system_boot',
+        33 =>  '64_bit_memory_error',
+        34 =>  'management_device',
+        35 =>  'management_device_component',
+        36 =>  'management_device_threshold_data',
+        37 =>  'memory_channel',
+        38 =>  'ipmi_device',
+        39 =>  'power_supply',
+        126 => 'disabled_entries',
+        127 => 'end_of_table_marker',
+      }
+
+      # list of IDs to collect, otherwise we generate pages of hashes about cache chip size and whatnot
+      # See OHAI-260. When we can give the user a choice, this will be a default.
+      IdToCapture = [ 0, 1, 2, 3, 4, 6, 11 ]
+
+      # look up DMI ID
+      def id_lookup(id)
+        begin
+          id = id.to_i
+          if (id >= 128) and (id <= 255)
+            id = "oem_data_#{id}"
+          elsif DMI::IdToDescription.has_key?(id)
+            id = DMI::IdToDescription[id]
+          else
+            Ohai::Log.debug("unrecognized header id; falling back to 'unknown'")
+            id = 'unknown'
+          end
+        rescue
+          Ohai::Log.debug("failed to look up id #{id}, returning unchanged")
+          id
+        end
+      end
+
+      # create simplified convenience access keys for each record type
+      # for single occurrences of one type, copy to top level all fields and values
+      # for multiple occurrences of same type, copy to top level all fields and values that are common to all records
+      def convenience_keys(dmi)
+        dmi.each{ |type, records|
+          in_common = Mash.new
+          next unless records.class.to_s == 'Mash'
+          next unless records.has_key?('all_records')
+          records[:all_records].each{ |record| 
+            record.each{ |field, value| 
+              next if value.class.to_s == 'Mash'
+              next if field.to_s == 'application_identifier'
+              next if field.to_s == 'size'
+              next if field.to_s == 'record_id'
+              translated = field.downcase.gsub(/[^a-z0-9]/, '_')
+              if in_common.has_key?(translated)
+                in_common[translated] = nil unless in_common[translated] == value
+              else
+                in_common[translated] = value
+              end
+            }
+          }
+          in_common.each{ |field, value|
+            next if value == nil
+            dmi[type][field] = value
+          }
+        }
+      end
+
+      module_function :id_lookup, :convenience_keys
+    end
+  end
+end

data/lib/ohai/config.rb

@@ -6,9 +6,9 @@
 # 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.
@@ -21,7 +21,7 @@ require 'mixlib/config'
 module Ohai
   class Config
     extend Mixlib::Config
-    
+
     # from chef/config.rb, should maybe be moved to mixlib-config?
     def self.platform_specific_path(path)
       if RUBY_PLATFORM =~ /mswin|mingw|windows/
@@ -32,12 +32,12 @@ module Ohai
       end
       path
     end
-    
 
-    log_level :info
-    log_location STDOUT
-    plugin_path [ File.expand_path(File.join(File.dirname(__FILE__), 'plugins'))]
-    disabled_plugins []
-    hints_path [ platform_specific_path('/etc/chef/ohai/hints') ]
+
+    default :log_level, :info
+    default :log_location, STDERR
+    default :plugin_path, [ File.expand_path(File.join(File.dirname(__FILE__), 'plugins'))]
+    default :disabled_plugins, []
+    default(:hints_path) { [ platform_specific_path('/etc/chef/ohai/hints') ] }
   end
 end

data/lib/ohai/{plugins/darwin/hostname.rb → dsl.rb}

@@ -1,6 +1,6 @@
 #
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# Author:: Serdar Sutay (<serdar@opscode.com>)
+# Copyright:: Copyright (c) 2013 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -11,12 +11,12 @@
 #
 # 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.
+# 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.
 #
 
-provides "fqdn", "hostname"
-
-hostname from("hostname -s")
-fqdn from("hostname")
+require 'ohai/dsl/plugin'
+require 'ohai/dsl/plugin/versionvi'
+require 'ohai/dsl/plugin/versionvii'

data/lib/ohai/dsl/plugin.rb

@@ -0,0 +1,186 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Claire McQuin (<claire@opscode.com>)
+# Copyright:: Copyright (c) 2008, 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 'ohai/mixin/os'
+require 'ohai/mixin/command'
+require 'ohai/mixin/seconds_to_human'
+require 'ohai/hints'
+
+module Ohai
+
+  # For plugin namespacing
+  module NamedPlugin
+    def self.valid_name?(name)
+      name.is_a?(Symbol) && name.to_s.match(/^[^A-Z]|_/).nil?
+    end
+
+    # dealing with ruby 1.8
+    if Module.method(:const_defined?).arity == 1
+      def self.strict_const_defined?(const)
+        const_defined?(const)
+      end
+    else
+      def self.strict_const_defined?(const)
+        const_defined?(const, false)
+      end
+    end
+  end
+
+  def self.plugin(name, &block)
+    raise Ohai::Exceptions::InvalidPluginName, "#{name} is not a valid plugin name. A valid plugin name is a symbol which begins with a capital letter and contains no underscores" unless NamedPlugin.valid_name?(name)
+
+    plugin = nil
+
+    if NamedPlugin.strict_const_defined?(name)
+      plugin = NamedPlugin.const_get(name)
+      plugin.class_eval(&block)
+    else
+      klass = Class.new(DSL::Plugin::VersionVII, &block)
+      plugin = NamedPlugin.const_set(name, klass)
+    end
+
+    plugin
+  end
+
+  # Cross platform /dev/null to support testability
+  def self.dev_null
+    if RUBY_PLATFORM =~ /mswin|mingw|windows/
+      "NUL"
+    else
+      "/dev/null"
+    end
+  end
+
+  # Extracted abs_path to support testability:
+  # This method gets overridden at test time, to force the shell to check
+  # ohai/spec/unit/path/original/absolute/path/to/exe
+  def self.abs_path( abs_path )
+    abs_path
+  end
+
+  module DSL
+    class Plugin
+
+      include Ohai::Mixin::OS
+      include Ohai::Mixin::Command
+      include Ohai::Mixin::SecondsToHuman
+
+      attr_reader :data
+
+      def initialize(data)
+        @data = data
+        @has_run = false
+      end
+
+      def run
+        @has_run = true
+        run_plugin
+      end
+
+      def has_run?
+        @has_run
+      end
+
+      def reset!
+        @has_run = false
+      end
+
+      def [](key)
+        @data[key]
+      end
+
+      def []=(key, value)
+        @data[key] = value
+      end
+
+      def each(&block)
+        @data.each do |key, value|
+          block.call(key, value)
+        end
+      end
+
+      def attribute?(name)
+        @data.has_key?(name)
+      end
+
+      def set(name, *value)
+        set_attribute(name, *value)
+      end
+
+      def from(cmd)
+        status, stdout, stderr = run_command(:command => cmd)
+        return "" if stdout.nil? || stdout.empty?
+        stdout.strip
+      end
+
+      # Set the value equal to the stdout of the command, plus
+      # run through a regex - the first piece of match data is\
+      # the value.
+      def from_with_regex(cmd, *regex_list)
+        regex_list.flatten.each do |regex|
+          status, stdout, stderr = run_command(:command => cmd)
+          return "" if stdout.nil? || stdout.empty?
+          stdout.chomp!.strip
+          md = stdout.match(regex)
+          return md[1]
+        end
+      end
+
+      def set_attribute(name, *values)
+        @data[name] = Array18(*values)
+        @data[name]
+      end
+
+      def get_attribute(name)
+        @data[name]
+      end
+
+      def hint?(name)
+        Ohai::Hints.hint?(name)
+      end
+
+      # emulates the old plugin loading behavior
+      def safe_run
+        begin
+          self.run
+        rescue Ohai::Exceptions::Error => e
+          raise e
+        rescue => e
+          Ohai::Log.debug("Plugin #{self.name} threw #{e.inspect}")
+          e.backtrace.each { |line| Ohai::Log.debug( line )}
+        end
+      end
+
+      def method_missing(name, *args)
+        return get_attribute(name) if args.length == 0
+
+        set_attribute(name, *args)
+      end
+
+      private
+
+      def Array18(*args)
+        return nil if args.empty?
+        return args.first if args.length == 1
+        return *args
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+#
+# Author:: Serdar Sutay (<serdar@opscode.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.
+#
+
+module Ohai
+  module DSL
+    class Plugin
+      class VersionVI < Plugin
+        attr_reader :version
+        attr_reader :source
+
+        def initialize(controller, plugin_path, plugin_dir_path)
+          super(controller.data)
+          @controller = controller
+          @version = :version6
+          @source = plugin_path
+          @plugin_dir_path = plugin_dir_path
+        end
+
+        def name
+          # Ohai V6 doesn't have any name specification for plugins. 
+          # So we are using the partial path to infer the name of the plugin
+          partial_path = Pathname.new(@source).relative_path_from(Pathname.new(@plugin_dir_path)).to_s
+          partial_path.chomp(".rb").gsub("/", "::")
+        end
+
+        def self.version
+          :version6
+        end
+
+        def self.collect_contents(contents)
+          define_method(:run_plugin) { self.instance_eval(contents) }
+        end
+
+        def provides(*paths)
+          Ohai::Log.debug("Skipping provides '#{paths.join(",")}' for plugin '#{name}'")
+        end
+
+        def require_plugin(plugin_ref)
+          @controller.require_plugin(plugin_ref)
+        end
+
+      end
+    end
+  end
+end
+