rubyipmi 0.8.1 → 0.9.0

data/lib/rubyipmi/commands/basecommand.rb

@@ -1,5 +1,6 @@
 require "observer"
 require 'tempfile'
+require 'rubyipmi'
 
 module Rubyipmi
 
@@ -9,6 +10,10 @@ module Rubyipmi
     attr_accessor :options, :passfile
     attr_reader :lastcall, :result
 
+    def logger
+      Rubyipmi.logger
+    end
+
     def makecommand
       # override in subclass
     end
@@ -35,23 +40,23 @@ module Rubyipmi
     def locate_command(commandname)
       location = `which #{commandname}`.strip
       if not $?.success?
+        logger.error("#{commandname} command not found, is #{commandname} installed?") if logger
         raise "#{commandname} command not found, is #{commandname} installed?"
       end
-      return location
+      location
     end
 
     # Use this function to run the command line tool, it will inherently use the options hash for all options
     # That need to be specified on the command line
-    def runcmd(debug=false)
+    def runcmd
       @success = false
-      @success = run(debug)
-      if ENV['rubyipmi_debug'] == 'true'
-        puts @lastcall.inspect unless @lastcall.nil?
-      end
-      return @success
+      @success = run
+      logger.debug(@lastcall.inspect) unless @lastcall.nil? if logger
+      logger.debug(@result) unless @result.nil? if logger
+      @success
     end
 
-    def run(debug=false)
+    def run
       # we search for the command everytime just in case its removed during execution
       # we also don't want to add this to the initialize since mocking is difficult and we don't want to
       # throw errors upon object creation
@@ -60,11 +65,7 @@ module Rubyipmi
       @cmd = locate_command(@cmdname)
       setpass
       @result = nil
-      if debug
-        # Log error
-        return makecommand
-      end
-
+      logger.debug(makecommand) if logger
       begin
         command = makecommand
         @lastcall = "#{command}"
@@ -78,14 +79,13 @@ module Rubyipmi
           retrycount = retrycount.next
           retry
         else
+          logger.error("Exhausted all auto fixes, cannot determine what the problem is") if logger
           raise "Exhausted all auto fixes, cannot determine what the problem is"
         end
       ensure
         removepass
         return process_status
-
       end
-
     end
 
     # The findfix method acts like a recursive method and applies fixes defined in the errorcodes
@@ -98,8 +98,8 @@ module Rubyipmi
         begin
           fix = ErrorCodes.search(result)
           @options.merge_notify!(fix)
-
         rescue
+          Rubyipmi.logger.debug("Could not find fix for error code: \n#{result}") if logger
           raise "Could not find fix for error code: \n#{result}"
         end
       end
@@ -118,7 +118,5 @@ module Rubyipmi
         return true
       end
     end
-
-
   end
 end

data/lib/rubyipmi/freeipmi/commands/basecommand.rb

@@ -10,7 +10,6 @@ module Rubyipmi::Freeipmi
       @passfile.write "username #{@options["username"]}\n"
       @passfile.write "password #{@options["password"]}\n"
       @passfile.close
-
     end
 
     def max_retry_count
@@ -33,6 +32,7 @@ module Rubyipmi::Freeipmi
     end
 
     # This method will check if the results are really valid as the exit code can be misleading and incorrect
+    # this is required because freeipmi in older version always returned 0 even if an error occured
     def validate_status(exitstatus)
       case @cmdname
         when "ipmipower"
@@ -42,7 +42,7 @@ module Rubyipmi::Freeipmi
             raise "Error occurred"
           end
         when "bmc-config"
-          if @result.length > 100
+          if @result.length > 100 and exitstatus.success?
             return true
           else
             raise "Error occurred"
@@ -53,7 +53,6 @@ module Rubyipmi::Freeipmi
           else
             raise "Error occurred"
           end
-
       end
     end
 
@@ -66,7 +65,6 @@ module Rubyipmi::Freeipmi
         begin
           fix = ErrorCodes.search(result)
           @options.merge_notify!(fix)
-
         rescue
           raise "Could not find fix for error code: \n#{result}"
         end

data/lib/rubyipmi/freeipmi/commands/bmc.rb

@@ -10,6 +10,13 @@ module Rubyipmi::Freeipmi
       @bmcinfo = {}
     end
 
+    def version
+      @options['version'] = false
+      value = runcmd
+      @options.delete_notify('version')
+      @result.slice(/\d\.\d.\d/)
+    end
+
     def info
       if @bmcinfo.length > 0
         @bmcinfo

