rubyipmi 0.9.2 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1fb4c5a2ee5350e88825085a4d8bc8629c0540a7
-  data.tar.gz: 4e4ecc9f2c3cda0a9bc9d1dc2f95c85f01209abd
+SHA256:
+  metadata.gz: ded5dae3237a5610e1b3d5e1595743be1401636b68b76965d9b1c4bfaa174ac8
+  data.tar.gz: bbfd85a434bfafdeccd6efbcea2dc898032b04b92ceb6c7ebe918f11ac12e4eb
 SHA512:
-  metadata.gz: 524f30bca98d535eab2ba5ff77a68816f8bcffe6d7c290e2f0024e25f1ccb2c994134fdaba359088d4c9eaec4338f9d8dc64193450c52428573e6fa198f8e5fb
-  data.tar.gz: d6304c667418b10143d7e9b753a2c2dfab367acbd888de03efc12a589a444cacf10d8e486ee136166626f85b37a5f4dbfd03ddba817576629d6baf20ad58dc67
+  metadata.gz: 60e95d651aa6b3275f91ea531628c33a473eaaf3d3e34c7c60a61d97cbbcbedfa907356138010eae1d0eda3c0a362316f8fb34e472b594edc834bbd78b0bb619
+  data.tar.gz: 1d8bb664adf6c327a238358ace1a90fdff409cbf8b8328d15f7081f1e60f114f55efdfbe754f98f08ce92ea59079ebd970f07834b6c38b14c3300b622e99e84c

data/Gemfile

@@ -3,11 +3,11 @@ source "http://rubygems.org"
 group :development do
   gem "rspec", "~> 3.1"
   gem "rdoc", "~> 3.12"
-  gem "bundler", ">= 1.1.5"
-  gem "jeweler", "~> 2.0.1"
+  gem "bundler", ">= 2.0.0"
   gem "highline"
   gem "rake"
-  gem 'coveralls', require: false
+  gem 'coveralls', :require => false
   gem 'pry'
   gem 'pry-rescue'
+  gem "rubocop", "~> 0.33.0", :require => false
 end

data/README.md

