rubyipmi 0.6.0 → 0.7.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTk3MjAzNzllY2Y0NWY0Y2RhNzc3MTFkZWZkYTdkY2M4ZjAxOGI5Nw==
+  data.tar.gz: !binary |-
+    MGY3MWY0ZDVlZmNiYmE1YTg2YzY1YzY0ODY3N2ZiMmFiZjM5YzdjMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDdiYmRlMjI3NjQ0Y2E3YmRkMTVmMmQzMDhkZmE0MTQwM2NkNGVjMTY0ODM2
+    M2Q1NzAwYzljZTdlYTE1NzU2ZjQ3NGUwZmI3NjdkMGE4MDNhZjNjY2UwNWRh
+    NGVlMjU5Mzc5NDRiODBkYjU4MWQxMjgyZDE0NWE2NzRmNmUyYjU=
+  data.tar.gz: !binary |-
+    N2YwMjM5YjI4NjhiNmY5ZmI1ZGRkYWIwNzZjMGY3NDQ0YjQwMGE2ZTUyYWIz
+    YTM5ODZlY2VhYjE2NzRjYjA3NDUxYzc1MzY1MjRlYmViOTA2OGUzZmUxOGMy
+    ODYxZGQ5ZjU0ZDBmMDEyMGI1NmNhYzAwYzc1YmIwNDczOGYxYzQ=

data/Gemfile

@@ -6,9 +6,11 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "rspec", "~> 2.8.0"
+  gem "rspec", "<= 2.8.0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1.5"
+  gem "bundler", ">= 1.1.5"
   gem "jeweler", "~> 1.8.4"
-  gem "rcov", ">= 0"
+  gem "rcov", "< 1.0.0"
+  gem "highline"
+  gem "rake"
 end

data/README.md

@@ -2,6 +2,8 @@
 This gem is a ruby wrapper for the freeipmi and ipmitool command line tools.
 It provides a ruby implementation of ipmi commands that will make it simple to connect to BMC devices from ruby.
 