data/lib/rubyipmi/freeipmi/commands/bmcconfig.rb

@@ -8,6 +8,14 @@ module Rubyipmi::Freeipmi
 
     end
 
+    def verbose(on=false)
+      if on
+        @options['verbose'] = false
+      else
+        @options.delete_notify('verbose')
+      end
+    end
+
     def section(section)
       @options["checkout"] = false
       @options["section"] = section
@@ -33,6 +41,8 @@ module Rubyipmi::Freeipmi
 
     # returns the entire bmc-config configuration, can take a while to execute
     def configuration
+      require 'pry'
+      binding.pry
       @options["checkout"] = false
       value = runcmd
       @options.delete_notify("checkout")

data/lib/rubyipmi/freeipmi/commands/bmcdevice.rb

@@ -20,6 +20,7 @@ module Rubyipmi::Freeipmi
         key = "#{type}-reset"
         command(key)
       else
+        logger.error("reset type: #{type} is not a valid choice, use warm or cold") if logger
         raise "reset type: #{type} is not a valid choice, use warm or cold"
       end
     end

data/lib/rubyipmi/freeipmi/commands/bmcinfo.rb

@@ -7,7 +7,6 @@ module Rubyipmi::Freeipmi
 
     end
 
-
     def guid
       options["get-device-guid"] = false
       status = runcmd
@@ -48,8 +47,6 @@ module Rubyipmi::Freeipmi
         return bmcinfo
       end
     end
-
-
   end
 end
 

data/lib/rubyipmi/freeipmi/commands/chassis.rb

@@ -43,6 +43,7 @@ module Rubyipmi::Freeipmi
         end
 
       else
+        logger.error("Device with name: #{device} is not a valid boot device for host #{options["hostname"]}") if logger
         raise "Device with name: #{device} is not a valid boot device for host #{options["hostname"]}"
       end
     end

data/lib/rubyipmi/freeipmi/commands/chassisconfig.rb

@@ -62,8 +62,6 @@ module Rubyipmi::Freeipmi
       return value
     end
 
-
-
     # shortcut to set boot device to pxe
     def bootpxe(persistent=true)
       bootdevice("PXE",persistent)

data/lib/rubyipmi/freeipmi/commands/fru.rb

@@ -21,7 +21,6 @@ module Rubyipmi::Freeipmi
       end
     end
 
-
     def manufacturer
       get_from_list('board_manufacturer')
     end

data/lib/rubyipmi/freeipmi/commands/lan.rb

@@ -8,18 +8,17 @@ module Rubyipmi::Freeipmi
 
     def initialize(opts)
       @config = Rubyipmi::Freeipmi::BmcConfig.new(opts)
-
       @info = {}
       @channel = 2
     end
 
-
     def info
       if @info.length < 1
+        @config.verbose(true)
         parse(@config.section("Lan_Conf"))
-      else
-        @info
+        @config.verbose(false)
       end
+      @info
     end
 
     def dhcp?
@@ -46,17 +45,20 @@ module Rubyipmi::Freeipmi
       info.fetch("default_gateway_ip_address", nil)
     end
 
-  #  def snmp
-  #
-  #  end
+    #  def snmp
+    #
+    #  end
 
-  #  def vlanid
-  #
-  #  end
+    def vlanid
+      info.fetch("vlan_id", nil)
+      # some other vlan configuration that might also be useful
+      # "vlan_id_enable"
+      # "vlan_priority"
+    end
 
-  #  def snmp=(community)
-  #
-  #  end
+    #  def snmp=(community)
+    #
+    #  end
 
     # validates that the address, returns true/false
     def validaddr?(source)
@@ -69,20 +71,20 @@ module Rubyipmi::Freeipmi
     end
 
     def ip=(address)
-        @config.setsection("Lan_Conf", "IP_Address", address) if validaddr?(address)
+      @config.setsection("Lan_Conf", "IP_Address", address) if validaddr?(address)
     end
 
     def netmask=(netmask)
-        @config.setsection("Lan_Conf", "Subnet_Mask", netmask) if validaddr?(netmask)
+      @config.setsection("Lan_Conf", "Subnet_Mask", netmask) if validaddr?(netmask)
     end
 
     def gateway=(address)
       @config.setsection("Lan_Conf", "Default_Gateway_IP_Address", address) if validaddr?(address)
     end
 
-  #  def vlanid=(vlan)
-  #
-  #  end
+    #  def vlanid=(vlan)
+    #
+    #  end
 
     def parse(landata)
       if ! landata.nil? and ! landata.empty?
