rubyipmi 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3ed850aa093b990a1aa90dd18715c163e69a1d5f
-  data.tar.gz: d26e0b37395b5c94054c5fa8287b02cf3a7b96eb
+SHA256:
+  metadata.gz: 7d71a0a1e0d59728f61b38be628466e17f2a27b837138e538682afef45ee2d5a
+  data.tar.gz: a7df4346c51b1147ecc1060a6b7c66a37a111fd78366fc9feadeb4b889900ac8
 SHA512:
-  metadata.gz: e0fba60554b048d68386581a7cb9a798c07257fd752f35ab8d0432d96bcddd7c4cf657818cc4cd2a0ac7257900e3d98af990ba4d190df626d6347510f926e8cc
-  data.tar.gz: dfb8e7a813fd20f2f1a8ff61e8b532fae46db6214cdc54b959bf960efb506d2865badbafc7b5b90b9c49c3f88a3362b4b11e2ebb82a0984a1af323819d7006f1
+  metadata.gz: ca95d910f47ef78d95ffec0c67c7b5109c3b2d37be8e1068ed9f087c9bc77dbabd0eda7121c5d819ac9c6a94db7d09a4aeff3e147419913fc4b370447b969dd4
+  data.tar.gz: 3418f3612947c775531ae3a1102953d8457e6887c4d01992f19d2cf2fec0d5a5fc7303b12a1c74ad2438fda471981075a57af9a036f57fe19c6d815b5997d41f

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+coverage.data
+.idea/
+# rdoc generated
+rdoc
+.vagrant/
+# yard generated
+doc
+.yardoc
+Gemfile.lock
+# bundler
+.bundle
+Gemfile.lock
+
+# jeweler generated
+pkg
+.vagrant
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,66 @@
+Style/StringLiterals:
+  Enabled: false
+AllCops:
+  Exclude:
+  - 'rubyipmi.gemspec'
+SignalException:
+  EnforcedStyle: only_raise
+Documentation:
+  Enabled: false
+ClassAndModuleChildren:
+  Enabled: false
+HashSyntax:
+  EnforcedStyle: hash_rockets
+ClassCheck:
+  EnforcedStyle: kind_of?
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+Style/WordArray:
+  Enabled: false
+
+
+# TODO: fix these
+Metrics/AbcSize:
+  Max: 60
+Metrics/CyclomaticComplexity:
+  Max: 19
+Metrics/LineLength:
+  Max: 149
+Metrics/MethodLength:
+  Max: 44
+Metrics/ModuleLength:
+  Max: 128
+Metrics/PerceivedComplexity:
+  Max: 22
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'lib/rubyipmi.rb'
+    - 'lib/rubyipmi/commands/basecommand.rb'
+    - 'lib/rubyipmi/freeipmi/commands/fru.rb'
+    - 'lib/rubyipmi/ipmitool/commands/fru.rb'
+Style/RescueModifier:
+  Exclude:
+    - 'lib/rubyipmi.rb'
+Style/RegexpLiteral:
+  Exclude:
+    - 'spec/spec_helper.rb'
+Style/PredicateName:
+  Exclude:
+    - 'lib/rubyipmi.rb'
+Lint/RescueException:
+  Exclude:
+    - 'spec/integration/rubyipmi_spec.rb'
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/rubyipmi/freeipmi/connection.rb'
+    - 'lib/rubyipmi/ipmitool/connection.rb'
+
+# Fixed by deprecation
+Style/MethodName:
+  Exclude:
+    - 'lib/rubyipmi/commands/mixins/power_mixin.rb'
+
+# Don't understand
+Style/FileName:
+  Exclude:
+    - 'spec/unit/freeipmi/bmc-info_spec.rb'

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1.3
+  - 2.2
+branches:
+  only:
+    - master
+    - development
+notifications:
+  email:
+    - corey@logicminds.biz 

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

@@ -135,9 +135,15 @@ from the standard.  In general this library should work will all servers.
   ```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
   ```
 
 

data/RELEASE_NOTES.md

@@ -1,3 +1,36 @@
+### 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
 

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/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