cvs2svn_lib/process.py

   1 # (Be in -*- python -*- mode.)
   2 #
   3 # ====================================================================
   4 # Copyright (c) 2000-2008 CollabNet.  All rights reserved.
   5 #
   6 # This software is licensed as described in the file COPYING, which
   7 # you should have received as part of this distribution.  The terms
   8 # are also available at http://subversion.tigris.org/license-1.html.
   9 # If newer versions of this license are posted there, you may use a
  10 # newer version instead, at your option.
  11 #
  12 # This software consists of voluntary contributions made by many
  13 # individuals.  For exact contribution history, see the revision
  14 # history and logs, available at http://cvs2svn.tigris.org/.
  15 # ====================================================================
  16
  17 """This module contains generic utilities used by cvs2svn."""
  18
  19
  20 import subprocess
  21
  22 from cvs2svn_lib.common import FatalError
  23 from cvs2svn_lib.common import CommandError
  24 from cvs2svn_lib.log import logger
  25
  26
  27 def call_command(command, **kw):
  28   """Call the specified command, checking that it exits successfully.
  29
  30   Raise a FatalError if the command cannot be executed, or if it exits
  31   with a non-zero exit code.  Pass KW as keyword arguments to
  32   subprocess.call()."""
  33
  34   logger.debug('Running command %r' % (command,))
  35   try:
  36     retcode = subprocess.call(command, **kw)
  37     if retcode < 0:
  38       raise FatalError(
  39           'Command terminated by signal %d: "%s"'
  40           % (-retcode, ' '.join(command),)
  41           )
  42     elif retcode > 0:
  43       raise FatalError(
  44           'Command failed with return code %d: "%s"'
  45           % (retcode, ' '.join(command),)
  46           )
  47   except OSError, e:
  48     raise FatalError(
  49         'Command execution failed (%s): "%s"'
  50         % (e, ' '.join(command),)
  51         )
  52
  53
  54 class CommandFailedException(Exception):
  55   """Exception raised if check_command_runs() fails."""
  56
  57   pass
  58
  59
  60 def check_command_runs(command, commandname):
  61   """Check whether the command CMD can be executed without errors.
  62
  63   CMD is a list or string, as accepted by subprocess.Popen().  CMDNAME
  64   is the name of the command as it should be included in exception
  65   error messages.
  66
  67   This function checks three things: (1) the command can be run
  68   without throwing an OSError; (2) it exits with status=0; (3) it
  69   doesn't output anything to stderr.  If any of these conditions is
  70   not met, raise a CommandFailedException describing the problem."""
  71
  72   logger.debug('Running command %r' % (command,))
  73   try:
  74     pipe = subprocess.Popen(
  75         command,
  76         stdin=subprocess.PIPE,
  77         stdout=subprocess.PIPE,
  78         stderr=subprocess.PIPE,
  79         )
  80   except OSError, e:
  81     raise CommandFailedException('error executing %s: %s' % (commandname, e,))
  82   (stdout, stderr) = pipe.communicate()
  83   if pipe.returncode or stderr:
  84     msg = 'error executing %s; returncode=%s' % (commandname, pipe.returncode,)
  85     if stderr:
  86       msg += ', error output:\n%s' % (stderr,)
  87     raise CommandFailedException(msg)
  88
  89
  90 def get_command_output(command):
  91   """Run COMMAND and return its stdout.
  92
  93   COMMAND is a list of strings.  Run the command and return its stdout
  94   as a string.  If the command exits with a nonzero return code or
  95   writes something to stderr, raise a CommandError."""
  96
  97   """A file-like object from which revision contents can be read."""
  98
  99   logger.debug('Running command %r' % (command,))
 100   pipe = subprocess.Popen(
 101       command,
 102       stdin=subprocess.PIPE,
 103       stdout=subprocess.PIPE,
 104       stderr=subprocess.PIPE,
 105       )
 106   (stdout, stderr) = pipe.communicate()
 107   if pipe.returncode or stderr:
 108     raise CommandError(' '.join(command), pipe.returncode, stderr)
 109   return stdout
 110
 111