@@ -95,12 +97,9 @@ module Rubyipmi::Freeipmi
           key = item.first.strip.downcase
           value = item.last.strip
           @info[key] = value
-
         end
       end
-      return @info
+      @info
     end
   end
-end
-
-
+end

data/lib/rubyipmi/freeipmi/commands/sensors.rb

@@ -4,9 +4,6 @@ module Rubyipmi::Freeipmi
 
     def initialize(opts = ObservableHash.new)
       super("ipmi-sensors", opts)
-      @options["no-header-output"] = false
-      @options["output-sensor-state"] = false
-      @options["entity-sensor-names"] = false
     end
 
     def refresh
@@ -51,8 +48,14 @@ module Rubyipmi::Freeipmi
     end
 
     def getsensors
+      @options["no-header-output"] = false
+      @options["output-sensor-state"] = false
+      @options["entity-sensor-names"] = false
       value = runcmd
-      return @result
+      @options.delete_notify('no-header-output')
+      @options.delete_notify('output-sensor-state')
+      @options.delete_notify('entity-sensor-names')
+      @result
     end
 
     private
@@ -106,6 +109,4 @@ module Rubyipmi::Freeipmi
       end
     end
   end
-
-end
-
+end

data/lib/rubyipmi/freeipmi/connection.rb

@@ -8,14 +8,10 @@ Dir[File.dirname(__FILE__) + '/commands/*.rb'].each do |file|
 end
 module Rubyipmi
   module Freeipmi
-
     class Connection
-
-      attr_accessor :options, :debug
-
+      attr_accessor :options
 
       def initialize(user, pass, host, opts)
-        @debug = opts[:debug]
         @options = Rubyipmi::ObservableHash.new
         raise("Must provide a host to connect to") unless host
         @options["hostname"] = host
@@ -27,10 +23,15 @@ module Rubyipmi
           @options["privilege-level"] = opts[:privilege]        # privilege type
         end
         # Note: rubyipmi should auto detect which driver to use so its unnecessary to specify the driver unless
-        #       the user really wants to.
+        #       the user really wants to
         @options['driver-type'] = drivers_map[opts[:driver]] unless drivers_map[opts[:driver]].nil?
       end
 
+      # test the connection to ensure we can at least make a single call
+      def connection_works?
+        status = ! (bmc.info.nil? || bmc.info.empty? )
+      end
+
       def drivers_map
         {
           'lan15' => 'LAN',
@@ -61,19 +62,13 @@ module Rubyipmi
 
       def get_diag
         data = {}
-        data['provider'] = provider
-        if @fru
-          data['frus'] = @fru.getfrus
-        end
-        if @sensors
-          data['sensors'] = @sensors.getsensors
-        end
-        if @bmc
-          data['bmc_info'] = @bmc.info
-        end
+        data[:provider] = provider
+        data[:frus]     = fru.getfrus
+        data[:sensors]  = sensors.getsensors
+        data[:bmc_info] = bmc.info
+        data[:version]  = bmc.version
+        data
       end
-
     end
   end
-end
-
+end

data/lib/rubyipmi/freeipmi/errorcodes.rb

@@ -5,7 +5,6 @@ module Rubyipmi::Freeipmi
     @@codes = {
         "authentication type unavailable for attempted privilege level" => {"driver-type" => "LAN_2_0"},
         "authentication type unavailable for attempted privilege level\n" => {"driver-type" => "LAN_2_0"},
-
     }
 
     def self.length

data/lib/rubyipmi/ipmitool/commands/basecommand.rb

@@ -48,8 +48,5 @@ module Rubyipmi::Ipmitool
         end
       end
     end
-
   end
-
-
 end

data/lib/rubyipmi/ipmitool/commands/bmc.rb

@@ -21,6 +21,13 @@ module Rubyipmi::Ipmitool
       end
     end
 
+    def version
+      @options['V'] = nil
+      value = runcmd
+      @options.delete_notify('V')
+      @result.slice(/\d\.\d.\d/)
+    end
+
     # reset the bmc device, useful for troubleshooting
     def reset(type='cold')
       if ['cold', 'warm'].include?(type)
@@ -29,6 +36,7 @@ module Rubyipmi::Ipmitool
          @options.delete_notify("cmdargs")
          return value
       else
+        logger.error("reset type: #{type} is not a valid choice, use warm or cold") if logger
         raise "reset type: #{type} is not a valid choice, use warm or cold"
       end