+[![Build Status](https://travis-ci.org/logicminds/rubyipmi.png)](https://travis-ci.org/logicminds/rubyipmi)
+
 ## Using the library in your code
 
 ### Install
@@ -12,10 +14,10 @@ It provides a ruby implementation of ipmi commands that will make it simple to c
 
 ### General Usage
 
-   ` require 'rubyipmi' `
+   ``` require 'rubyipmi' ```
 
 #### Create a connection object
-   `conn = Rubyipmi.connect("username", "password", "hostname", "providertype) `
+   ```conn = Rubyipmi.connect("username", "password", "hostname", "providertype) ```
 
    Providertype: optional (ipmitool or freeipmi)
 
@@ -25,38 +27,38 @@ It provides a ruby implementation of ipmi commands that will make it simple to c
 
 
 #### Use power functions (not all listed)
-   `
+   ```
    conn.chassis.power.on
    conn.chassis.power.off
    conn.chassis.power.on?
    conn.chassis.power.off?
    conn.chassis.power.cycle
-   `
+   ```
 
 #### Boot to specific device
-  `
+  ```
    conn.chassis.bootpxe(true, false) # reboot after setting, one time boot only - non persistent
    conn.chassis.bootdisk(false, false) # boot to disk on next reboot, don't reboot automatically
 
-   `
+   ```
 
 
 #### Sensors
-    `
+    ```
     conn.sensors.names
     conn.sensors.list
     conn.sensors.<sensor name>
 
-    `
+    ```
 
 #### Fru
-    `
+    ```
     conn.fru.list
     conn.fru.serial
     conn.fru.manufacturer
     conn.fru.product
 
-    `
+    ```
 
 ## Testing
 There are a series of automated rspec tests that test the functionality of this library with the ipmi device.
@@ -67,7 +69,8 @@ DO NOT PERFORM THESE TEST ON ANY PRODUCTION SYSTEM.  THESE TESTS WILL TURN OFF T
 
 1.  Install gem via source
 2.  bundle install
-3.  rake ipmiuser=ipmiuser ipmipass=ipmiuserpass ipmihost=192.168.1.22 ipmiprovider=freeipmi   (fill in your your details)
+3.  rake (runs unit tests, does not require a ipmi device) 
+3.  rake integration ipmiuser=ipmiuser ipmipass=ipmiuserpass ipmihost=192.168.1.22 ipmiprovider=freeipmi   (fill in your your details)
 4.  report any failures with your make/model/firmware revision to corey@logicminds.biz
 
 ## Security
@@ -155,14 +158,21 @@ end
 ```
 
 ### How to get the results of the command
-After running a command it may be desirable to get the results for further processing.  To get the results, follow the example below:
+After running a command it may be desirable to get the results for further processing.
+Note that there are two kinds of results.
+1. the text returned from the shell command, this is stored in @results
+2. the status value returned from the shell command (true or false only) this is returned from runcmd.
+
+To get the results:
 
 Example:
 
 ```
     def status
-      command("--stat")
-      @result.split(":").last.chomp.trim
+      value = command("--stat")
+      if value == true
+         @result.split(":").last.chomp.trim
+      end
     end
 
     def command(opt)

data/Rakefile

@@ -2,6 +2,9 @@
 
 require 'rubygems'
 require 'bundler'
+@base_dir = File.dirname(__FILE__)
+
+
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -18,17 +21,49 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/logicminds/rubyipmi"
   gem.license = "GPLv3"
   gem.summary = %Q{A ruby wrapper for ipmi command line tools that supports ipmitool and freeipmi}
-  gem.description = %Q{A ruby wrapper for ipmi command line tools that supports ipmitool and freeipmi}
+  gem.description = %Q{Provides a library for controlling IPMI devices using pure ruby code}
   gem.email = "corey@logicminds.biz"
   gem.authors = ["Corey Osman"]
+  gem.files.exclude '.travis.yml'
+  gem.files.exclude 'Gemfile.lock'
+  gem.files.exclude '.rspec'
+  gem.files.exclude '.gitignore'
+  gem.files.exclude '.document'
+  gem.files.exclude 'coverage/'
+
+
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
 
 require 'rspec/core'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
+
+desc "run unit tests"
+RSpec::Core::RakeTask.new(:unit) do |spec|
+  spec.pattern = FileList['spec/unit/**/*_spec.rb']
+end
+
+desc "Run integrations tests against real systems using a vagrant box"
+task :vintegration, :user, :pass, :host do |task, args|
+  vars = "ipmiuser=#{args[:user]} ipmipass=#{args[:pass]} ipmihost=#{args[:host]}"
+  ipmiprovider="freeipmi"
+  puts `cd #{@base_dir}/spec && vagrant up`
+  puts `cd #{@base_dir}/spec && vagrant provision`
+  puts `vagrant ssh \"/rubyipmi/rake integration #{vars}\"`
+end
+
+desc "Run integrations tests against real systems"
+RSpec::Core::RakeTask.new :integration do |spec|
+  ENV['ipmiuser'] = 'admin'
+  ENV['ipmipass'] = 'password'
+  ENV['ipmihost'] = '10.0.1.16'
+  providers ||=  ENV['ipmiprovider'].to_a || ['freeipmi', 'ipmitool']
+
+  providers.each do | provider |
+    ENV['ipmiprovider'] = provider
+    spec.pattern = FileList['spec/integration/**/*_spec.rb']
+  end
 end
 
 RSpec::Core::RakeTask.new(:rcov) do |spec|
@@ -36,7 +71,7 @@ RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :default => :spec
+task :default => :unit
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
@@ -47,3 +82,46 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "send diagnostics to logicminds for testing for the given host"
+task :send_diag, :user, :pass, :host do |t, args |
+  require 'rubyipmi'
+  require 'net/smtp'
+  require 'json'
+  require "highline/import"
+
+  if args.count < 3
+    raise "You must provide arguments: rake send_diag[user, pass, host]"
+  end
+  data = Rubyipmi.get_diag(args[:user], args[:pass], args[:host])
+  emailto = 'corey@logicminds.biz'
+  subject = "Rubyipmi diagnostics data"
+  send_email(emailto, data.to_json, {:subject => subject})
+
+end
+
+def send_email(to,data, opts={})
+  gmail_id = ask("Enter your gmail account:  ")
+  pass = ask("Enter your gmail password:  ") { |q| q.echo = '*' }
+  opts[:from] = gmail_id
+  opts[:server]      ||= 'smtp.gmail.com'
+  opts[:from_alias]  ||= gmail_id
+  opts[:subject]     ||= @subject
+  opts[:body]        ||= data
+  opts[:to]          ||= to
+  opts[:port]        ||= 587
+  msg = <<END_OF_MESSAGE
+From: #{opts[:from_alias]} <#{opts[:from]}>
+To: <#{to}>
+Subject: #{opts[:subject]}
+Date: #{Time.now.rfc2822}
+
+  #{opts[:body]}
+END_OF_MESSAGE
+
+  smtp = Net::SMTP.new(opts[:server],opts[:port])
+  smtp.enable_starttls
+  smtp.start(opts[:server],gmail_id,pass,:login) do
+    smtp.send_message(msg, gmail_id, to)
+  end
+end

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/rubyipmi.rb

@@ -1,6 +1,5 @@
 require 'rubyipmi/ipmitool/connection'
 require 'rubyipmi/freeipmi/connection'
-require 'net/smtp'
 
 
 module Rubyipmi
@@ -9,7 +8,7 @@ module Rubyipmi
   # The connect method will create a connection object based the provider type passed in
   # If provider is left blank the function will use the first available provider
 
-    def self.connect(user, pass, host, provider="any")
+    def self.connect(user, pass, host, provider="any",debug=false)
 
       # use this variable to reduce cmd calls
       installed = false
@@ -30,9 +29,9 @@ module Rubyipmi
       # If the provider is available create a connection object
       if installed or is_provider_installed?(provider)
         if provider == "freeipmi"
-          @conn = Rubyipmi::Freeipmi::Connection.new(user, pass, host)
+          @conn = Rubyipmi::Freeipmi::Connection.new(user, pass, host, debug)
         elsif provider == "ipmitool"
-          @conn = Rubyipmi::Ipmitool::Connection.new(user,pass,host)
+          @conn = Rubyipmi::Ipmitool::Connection.new(user,pass,host, debug)
         else
           raise "Incorrect provider given, must use freeipmi or ipmitool"
         end
@@ -48,17 +47,27 @@ module Rubyipmi
       raise "No Connection available, please use the connect method"
     end
 
+    # method used to find the command which also makes it easier to mock with
+    def self.locate_command(commandname)
+      location = `which #{commandname}`.strip
+      if not $?.success?
+        location = nil
+      end
+      return location
+    end
+
     # Return true or false if the provider is available
     def self.is_provider_installed?(provider)
       case provider
         when "freeipmi"
-          cmdpath = `which ipmipower`.strip
+          cmdpath = locate_command('ipmipower')
         when "ipmitool"
-          cmdpath = `which ipmitool`.strip
+          cmdpath = locate_command('ipmitool')
         else
           raise "Invalid BMC provider type"
       end
-      return $?.success?
+      # return false if command was not found
+      return ! cmdpath.nil?
     end
 
     def self.providers
@@ -80,12 +89,25 @@ module Rubyipmi
       return available
     end
 
-    def self.printdiag(user, pass, host)
-      @conn = Rubyipmi::connect(user, pass, host)
-      puts "Product: #{@conn.fru.product}"
-      puts "Manufacturer: #{@conn.fru.manufacturer}"
-      puts "BMC Info #{@conn.bmc.info.inspect}\n"
-      puts "Please email to corey@logicminds.biz when troubleshooting"
-      return true
+    # gets data from the bmc device and puts in a hash for diagnostics
+    def self.get_diag(user, pass, host)
+      data = {}
+
+      if Rubyipmi.is_provider_installed?('freeipmi')
+        @freeconn = Rubyipmi::connect(user, pass, host, 'freeipmi')
+        if @freeconn
+          puts "Retrieving freeipmi data"
+          data['freeipmi'] = @freeconn.get_diag
+        end
+      end
+      if Rubyipmi.is_provider_installed?('ipmitool')
+        @ipmiconn = Rubyipmi::connect(user, pass, host, 'ipmitool')
+        if @ipmiconn
+          puts "Retrieving ipmitool data"
+          data['ipmitool'] = @ipmiconn.get_diag
+        end
+      end
+      return data
     end
+
 end

data/lib/rubyipmi/commands/basecommand.rb

@@ -5,11 +5,9 @@ module Rubyipmi
 
   class BaseCommand
     include Observable
-
-
-    attr_reader :cmd
-    attr_accessor :options
-    attr_reader :lastcall
+    attr_reader :cmd, :max_retry_count
+    attr_accessor :options, :passfile
+    attr_reader :lastcall, :result
 
     def makecommand
       # override in subclass
@@ -17,170 +15,110 @@ module Rubyipmi
 
     def setpass
       @passfile = Tempfile.new('')
-      @passfile.open
     end
 
     def removepass
-      @passfile.close!
+      @passfile.unlink
     end
 
-    def to_s
+    def dump_command
       makecommand
     end
 
     def initialize(commandname, opts = ObservableHash.new)
       # This will locate the command path or raise an error if not found
       @cmdname = commandname
-      @cmd = `which #{commandname}`.strip
+      @options = opts
+      @options.add_observer(self)
+    end
+
+    def locate_command(commandname)
+      location = `which #{commandname}`.strip
       if not $?.success?
         raise "#{commandname} command not found, is #{commandname} installed?"
       end
-      @options = opts
-      @options.add_observer(self)
+      return 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)
       @success = false
-
-      result = catch(:ipmierror){
-        @success = run(debug)
-      }
-      # if error occurs try and find the fix
-      if result and not @success
-        findfix(result, nil, debug, "runcmd")
+      @success = run(debug)
+      if ENV['rubyipmi_debug'] == 'true'
+        puts @lastcall.inspect unless @lastcall.nil?
       end
       return @success
-
-
     end
 
+    def run(debug=false)
+      # 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
+      retrycount = 0
+      process_status = false
+      @cmd = locate_command(@cmdname)
+      setpass
+      @result = nil
+      if debug
+        # Log error
+        return makecommand
+      end
 
-    def runcmd_without_opts(args=[], debug=false)
-
-      @success = false
-      result = catch(:ipmierror){
-        @success = run_without_opts(args, debug)
+      begin
+        command = makecommand
+        @lastcall = "#{command}"
+        @result = `#{command} 2>&1`
+        # sometimes the command tool does not return the correct result so we have to validate it with additional
+        # code
+        process_status = validate_status($?)
+      rescue
+        if retrycount < max_retry_count
+          find_fix(@result)
+          retrycount = retrycount.next
+          retry
+        else
+          raise "Exhausted all auto fixes, cannot determine what the problem is"
+        end
+      ensure
+        removepass
+        return process_status
 
-      }
-      # if error occurs try and find the fix and rerun the method
-      if result and not @success
-        findfix(result, args, debug, "runcmd_with_args")
       end
-      return @success
+
     end
 
     # The findfix method acts like a recursive method and applies fixes defined in the errorcodes
     # If a fix is found it is applied to the options hash, and then the last run command is retried
     # until all the fixes are exhausted or a error not defined in the errorcodes is found
-    def findfix(result, args, debug, runmethod)
+    # this must be overrided in the subclass, as there are no generic errors that fit both providers
+    def find_fix(result)
       if result
         # The errorcode code hash contains the fix
-        fix = ErrorCodes.code[result]
-        if not fix
-          raise "#{result}"
-        else
+        begin
+          fix = ErrorCodes.search(result)
           @options.merge_notify!(fix)
-          # retry the last called method
-          # its quicker to explicitly call these commands than calling a command block
-          if runmethod == "run"
-            run(debug)
-          else
-            run_without_opts(args, debug)
-          end
 
+        rescue
+          raise "Could not find fix for error code: \n#{result}"
         end
-
-      end
-    end
-
-
-    def run(debug=false)
-      setpass
-      @result = nil
-      command = makecommand
-      if debug
-        return command
-      end
-
-      @lastcall = "#{command}"
-      @result = `#{command} 2>&1`
-      removepass
-      #puts "Last Call: #{@lastcall}"
-
-      # sometimes the command tool doesnt return the correct result
-      process_status = validate_status($?)
-
-      if not process_status
-        throwError
       end
-      return process_status
-    end
-
-
-
-    def run_without_opts(args=[], debug=false)
-      setpass
-      @result = ""
-      if debug
-        return "#{cmd} #{args.join(" ")}"
-      else
-        @lastcall = "#{cmd} #{args.join(" ")}"
-        @result = `#{cmd} #{args.join(" ")} 2>&1`
-        removepass
-      end
-
-      process_status = validate_status($?)
-
-      if not process_status
-        throwError
-      end
-      return process_status
-
-
     end
 
     def update(opts)
           @options.merge!(opts)
-          #puts "Options were updated: #{@options.inspect}"
     end
 
-
-
-
-    # This method will check if the results are really valid as the exit code can be misleading and incorrect
+  # This method will check if the results are really valid as the exit code can be misleading and incorrect
     def validate_status(exitstatus)
       # override in child class if needed
-      return exitstatus.success?
-
-    end
-
-    def throwError
-      # Find out what kind of error is happening, parse results
-      # Check for authentication or connection issue
-      #puts "ipmi call: #{@lastcall}"
-
-      if @result =~ /timeout|timed\ out/
-        code = "ipmi call: #{@lastcall} timed out"
-        raise code
+      if ! exitstatus.success?
+         raise "Error occurred"
       else
-        code = @result.split(":").last.chomp.strip if not @result.empty?
+        return true
       end
-      case code
-        when "invalid hostname"
-          raise code
-        when "password invalid"
-          raise code
-        when "username invalid"
-          raise code
-        else
-          throw :ipmierror, code
-      end
-
     end
 
 
-
   end
 end