Class: Rubyipmi::BaseCommand
- Inherits:
-
Object
- Object
- Rubyipmi::BaseCommand
- Includes:
- Observable
- Defined in:
- lib/rubyipmi/commands/basecommand.rb
Direct Known Subclasses
Instance Attribute Summary collapse
-
#cmd ⇒ Object
readonly
Returns the value of attribute cmd.
-
#lastcall ⇒ Object
readonly
Returns the value of attribute lastcall.
-
#max_retry_count ⇒ Object
readonly
Returns the value of attribute max_retry_count.
-
#options ⇒ Object
Returns the value of attribute options.
-
#passfile ⇒ Object
Returns the value of attribute passfile.
-
#result ⇒ Object
readonly
Returns the value of attribute result.
Instance Method Summary collapse
- #dump_command ⇒ Object
-
#find_fix(result) ⇒ Object
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 this must be overrided in the subclass, as there are no generic errors that fit both providers.
-
#initialize(commandname, opts = ObservableHash.new) ⇒ BaseCommand
constructor
A new instance of BaseCommand.
- #locate_command(commandname) ⇒ Object
- #makecommand ⇒ Object
- #removepass ⇒ Object
- #run(debug = false) ⇒ Object
-
#runcmd(debug = false) ⇒ Object
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.
- #setpass ⇒ Object
- #update(opts) ⇒ Object
-
#validate_status(exitstatus) ⇒ Object
This method will check if the results are really valid as the exit code can be misleading and incorrect.
Constructor Details
#initialize(commandname, opts = ObservableHash.new) ⇒ BaseCommand
Returns a new instance of BaseCommand.
28 29 30 31 32 33 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 28 def initialize(commandname, opts = ObservableHash.new) # This will locate the command path or raise an error if not found @cmdname = commandname @options = opts @options.add_observer(self) end |
Instance Attribute Details
#cmd ⇒ Object (readonly)
Returns the value of attribute cmd.
8 9 10 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 8 def cmd @cmd end |
#lastcall ⇒ Object (readonly)
Returns the value of attribute lastcall.
10 11 12 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 10 def lastcall @lastcall end |
#max_retry_count ⇒ Object (readonly)
Returns the value of attribute max_retry_count.
8 9 10 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 8 def max_retry_count @max_retry_count end |
#options ⇒ Object
Returns the value of attribute options.
9 10 11 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 9 def @options end |
#passfile ⇒ Object
Returns the value of attribute passfile.
9 10 11 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 9 def passfile @passfile end |
#result ⇒ Object (readonly)
Returns the value of attribute result.
10 11 12 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 10 def result @result end |
Instance Method Details
#dump_command ⇒ Object
24 25 26 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 24 def dump_command makecommand end |
#find_fix(result) ⇒ Object
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 this must be overrided in the subclass, as there are no generic errors that fit both providers
95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 95 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 end end |
#locate_command(commandname) ⇒ Object
35 36 37 38 39 40 41 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 35 def locate_command(commandname) location = `which #{commandname}`.strip if not $?.success? raise "#{commandname} command not found, is #{commandname} installed?" end return location end |
#makecommand ⇒ Object
12 13 14 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 12 def makecommand # override in subclass end |
#removepass ⇒ Object
20 21 22 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 20 def removepass @passfile.unlink end |
#run(debug = false) ⇒ Object
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 54 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 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 end end |
#runcmd(debug = false) ⇒ Object
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
45 46 47 48 49 50 51 52 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 45 def runcmd(debug=false) @success = false @success = run(debug) if ENV['rubyipmi_debug'] == 'true' puts @lastcall.inspect unless @lastcall.nil? end return @success end |
#setpass ⇒ Object
16 17 18 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 16 def setpass @passfile = Tempfile.new('') end |
#update(opts) ⇒ Object
108 109 110 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 108 def update(opts) @options.merge!(opts) end |
#validate_status(exitstatus) ⇒ Object
This method will check if the results are really valid as the exit code can be misleading and incorrect
113 114 115 116 117 118 119 120 |
# File 'lib/rubyipmi/commands/basecommand.rb', line 113 def validate_status(exitstatus) # override in child class if needed if ! exitstatus.success? raise "Error occurred" else return true end end |