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 _all_log_modes = ['debug', 'profile']
  31 _log_mode = os.environ.get('STGIT_SUBPROCESS_LOG', '')
  32 if _log_mode and not _log_mode in _all_log_modes:
  33     out.warn(('Unknown log mode "%s" specified in $STGIT_SUBPROCESS_LOG.'
  34               % _log_mode),
  35              'Valid values are: %s' % ', '.join(_all_log_modes))
  36
  37 class Run:
  38     exc = RunException
  39     def __init__(self, *cmd):
  40         self.__cmd = list(cmd)
  41         for c in cmd:
  42             if type(c) != str:
  43                 raise Exception, 'Bad command: %r' % (cmd,)
  44         self.__good_retvals = [0]
  45         self.__env = None
  46         self.__indata = None
  47         self.__discard_stderr = False
  48     def __log_start(self):
  49         if _log_mode == 'debug':
  50             out.start('Running subprocess %s' % self.__cmd)
  51         elif _log_mode == 'profile':
  52             out.start('Running subprocess %s' % self.__cmd[0])
  53             self.__starttime = datetime.datetime.now()
  54     def __log_end(self, retcode):
  55         if _log_mode == 'debug':
  56             out.done('return code: %d' % retcode)
  57         elif _log_mode == 'profile':
  58             duration = datetime.datetime.now() - self.__starttime
  59             out.done('%1.3f s' % (duration.microseconds/1e6 + duration.seconds))
  60     def __check_exitcode(self):
  61         if self.exitcode not in self.__good_retvals:
  62             raise self.exc('%s failed with code %d'
  63                            % (self.__cmd[0], self.exitcode))
  64     def __run_io(self):
  65         """Run with captured IO."""
  66         self.__log_start()
  67         try:
  68             p = subprocess.Popen(self.__cmd, env = self.__env,
  69                                  stdin = subprocess.PIPE,
  70                                  stdout = subprocess.PIPE,
  71                                  stderr = subprocess.PIPE)
  72             outdata, errdata = p.communicate(self.__indata)
  73             self.exitcode = p.returncode
  74         except OSError, e:
  75             raise self.exc('%s failed: %s' % (self.__cmd[0], e))
  76         if errdata and not self.__discard_stderr:
  77             out.err_raw(errdata)
  78         self.__log_end(self.exitcode)
  79         self.__check_exitcode()
  80         return outdata
  81     def __run_noio(self):
  82         """Run without captured IO."""
  83         assert self.__indata == None
  84         self.__log_start()
  85         try:
  86             p = subprocess.Popen(self.__cmd, env = self.__env)
  87             self.exitcode = p.wait()
  88         except OSError, e:
  89             raise self.exc('%s failed: %s' % (self.__cmd[0], e))
  90         self.__log_end(self.exitcode)
  91         self.__check_exitcode()
  92     def returns(self, retvals):
  93         self.__good_retvals = retvals
  94         return self
  95     def discard_stderr(self, discard = True):
  96         self.__discard_stderr = discard
  97         return self
  98     def env(self, env):
  99         self.__env = dict(os.environ)
 100         self.__env.update(env)
 101         return self
 102     def raw_input(self, indata):
 103         self.__indata = indata
 104         return self
 105     def input_lines(self, lines):
 106         self.__indata = ''.join(['%s\n' % line for line in lines])
 107         return self
 108     def no_output(self):
 109         outdata = self.__run_io()
 110         if outdata:
 111             raise self.exc, '%s produced output' % self.__cmd[0]
 112     def discard_output(self):
 113         self.__run_io()
 114     def raw_output(self):
 115         return self.__run_io()
 116     def output_lines(self):
 117         outdata = self.__run_io()
 118         if outdata.endswith('\n'):
 119             outdata = outdata[:-1]
 120         if outdata:
 121             return outdata.split('\n')
 122         else:
 123             return []
 124     def output_one_line(self):
 125         outlines = self.output_lines()
 126         if len(outlines) == 1:
 127             return outlines[0]
 128         else:
 129             raise self.exc('%s produced %d lines, expected 1'
 130                            % (self.__cmd[0], len(outlines)))
 131     def run(self):
 132         """Just run, with no IO redirection."""
 133         self.__run_noio()
 134     def xargs(self, xargs):
 135         """Just run, with no IO redirection. The extra arguments are
 136         appended to the command line a few at a time; the command is
 137         run as many times as needed to consume them all."""
 138         step = 100
 139         basecmd = self.__cmd
 140         for i in xrange(0, len(xargs), step):
 141             self.__cmd = basecmd + xargs[i:i+step]
 142             self.__run_noio()
 143         self.__cmd = basecmd