blob: 92c453b5c1374b7a5c9f1c8fb988dda25e9796e3 [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 Glassa997ea52020-04-17 18:09:04 -06006
7from patman import cros_subprocess
Simon Glass26132882012-01-14 15:12:45 +00008
9"""Shell command ease-ups for Python."""
10
Simon Glass34e59432012-12-15 10:42:04 +000011class 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 Glassde384972014-09-05 19:00:12 -060020 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 Glass840be732022-01-29 14:14:05 -070028 def to_output(self, binary):
Simon Glasscc311ac2019-10-31 07:42:50 -060029 if not binary:
Simon Glass4ba3ea52020-06-07 06:45:46 -060030 self.stdout = self.stdout.decode('utf-8')
31 self.stderr = self.stderr.decode('utf-8')
32 self.combined = self.combined.decode('utf-8')
Simon Glasscc311ac2019-10-31 07:42:50 -060033 return self
34
Simon Glassde384972014-09-05 19:00:12 -060035
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 Glass840be732022-01-29 14:14:05 -070039# returned as the result for every run_pipe() call.
Simon Glassde384972014-09-05 19:00:12 -060040# When this value is None, commands are executed as normal.
41test_result = None
Simon Glass34e59432012-12-15 10:42:04 +000042
Simon Glass840be732022-01-29 14:14:05 -070043def run_pipe(pipe_list, infile=None, outfile=None,
Simon Glass34e59432012-12-15 10:42:04 +000044 capture=False, capture_stderr=False, oneline=False,
Simon Glass146b6022021-10-19 21:43:24 -060045 raise_on_error=True, cwd=None, binary=False,
46 output_func=None, **kwargs):
Simon Glass26132882012-01-14 15:12:45 +000047 """
48 Perform a command pipeline, with optional input/output filenames.
49
Simon Glass34e59432012-12-15 10:42:04 +000050 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 Glass146b6022021-10-19 21:43:24 -060060 output_func: Output function to call with each output fragment
61 (if it returns True the function terminates)
Simon Glass34e59432012-12-15 10:42:04 +000062 kwargs: Additional keyword arguments to cros_subprocess.Popen()
63 Returns:
64 CommandResult object
Simon Glass26132882012-01-14 15:12:45 +000065 """
Simon Glassde384972014-09-05 19:00:12 -060066 if test_result:
67 if hasattr(test_result, '__call__'):
Simon Glass547cba62022-02-11 13:23:18 -070068 # pylint: disable=E1102
Simon Glass6a8480b2018-07-17 13:25:42 -060069 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 Glasscc311ac2019-10-31 07:42:50 -060075 result = CommandResult(b'', b'', b'')
Simon Glass26132882012-01-14 15:12:45 +000076 last_pipe = None
Simon Glass34e59432012-12-15 10:42:04 +000077 pipeline = list(pipe_list)
Simon Glass519fad22012-12-15 10:42:05 +000078 user_pipestr = '|'.join([' '.join(pipe) for pipe in pipe_list])
Simon Glassf1bf6862014-09-05 19:00:09 -060079 kwargs['stdout'] = None
80 kwargs['stderr'] = None
Simon Glass26132882012-01-14 15:12:45 +000081 while pipeline:
82 cmd = pipeline.pop(0)
Simon Glass26132882012-01-14 15:12:45 +000083 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 Glass34e59432012-12-15 10:42:04 +000088 kwargs['stdout'] = cros_subprocess.PIPE
Simon Glass26132882012-01-14 15:12:45 +000089 elif outfile:
90 kwargs['stdout'] = open(outfile, 'wb')
Simon Glass34e59432012-12-15 10:42:04 +000091 if capture_stderr:
92 kwargs['stderr'] = cros_subprocess.PIPE
Simon Glass26132882012-01-14 15:12:45 +000093
Simon Glass34e59432012-12-15 10:42:04 +000094 try:
95 last_pipe = cros_subprocess.Popen(cmd, cwd=cwd, **kwargs)
Paul Burtonf14a1312016-09-27 16:03:51 +010096 except Exception as err:
Simon Glass34e59432012-12-15 10:42:04 +000097 result.exception = err
Simon Glass519fad22012-12-15 10:42:05 +000098 if raise_on_error:
99 raise Exception("Error running '%s': %s" % (user_pipestr, str))
100 result.return_code = 255
Simon Glass840be732022-01-29 14:14:05 -0700101 return result.to_output(binary)
Simon Glass26132882012-01-14 15:12:45 +0000102
103 if capture:
Simon Glass34e59432012-12-15 10:42:04 +0000104 result.stdout, result.stderr, result.combined = (
Simon Glass4c0557b2022-01-29 14:14:08 -0700105 last_pipe.communicate_filter(output_func))
Simon Glass34e59432012-12-15 10:42:04 +0000106 if result.stdout and oneline:
Simon Glasscc311ac2019-10-31 07:42:50 -0600107 result.output = result.stdout.rstrip(b'\r\n')
Simon Glass34e59432012-12-15 10:42:04 +0000108 result.return_code = last_pipe.wait()
Simon Glass26132882012-01-14 15:12:45 +0000109 else:
Simon Glass34e59432012-12-15 10:42:04 +0000110 result.return_code = os.waitpid(last_pipe.pid, 0)[1]
Simon Glass519fad22012-12-15 10:42:05 +0000111 if raise_on_error and result.return_code:
112 raise Exception("Error running '%s'" % user_pipestr)
Simon Glass840be732022-01-29 14:14:05 -0700113 return result.to_output(binary)
Simon Glass26132882012-01-14 15:12:45 +0000114
Simon Glass840be732022-01-29 14:14:05 -0700115def output(*cmd, **kwargs):
Simon Glass097483d2019-07-08 13:18:23 -0600116 kwargs['raise_on_error'] = kwargs.get('raise_on_error', True)
Simon Glass840be732022-01-29 14:14:05 -0700117 return run_pipe([cmd], capture=True, **kwargs).stdout
Simon Glass26132882012-01-14 15:12:45 +0000118
Simon Glass840be732022-01-29 14:14:05 -0700119def output_one_line(*cmd, **kwargs):
Simon Glasscc311ac2019-10-31 07:42:50 -0600120 """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 Glass519fad22012-12-15 10:42:05 +0000127 raise_on_error = kwargs.pop('raise_on_error', True)
Simon Glass840be732022-01-29 14:14:05 -0700128 result = run_pipe([cmd], capture=True, oneline=True,
Simon Glasscc311ac2019-10-31 07:42:50 -0600129 raise_on_error=raise_on_error, **kwargs).stdout.strip()
130 return result
Simon Glass26132882012-01-14 15:12:45 +0000131
Simon Glass840be732022-01-29 14:14:05 -0700132def run(*cmd, **kwargs):
133 return run_pipe([cmd], **kwargs).stdout
Simon Glass26132882012-01-14 15:12:45 +0000134
Simon Glass840be732022-01-29 14:14:05 -0700135def run_list(cmd):
136 return run_pipe([cmd], capture=True).stdout
Simon Glass34e59432012-12-15 10:42:04 +0000137
Simon Glass840be732022-01-29 14:14:05 -0700138def stop_all():
Simon Glass34e59432012-12-15 10:42:04 +0000139 cros_subprocess.stay_alive = False