rightscale-ohai 0.3.3.1

data/lib/ohai/exception.rb

@@ -0,0 +1,23 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 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 Exceptions
+    class Exec < RuntimeError; end
+  end
+end

data/lib/ohai/log/formatter.rb

@@ -0,0 +1,57 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 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 'logger'
+require 'time'
+
+module Ohai
+  class Log
+    class Formatter < Logger::Formatter
+      @@show_time = true
+      
+      def self.show_time=(show=false)
+        @@show_time = show
+      end
+      
+      # Prints a log message as '[time] severity: message' if Ohai::Log::Formatter.show_time == true.
+      # Otherwise, doesn't print the time.
+      def call(severity, time, progname, msg)
+        if @@show_time
+          sprintf("[%s] %s: %s\n", time.rfc2822(), severity, msg2str(msg))
+        else
+          sprintf("%s: %s\n", severity, msg2str(msg))
+        end
+      end
+      
+      # Converts some argument to a Logger.severity() call to a string.  Regular strings pass through like
+      # normal, Exceptions get formatted as "message (class)\nbacktrace", and other random stuff gets 
+      # put through "object.inspect"
+      def msg2str(msg)
+        case msg
+        when ::String
+          msg
+        when ::Exception
+          "#{ msg.message } (#{ msg.class })\n" <<
+            (msg.backtrace || []).join("\n")
+        else
+          msg.inspect
+        end
+      end
+    end
+  end
+end

data/lib/ohai/log.rb

@@ -0,0 +1,89 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 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/config'
+require 'ohai/log/formatter'
+require 'logger'
+
+module Ohai
+  class Log
+  
+    @logger = nil
+    
+    class << self
+      attr_accessor :logger #:nodoc
+      
+      # Use Ohai::Logger.init when you want to set up the logger manually.  Arguments to this method
+      # get passed directly to Logger.new, so check out the documentation for the standard Logger class
+      # to understand what to do here.
+      #
+      # If this method is called with no arguments, it will log to STDOUT at the :info level.
+      #
+      # It also configures the Logger instance it creates to use the custom Ohai::Log::Formatter class.
+      def init(*opts)
+        if opts.length == 0
+          @logger = Logger.new(STDOUT)
+        else
+          @logger = Logger.new(*opts)
+        end
+        @logger.formatter = Ohai::Log::Formatter.new()
+        level(Ohai::Config.log_level)
+      end
+      
+      # Sets the level for the Logger object by symbol.  Valid arguments are:
+      #
+      #  :debug
+      #  :info
+      #  :warn
+      #  :error
+      #  :fatal
+      #
+      # Throws an ArgumentError if you feed it a bogus log level.
+      def level(loglevel)
+        init() unless @logger
+        case loglevel
+        when :debug
+          @logger.level = Logger::DEBUG
+        when :info
+          @logger.level = Logger::INFO
+        when :warn
+          @logger.level = Logger::WARN
+        when :error
+          @logger.level = Logger::ERROR
+        when :fatal
+          @logger.level = Logger::FATAL
+        else
+          raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal"
+        end
+      end
+      
+      # Passes any other method calls on directly to the underlying Logger object created with init. If
+      # this method gets hit before a call to Ohai::Logger.init has been made, it will call 
+      # Ohai::Logger.init() with no arguments.
+      def method_missing(method_symbol, *args)
+        init() unless @logger
+        if args.length > 0
+          @logger.send(method_symbol, *args)
+        else
+          @logger.send(method_symbol)
+        end
+      end
+      
+    end # class << self
+  end
+end

data/lib/ohai/mixin/command.rb

