move command.py from monitor module into pcucontrol module. pcucontrol should
authorStephen Soltesz <soltesz@cs.princeton.edu>
Thu, 12 Mar 2009 17:33:06 +0000 (17:33 +0000)
committerStephen Soltesz <soltesz@cs.princeton.edu>
Thu, 12 Mar 2009 17:33:06 +0000 (17:33 +0000)
be self-contained.

pcucontrol/util/command.py [new file with mode: 0644]

diff --git a/pcucontrol/util/command.py b/pcucontrol/util/command.py
new file mode 100644 (file)
index 0000000..e5663c3
--- /dev/null
@@ -0,0 +1,240 @@
+import os
+from select import select 
+import subprocess
+import signal
+import time
+import traceback
+import fcntl
+
+DEBUG= 0
+
+class ExceptionTimeout(Exception): pass
+class ExceptionReadTimeout(Exception): pass
+COMMAND_TIMEOUT = 60
+ssh_options = { 'StrictHostKeyChecking':'no', 
+                               'BatchMode':'yes', 
+                               'PasswordAuthentication':'no',
+                               'ConnectTimeout':'%s' % COMMAND_TIMEOUT}
+
+class Sopen(subprocess.Popen):
+       def kill(self, sig = signal.SIGTERM):
+               try:
+                       # NOTE: this also kills parent... so doesn't work like I want.
+                       # NOTE: adding 'exec' before the cmd removes the extra sh, and
+                       #               partially addresses this problem.
+                       #os.killpg(os.getpgid(self.pid), signal.SIGKILL)
+                       os.kill(self.pid, sig)
+               except OSError:
+                       # no such process, due to it already exiting...
+                       pass
+
+
+def read_t(stream, count=1, timeout=COMMAND_TIMEOUT*2):
+       if count == 1:
+               retstr = ""
+
+               while True:
+                       lin, lout, lerr = select([stream], [], [], timeout)
+                       if len(lin) == 0:
+                               print "timeout!"
+                               raise ExceptionReadTimeout("TIMEOUT reading from command")
+
+                       try:
+                               outbytes = stream.read(count)
+                       except IOError, err:
+                               print 'no content yet.'
+                               # due to no content.
+                               # the select timeout should catch this.
+                               continue
+
+                       if not outbytes:
+                               break
+                       retstr += outbytes
+
+               return retstr
+       else:
+               lin, lout, lerr = select([stream], [], [], timeout)
+               if len(lin) == 0:
+                       raise ExceptionReadTimeout("TIMEOUT reading from command")
+
+               return stream.read(count)
+
+class CMD:
+       def __init__(self):
+               pass
+
+       def run_noexcept(self, cmd, timeout=COMMAND_TIMEOUT*2):
+
+               try:
+                       return CMD.run(self,cmd,timeout)
+               except ExceptionTimeout:
+                       print traceback.print_exc()
+                       return ("", "ScriptTimeout")
+               except ExceptionReadTimeout:
+                       print traceback.print_exc()
+                       return ("", "RunningScriptTimeout")
+               except Exception, err:
+                       from monitor.common import email_exception
+                       email_exception()
+                       return ("", str(err))
+                       
+       def system(self, cmd, timeout=COMMAND_TIMEOUT*2):
+               (o,e) = self.run(cmd, timeout)
+               self.output = o
+               self.error = e
+               if self.s.returncode is None:
+                       self.s.wait()
+               return self.s.returncode
+
+       def run(self, cmd, timeout=COMMAND_TIMEOUT*2):
+
+               s = Sopen(cmd, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True)
+               self.s = s
+               (f_in, f_out, f_err) = (s.stdin, s.stdout, s.stderr)
+               lout, lin, lerr = select([f_out], [], [f_err], timeout)
+               if len(lin) == 0 and len(lout) == 0 and len(lerr) == 0:
+                       # Reached a timeout!  Nuke process so it does not hang.
+                       print "TIMEOUT!!!!!!!!!!!!!!!!!!!"
+                       s.kill(signal.SIGKILL)
+                       raise ExceptionTimeout("TIMEOUT Running: %s" % cmd)
+               else:
+                       #print "RETURNING"
+                       #print len(lin), len(lout), len(lerr)
+                       pass
+
+               o_value = ""
+               e_value = ""
+
+               #o_value = f_out.read()
+               flags = fcntl.fcntl(f_out, fcntl.F_GETFL)
+               fcntl.fcntl(f_out, fcntl.F_SETFL, flags | os.O_NONBLOCK)
+
+               try:
+                       o_value = read_t(f_out,1,30)
+               except ExceptionReadTimeout:
+                       s.kill(signal.SIGKILL)
+                       raise ExceptionReadTimeout("TIMEOUT: failed to read from cmd: %s" % cmd)
+                       
+               e_value = f_err.read()
+
+               o_value = o_value.strip()
+               e_value = e_value.strip()
+
+               f_out.close()
+               f_in.close()
+               f_err.close()
+               s.kill(signal.SIGKILL)
+
+               return (o_value, e_value)
+
+       def runargs(self, args, timeout=COMMAND_TIMEOUT*2):
+
+               #print "CMD.run(%s)" % " ".join(args)
+               s = Sopen(args, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, close_fds=True)
+               self.s = s
+               (f_in, f_out, f_err) = (s.stdin, s.stdout, s.stderr)
+               lout, lin, lerr = select([f_out], [], [f_err], timeout)
+               if len(lin) == 0 and len(lout) == 0 and len(lerr) == 0:
+                       # Reached a timeout!  Nuke process so it does not hang.
+                       s.kill(signal.SIGKILL)
+                       raise ExceptionTimeout("TIMEOUT Running: %s" % cmd)
+               o_value = f_out.read()
+               e_value = ""
+               if o_value == "":       # An error has occured
+                       e_value = f_err.read()
+
+               o_value = o_value.strip()
+               e_value = e_value.strip()
+
+               f_out.close()
+               f_in.close()
+               f_err.close()
+               s.kill(signal.SIGKILL)
+
+               return (o_value, e_value)
+
+
+class SSH(CMD):
+       def __init__(self, user, host, port=22, options = ssh_options):
+               self.options = options
+               self.user = user
+               self.host = host
+               self.port = port
+               return
+
+       def __options_to_str(self):
+               options = ""
+               for o,v in self.options.iteritems():
+                       options = options + "-o %s=%s " % (o,v)
+               return options
+
+       def run(self, cmd, timeout=COMMAND_TIMEOUT*2):
+               cmd = "ssh -p %s %s %s@%s '%s'" % (self.port, self.__options_to_str(), 
+                                                                       self.user, self.host, cmd)
+               #print "SSH.run(%s)" % cmd
+               return CMD.run(self, cmd, timeout)
+
+       def get_file(self, rmt_filename, local_filename=None):
+               if local_filename == None:
+                       local_filename = "./"
+               cmd = "scp -P %s -B %s %s@%s:%s %s" % (self.port, self.__options_to_str(), 
+                                                                       self.user, self.host, 
+                                                                       rmt_filename, local_filename)
+               # output :
+               #       errors will be on stderr,
+               #   success will have a blank stderr...
+               return CMD.run_noexcept(self, cmd)
+
+       def run_noexcept(self, cmd):
+               cmd = "ssh -p %s %s %s@%s '%s'" % (self.port, self.__options_to_str(), 
+                                                                       self.user, self.host, cmd)
+               #print "SSH.run_noexcept(%s)" % cmd
+               return CMD.run_noexcept(self, cmd)
+
+       def run_noexcept2(self, cmd, timeout=COMMAND_TIMEOUT*2):
+               cmd = "exec ssh -p %s %s %s@%s %s" % (self.port, self.__options_to_str(), 
+                                                                       self.user, self.host, cmd)
+               r = CMD.run_noexcept(self, cmd, timeout)
+               self.ret = -1
+
+               return r
+
+       def system2(self, cmd, timeout=COMMAND_TIMEOUT*2):
+               cmd = "ssh -p %s %s %s@%s %s" % (self.port, self.__options_to_str(), 
+                                                                       self.user, self.host, cmd)
+               #print "SSH.system2(%s)" % cmd
+               return CMD.system(self, cmd, timeout)
+
+       def runE(self, cmd):
+               cmd = "ssh -p %s %s %s@%s '%s'" % (self.port, self.__options_to_str(), 
+                                                                       self.user, self.host, cmd)
+               if ( DEBUG == 1 ):
+                       print cmd,
+               (f_in, f_out, f_err) = os.popen3(cmd)
+
+               value = f_out.read()
+               if value == "": # An error has occured
+                       value = f_err.read()
+                       value = value.strip()
+
+               if ( DEBUG == 1 ):
+                       print " == %s" % value
+               f_out.close()
+               f_in.close()
+               f_err.close()
+               return value.strip()
+               
+class MyTimer:
+       def __init__(self):
+               self.start = time.time()
+
+       def end(self):
+               self.end = time.time()
+               t = self.end-self.start
+               return t
+
+       def diff(self):
+               self.end = time.time()
+               t = self.end-self.start
+               self.start = self.end
+               return t