@@ -78,39 +78,46 @@ from the standard.  In general this library should work will all servers.
    1. Install the freeipmi from source (http://www.gnu.org/software/freeipmi/) or ipmitool
    2. `gem install rubyipmi`
 
-#### Create a connection object
+### Create a connection object
 
    ```ruby
    require 'rubyipmi'
    conn = Rubyipmi.connect("username", "password", "hostname", "providertype")
-
    ```
 
-   Providertype: optional (ipmitool or freeipmi)
+   Additionally, if your using [openipmi](http://openipmi.sourceforge.net) and will be using rubyipmi to connect to
+   the 
localhost you can utilize the openipmi driver and not have to pass in any connection parameters.
+   Openipmi works
by installing a driver and makes it available to the host.  Freeipmi/Ipmitool will then try to use
+   this driver to
automatically use the openipmi if no host is given.  The one caveat here is that you cannot control
+   remote hosts using
openipmi.  The rubyipmi code must be executed on the host you want to control.
+   The upside is that you don't need
any credentials.  Some commands may require root privileges to run when using openipmi.
+
+   Providertype: optional
+
+      valid options: 'auto', 'ipmitool', 'freeipmi'
 
    If you don't specify the provider type, Rubyipmi will detect if freeipmi or ipmitool
    is installed and load the first tool found.  If you specify the provider type rubyipmi will only use that specific
    provider.
 
-   Additionally, if your using [openipmi](http://openipmi.sourceforge.net) and will be using rubyipmi to connect to the
-   localhost you can utilize the openipmi driver and not have to pass in any connection parameters. Openipmi works
-   by installing a driver and makes it available to the host.  Freeipmi/Ipmitool will then try to use this driver to
-   automatically use the openipmi if no host is given.  The one caveat here is that you cannot control remote hosts using
-   openipmi.  The rubyipmi code must be executed on the host you want to control.  The upside is that you don't need
-   any credentials.  Some commands may require root privileges to run when using openipmi.
-
+   You can specify additional options by passing an options hash into the connection method
    ```ruby
-      conn = Rubyipmi.connect
-      conn.power.status
+      conn = Rubyipmi.connect("username", "password", "hostname", 'freeipmi', {:privilege  =>'USER', :driver => 'lan20'})
    ```
 
-   Should you need to specify some additional options or the provider type
-   ```ruby
-      conn = Rubyipmi.connect("username", "password", "hostname", 'freeipmi', {:privilege  =>'USER'})
-   ```
+   Privilege
+
+      This option controls the role of the user making the ipmi call.
+      valid options: 'CALLBACK', 'USER', 'OPERATOR', 'ADMINISTRATOR'  -- defaults to nil and uses the freeipmi/ipmitool default
+
+   Driver
 
+      This option allows you to control which driver to use when making IPMI calls.  Selecting auto will choose
+      either lan15 or lan20 based on your device.  The open type is when using openipmi in conjunction with the provider.
+      valid options: "auto", "lan15", "lan20", "open"   -- defaults to lan20
 
-#### power functions
+
+### power functions
 
    ```ruby
    require 'rubyipmi'
@@ -123,18 +130,24 @@ from the standard.  In general this library should work will all servers.
 
    ```
 
-#### Boot to specific device
+### Boot to specific device
 
   ```ruby
    require 'rubyipmi'
    conn = Rubyipmi.connect("username", "password", "hostname")
-   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
-
+   conn.chassis.bootpxe(reboot=bool, persistent=bool)
+   conn.chassis.bootdisk(reboot=bool, persistent=bool)
+   
+   Examples:
+   conn.chassis.bootpxe(reboot=true, persistent=false) # reboot immediately, PXE boot once
+   conn.chassis.bootpxe(reboot=false, persistent=false) # on next reboot PXE boot once
+   conn.chassis.bootdisk(reboot=true, persistent=false) # reboot immediately, boot off disk once
+   conn.chassis.bootdisk(reboot=true, persistent=true) # reboot immediately, boot off disk forever
+   conn.chassis.bootdisk(reboot=false, persistent=true) # reboot off disk forever, starting on next reboot
   ```
 
 
-#### Sensors
+### Sensors
 
   ```ruby
     require 'rubyipmi'
@@ -145,7 +158,7 @@ from the standard.  In general this library should work will all servers.
 
   ```
 
-#### Fru
+### Fru
 
   ```ruby
     require 'rubyipmi'

data/RELEASE_NOTES.md

@@ -1,3 +1,51 @@
+### 0.11.1
+ * remove hidden files from gem package
+
+### 0.11.0
+This is a big update with many minor changes and bug fixes.  Thank you for all that submitted fixes.
+- Removes jeweler dependency and replaces with bundler commands, updates gemspec
+- Use HTTPS for homepage field in the gemspec
+- Fix infinite loop when executing 'lan print' command
+- The retry count counter is currently not incremented, so in the situation
+  when this command fails, library enters infinite loop of executing this
+  command, which is bad.
+
+  Adds a missing counter incrementation with the same style as
+  in basecommands and make it return current @info in case of a failure,
+  so all methods accessing it will just get return nil.
+ 
+- Leverage Enumerable#each_with_object
+- Add a SensorsMixin to remove duplicate code
+- Enable Rubocop GuardClause and fix complaints
+- Remove duplicate methods
+- Fixes "NoMethodError: undefined method `success?' for nil:NilClass"
+- Some ruby versions need to require 'English' otherwise $CHILD_STATUS is nil
+- Fix rubocop Style/MethodName "Use snake_case for method names."
+- Rename private method
+- Add deprecation warnings for two public methods
+- Delete unused method
+- Update .rubocop.yml accordingly
+- Refactor duplicated chassis power command methods
+- Adds additional rubycops
+- Fixes many rubycop infractions
+- Remove puppet code and vagrant
+- Remove if / else logic and unnecessary return in #validate_status
+- Reword confusing project description
+- Update README.md section on booting to specific devices
+- Update documentation around bootpxe, bootdisk functions 
+- Remove pry statement from method
+### 0.10.0
+* gh-26 - make the driver default to lan20
+
+Users of older IPMI devices will now need to pass the specified driver type.
+
+### 0.9.3
+* normalize the options being passed into the connect method
+
+### 0.9.2
+* fixes an issue where is_provider_installed? should only return a boolean value instead of raising and error
+* fixes a minor style issue where providers_installed? was returning an array when a boolean might have been expected
+
 ### 0.9.1
 * fixes an issue with connection_works? api call when command raises an error
 

data/Rakefile

@@ -1,10 +1,8 @@
 # encoding: utf-8
+require 'bundler/gem_tasks'
 
-require 'rubygems'
-require 'bundler'
 @base_dir = File.dirname(__FILE__)
 
-
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -13,29 +11,6 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "rubyipmi"
-  gem.homepage = "http://github.com/logicminds/rubyipmi"
-  gem.license = "LGPLv2.1"
-  gem.summary = %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'
 
@@ -45,9 +20,8 @@ RSpec::Core::RakeTask.new(:unit) do |spec|
 end
 
 desc "Run integrations tests against real systems using a vagrant box"
-task :vintegration, :user, :pass, :host do |task, args|
+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}\"`
@@ -58,9 +32,9 @@ RSpec::Core::RakeTask.new :integration do |spec|
   ENV['ipmiuser'] = 'admin'
   ENV['ipmipass'] = 'password'
   ENV['ipmihost'] = '10.0.1.16'
-  providers ||=  Array(ENV['ipmiprovider']) || ['freeipmi', 'ipmitool']
+  providers ||= Array(ENV['ipmiprovider']) || ['freeipmi', 'ipmitool']
 
-  providers.each do | provider |
+  providers.each do |provider|
     ENV['ipmiprovider'] = provider
     spec.pattern = FileList['spec/integration/**/*_spec.rb']
   end
@@ -79,7 +53,7 @@ Rake::RDocTask.new do |rdoc|
 end
 
 desc "send diagnostics to logicminds for testing for the given host"
-task :send_diag, :user, :pass, :host do |t, args |
+task :send_diag, :user, :pass, :host do |_t, args|
   require 'rubyipmi'
   require 'net/smtp'
   require 'json'
@@ -91,20 +65,19 @@ task :send_diag, :user, :pass, :host do |t, args |
   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})
