| 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 | outdata, errdata = p.communicate(self.__indata) |
| 114 | self.exitcode = p.returncode |
| 115 | except OSError, e: |
| 116 | raise self.exc('%s failed: %s' % (self.__cmd[0], e)) |
| 117 | if errdata and not self.__discard_stderr: |
| 118 | out.err_raw(errdata) |
| 119 | self.__log_end(self.exitcode) |
| 120 | self.__check_exitcode() |
| 121 | return outdata |
| 122 | def __run_noio(self): |
| 123 | """Run without captured IO.""" |
| 124 | assert self.__indata == None |
| 125 | self.__log_start() |
| 126 | try: |
| 127 | p = subprocess.Popen(self.__cmd, env = self.__env, cwd = self.__cwd) |
| 128 | self.exitcode = p.wait() |
| 129 | except OSError, e: |
| 130 | raise self.exc('%s failed: %s' % (self.__cmd[0], e)) |
| 131 | self.__log_end(self.exitcode) |
| 132 | self.__check_exitcode() |
| 133 | def returns(self, retvals): |
| 134 | self.__good_retvals = retvals |
| 135 | return self |
| 136 | def discard_exitcode(self): |
| 137 | self.__good_retvals = None |
| 138 | return self |
| 139 | def discard_stderr(self, discard = True): |
| 140 | self.__discard_stderr = discard |
| 141 | return self |
| 142 | def env(self, env): |
| 143 | self.__env = dict(os.environ) |
| 144 | self.__env.update(env) |
| 145 | return self |
| 146 | def cwd(self, cwd): |
| 147 | self.__cwd = cwd |
| 148 | return self |
| 149 | def raw_input(self, indata): |
| 150 | self.__indata = indata |
| 151 | return self |
| 152 | def input_lines(self, lines): |
| 153 | self.__indata = ''.join(['%s\n' % line for line in lines]) |
| 154 | return self |
| 155 | def input_nulterm(self, lines): |
| 156 | self.__indata = ''.join('%s\0' % line for line in lines) |
| 157 | return self |
| 158 | def no_output(self): |
| 159 | outdata = self.__run_io() |
| 160 | if outdata: |
| 161 | raise self.exc, '%s produced output' % self.__cmd[0] |
| 162 | def discard_output(self): |
| 163 | self.__run_io() |
| 164 | def raw_output(self): |
| 165 | return self.__run_io() |
| 166 | def output_lines(self): |
| 167 | outdata = self.__run_io() |
| 168 | if outdata.endswith('\n'): |
| 169 | outdata = outdata[:-1] |
| 170 | if outdata: |
| 171 | return outdata.split('\n') |
| 172 | else: |
| 173 | return [] |
| 174 | def output_one_line(self): |
| 175 | outlines = self.output_lines() |
| 176 | if len(outlines) == 1: |
| 177 | return outlines[0] |
| 178 | else: |
| 179 | raise self.exc('%s produced %d lines, expected 1' |
| 180 | % (self.__cmd[0], len(outlines))) |
| 181 | def run(self): |
| 182 | """Just run, with no IO redirection.""" |
| 183 | self.__run_noio() |
| 184 | def xargs(self, xargs): |
| 185 | """Just run, with no IO redirection. The extra arguments are |
| 186 | appended to the command line a few at a time; the command is |
| 187 | run as many times as needed to consume them all.""" |
| 188 | step = 100 |
| 189 | basecmd = self.__cmd |
| 190 | for i in xrange(0, len(xargs), step): |
| 191 | self.__cmd = basecmd + xargs[i:i+step] |
| 192 | self.__run_noio() |
| 193 | self.__cmd = basecmd |