blob: 598bfdcd90b6d2e3995db2f6fce9011ce2335c2d [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001# SPDX-License-Identifier: GPL-2.0+
Simon Glass26132882012-01-14 15:12:45 +00002# Copyright (c) 2011 The Chromium OS Authors.
3#
Simon Glass26132882012-01-14 15:12:45 +00004
5import os
Simon Glass34e59432012-12-15 10:42:04 +00006import cros_subprocess
Simon Glass26132882012-01-14 15:12:45 +00007
8"""Shell command ease-ups for Python."""
9
Simon Glass34e59432012-12-15 10:42:04 +000010class CommandResult:
11 """A class which captures the result of executing a command.
12
13 Members:
14 stdout: stdout obtained from command, as a string
15 stderr: stderr obtained from command, as a string
16 return_code: Return code from command
17 exception: Exception received, or None if all ok
18 """
19 def __init__(self):
20 self.stdout = None
21 self.stderr = None
Simon Glassde384972014-09-05 19:00:12 -060022 self.combined = None
Simon Glass34e59432012-12-15 10:42:04 +000023 self.return_code = None
24 self.exception = None
25
Simon Glassde384972014-09-05 19:00:12 -060026 def __init__(self, stdout='', stderr='', combined='', return_code=0,
27 exception=None):
28 self.stdout = stdout
29 self.stderr = stderr
30 self.combined = combined
31 self.return_code = return_code
32 self.exception = exception
33
34
35# This permits interception of RunPipe for test purposes. If it is set to
36# a function, then that function is called with the pipe list being
37# executed. Otherwise, it is assumed to be a CommandResult object, and is
38# returned as the result for every RunPipe() call.
39# When this value is None, commands are executed as normal.
40test_result = None
Simon Glass34e59432012-12-15 10:42:04 +000041
42def RunPipe(pipe_list, infile=None, outfile=None,
43 capture=False, capture_stderr=False, oneline=False,
Simon Glass519fad22012-12-15 10:42:05 +000044 raise_on_error=True, cwd=None, **kwargs):
Simon Glass26132882012-01-14 15:12:45 +000045 """
46 Perform a command pipeline, with optional input/output filenames.
47
Simon Glass34e59432012-12-15 10:42:04 +000048 Args:
49 pipe_list: List of command lines to execute. Each command line is
50 piped into the next, and is itself a list of strings. For
51 example [ ['ls', '.git'] ['wc'] ] will pipe the output of
52 'ls .git' into 'wc'.
53 infile: File to provide stdin to the pipeline
54 outfile: File to store stdout
55 capture: True to capture output
56 capture_stderr: True to capture stderr
57 oneline: True to strip newline chars from output
58 kwargs: Additional keyword arguments to cros_subprocess.Popen()
59 Returns:
60 CommandResult object
Simon Glass26132882012-01-14 15:12:45 +000061 """
Simon Glassde384972014-09-05 19:00:12 -060062 if test_result:
63 if hasattr(test_result, '__call__'):
64 return test_result(pipe_list=pipe_list)
65 return test_result
Simon Glass34e59432012-12-15 10:42:04 +000066 result = CommandResult()
Simon Glass26132882012-01-14 15:12:45 +000067 last_pipe = None
Simon Glass34e59432012-12-15 10:42:04 +000068 pipeline = list(pipe_list)
Simon Glass519fad22012-12-15 10:42:05 +000069 user_pipestr = '|'.join([' '.join(pipe) for pipe in pipe_list])
Simon Glassf1bf6862014-09-05 19:00:09 -060070 kwargs['stdout'] = None
71 kwargs['stderr'] = None
Simon Glass26132882012-01-14 15:12:45 +000072 while pipeline:
73 cmd = pipeline.pop(0)
Simon Glass26132882012-01-14 15:12:45 +000074 if last_pipe is not None:
75 kwargs['stdin'] = last_pipe.stdout
76 elif infile:
77 kwargs['stdin'] = open(infile, 'rb')
78 if pipeline or capture:
Simon Glass34e59432012-12-15 10:42:04 +000079 kwargs['stdout'] = cros_subprocess.PIPE
Simon Glass26132882012-01-14 15:12:45 +000080 elif outfile:
81 kwargs['stdout'] = open(outfile, 'wb')
Simon Glass34e59432012-12-15 10:42:04 +000082 if capture_stderr:
83 kwargs['stderr'] = cros_subprocess.PIPE
Simon Glass26132882012-01-14 15:12:45 +000084
Simon Glass34e59432012-12-15 10:42:04 +000085 try:
86 last_pipe = cros_subprocess.Popen(cmd, cwd=cwd, **kwargs)
Paul Burtonf14a1312016-09-27 16:03:51 +010087 except Exception as err:
Simon Glass34e59432012-12-15 10:42:04 +000088 result.exception = err
Simon Glass519fad22012-12-15 10:42:05 +000089 if raise_on_error:
90 raise Exception("Error running '%s': %s" % (user_pipestr, str))
91 result.return_code = 255
92 return result
Simon Glass26132882012-01-14 15:12:45 +000093
94 if capture:
Simon Glass34e59432012-12-15 10:42:04 +000095 result.stdout, result.stderr, result.combined = (
96 last_pipe.CommunicateFilter(None))
97 if result.stdout and oneline:
98 result.output = result.stdout.rstrip('\r\n')
99 result.return_code = last_pipe.wait()
Simon Glass26132882012-01-14 15:12:45 +0000100 else:
Simon Glass34e59432012-12-15 10:42:04 +0000101 result.return_code = os.waitpid(last_pipe.pid, 0)[1]
Simon Glass519fad22012-12-15 10:42:05 +0000102 if raise_on_error and result.return_code:
103 raise Exception("Error running '%s'" % user_pipestr)
Simon Glass34e59432012-12-15 10:42:04 +0000104 return result
Simon Glass26132882012-01-14 15:12:45 +0000105
Simon Glassc55e0562016-07-25 18:59:00 -0600106def Output(*cmd, **kwargs):
107 raise_on_error = kwargs.get('raise_on_error', True)
108 return RunPipe([cmd], capture=True, raise_on_error=raise_on_error).stdout
Simon Glass26132882012-01-14 15:12:45 +0000109
Simon Glass34e59432012-12-15 10:42:04 +0000110def OutputOneLine(*cmd, **kwargs):
Simon Glass519fad22012-12-15 10:42:05 +0000111 raise_on_error = kwargs.pop('raise_on_error', True)
Simon Glass34e59432012-12-15 10:42:04 +0000112 return (RunPipe([cmd], capture=True, oneline=True,
Simon Glass519fad22012-12-15 10:42:05 +0000113 raise_on_error=raise_on_error,
Simon Glass34e59432012-12-15 10:42:04 +0000114 **kwargs).stdout.strip())
Simon Glass26132882012-01-14 15:12:45 +0000115
116def Run(*cmd, **kwargs):
Simon Glass34e59432012-12-15 10:42:04 +0000117 return RunPipe([cmd], **kwargs).stdout
Simon Glass26132882012-01-14 15:12:45 +0000118
119def RunList(cmd):
Simon Glass34e59432012-12-15 10:42:04 +0000120 return RunPipe([cmd], capture=True).stdout
121
122def StopAll():
123 cros_subprocess.stay_alive = False