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