tools/patman/command.py

   1 # SPDX-License-Identifier: GPL-2.0+
   2 # Copyright (c) 2011 The Chromium OS Authors.
   3 #
   4
   5 import os
   6
   7 from patman import cros_subprocess
   8 from patman import tools
   9
  10 """Shell command ease-ups for Python."""
  11
  12 class CommandResult:
  13     """A class which captures the result of executing a command.
  14
  15     Members:
  16         stdout: stdout obtained from command, as a string
  17         stderr: stderr obtained from command, as a string
  18         return_code: Return code from command
  19         exception: Exception received, or None if all ok
  20     """
  21     def __init__(self):
  22         self.stdout = None
  23         self.stderr = None
  24         self.combined = None
  25         self.return_code = None
  26         self.exception = None
  27
  28     def __init__(self, stdout='', stderr='', combined='', return_code=0,
  29                  exception=None):
  30         self.stdout = stdout
  31         self.stderr = stderr
  32         self.combined = combined
  33         self.return_code = return_code
  34         self.exception = exception
  35
  36     def ToOutput(self, binary):
  37         if not binary:
  38             self.stdout = tools.ToString(self.stdout)
  39             self.stderr = tools.ToString(self.stderr)
  40             self.combined = tools.ToString(self.combined)
  41         return self
  42
  43
  44 # This permits interception of RunPipe for test purposes. If it is set to
  45 # a function, then that function is called with the pipe list being
  46 # executed. Otherwise, it is assumed to be a CommandResult object, and is
  47 # returned as the result for every RunPipe() call.
  48 # When this value is None, commands are executed as normal.
  49 test_result = None
  50
  51 def RunPipe(pipe_list, infile=None, outfile=None,
  52             capture=False, capture_stderr=False, oneline=False,
  53             raise_on_error=True, cwd=None, binary=False, **kwargs):
  54     """
  55     Perform a command pipeline, with optional input/output filenames.
  56
  57     Args:
  58         pipe_list: List of command lines to execute. Each command line is
  59             piped into the next, and is itself a list of strings. For
  60             example [ ['ls', '.git'] ['wc'] ] will pipe the output of
  61             'ls .git' into 'wc'.
  62         infile: File to provide stdin to the pipeline
  63         outfile: File to store stdout
  64         capture: True to capture output
  65         capture_stderr: True to capture stderr
  66         oneline: True to strip newline chars from output
  67         kwargs: Additional keyword arguments to cros_subprocess.Popen()
  68     Returns:
  69         CommandResult object
  70     """
  71     if test_result:
  72         if hasattr(test_result, '__call__'):
  73             result = test_result(pipe_list=pipe_list)
  74             if result:
  75                 return result
  76         else:
  77             return test_result
  78         # No result: fall through to normal processing
  79     result = CommandResult(b'', b'', b'')
  80     last_pipe = None
  81     pipeline = list(pipe_list)
  82     user_pipestr =  '|'.join([' '.join(pipe) for pipe in pipe_list])
  83     kwargs['stdout'] = None
  84     kwargs['stderr'] = None
  85     while pipeline:
  86         cmd = pipeline.pop(0)
  87         if last_pipe is not None:
  88             kwargs['stdin'] = last_pipe.stdout
  89         elif infile:
  90             kwargs['stdin'] = open(infile, 'rb')
  91         if pipeline or capture:
  92             kwargs['stdout'] = cros_subprocess.PIPE
  93         elif outfile:
  94             kwargs['stdout'] = open(outfile, 'wb')
  95         if capture_stderr:
  96             kwargs['stderr'] = cros_subprocess.PIPE
  97
  98         try:
  99             last_pipe = cros_subprocess.Popen(cmd, cwd=cwd, **kwargs)
 100         except Exception as err:
 101             result.exception = err
 102             if raise_on_error:
 103                 raise Exception("Error running '%s': %s" % (user_pipestr, str))
 104             result.return_code = 255
 105             return result.ToOutput(binary)
 106
 107     if capture:
 108         result.stdout, result.stderr, result.combined = (
 109                 last_pipe.CommunicateFilter(None))
 110         if result.stdout and oneline:
 111             result.output = result.stdout.rstrip(b'\r\n')
 112         result.return_code = last_pipe.wait()
 113     else:
 114         result.return_code = os.waitpid(last_pipe.pid, 0)[1]
 115     if raise_on_error and result.return_code:
 116         raise Exception("Error running '%s'" % user_pipestr)
 117     return result.ToOutput(binary)
 118
 119 def Output(*cmd, **kwargs):
 120     kwargs['raise_on_error'] = kwargs.get('raise_on_error', True)
 121     return RunPipe([cmd], capture=True, **kwargs).stdout
 122
 123 def OutputOneLine(*cmd, **kwargs):
 124     """Run a command and output it as a single-line string
 125
 126     The command us expected to produce a single line of output
 127
 128     Returns:
 129         String containing output of command
 130     """
 131     raise_on_error = kwargs.pop('raise_on_error', True)
 132     result = RunPipe([cmd], capture=True, oneline=True,
 133                      raise_on_error=raise_on_error, **kwargs).stdout.strip()
 134     return result
 135
 136 def Run(*cmd, **kwargs):
 137     return RunPipe([cmd], **kwargs).stdout
 138
 139 def RunList(cmd):
 140     return RunPipe([cmd], capture=True).stdout
 141
 142 def StopAll():
 143     cros_subprocess.stay_alive = False