mdw@git.distorted.org.uk Git - stgit/blob - stgit/run.py

   1 # -*- coding: utf-8 -*-
   2
   3 __copyright__ = """
   4 Copyright (C) 2007, Karl Hasselström <kha@treskal.com>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License version 2 as
   8 published by the Free Software Foundation.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18 """
  19
  20 import datetime, os, subprocess
  21
  22 from stgit.exception import *
  23 from stgit.out import *
  24
  25 class RunException(StgException):
  26     """Thrown when something bad happened when we tried to run the
  27     subprocess."""
  28     pass
  29
  30 def get_log_mode(spec):
  31     if not ':' in spec:
  32         spec += ':'
  33     (log_mode, outfile) = spec.split(':', 1)
  34     all_log_modes = ['debug', 'profile']
  35     if log_mode and not log_mode in all_log_modes:
  36         out.warn(('Unknown log mode "%s" specified in $STGIT_SUBPROCESS_LOG.'
  37                   % log_mode),
  38                  'Valid values are: %s' % ', '.join(all_log_modes))
  39     if outfile:
  40         f = MessagePrinter(open(outfile, 'a'))
  41     else:
  42         f = out
  43     return (log_mode, f)
  44
  45 (_log_mode, _logfile) = get_log_mode(os.environ.get('STGIT_SUBPROCESS_LOG', ''))
  46 if _log_mode == 'profile':
  47     _log_starttime = datetime.datetime.now()
  48     _log_subproctime = 0.0
  49
  50 def duration(t1, t2):
  51     d = t2 - t1
  52     return 86400*d.days + d.seconds + 1e-6*d.microseconds
  53
  54 def finish_logging():
  55     if _log_mode != 'profile':
  56         return
  57     ttime = duration(_log_starttime, datetime.datetime.now())
  58     rtime = ttime - _log_subproctime
  59     _logfile.info('Total time: %1.3f s' % ttime,
  60                   'Time spent in subprocess calls: %1.3f s (%1.1f%%)'
  61                   % (_log_subproctime, 100*_log_subproctime/ttime),
  62                   'Remaining time: %1.3f s (%1.1f%%)'
  63                   % (rtime, 100*rtime/ttime))
  64
  65 class Run:
  66     exc = RunException
  67     def __init__(self, *cmd):
  68         self.__cmd = list(cmd)
  69         for c in cmd:
  70             if type(c) != str:
  71                 raise Exception, 'Bad command: %r' % (cmd,)
  72         self.__good_retvals = [0]
  73         self.__env = self.__cwd = None
  74         self.__indata = None
  75         self.__discard_stderr = False
  76     def __log_start(self):
  77         if _log_mode == 'debug':
  78             _logfile.start('Running subprocess %s' % self.__cmd)
  79             if self.__cwd != None:
  80                 _logfile.info('cwd: %s' % self.__cwd)
  81             if self.__env != None:
  82                 for k in sorted(self.__env.iterkeys()):
  83                     if k not in os.environ or os.environ[k] != self.__env[k]:
  84                         _logfile.info('%s: %s' % (k, self.__env[k]))
  85         elif _log_mode == 'profile':
  86             _logfile.start('Running subprocess %s' % self.__cmd)
  87             self.__starttime = datetime.datetime.now()
  88     def __log_end(self, retcode):
  89         global _log_subproctime, _log_starttime
  90         if _log_mode == 'debug':
  91             _logfile.done('return code: %d' % retcode)
  92         elif _log_mode == 'profile':
  93             n = datetime.datetime.now()
  94             d = duration(self.__starttime, n)
  95             _logfile.done('%1.3f s' % d)
  96             _log_subproctime += d
  97             _logfile.info('Time since program start: %1.3f s'
  98                           % duration(_log_starttime, n))
  99     def __check_exitcode(self):
 100         if self.__good_retvals == None:
 101             return
 102         if self.exitcode not in self.__good_retvals:
 103             raise self.exc('%s failed with code %d'
 104                            % (self.__cmd[0], self.exitcode))
 105     def __run_io(self):
 106         """Run with captured IO."""
 107         self.__log_start()
 108         try:
 109             p = subprocess.Popen(self.__cmd, env = self.__env, cwd = self.__cwd,
 110                                  stdin = subprocess.PIPE,
 111                                  stdout = subprocess.PIPE,
 112                                  stderr = subprocess.PIPE)
 113             # TODO: only use communicate() once support for Python 2.4 is
 114             # dropped (write() needed because of performance reasons)
 115             if self.__indata:
 116                 p.stdin.write(self.__indata)
 117             outdata, errdata = p.communicate()
 118             self.exitcode = p.returncode
 119         except OSError, e:
 120             raise self.exc('%s failed: %s' % (self.__cmd[0], e))
 121         if errdata and not self.__discard_stderr:
 122             out.err_raw(errdata)
 123         self.__log_end(self.exitcode)
 124         self.__check_exitcode()
 125         return outdata
 126     def __run_noio(self):
 127         """Run without captured IO."""
 128         assert self.__indata == None
 129         self.__log_start()
 130         try:
 131             p = subprocess.Popen(self.__cmd, env = self.__env, cwd = self.__cwd)
 132             self.exitcode = p.wait()
 133         except OSError, e:
 134             raise self.exc('%s failed: %s' % (self.__cmd[0], e))
 135         self.__log_end(self.exitcode)
 136         self.__check_exitcode()
 137     def __run_background(self):
 138         """Run in background."""
 139         assert self.__indata == None
 140         try:
 141             p = subprocess.Popen(self.__cmd, env = self.__env, cwd = self.__cwd,
 142                                  stdin = subprocess.PIPE,
 143                                  stdout = subprocess.PIPE,
 144                                  stderr = subprocess.PIPE)
 145         except OSError, e:
 146             raise self.exc('%s failed: %s' % (self.__cmd[0], e))
 147         self.stdin = p.stdin
 148         self.stdout = p.stdout
 149         self.stderr = p.stderr
 150         self.wait = p.wait
 151         self.pid = lambda: p.pid
 152     def returns(self, retvals):
 153         self.__good_retvals = retvals
 154         return self
 155     def discard_exitcode(self):
 156         self.__good_retvals = None
 157         return self
 158     def discard_stderr(self, discard = True):
 159         self.__discard_stderr = discard
 160         return self
 161     def env(self, env):
 162         self.__env = dict(os.environ)
 163         self.__env.update(env)
 164         return self
 165     def cwd(self, cwd):
 166         self.__cwd = cwd
 167         return self
 168     def raw_input(self, indata):
 169         self.__indata = indata
 170         return self
 171     def input_lines(self, lines):
 172         self.__indata = ''.join(['%s\n' % line for line in lines])
 173         return self
 174     def input_nulterm(self, lines):
 175         self.__indata = ''.join('%s\0' % line for line in lines)
 176         return self
 177     def no_output(self):
 178         outdata = self.__run_io()
 179         if outdata:
 180             raise self.exc, '%s produced output' % self.__cmd[0]
 181     def discard_output(self):
 182         self.__run_io()
 183     def raw_output(self):
 184         return self.__run_io()
 185     def output_lines(self):
 186         outdata = self.__run_io()
 187         if outdata.endswith('\n'):
 188             outdata = outdata[:-1]
 189         if outdata:
 190             return outdata.split('\n')
 191         else:
 192             return []
 193     def output_one_line(self):
 194         outlines = self.output_lines()
 195         if len(outlines) == 1:
 196             return outlines[0]
 197         else:
 198             raise self.exc('%s produced %d lines, expected 1'
 199                            % (self.__cmd[0], len(outlines)))
 200     def run(self):
 201         """Just run, with no IO redirection."""
 202         self.__run_noio()
 203     def run_background(self):
 204         """Run as a background process."""
 205         self.__run_background()
 206         return self
 207     def xargs(self, xargs):
 208         """Just run, with no IO redirection. The extra arguments are
 209         appended to the command line a few at a time; the command is
 210         run as many times as needed to consume them all."""
 211         step = 100
 212         basecmd = self.__cmd
 213         for i in xrange(0, len(xargs), step):
 214             self.__cmd = basecmd + xargs[i:i+step]
 215             self.__run_noio()
 216         self.__cmd = basecmd