@@ -0,0 +1,203 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 Opscode, Inc.
+# License:: GNU GPL, Version 3
+#
+# Copyright (C) 2008, Opscode Inc. 
+# 
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ohai/exception'
+require 'ohai/config'
+require 'ohai/log'
+require 'tmpdir'
+require 'fcntl'
+require 'etc'
+require 'systemu'
+
+module Ohai
+  module Mixin
+    module Command
+      
+      def run_command(args={})         
+        if args.has_key?(:creates)
+          if File.exists?(args[:creates])
+            Ohai::Log.debug("Skipping #{args[:command]} - creates #{args[:creates]} exists.")
+            return false
+          end
+        end
+        
+        stdout_string = nil
+        stderr_string = nil
+                
+        args[:cwd] ||= Dir.tmpdir        
+        unless File.directory?(args[:cwd])
+          raise Ohai::Exceptions::Exec, "#{args[:cwd]} does not exist or is not a directory"
+        end
+        
+        status = nil
+        Dir.chdir(args[:cwd]) do
+          if args[:timeout]
+            begin
+              Timeout.timeout(args[:timeout]) do
+                status, stdout_string, stderr_string = systemu(args[:command])
+              end
+            rescue Exception => e
+              Ohai::Log.error("#{args[:command_string]} exceeded timeout #{args[:timeout]}")
+              raise(e)
+            end
+          else
+            status, stdout_string, stderr_string = systemu(args[:command])
+          end
+
+          # systemu returns 42 when it hits unexpected errors
+          if status.exitstatus == 42 and stderr_string == ""
+            stderr_string = "Failed to run: #{args[:command]}, assuming command not found"
+            Ohai::Log.debug(stderr_string)          
+          end
+
+          if stdout_string
+            Ohai::Log.debug("---- Begin #{args[:command]} STDOUT ----")
+            Ohai::Log.debug(stdout_string.strip)
+            Ohai::Log.debug("---- End #{args[:command]} STDOUT ----")
+          end
+          if stderr_string
+            Ohai::Log.debug("---- Begin #{args[:command]} STDERR ----")
+            Ohai::Log.debug(stderr_string.strip)
+            Ohai::Log.debug("---- End #{args[:command]} STDERR ----")
+          end
+        
+          args[:returns] ||= 0
+          args[:no_status_check] ||= false
+          if status.exitstatus != args[:returns] and not args[:no_status_check]
+            raise Ohai::Exceptions::Exec, "#{args[:command_string]} returned #{status.exitstatus}, expected #{args[:returns]}"
+          else
+            Ohai::Log.debug("Ran #{args[:command_string]} (#{args[:command]}) returned #{status.exitstatus}")
+          end
+        end
+        return status, stdout_string, stderr_string
+      end
+
+      module_function :run_command
+           
+      # This is taken directly from Ara T Howard's Open4 library, and then 
+      # modified to suit the needs of Ohai.  Any bugs here are most likely
+      # my own, and not Ara's.
+      #
+      # The original appears in external/open4.rb in its unmodified form. 
+      #
+      # Thanks Ara!
+      def popen4(cmd, args={}, &b)
+        
+        args[:user] ||= nil
+        unless args[:user].kind_of?(Integer)
+          args[:user] = Etc.getpwnam(args[:user]).uid if args[:user]
+        end
+        args[:group] ||= nil
+        unless args[:group].kind_of?(Integer)
+          args[:group] = Etc.getgrnam(args[:group]).gid if args[:group]
+        end
+        args[:environment] ||= nil
+        
+        pw, pr, pe, ps = IO.pipe, IO.pipe, IO.pipe, IO.pipe
+
+        verbose = $VERBOSE
+        begin
+          $VERBOSE = nil
+          ps.last.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
+
+          cid = fork {
+            pw.last.close
+            STDIN.reopen pw.first
+            pw.first.close
+
+            pr.first.close
+            STDOUT.reopen pr.last
+            pr.last.close
+
+            pe.first.close
+            STDERR.reopen pe.last
+            pe.last.close
+
+            STDOUT.sync = STDERR.sync = true
+
+            if args[:user]
+              Process.euid = args[:user]
+              Process.uid = args[:user]
+            end
+            
+            if args[:group]
+              Process.egid = args[:group]
+              Process.gid = args[:group]
+            end
+            
+            if args[:environment]
+              args[:environment].each do |key,value|
+                ENV[key] = value
+              end
+            end
+            
+            begin
+              if cmd.kind_of?(Array)
+                exec(*cmd)
+              else
+                exec(cmd)
+              end
+              raise 'forty-two' 
+            rescue Exception => e
+              Marshal.dump(e, ps.last)
+              ps.last.flush
+            end
+            ps.last.close unless (ps.last.closed?)
+            exit!
+          }
+        ensure
+          $VERBOSE = verbose
+        end
+
+        [pw.first, pr.last, pe.last, ps.last].each{|fd| fd.close}
+
+        begin
+          e = Marshal.load ps.first
+          # If we get here, exec failed. Collect status of child to prevent
+          # zombies.
+          Process.waitpid(cid)
+          raise(Exception === e ? e : "unknown failure!")
+        rescue EOFError # If we get an EOF error, then the exec was successful
+          42
+        ensure
+          ps.first.close
+        end
+
+        pw.last.sync = true
+
+        pi = [pw.last, pr.first, pe.first]
+
+        if b 
+          begin
+            b[cid, *pi]
+            Process.waitpid2(cid).last
+          ensure
+            pi.each{|fd| fd.close unless fd.closed?}
+          end
+        else
+          [cid, pw.last, pr.first, pe.first]
+        end
+      end      
+      
+      module_function :popen4
+    end
+  end
+end

data/lib/ohai/mixin/from_file.rb

@@ -0,0 +1,36 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2008 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 Mixin
+    module FromFile
+    
+      # Loads a given ruby file, and runs instance_eval against it in the context of the current 
+      # object.  
+      #
+      # Raises an IOError if the file cannot be found, or is not readable.
+      def from_file(filename)
+        if File.exists?(filename) && File.readable?(filename)
+          self.instance_eval(IO.read(filename), filename, 1)
+        else
+          raise IOError, "Cannot open or read #{filename}!"
+        end
+      end
+    end
+  end
+end

data/lib/ohai/mixin/string.rb

@@ -0,0 +1,29 @@
+#
+# Author:: James Gartrell (<jgartrel@gmail.com>)
+# Copyright:: Copyright (c) 2009 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.
+#
+
+class String
+  # Add string function to handle WMI property conversion to json hash keys
+  # Makes an underscored, lowercase form from the expression in the string.
+  # underscore will also change ’::’ to ’/’ to convert namespaces to paths. 
+  # This should implement the same functionality as underscore method in
+  # ActiveSupport::CoreExtensions::String::Inflections
+  def wmi_underscore
+     self.gsub(/::/, '/').gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+     gsub(/([a-z\d])([A-Z])/,'\1_\2').tr("-", "_").downcase
+  end
+end

data/lib/ohai/plugins/cloud.rb

@@ -0,0 +1,35 @@
+#
+# Author:: Cary Penniman (<cary@rightscale.com>)
+# 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.
+
+provides "cloud"
+
+require_plugin "ec2"
+
+def on_ec2?
+  ec2 != nil
+end
+
+def get_ec2_values
+  cloud[:instance_id] = ec2['instance_id']
+  cloud[:public_ip] = ec2['public_ipv4']
+  cloud[:private_ip] = ec2['local_ipv4']
+  cloud[:provider] = "ec2"
+end
+
+if on_ec2?
+  cloud Mash.new
+  get_ec2_values
+end