-
+  send_email(emailto, data.to_json, :subject => subject)
 end
 
-def send_email(to,data, opts={})
+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
+  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}>
@@ -114,9 +87,9 @@ Date: #{Time.now.rfc2822}
   #{opts[:body]}
 END_OF_MESSAGE
 
-  smtp = Net::SMTP.new(opts[:server],opts[:port])
+  smtp = Net::SMTP.new(opts[:server], opts[:port])
   smtp.enable_starttls
-  smtp.start(opts[:server],gmail_id,pass,:login) do
+  smtp.start(opts[:server], gmail_id, pass, :login) do
     smtp.send_message(msg, gmail_id, to)
   end
 end

data/VERSION

@@ -1 +1 @@
-0.9.2
+0.10.0

data/lib/rubyipmi/commands/basecommand.rb

@@ -3,7 +3,6 @@ require 'tempfile'
 require 'rubyipmi'
 
 module Rubyipmi
-
   class BaseCommand
     include Observable
     attr_reader :cmd, :max_retry_count
@@ -39,7 +38,7 @@ module Rubyipmi
 
     def locate_command(commandname)
       location = `which #{commandname}`.strip
-      if not $?.success?
+      unless $?.success?
         logger.error("#{commandname} command not found, is #{commandname} installed?") if logger
         raise "#{commandname} command not found, is #{commandname} installed?"
       end
@@ -70,8 +69,7 @@ module Rubyipmi
         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
+        # sometimes the command tool does not return the correct result, validate it with additional code
         process_status = validate_status($?)
       rescue
         if retrycount < max_retry_count
@@ -84,7 +82,7 @@ module Rubyipmi
         end
       ensure
         removepass
-        return process_status
+        process_status
       end
     end
 
@@ -93,30 +91,26 @@ module Rubyipmi
     # until all the fixes are exhausted or a error not defined in the errorcodes is found
     # 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
-        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
+      return unless result
+      # The errorcode code hash contains the fix
+      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
 
     def update(opts)
-          @options.merge!(opts)
+      @options.merge!(opts)
     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
-      if ! exitstatus.success?
-         raise "Error occurred"
-      else
-        return true
-      end
+      raise "Error occurred" unless exitstatus.success?
+
+      true
     end
   end
-end
+end

data/lib/rubyipmi/commands/mixins/power_mixin.rb

@@ -0,0 +1,50 @@
+module Rubyipmi
+  module PowerMixin
+    # Turn the system on
+    def on
+      command("on")
+    end
+
+    # Turn the system off
+    def off
+      command("off")
+    end
+
+    # Perform a power reset on the system
+    def reset
+      command("reset")
+    end
+
+    # Power cycle the system
+    def cycle
+      off? ? on : command("cycle")
+    end
+
+    # Perform a soft shutdown, like briefly pushing the power button
+    def soft_shutdown
+      command("soft")
+    end
+
+    # Test to see if the power is on
+    def on?
+      status == "on"
+    end
+
+    # Test to see if the power is off
+    def off?
+      status == "off"
+    end
+
+    # DEPRECATED: Please use soft_shutdown instead.
+    def softShutdown
+      warn "[DEPRECATION] `softShutdown` is deprecated, please use `soft_shutdown` instead."
+      soft_shutdown
+    end
+
+    # DEPRECATED: Please use power_interrupt instead.
+    def powerInterrupt
+      warn "[DEPRECATION] `powerInterrupt` is deprecated, please use `power_interrupt` instead."
+      power_interrupt
+    end
+  end
+end

data/lib/rubyipmi/commands/mixins/sensors_mixin.rb

