Object
# 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
# File lib/rubyipmi/commands/basecommand.rb, line 24 def dump_command makecommand 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 this must be overrided in the subclass, as there are no generic errors that fit both providers
# 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
# 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
# File lib/rubyipmi/commands/basecommand.rb, line 12 def makecommand # override in subclass end
# File lib/rubyipmi/commands/basecommand.rb, line 20 def removepass @passfile.unlink end
# 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
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
# 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
# File lib/rubyipmi/commands/basecommand.rb, line 16 def setpass @passfile = Tempfile.new('') end
# File lib/rubyipmi/commands/basecommand.rb, line 108 def update(opts) @options.merge!(opts) end
This method will check if the results are really valid as the exit code can be misleading and incorrect
# 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
Generated with the Darkfish Rdoc Generator 2.