blob: a71c16ab1494c8a862c0f6b10a8f2466e38289c7 [file] [log] [blame]
Brad Bishopc342db32019-05-15 21:57:59 -04001#
Patrick Williamsc124f4f2015-09-15 14:41:29 -05002# Copyright (c) 2013-2014 Intel Corporation
3#
Brad Bishopc342db32019-05-15 21:57:59 -04004# SPDX-License-Identifier: MIT
5#
Patrick Williamsc124f4f2015-09-15 14:41:29 -05006
7# DESCRIPTION
8# This module is mainly used by scripts/oe-selftest and modules under meta/oeqa/selftest
9# It provides a class and methods for running commands on the host in a convienent way for tests.
10
11
12
13import os
14import sys
15import signal
16import subprocess
17import threading
Brad Bishopd7bf8c12018-02-25 22:55:05 -050018import time
Patrick Williamsc124f4f2015-09-15 14:41:29 -050019import logging
20from oeqa.utils import CommandError
21from oeqa.utils import ftools
22import re
23import contextlib
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050024# Export test doesn't require bb
25try:
26 import bb
27except ImportError:
28 pass
Patrick Williamsc124f4f2015-09-15 14:41:29 -050029
30class Command(object):
Brad Bishopd7bf8c12018-02-25 22:55:05 -050031 def __init__(self, command, bg=False, timeout=None, data=None, output_log=None, **options):
Patrick Williamsc124f4f2015-09-15 14:41:29 -050032
33 self.defaultopts = {
34 "stdout": subprocess.PIPE,
35 "stderr": subprocess.STDOUT,
36 "stdin": None,
37 "shell": False,
38 "bufsize": -1,
39 }
40
41 self.cmd = command
42 self.bg = bg
43 self.timeout = timeout
44 self.data = data
45
46 self.options = dict(self.defaultopts)
Patrick Williamsc0f7c042017-02-23 20:41:17 -060047 if isinstance(self.cmd, str):
Patrick Williamsc124f4f2015-09-15 14:41:29 -050048 self.options["shell"] = True
49 if self.data:
50 self.options['stdin'] = subprocess.PIPE
51 self.options.update(options)
52
53 self.status = None
Brad Bishopd7bf8c12018-02-25 22:55:05 -050054 # We collect chunks of output before joining them at the end.
55 self._output_chunks = []
56 self._error_chunks = []
Patrick Williamsc124f4f2015-09-15 14:41:29 -050057 self.output = None
58 self.error = None
Brad Bishopd7bf8c12018-02-25 22:55:05 -050059 self.threads = []
Patrick Williamsc124f4f2015-09-15 14:41:29 -050060
Brad Bishopd7bf8c12018-02-25 22:55:05 -050061 self.output_log = output_log
Patrick Williamsc124f4f2015-09-15 14:41:29 -050062 self.log = logging.getLogger("utils.commands")
63
64 def run(self):
65 self.process = subprocess.Popen(self.cmd, **self.options)
66
Brad Bishopd7bf8c12018-02-25 22:55:05 -050067 def readThread(output, stream, logfunc):
68 if logfunc:
69 for line in stream:
70 output.append(line)
71 logfunc(line.decode("utf-8", errors='replace').rstrip())
72 else:
73 output.append(stream.read())
Patrick Williamsc124f4f2015-09-15 14:41:29 -050074
Brad Bishopd7bf8c12018-02-25 22:55:05 -050075 def readStderrThread():
76 readThread(self._error_chunks, self.process.stderr, self.output_log.error if self.output_log else None)
77
78 def readStdoutThread():
79 readThread(self._output_chunks, self.process.stdout, self.output_log.info if self.output_log else None)
80
81 def writeThread():
82 try:
83 self.process.stdin.write(self.data)
84 self.process.stdin.close()
85 except OSError as ex:
86 # It's not an error when the command does not consume all
87 # of our data. subprocess.communicate() also ignores that.
88 if ex.errno != EPIPE:
89 raise
90
91 # We write in a separate thread because then we can read
92 # without worrying about deadlocks. The additional thread is
93 # expected to terminate by itself and we mark it as a daemon,
94 # so even it should happen to not terminate for whatever
95 # reason, the main process will still exit, which will then
96 # kill the write thread.
97 if self.data:
Andrew Geisslerd25ed322020-06-27 00:28:28 -050098 thread = threading.Thread(target=writeThread, daemon=True)
99 thread.start()
100 self.threads.append(thread)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500101 if self.process.stderr:
102 thread = threading.Thread(target=readStderrThread)
103 thread.start()
104 self.threads.append(thread)
105 if self.output_log:
106 self.output_log.info('Running: %s' % self.cmd)
107 thread = threading.Thread(target=readStdoutThread)
108 thread.start()
109 self.threads.append(thread)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500110
111 self.log.debug("Running command '%s'" % self.cmd)
112
113 if not self.bg:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500114 if self.timeout is None:
115 for thread in self.threads:
116 thread.join()
117 else:
118 deadline = time.time() + self.timeout
119 for thread in self.threads:
120 timeout = deadline - time.time()
121 if timeout < 0:
122 timeout = 0
123 thread.join(timeout)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500124 self.stop()
125
126 def stop(self):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500127 for thread in self.threads:
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600128 if thread.is_alive():
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500129 self.process.terminate()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500130 # let's give it more time to terminate gracefully before killing it
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500131 thread.join(5)
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600132 if thread.is_alive():
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500133 self.process.kill()
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500134 thread.join()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500135
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500136 def finalize_output(data):
137 if not data:
138 data = ""
139 else:
140 data = b"".join(data)
141 data = data.decode("utf-8", errors='replace').rstrip()
142 return data
143
144 self.output = finalize_output(self._output_chunks)
145 self._output_chunks = None
146 # self.error used to be a byte string earlier, probably unintentionally.
147 # Now it is a normal string, just like self.output.
148 self.error = finalize_output(self._error_chunks)
149 self._error_chunks = None
150 # At this point we know that the process has closed stdout/stderr, so
151 # it is safe and necessary to wait for the actual process completion.
152 self.status = self.process.wait()
Brad Bishopf86d0552018-12-04 14:18:15 -0800153 self.process.stdout.close()
154 if self.process.stderr:
155 self.process.stderr.close()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500156
157 self.log.debug("Command '%s' returned %d as exit code." % (self.cmd, self.status))
158 # logging the complete output is insane
159 # bitbake -e output is really big
160 # and makes the log file useless
161 if self.status:
162 lout = "\n".join(self.output.splitlines()[-20:])
163 self.log.debug("Last 20 lines:\n%s" % lout)
164
165
166class Result(object):
167 pass
168
169
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500170def runCmd(command, ignore_status=False, timeout=None, assert_error=True, sync=True,
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500171 native_sysroot=None, limit_exc_output=0, output_log=None, **options):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500172 result = Result()
173
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500174 if native_sysroot:
175 extra_paths = "%s/sbin:%s/usr/sbin:%s/usr/bin" % \
176 (native_sysroot, native_sysroot, native_sysroot)
Brad Bishop79641f22019-09-10 07:20:22 -0400177 extra_libpaths = "%s/lib:%s/usr/lib" % \
178 (native_sysroot, native_sysroot)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500179 nenv = dict(options.get('env', os.environ))
180 nenv['PATH'] = extra_paths + ':' + nenv.get('PATH', '')
Brad Bishop79641f22019-09-10 07:20:22 -0400181 nenv['LD_LIBRARY_PATH'] = extra_libpaths + ':' + nenv.get('LD_LIBRARY_PATH', '')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500182 options['env'] = nenv
183
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500184 cmd = Command(command, timeout=timeout, output_log=output_log, **options)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500185 cmd.run()
186
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500187 # tests can be heavy on IO and if bitbake can't write out its caches, we see timeouts.
188 # call sync around the tests to ensure the IO queue doesn't get too large, taking any IO
189 # hit here rather than in bitbake shutdown.
190 if sync:
Andrew Geisslerd1e89492021-02-12 15:35:20 -0600191 p = os.environ['PATH']
192 os.environ['PATH'] = "/usr/bin:/bin:/usr/sbin:/sbin:" + p
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500193 os.system("sync")
Andrew Geisslerd1e89492021-02-12 15:35:20 -0600194 os.environ['PATH'] = p
Andrew Geissler4c19ea12020-10-27 13:52:24 -0500195
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500196 result.command = command
197 result.status = cmd.status
198 result.output = cmd.output
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600199 result.error = cmd.error
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500200 result.pid = cmd.process.pid
201
202 if result.status and not ignore_status:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500203 exc_output = result.output
204 if limit_exc_output > 0:
205 split = result.output.splitlines()
206 if len(split) > limit_exc_output:
207 exc_output = "\n... (last %d lines of output)\n" % limit_exc_output + \
208 '\n'.join(split[-limit_exc_output:])
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500209 if assert_error:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500210 raise AssertionError("Command '%s' returned non-zero exit status %d:\n%s" % (command, result.status, exc_output))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500211 else:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500212 raise CommandError(result.status, command, exc_output)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500213
214 return result
215
216
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500217def bitbake(command, ignore_status=False, timeout=None, postconfig=None, output_log=None, **options):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500218
219 if postconfig:
220 postconfig_file = os.path.join(os.environ.get('BUILDDIR'), 'oeqa-post.conf')
221 ftools.write_file(postconfig_file, postconfig)
222 extra_args = "-R %s" % postconfig_file
223 else:
224 extra_args = ""
225
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600226 if isinstance(command, str):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500227 cmd = "bitbake " + extra_args + " " + command
228 else:
229 cmd = [ "bitbake" ] + [a for a in (command + extra_args.split(" ")) if a not in [""]]
230
231 try:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500232 return runCmd(cmd, ignore_status, timeout, output_log=output_log, **options)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500233 finally:
234 if postconfig:
235 os.remove(postconfig_file)
236
237
238def get_bb_env(target=None, postconfig=None):
239 if target:
240 return bitbake("-e %s" % target, postconfig=postconfig).output
241 else:
242 return bitbake("-e", postconfig=postconfig).output
243
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600244def get_bb_vars(variables=None, target=None, postconfig=None):
245 """Get values of multiple bitbake variables"""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500246 bbenv = get_bb_env(target, postconfig=postconfig)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600247
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500248 if variables is not None:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400249 variables = list(variables)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500250 var_re = re.compile(r'^(export )?(?P<var>\w+(_.*)?)="(?P<value>.*)"$')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600251 unset_re = re.compile(r'^unset (?P<var>\w+)$')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500252 lastline = None
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600253 values = {}
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500254 for line in bbenv.splitlines():
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600255 match = var_re.match(line)
256 val = None
257 if match:
258 val = match.group('value')
259 else:
260 match = unset_re.match(line)
261 if match:
262 # Handle [unexport] variables
263 if lastline.startswith('# "'):
264 val = lastline.split('"')[1]
265 if val:
266 var = match.group('var')
267 if variables is None:
268 values[var] = val
269 else:
270 if var in variables:
271 values[var] = val
272 variables.remove(var)
273 # Stop after all required variables have been found
274 if not variables:
275 break
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500276 lastline = line
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600277 if variables:
278 # Fill in missing values
279 for var in variables:
280 values[var] = None
281 return values
282
283def get_bb_var(var, target=None, postconfig=None):
284 return get_bb_vars([var], target, postconfig)[var]
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500285
286def get_test_layer():
287 layers = get_bb_var("BBLAYERS").split()
288 testlayer = None
289 for l in layers:
290 if '~' in l:
291 l = os.path.expanduser(l)
292 if "/meta-selftest" in l and os.path.isdir(l):
293 testlayer = l
294 break
295 return testlayer
296
297def create_temp_layer(templayerdir, templayername, priority=999, recipepathspec='recipes-*/*'):
298 os.makedirs(os.path.join(templayerdir, 'conf'))
299 with open(os.path.join(templayerdir, 'conf', 'layer.conf'), 'w') as f:
300 f.write('BBPATH .= ":${LAYERDIR}"\n')
301 f.write('BBFILES += "${LAYERDIR}/%s/*.bb \\' % recipepathspec)
302 f.write(' ${LAYERDIR}/%s/*.bbappend"\n' % recipepathspec)
303 f.write('BBFILE_COLLECTIONS += "%s"\n' % templayername)
304 f.write('BBFILE_PATTERN_%s = "^${LAYERDIR}/"\n' % templayername)
305 f.write('BBFILE_PRIORITY_%s = "%d"\n' % (templayername, priority))
306 f.write('BBFILE_PATTERN_IGNORE_EMPTY_%s = "1"\n' % templayername)
Brad Bishop316dfdd2018-06-25 12:45:53 -0400307 f.write('LAYERSERIES_COMPAT_%s = "${LAYERSERIES_COMPAT_core}"\n' % templayername)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500308
309@contextlib.contextmanager
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500310def runqemu(pn, ssh=True, runqemuparams='', image_fstype=None, launch_cmd=None, qemuparams=None, overrides={}, discard_writes=True):
311 """
312 launch_cmd means directly run the command, don't need set rootfs or env vars.
313 """
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500314
315 import bb.tinfoil
316 import bb.build
317
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500318 # Need a non-'BitBake' logger to capture the runner output
319 targetlogger = logging.getLogger('TargetRunner')
320 targetlogger.setLevel(logging.DEBUG)
321 handler = logging.StreamHandler(sys.stdout)
322 targetlogger.addHandler(handler)
323
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500324 tinfoil = bb.tinfoil.Tinfoil()
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500325 tinfoil.prepare(config_only=False, quiet=True)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500326 try:
327 tinfoil.logger.setLevel(logging.WARNING)
328 import oeqa.targetcontrol
Andrew Geissler82c905d2020-04-13 13:39:40 -0500329 recipedata = tinfoil.parse_recipe(pn)
330 recipedata.setVar("TEST_LOG_DIR", "${WORKDIR}/testimage")
331 recipedata.setVar("TEST_QEMUBOOT_TIMEOUT", "1000")
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500332 # Tell QemuTarget() whether need find rootfs/kernel or not
333 if launch_cmd:
Andrew Geissler82c905d2020-04-13 13:39:40 -0500334 recipedata.setVar("FIND_ROOTFS", '0')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500335 else:
Andrew Geissler82c905d2020-04-13 13:39:40 -0500336 recipedata.setVar("FIND_ROOTFS", '1')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500337
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500338 for key, value in overrides.items():
339 recipedata.setVar(key, value)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500340
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500341 logdir = recipedata.getVar("TEST_LOG_DIR")
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500342
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500343 qemu = oeqa.targetcontrol.QemuTarget(recipedata, targetlogger, image_fstype)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500344 finally:
345 # We need to shut down tinfoil early here in case we actually want
346 # to run tinfoil-using utilities with the running QEMU instance.
347 # Luckily QemuTarget doesn't need it after the constructor.
348 tinfoil.shutdown()
349
350 try:
351 qemu.deploy()
352 try:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500353 qemu.start(params=qemuparams, ssh=ssh, runqemuparams=runqemuparams, launch_cmd=launch_cmd, discard_writes=discard_writes)
Brad Bishop79641f22019-09-10 07:20:22 -0400354 except Exception as e:
Brad Bishop08902b02019-08-20 09:16:51 -0400355 msg = str(e) + '\nFailed to start QEMU - see the logs in %s' % logdir
Brad Bishopf86d0552018-12-04 14:18:15 -0800356 if os.path.exists(qemu.qemurunnerlog):
357 with open(qemu.qemurunnerlog, 'r') as f:
358 msg = msg + "Qemurunner log output from %s:\n%s" % (qemu.qemurunnerlog, f.read())
359 raise Exception(msg)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500360
361 yield qemu
362
363 finally:
Brad Bishopf86d0552018-12-04 14:18:15 -0800364 targetlogger.removeHandler(handler)
Andrew Geissler4ed12e12020-06-05 18:00:41 -0500365 qemu.stop()
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600366
367def updateEnv(env_file):
368 """
369 Source a file and update environment.
370 """
371
372 cmd = ". %s; env -0" % env_file
373 result = runCmd(cmd)
374
375 for line in result.output.split("\0"):
376 (key, _, value) = line.partition("=")
377 os.environ[key] = value