@@ -0,0 +1,54 @@
+module Rubyipmi
+  module SensorsMixin
+    def refresh
+      @sensors = nil
+      list
+    end
+
+    def list
+      @sensors ||= parse(getsensors)
+    end
+
+    def count
+      list.count
+    end
+
+    def names
+      list.keys
+    end
+
+    # returns a hash of fan sensors where the key is fan name and value is the sensor
+    def fanlist(refreshdata = false)
+      refresh if refreshdata
+      list.each_with_object({}) { |(name, sensor), flist| flist[name] = sensor if name =~ /.*fan.*/ }
+    end
+
+    # returns a hash of sensors where each key is the name of the sensor and the value is the sensor
+    def templist(refreshdata = false)
+      refresh if refreshdata
+      list.each_with_object({}) do |(name, sensor), tlist|
+        tlist[name] = sensor if (sensor[:unit] =~ /.*degree.*/ || name =~ /.*temp.*/)
+      end
+    end
+
+    private
+
+    def method_missing(method, *_args, &_block)
+      if !list.key?(method.to_s)
+        raise NoMethodError
+      else
+        list[method.to_s]
+      end
+    end
+
+    def parse(data)
+      return {} if data.nil?
+
+      data.lines.each_with_object({}) do |line, sensorlist|
+        # skip the header
+        sensor = sensor_class.new(line)
+        sensorlist[sensor[:name]] = sensor
+      end
+    end
+  end
+end

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

@@ -1,14 +1,12 @@
 require 'rubyipmi/freeipmi/errorcodes'
 
 module Rubyipmi::Freeipmi
-
   class BaseCommand < Rubyipmi::BaseCommand
-
     def setpass
       super
       @options["config-file"] = @passfile.path
-      @passfile.write "username #{@options["username"]}\n"
-      @passfile.write "password #{@options["password"]}\n"
+      @passfile.write "username #{@options['username']}\n"
+      @passfile.write "password #{@options['password']}\n"
       @passfile.close
     end
 
@@ -18,41 +16,36 @@ module Rubyipmi::Freeipmi
 
     def makecommand
       # need to format the options to freeipmi format
-      args = @options.collect { |k, v|
+      args = @options.collect do |k, v|
         # must remove from command line as its handled via conf file
         next if k == 'password'
         next if k == 'username'
-        if not v
+        if !v
           "--#{k}"
         else
           "--#{k}=#{v}"
         end
-      }.join(" ")
-      return "#{cmd} #{args.rstrip}"
+      end.join(" ")
+
+      "#{cmd} #{args.rstrip}"
     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"
-          # until ipmipower returns the correct exit status this is a hack
-          # essentially any result greater than 23 characters is an error
-          if @result.length > 23
-            raise "Error occurred"
-          end
-        when "bmc-config"
-          if @result.length > 100 and exitstatus.success?
-            return true
-          else
-            raise "Error occurred"
-          end
+      when "ipmipower"
+        # until ipmipower returns the correct exit status this is a hack
+        # essentially any result greater than 23 characters is an error
+        raise "Error occurred" if @result.length > 23
+      when "bmc-config"
+        if @result.length > 100 && exitstatus.success?
+          return true
         else
-          if exitstatus.success?
-            return true
-          else
-            raise "Error occurred"
-          end
+          raise "Error occurred"
+        end
+      else
+        super
       end
     end
 
@@ -60,16 +53,14 @@ module Rubyipmi::Freeipmi
     # 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 find_fix(result)
-      if result
-        # The errorcode code hash contains the fix
-        begin
-          fix = ErrorCodes.search(result)
-          @options.merge_notify!(fix)
-        rescue
-          raise "Could not find fix for error code: \n#{result}"
-        end
+      return unless result
+      # The errorcode code hash contains the fix
+      begin
+        fix = ErrorCodes.search(result)
+        @options.merge_notify!(fix)
+      rescue
+        raise "Could not find fix for error code: \n#{result}"
       end
     end
-
   end
-end
+end

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

@@ -1,8 +1,6 @@
 module Rubyipmi::Freeipmi
-
   class Bmc < Rubyipmi::Freeipmi::BaseCommand
-
-    #attr_accessor :options
+    # attr_accessor :options
     attr_accessor :config
 
     def initialize(opts = ObservableHash.new)
@@ -12,7 +10,7 @@ module Rubyipmi::Freeipmi
 
     def version
       @options['version'] = false
-      value = runcmd
+      runcmd
       @options.delete_notify('version')
       @result.slice(/\d\.\d.\d/)
     end
@@ -25,12 +23,12 @@ module Rubyipmi::Freeipmi
       end
     end
 
-    def reset(type='cold')
+    def reset(type = 'cold')
       device.reset(type)
     end
 
     def guid
-       information.guid
+      information.guid
     end
 
     def config
@@ -48,6 +46,5 @@ module Rubyipmi::Freeipmi
     def device
       @bmcdevice ||= Rubyipmi::Freeipmi::BmcDevice.new(options)
     end
-
   end
 end