blob: 8ffaeab2844c0029c61d54da970c1281da43decd [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001# Copyright (C) 2013 Intel Corporation
2#
3# Released under the MIT license (see COPYING.MIT)
4
Brad Bishopf86d0552018-12-04 14:18:15 -08005inherit metadata_scm
Andrew Geisslerc9f78652020-09-18 14:11:35 -05006inherit image-artifact-names
7
Patrick Williamsc124f4f2015-09-15 14:41:29 -05008# testimage.bbclass enables testing of qemu images using python unittests.
9# Most of the tests are commands run on target image over ssh.
10# To use it add testimage to global inherit and call your target image with -c testimage
11# You can try it out like this:
Brad Bishopd7bf8c12018-02-25 22:55:05 -050012# - first add IMAGE_CLASSES += "testimage" in local.conf
13# - build a qemu core-image-sato
Patrick Williamsc124f4f2015-09-15 14:41:29 -050014# - then bitbake core-image-sato -c testimage. That will run a standard suite of tests.
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080015#
16# The tests can be run automatically each time an image is built if you set
17# TESTIMAGE_AUTO = "1"
18
19TESTIMAGE_AUTO ??= "0"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050020
21# You can set (or append to) TEST_SUITES in local.conf to select the tests
22# which you want to run for your target.
Brad Bishopd7bf8c12018-02-25 22:55:05 -050023# The test names are the module names in meta/lib/oeqa/runtime/cases.
Patrick Williamsc124f4f2015-09-15 14:41:29 -050024# Each name in TEST_SUITES represents a required test for the image. (no skipping allowed)
25# Appending "auto" means that it will try to run all tests that are suitable for the image (each test decides that on it's own).
26# Note that order in TEST_SUITES is relevant: tests are run in an order such that
27# tests mentioned in @skipUnlessPassed run before the tests that depend on them,
28# but without such dependencies, tests run in the order in which they are listed
29# in TEST_SUITES.
30#
31# A layer can add its own tests in lib/oeqa/runtime, provided it extends BBPATH as normal in its layer.conf.
32
33# TEST_LOG_DIR contains a command ssh log and may contain infromation about what command is running, output and return codes and for qemu a boot log till login.
34# Booting is handled by this class, and it's not a test in itself.
35# TEST_QEMUBOOT_TIMEOUT can be used to set the maximum time in seconds the launch code will wait for the login prompt.
Andrew Geissler82c905d2020-04-13 13:39:40 -050036# TEST_OVERALL_TIMEOUT can be used to set the maximum time in seconds the tests will be allowed to run (defaults to no limit).
Brad Bishop977dc1a2019-02-06 16:01:43 -050037# TEST_QEMUPARAMS can be used to pass extra parameters to qemu, e.g. "-m 1024" for setting the amount of ram to 1 GB.
Brad Bishop19323692019-04-05 15:28:33 -040038# TEST_RUNQEMUPARAMS can be used to pass extra parameters to runqemu, e.g. "gl" to enable OpenGL acceleration.
Andrew Geissler595f6302022-01-24 19:11:47 +000039# QEMU_USE_KVM can be set to "" to disable the use of kvm (by default it is enabled if target_arch == build_arch or both of them are x86 archs)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050040
Andrew Geissler82c905d2020-04-13 13:39:40 -050041# TESTIMAGE_BOOT_PATTERNS can be used to override certain patterns used to communicate with the target when booting,
42# if a pattern is not specifically present on this variable a default will be used when booting the target.
43# TESTIMAGE_BOOT_PATTERNS[<flag>] overrides the pattern used for that specific flag, where flag comes from a list of accepted flags
44# e.g. normally the system boots and waits for a login prompt (login:), after that it sends the command: "root\n" to log as the root user
45# if we wanted to log in as the hypothetical "webserver" user for example we could set the following:
46# TESTIMAGE_BOOT_PATTERNS = "send_login_user search_login_succeeded"
47# TESTIMAGE_BOOT_PATTERNS[send_login_user] = "webserver\n"
48# TESTIMAGE_BOOT_PATTERNS[search_login_succeeded] = "webserver@[a-zA-Z0-9\-]+:~#"
49# The accepted flags are the following: search_reached_prompt, send_login_user, search_login_succeeded, search_cmd_finished.
50# They are prefixed with either search/send, to differentiate if the pattern is meant to be sent or searched to/from the target terminal
51
Patrick Williamsc124f4f2015-09-15 14:41:29 -050052TEST_LOG_DIR ?= "${WORKDIR}/testimage"
53
54TEST_EXPORT_DIR ?= "${TMPDIR}/testimage/${PN}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -060055TEST_INSTALL_TMP_DIR ?= "${WORKDIR}/testimage/install_tmp"
56TEST_NEEDED_PACKAGES_DIR ?= "${WORKDIR}/testimage/packages"
57TEST_EXTRACTED_DIR ?= "${TEST_NEEDED_PACKAGES_DIR}/extracted"
58TEST_PACKAGED_DIR ?= "${TEST_NEEDED_PACKAGES_DIR}/packaged"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050059
Brad Bishop977dc1a2019-02-06 16:01:43 -050060BASICTESTSUITE = "\
61 ping date df ssh scp python perl gi ptest parselogs \
62 logrotate connman systemd oe_syslog pam stap ldd xorg \
63 kernelmodule gcc buildcpio buildlzip buildgalculator \
Andrew Geissler595f6302022-01-24 19:11:47 +000064 dnf rpm opkg apt weston go rust"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050065
Brad Bishop977dc1a2019-02-06 16:01:43 -050066DEFAULT_TEST_SUITES = "${BASICTESTSUITE}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050067
Brad Bishop316dfdd2018-06-25 12:45:53 -040068# musl doesn't support systemtap
Patrick Williams213cb262021-08-07 19:21:33 -050069DEFAULT_TEST_SUITES:remove:libc-musl = "stap"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050070
Patrick Williamsc0f7c042017-02-23 20:41:17 -060071# qemumips is quite slow and has reached the timeout limit several times on the YP build cluster,
72# mitigate this by removing build tests for qemumips machines.
Brad Bishopd7bf8c12018-02-25 22:55:05 -050073MIPSREMOVE ??= "buildcpio buildlzip buildgalculator"
Patrick Williams213cb262021-08-07 19:21:33 -050074DEFAULT_TEST_SUITES:remove:qemumips = "${MIPSREMOVE}"
75DEFAULT_TEST_SUITES:remove:qemumips64 = "${MIPSREMOVE}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050076
77TEST_SUITES ?= "${DEFAULT_TEST_SUITES}"
78
Andrew Geissler595f6302022-01-24 19:11:47 +000079QEMU_USE_KVM ?= "1"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050080TEST_QEMUBOOT_TIMEOUT ?= "1000"
Andrew Geissler82c905d2020-04-13 13:39:40 -050081TEST_OVERALL_TIMEOUT ?= ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -050082TEST_TARGET ?= "qemu"
Brad Bishop977dc1a2019-02-06 16:01:43 -050083TEST_QEMUPARAMS ?= ""
Brad Bishop19323692019-04-05 15:28:33 -040084TEST_RUNQEMUPARAMS ?= ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -050085
Andrew Geissler82c905d2020-04-13 13:39:40 -050086TESTIMAGE_BOOT_PATTERNS ?= ""
87
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088TESTIMAGEDEPENDS = ""
Patrick Williams213cb262021-08-07 19:21:33 -050089TESTIMAGEDEPENDS:append:qemuall = " qemu-native:do_populate_sysroot qemu-helper-native:do_populate_sysroot qemu-helper-native:do_addto_recipe_sysroot"
Patrick Williamsc0f7c042017-02-23 20:41:17 -060090TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'rpm', 'cpio-native:do_populate_sysroot', '', d)}"
Brad Bishop6e60e8b2018-02-01 10:27:11 -050091TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'rpm', 'dnf-native:do_populate_sysroot', '', d)}"
Brad Bishop977dc1a2019-02-06 16:01:43 -050092TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'rpm', 'createrepo-c-native:do_populate_sysroot', '', d)}"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080093TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'ipk', 'opkg-utils-native:do_populate_sysroot package-index:do_package_index', '', d)}"
94TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'deb', 'apt-native:do_populate_sysroot package-index:do_package_index', '', d)}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050095
96TESTIMAGELOCK = "${TMPDIR}/testimage.lock"
Patrick Williams213cb262021-08-07 19:21:33 -050097TESTIMAGELOCK:qemuall = ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -050098
Brad Bishop977dc1a2019-02-06 16:01:43 -050099TESTIMAGE_DUMP_DIR ?= "${LOG_DIR}/runtime-hostdump/"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500100
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500101TESTIMAGE_UPDATE_VARS ?= "DL_DIR WORKDIR DEPLOY_DIR"
102
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500103testimage_dump_target () {
104 top -bn1
105 ps
106 free
107 df
108 # The next command will export the default gateway IP
109 export DEFAULT_GATEWAY=$(ip route | awk '/default/ { print $3}')
110 ping -c3 $DEFAULT_GATEWAY
111 dmesg
112 netstat -an
113 ip address
114 # Next command will dump logs from /var/log/
115 find /var/log/ -type f 2>/dev/null -exec echo "====================" \; -exec echo {} \; -exec echo "====================" \; -exec cat {} \; -exec echo "" \;
116}
117
118testimage_dump_host () {
119 top -bn1
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500120 iostat -x -z -N -d -p ALL 20 2
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500121 ps -ef
122 free
123 df
124 memstat
125 dmesg
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500126 ip -s link
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500127 netstat -an
128}
129
Andrew Geisslerc926e172021-05-07 16:11:35 -0500130testimage_dump_monitor () {
131 query-status
132 query-block
Andrew Geissler5f350902021-07-23 13:09:54 -0400133 dump-guest-memory {"paging":false,"protocol":"file:%s.img"}
Andrew Geisslerc926e172021-05-07 16:11:35 -0500134}
135
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500136python do_testimage() {
137 testimage_main(d)
138}
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600139
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500140addtask testimage
141do_testimage[nostamp] = "1"
Andrew Geissler595f6302022-01-24 19:11:47 +0000142do_testimage[network] = "1"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500143do_testimage[depends] += "${TESTIMAGEDEPENDS}"
144do_testimage[lockfiles] += "${TESTIMAGELOCK}"
145
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500146def testimage_sanity(d):
147 if (d.getVar('TEST_TARGET') == 'simpleremote'
148 and (not d.getVar('TEST_TARGET_IP')
149 or not d.getVar('TEST_SERVER_IP'))):
150 bb.fatal('When TEST_TARGET is set to "simpleremote" '
151 'TEST_TARGET_IP and TEST_SERVER_IP are needed too.')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500152
Brad Bishopf86d0552018-12-04 14:18:15 -0800153def get_testimage_configuration(d, test_type, machine):
154 import platform
155 from oeqa.utils.metadata import get_layers
156 configuration = {'TEST_TYPE': test_type,
157 'MACHINE': machine,
158 'DISTRO': d.getVar("DISTRO"),
159 'IMAGE_BASENAME': d.getVar("IMAGE_BASENAME"),
160 'IMAGE_PKGTYPE': d.getVar("IMAGE_PKGTYPE"),
161 'STARTTIME': d.getVar("DATETIME"),
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800162 'HOST_DISTRO': oe.lsb.distro_identifier().replace(' ', '-'),
Brad Bishopf86d0552018-12-04 14:18:15 -0800163 'LAYERS': get_layers(d.getVar("BBLAYERS"))}
164 return configuration
165get_testimage_configuration[vardepsexclude] = "DATETIME"
166
167def get_testimage_json_result_dir(d):
168 json_result_dir = os.path.join(d.getVar("LOG_DIR"), 'oeqa')
169 custom_json_result_dir = d.getVar("OEQA_JSON_RESULT_DIR")
170 if custom_json_result_dir:
171 json_result_dir = custom_json_result_dir
172 return json_result_dir
173
174def get_testimage_result_id(configuration):
175 return '%s_%s_%s_%s' % (configuration['TEST_TYPE'], configuration['IMAGE_BASENAME'], configuration['MACHINE'], configuration['STARTTIME'])
176
Andrew Geissler82c905d2020-04-13 13:39:40 -0500177def get_testimage_boot_patterns(d):
178 from collections import defaultdict
179 boot_patterns = defaultdict(str)
180 # Only accept certain values
181 accepted_patterns = ['search_reached_prompt', 'send_login_user', 'search_login_succeeded', 'search_cmd_finished']
182 # Not all patterns need to be overriden, e.g. perhaps we only want to change the user
183 boot_patterns_flags = d.getVarFlags('TESTIMAGE_BOOT_PATTERNS') or {}
184 if boot_patterns_flags:
185 patterns_set = [p for p in boot_patterns_flags.items() if p[0] in d.getVar('TESTIMAGE_BOOT_PATTERNS').split()]
186 for flag, flagval in patterns_set:
187 if flag not in accepted_patterns:
188 bb.fatal('Testimage: The only accepted boot patterns are: search_reached_prompt,send_login_user, \
189 search_login_succeeded,search_cmd_finished\n Make sure your TESTIMAGE_BOOT_PATTERNS=%s \
190 contains an accepted flag.' % d.getVar('TESTIMAGE_BOOT_PATTERNS'))
191 return
192 # We know boot prompt is searched through in binary format, others might be expressions
193 if flag == 'search_reached_prompt':
194 boot_patterns[flag] = flagval.encode()
195 else:
196 boot_patterns[flag] = flagval.encode().decode('unicode-escape')
197 return boot_patterns
198
199
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500200def testimage_main(d):
201 import os
202 import json
203 import signal
204 import logging
Andrew Geissler5199d832021-09-24 16:47:35 -0500205 import shutil
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500206
207 from bb.utils import export_proxies
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500208 from oeqa.runtime.context import OERuntimeTestContext
209 from oeqa.runtime.context import OERuntimeTestContextExecutor
210 from oeqa.core.target.qemu import supported_fstypes
211 from oeqa.core.utils.test import getSuiteCases
212 from oeqa.utils import make_logger_bitbake_compatible
213
214 def sigterm_exception(signum, stackframe):
215 """
216 Catch SIGTERM from worker in order to stop qemu.
217 """
Andrew Geissler82c905d2020-04-13 13:39:40 -0500218 os.kill(os.getpid(), signal.SIGINT)
219
220 def handle_test_timeout(timeout):
221 bb.warn("Global test timeout reached (%s seconds), stopping the tests." %(timeout))
222 os.kill(os.getpid(), signal.SIGINT)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500223
Brad Bishopd5ae7d92018-06-14 09:52:03 -0700224 testimage_sanity(d)
225
226 if (d.getVar('IMAGE_PKGTYPE') == 'rpm'
227 and ('dnf' in d.getVar('TEST_SUITES') or 'auto' in d.getVar('TEST_SUITES'))):
228 create_rpm_index(d)
229
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500230 logger = make_logger_bitbake_compatible(logging.getLogger("BitBake"))
231 pn = d.getVar("PN")
232
233 bb.utils.mkdirhier(d.getVar("TEST_LOG_DIR"))
234
235 image_name = ("%s/%s" % (d.getVar('DEPLOY_DIR_IMAGE'),
236 d.getVar('IMAGE_LINK_NAME')))
237
238 tdname = "%s.testdata.json" % image_name
239 try:
Andrew Geisslereff27472021-10-29 15:35:00 -0500240 with open(tdname, "r") as f:
241 td = json.load(f)
242 except FileNotFoundError as err:
243 bb.fatal('File %s not found (%s).\nHave you built the image with INHERIT += "testimage" in the conf/local.conf?' % (tdname, err))
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500244
245 # Some variables need to be updates (mostly paths) with the
246 # ones of the current environment because some tests require them.
Patrick Williams45852732022-04-02 08:58:32 -0500247 for var in d.getVar('TESTIMAGE_UPDATE_VARS').split():
248 td[var] = d.getVar(var)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500249
250 image_manifest = "%s.manifest" % image_name
251 image_packages = OERuntimeTestContextExecutor.readPackagesManifest(image_manifest)
252
253 extract_dir = d.getVar("TEST_EXTRACTED_DIR")
254
255 # Get machine
256 machine = d.getVar("MACHINE")
257
258 # Get rootfs
Brad Bishop977dc1a2019-02-06 16:01:43 -0500259 fstypes = d.getVar('IMAGE_FSTYPES').split()
260 if d.getVar("TEST_TARGET") == "qemu":
261 fstypes = [fs for fs in fstypes if fs in supported_fstypes]
262 if not fstypes:
Andrew Geissler82c905d2020-04-13 13:39:40 -0500263 bb.fatal('Unsupported image type built. Add a compatible image to '
Brad Bishop977dc1a2019-02-06 16:01:43 -0500264 'IMAGE_FSTYPES. Supported types: %s' %
265 ', '.join(supported_fstypes))
Brad Bishop15ae2502019-06-18 21:44:24 -0400266 qfstype = fstypes[0]
267 qdeffstype = d.getVar("QB_DEFAULT_FSTYPE")
268 if qdeffstype:
269 qfstype = qdeffstype
270 rootfs = '%s.%s' % (image_name, qfstype)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500271
272 # Get tmpdir (not really used, just for compatibility)
273 tmpdir = d.getVar("TMPDIR")
274
275 # Get deploy_dir_image (not really used, just for compatibility)
276 dir_image = d.getVar("DEPLOY_DIR_IMAGE")
277
278 # Get bootlog
279 bootlog = os.path.join(d.getVar("TEST_LOG_DIR"),
280 'qemu_boot_log.%s' % d.getVar('DATETIME'))
281
282 # Get display
283 display = d.getVar("BB_ORIGENV").getVar("DISPLAY")
284
285 # Get kernel
286 kernel_name = ('%s-%s.bin' % (d.getVar("KERNEL_IMAGETYPE"), machine))
287 kernel = os.path.join(d.getVar("DEPLOY_DIR_IMAGE"), kernel_name)
288
289 # Get boottime
290 boottime = int(d.getVar("TEST_QEMUBOOT_TIMEOUT"))
291
292 # Get use_kvm
Brad Bishop977dc1a2019-02-06 16:01:43 -0500293 kvm = oe.types.qemu_use_kvm(d.getVar('QEMU_USE_KVM'), d.getVar('TARGET_ARCH'))
294
Andrew Geissler82c905d2020-04-13 13:39:40 -0500295 # Get OVMF
296 ovmf = d.getVar("QEMU_USE_OVMF")
297
Brad Bishop977dc1a2019-02-06 16:01:43 -0500298 slirp = False
299 if d.getVar("QEMU_USE_SLIRP"):
300 slirp = True
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500301
Andrew Geissler82c905d2020-04-13 13:39:40 -0500302 # TODO: We use the current implementation of qemu runner because of
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500303 # time constrains, qemu runner really needs a refactor too.
304 target_kwargs = { 'machine' : machine,
305 'rootfs' : rootfs,
306 'tmpdir' : tmpdir,
307 'dir_image' : dir_image,
308 'display' : display,
309 'kernel' : kernel,
310 'boottime' : boottime,
311 'bootlog' : bootlog,
312 'kvm' : kvm,
Brad Bishop977dc1a2019-02-06 16:01:43 -0500313 'slirp' : slirp,
314 'dump_dir' : d.getVar("TESTIMAGE_DUMP_DIR"),
Andrew Geissler82c905d2020-04-13 13:39:40 -0500315 'serial_ports': len(d.getVar("SERIAL_CONSOLES").split()),
316 'ovmf' : ovmf,
Andrew Geissler3b8a17c2021-04-15 15:55:55 -0500317 'tmpfsdir' : d.getVar("RUNQEMU_TMPFS_DIR"),
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500318 }
319
Andrew Geissler82c905d2020-04-13 13:39:40 -0500320 if d.getVar("TESTIMAGE_BOOT_PATTERNS"):
321 target_kwargs['boot_patterns'] = get_testimage_boot_patterns(d)
322
Brad Bishop64c979e2019-11-04 13:55:29 -0500323 # hardware controlled targets might need further access
324 target_kwargs['powercontrol_cmd'] = d.getVar("TEST_POWERCONTROL_CMD") or None
325 target_kwargs['powercontrol_extra_args'] = d.getVar("TEST_POWERCONTROL_EXTRA_ARGS") or ""
326 target_kwargs['serialcontrol_cmd'] = d.getVar("TEST_SERIALCONTROL_CMD") or None
327 target_kwargs['serialcontrol_extra_args'] = d.getVar("TEST_SERIALCONTROL_EXTRA_ARGS") or ""
Andrew Geisslerc926e172021-05-07 16:11:35 -0500328 target_kwargs['testimage_dump_monitor'] = d.getVar("testimage_dump_monitor") or ""
Andrew Geisslerc3d88e42020-10-02 09:45:00 -0500329 target_kwargs['testimage_dump_target'] = d.getVar("testimage_dump_target") or ""
Brad Bishop64c979e2019-11-04 13:55:29 -0500330
331 def export_ssh_agent(d):
332 import os
333
334 variables = ['SSH_AGENT_PID', 'SSH_AUTH_SOCK']
335 for v in variables:
336 if v not in os.environ.keys():
337 val = d.getVar(v)
338 if val is not None:
339 os.environ[v] = val
340
341 export_ssh_agent(d)
342
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500343 # runtime use network for download projects for build
344 export_proxies(d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500345
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500346 # we need the host dumper in test context
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500347 host_dumper = OERuntimeTestContextExecutor.getHostDumper(
348 d.getVar("testimage_dump_host"),
349 d.getVar("TESTIMAGE_DUMP_DIR"))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500350
351 # the robot dance
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500352 target = OERuntimeTestContextExecutor.getTarget(
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500353 d.getVar("TEST_TARGET"), logger, d.getVar("TEST_TARGET_IP"),
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500354 d.getVar("TEST_SERVER_IP"), **target_kwargs)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500355
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500356 # test context
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500357 tc = OERuntimeTestContext(td, logger, target, host_dumper,
358 image_packages, extract_dir)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500359
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500360 # Load tests before starting the target
361 test_paths = get_runtime_paths(d)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500362 test_modules = d.getVar('TEST_SUITES').split()
Brad Bishopd5ae7d92018-06-14 09:52:03 -0700363 if not test_modules:
364 bb.fatal('Empty test suite, please verify TEST_SUITES variable')
365
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500366 tc.loadTests(test_paths, modules=test_modules)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500367
Brad Bishopd5ae7d92018-06-14 09:52:03 -0700368 suitecases = getSuiteCases(tc.suites)
369 if not suitecases:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500370 bb.fatal('Empty test suite, please verify TEST_SUITES variable')
Brad Bishopd5ae7d92018-06-14 09:52:03 -0700371 else:
372 bb.debug(2, 'test suites:\n\t%s' % '\n\t'.join([str(c) for c in suitecases]))
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500373
374 package_extraction(d, tc.suites)
375
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500376 results = None
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600377 complete = False
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500378 orig_sigterm_handler = signal.signal(signal.SIGTERM, sigterm_exception)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600379 try:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500380 # We need to check if runqemu ends unexpectedly
381 # or if the worker send us a SIGTERM
Brad Bishop19323692019-04-05 15:28:33 -0400382 tc.target.start(params=d.getVar("TEST_QEMUPARAMS"), runqemuparams=d.getVar("TEST_RUNQEMUPARAMS"))
Andrew Geissler82c905d2020-04-13 13:39:40 -0500383 import threading
384 try:
385 threading.Timer(int(d.getVar("TEST_OVERALL_TIMEOUT")), handle_test_timeout, (int(d.getVar("TEST_OVERALL_TIMEOUT")),)).start()
386 except ValueError:
387 pass
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500388 results = tc.runTests()
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600389 complete = True
Andrew Geissler82c905d2020-04-13 13:39:40 -0500390 except (KeyboardInterrupt, BlockingIOError) as err:
391 if isinstance(err, KeyboardInterrupt):
392 bb.error('testimage interrupted, shutting down...')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600393 else:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500394 bb.error('runqemu failed, shutting down...')
395 if results:
396 results.stop()
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600397 results = tc.results
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600398 finally:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500399 signal.signal(signal.SIGTERM, orig_sigterm_handler)
400 tc.target.stop()
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600401
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500402 # Show results (if we have them)
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600403 if results:
404 configuration = get_testimage_configuration(d, 'runtime', machine)
405 results.logDetails(get_testimage_json_result_dir(d),
406 configuration,
407 get_testimage_result_id(configuration),
408 dump_streams=d.getVar('TESTREPORT_FULLLOGS'))
409 results.logSummary(pn)
Andrew Geissler5199d832021-09-24 16:47:35 -0500410
411 # Copy additional logs to tmp/log/oeqa so it's easier to find them
412 targetdir = os.path.join(get_testimage_json_result_dir(d), d.getVar("PN"))
413 os.makedirs(targetdir, exist_ok=True)
414 os.symlink(bootlog, os.path.join(targetdir, os.path.basename(bootlog)))
415 os.symlink(d.getVar("BB_LOGFILE"), os.path.join(targetdir, os.path.basename(d.getVar("BB_LOGFILE") + "." + d.getVar('DATETIME'))))
416
Andrew Geissler6ce62a22020-11-30 19:58:47 -0600417 if not results or not complete:
Andrew Geissler5199d832021-09-24 16:47:35 -0500418 bb.fatal('%s - FAILED - tests were interrupted during execution, check the logs in %s' % (pn, d.getVar("LOG_DIR")), forcelog=True)
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500419 if not results.wasSuccessful():
Andrew Geissler5199d832021-09-24 16:47:35 -0500420 bb.fatal('%s - FAILED - also check the logs in %s' % (pn, d.getVar("LOG_DIR")), forcelog=True)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600421
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500422def get_runtime_paths(d):
423 """
424 Returns a list of paths where runtime test must reside.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500425
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500426 Runtime tests are expected in <LAYER_DIR>/lib/oeqa/runtime/cases/
427 """
428 paths = []
429
430 for layer in d.getVar('BBLAYERS').split():
431 path = os.path.join(layer, 'lib/oeqa/runtime/cases')
432 if os.path.isdir(path):
433 paths.append(path)
434 return paths
435
436def create_index(arg):
437 import subprocess
438
439 index_cmd = arg
440 try:
441 bb.note("Executing '%s' ..." % index_cmd)
442 result = subprocess.check_output(index_cmd,
443 stderr=subprocess.STDOUT,
444 shell=True)
445 result = result.decode('utf-8')
446 except subprocess.CalledProcessError as e:
447 return("Index creation command '%s' failed with return code "
448 '%d:\n%s' % (e.cmd, e.returncode, e.output.decode("utf-8")))
449 if result:
450 bb.note(result)
451 return None
452
453def create_rpm_index(d):
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800454 import glob
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500455 # Index RPMs
456 rpm_createrepo = bb.utils.which(os.getenv('PATH'), "createrepo_c")
457 index_cmds = []
458 archs = (d.getVar('ALL_MULTILIB_PACKAGE_ARCHS') or '').replace('-', '_')
459
460 for arch in archs.split():
461 rpm_dir = os.path.join(d.getVar('DEPLOY_DIR_RPM'), arch)
462 idx_path = os.path.join(d.getVar('WORKDIR'), 'oe-testimage-repo', arch)
463
464 if not os.path.isdir(rpm_dir):
465 continue
466
467 lockfilename = os.path.join(d.getVar('DEPLOY_DIR_RPM'), 'rpm.lock')
468 lf = bb.utils.lockfile(lockfilename, False)
469 oe.path.copyhardlinktree(rpm_dir, idx_path)
470 # Full indexes overload a 256MB image so reduce the number of rpms
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800471 # in the feed by filtering to specific packages needed by the tests.
472 package_list = glob.glob(idx_path + "*/*.rpm")
473
474 for pkg in package_list:
475 if not os.path.basename(pkg).startswith(("rpm", "run-postinsts", "busybox", "bash", "update-alternatives", "libc6", "curl", "musl")):
476 bb.utils.remove(pkg)
477
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500478 bb.utils.unlockfile(lf)
479 cmd = '%s --update -q %s' % (rpm_createrepo, idx_path)
480
481 # Create repodata
482 result = create_index(cmd)
483 if result:
484 bb.fatal('%s' % ('\n'.join(result)))
485
486def package_extraction(d, test_suites):
487 from oeqa.utils.package_manager import find_packages_to_extract
488 from oeqa.utils.package_manager import extract_packages
489
490 bb.utils.remove(d.getVar("TEST_NEEDED_PACKAGES_DIR"), recurse=True)
491 packages = find_packages_to_extract(test_suites)
492 if packages:
493 bb.utils.mkdirhier(d.getVar("TEST_INSTALL_TMP_DIR"))
494 bb.utils.mkdirhier(d.getVar("TEST_PACKAGED_DIR"))
495 bb.utils.mkdirhier(d.getVar("TEST_EXTRACTED_DIR"))
496 extract_packages(d, packages)
497
498testimage_main[vardepsexclude] += "BB_ORIGENV DATETIME"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500499
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800500python () {
501 if oe.types.boolean(d.getVar("TESTIMAGE_AUTO") or "False"):
502 bb.build.addtask("testimage", "do_build", "do_image_complete", d)
503}
504
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500505inherit testsdk