summaryrefslogtreecommitdiffstats
path: root/meta/classes/testimage.bbclass
diff options
context:
space:
mode:
Diffstat (limited to 'meta/classes/testimage.bbclass')
-rw-r--r--meta/classes/testimage.bbclass491
1 files changed, 0 insertions, 491 deletions
diff --git a/meta/classes/testimage.bbclass b/meta/classes/testimage.bbclass
deleted file mode 100644
index 78da4b09bd..0000000000
--- a/meta/classes/testimage.bbclass
+++ /dev/null
@@ -1,491 +0,0 @@
1# Copyright (C) 2013 Intel Corporation
2#
3# Released under the MIT license (see COPYING.MIT)
4
5inherit metadata_scm
6inherit image-artifact-names
7
8# 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:
12# - first add IMAGE_CLASSES += "testimage" in local.conf
13# - build a qemu core-image-sato
14# - then bitbake core-image-sato -c testimage. That will run a standard suite of tests.
15#
16# The tests can be run automatically each time an image is built if you set
17# TESTIMAGE_AUTO = "1"
18
19TESTIMAGE_AUTO ??= "0"
20
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.
23# The test names are the module names in meta/lib/oeqa/runtime/cases.
24# 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.
36# TEST_OVERALL_TIMEOUT can be used to set the maximum time in seconds the tests will be allowed to run (defaults to no limit).
37# TEST_QEMUPARAMS can be used to pass extra parameters to qemu, e.g. "-m 1024" for setting the amount of ram to 1 GB.
38# TEST_RUNQEMUPARAMS can be used to pass extra parameters to runqemu, e.g. "gl" to enable OpenGL acceleration.
39
40# TESTIMAGE_BOOT_PATTERNS can be used to override certain patterns used to communicate with the target when booting,
41# if a pattern is not specifically present on this variable a default will be used when booting the target.
42# TESTIMAGE_BOOT_PATTERNS[<flag>] overrides the pattern used for that specific flag, where flag comes from a list of accepted flags
43# 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
44# if we wanted to log in as the hypothetical "webserver" user for example we could set the following:
45# TESTIMAGE_BOOT_PATTERNS = "send_login_user search_login_succeeded"
46# TESTIMAGE_BOOT_PATTERNS[send_login_user] = "webserver\n"
47# TESTIMAGE_BOOT_PATTERNS[search_login_succeeded] = "webserver@[a-zA-Z0-9\-]+:~#"
48# The accepted flags are the following: search_reached_prompt, send_login_user, search_login_succeeded, search_cmd_finished.
49# They are prefixed with either search/send, to differentiate if the pattern is meant to be sent or searched to/from the target terminal
50
51TEST_LOG_DIR ?= "${WORKDIR}/testimage"
52
53TEST_EXPORT_DIR ?= "${TMPDIR}/testimage/${PN}"
54TEST_INSTALL_TMP_DIR ?= "${WORKDIR}/testimage/install_tmp"
55TEST_NEEDED_PACKAGES_DIR ?= "${WORKDIR}/testimage/packages"
56TEST_EXTRACTED_DIR ?= "${TEST_NEEDED_PACKAGES_DIR}/extracted"
57TEST_PACKAGED_DIR ?= "${TEST_NEEDED_PACKAGES_DIR}/packaged"
58
59BASICTESTSUITE = "\
60 ping date df ssh scp python perl gi ptest parselogs \
61 logrotate connman systemd oe_syslog pam stap ldd xorg \
62 kernelmodule gcc buildcpio buildlzip buildgalculator \
63 dnf rpm opkg apt weston"
64
65DEFAULT_TEST_SUITES = "${BASICTESTSUITE}"
66
67# aarch64 has no graphics
68DEFAULT_TEST_SUITES_remove_aarch64 = "xorg"
69# musl doesn't support systemtap
70DEFAULT_TEST_SUITES_remove_libc-musl = "stap"
71
72# qemumips is quite slow and has reached the timeout limit several times on the YP build cluster,
73# mitigate this by removing build tests for qemumips machines.
74MIPSREMOVE ??= "buildcpio buildlzip buildgalculator"
75DEFAULT_TEST_SUITES_remove_qemumips = "${MIPSREMOVE}"
76DEFAULT_TEST_SUITES_remove_qemumips64 = "${MIPSREMOVE}"
77
78TEST_SUITES ?= "${DEFAULT_TEST_SUITES}"
79
80TEST_QEMUBOOT_TIMEOUT ?= "1000"
81TEST_OVERALL_TIMEOUT ?= ""
82TEST_TARGET ?= "qemu"
83TEST_QEMUPARAMS ?= ""
84TEST_RUNQEMUPARAMS ?= ""
85
86TESTIMAGE_BOOT_PATTERNS ?= ""
87
88TESTIMAGEDEPENDS = ""
89TESTIMAGEDEPENDS_append_qemuall = " qemu-native:do_populate_sysroot qemu-helper-native:do_populate_sysroot qemu-helper-native:do_addto_recipe_sysroot"
90TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'rpm', 'cpio-native:do_populate_sysroot', '', d)}"
91TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'rpm', 'dnf-native:do_populate_sysroot', '', d)}"
92TESTIMAGEDEPENDS += "${@bb.utils.contains('IMAGE_PKGTYPE', 'rpm', 'createrepo-c-native:do_populate_sysroot', '', d)}"
93TESTIMAGEDEPENDS += "${@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)}"
95
96TESTIMAGELOCK = "${TMPDIR}/testimage.lock"
97TESTIMAGELOCK_qemuall = ""
98
99TESTIMAGE_DUMP_DIR ?= "${LOG_DIR}/runtime-hostdump/"
100
101TESTIMAGE_UPDATE_VARS ?= "DL_DIR WORKDIR DEPLOY_DIR"
102
103testimage_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
120 iostat -x -z -N -d -p ALL 20 2
121 ps -ef
122 free
123 df
124 memstat
125 dmesg
126 ip -s link
127 netstat -an
128}
129
130python do_testimage() {
131 testimage_main(d)
132}
133
134addtask testimage
135do_testimage[nostamp] = "1"
136do_testimage[depends] += "${TESTIMAGEDEPENDS}"
137do_testimage[lockfiles] += "${TESTIMAGELOCK}"
138
139def testimage_sanity(d):
140 if (d.getVar('TEST_TARGET') == 'simpleremote'
141 and (not d.getVar('TEST_TARGET_IP')
142 or not d.getVar('TEST_SERVER_IP'))):
143 bb.fatal('When TEST_TARGET is set to "simpleremote" '
144 'TEST_TARGET_IP and TEST_SERVER_IP are needed too.')
145
146def get_testimage_configuration(d, test_type, machine):
147 import platform
148 from oeqa.utils.metadata import get_layers
149 configuration = {'TEST_TYPE': test_type,
150 'MACHINE': machine,
151 'DISTRO': d.getVar("DISTRO"),
152 'IMAGE_BASENAME': d.getVar("IMAGE_BASENAME"),
153 'IMAGE_PKGTYPE': d.getVar("IMAGE_PKGTYPE"),
154 'STARTTIME': d.getVar("DATETIME"),
155 'HOST_DISTRO': oe.lsb.distro_identifier().replace(' ', '-'),
156 'LAYERS': get_layers(d.getVar("BBLAYERS"))}
157 return configuration
158get_testimage_configuration[vardepsexclude] = "DATETIME"
159
160def get_testimage_json_result_dir(d):
161 json_result_dir = os.path.join(d.getVar("LOG_DIR"), 'oeqa')
162 custom_json_result_dir = d.getVar("OEQA_JSON_RESULT_DIR")
163 if custom_json_result_dir:
164 json_result_dir = custom_json_result_dir
165 return json_result_dir
166
167def get_testimage_result_id(configuration):
168 return '%s_%s_%s_%s' % (configuration['TEST_TYPE'], configuration['IMAGE_BASENAME'], configuration['MACHINE'], configuration['STARTTIME'])
169
170def get_testimage_boot_patterns(d):
171 from collections import defaultdict
172 boot_patterns = defaultdict(str)
173 # Only accept certain values
174 accepted_patterns = ['search_reached_prompt', 'send_login_user', 'search_login_succeeded', 'search_cmd_finished']
175 # Not all patterns need to be overriden, e.g. perhaps we only want to change the user
176 boot_patterns_flags = d.getVarFlags('TESTIMAGE_BOOT_PATTERNS') or {}
177 if boot_patterns_flags:
178 patterns_set = [p for p in boot_patterns_flags.items() if p[0] in d.getVar('TESTIMAGE_BOOT_PATTERNS').split()]
179 for flag, flagval in patterns_set:
180 if flag not in accepted_patterns:
181 bb.fatal('Testimage: The only accepted boot patterns are: search_reached_prompt,send_login_user, \
182 search_login_succeeded,search_cmd_finished\n Make sure your TESTIMAGE_BOOT_PATTERNS=%s \
183 contains an accepted flag.' % d.getVar('TESTIMAGE_BOOT_PATTERNS'))
184 return
185 # We know boot prompt is searched through in binary format, others might be expressions
186 if flag == 'search_reached_prompt':
187 boot_patterns[flag] = flagval.encode()
188 else:
189 boot_patterns[flag] = flagval.encode().decode('unicode-escape')
190 return boot_patterns
191
192
193def testimage_main(d):
194 import os
195 import json
196 import signal
197 import logging
198
199 from bb.utils import export_proxies
200 from oeqa.core.utils.misc import updateTestData
201 from oeqa.runtime.context import OERuntimeTestContext
202 from oeqa.runtime.context import OERuntimeTestContextExecutor
203 from oeqa.core.target.qemu import supported_fstypes
204 from oeqa.core.utils.test import getSuiteCases
205 from oeqa.utils import make_logger_bitbake_compatible
206
207 def sigterm_exception(signum, stackframe):
208 """
209 Catch SIGTERM from worker in order to stop qemu.
210 """
211 os.kill(os.getpid(), signal.SIGINT)
212
213 def handle_test_timeout(timeout):
214 bb.warn("Global test timeout reached (%s seconds), stopping the tests." %(timeout))
215 os.kill(os.getpid(), signal.SIGINT)
216
217 testimage_sanity(d)
218
219 if (d.getVar('IMAGE_PKGTYPE') == 'rpm'
220 and ('dnf' in d.getVar('TEST_SUITES') or 'auto' in d.getVar('TEST_SUITES'))):
221 create_rpm_index(d)
222
223 logger = make_logger_bitbake_compatible(logging.getLogger("BitBake"))
224 pn = d.getVar("PN")
225
226 bb.utils.mkdirhier(d.getVar("TEST_LOG_DIR"))
227
228 image_name = ("%s/%s" % (d.getVar('DEPLOY_DIR_IMAGE'),
229 d.getVar('IMAGE_LINK_NAME')))
230
231 tdname = "%s.testdata.json" % image_name
232 try:
233 td = json.load(open(tdname, "r"))
234 except (FileNotFoundError) as err:
235 bb.fatal('File %s Not Found. Have you built the image with INHERIT+="testimage" in the conf/local.conf?' % tdname)
236
237 # Some variables need to be updates (mostly paths) with the
238 # ones of the current environment because some tests require them.
239 updateTestData(d, td, d.getVar('TESTIMAGE_UPDATE_VARS').split())
240
241 image_manifest = "%s.manifest" % image_name
242 image_packages = OERuntimeTestContextExecutor.readPackagesManifest(image_manifest)
243
244 extract_dir = d.getVar("TEST_EXTRACTED_DIR")
245
246 # Get machine
247 machine = d.getVar("MACHINE")
248
249 # Get rootfs
250 fstypes = d.getVar('IMAGE_FSTYPES').split()
251 if d.getVar("TEST_TARGET") == "qemu":
252 fstypes = [fs for fs in fstypes if fs in supported_fstypes]
253 if not fstypes:
254 bb.fatal('Unsupported image type built. Add a compatible image to '
255 'IMAGE_FSTYPES. Supported types: %s' %
256 ', '.join(supported_fstypes))
257 qfstype = fstypes[0]
258 qdeffstype = d.getVar("QB_DEFAULT_FSTYPE")
259 if qdeffstype:
260 qfstype = qdeffstype
261 rootfs = '%s.%s' % (image_name, qfstype)
262
263 # Get tmpdir (not really used, just for compatibility)
264 tmpdir = d.getVar("TMPDIR")
265
266 # Get deploy_dir_image (not really used, just for compatibility)
267 dir_image = d.getVar("DEPLOY_DIR_IMAGE")
268
269 # Get bootlog
270 bootlog = os.path.join(d.getVar("TEST_LOG_DIR"),
271 'qemu_boot_log.%s' % d.getVar('DATETIME'))
272
273 # Get display
274 display = d.getVar("BB_ORIGENV").getVar("DISPLAY")
275
276 # Get kernel
277 kernel_name = ('%s-%s.bin' % (d.getVar("KERNEL_IMAGETYPE"), machine))
278 kernel = os.path.join(d.getVar("DEPLOY_DIR_IMAGE"), kernel_name)
279
280 # Get boottime
281 boottime = int(d.getVar("TEST_QEMUBOOT_TIMEOUT"))
282
283 # Get use_kvm
284 kvm = oe.types.qemu_use_kvm(d.getVar('QEMU_USE_KVM'), d.getVar('TARGET_ARCH'))
285
286 # Get OVMF
287 ovmf = d.getVar("QEMU_USE_OVMF")
288
289 slirp = False
290 if d.getVar("QEMU_USE_SLIRP"):
291 slirp = True
292
293 # TODO: We use the current implementation of qemu runner because of
294 # time constrains, qemu runner really needs a refactor too.
295 target_kwargs = { 'machine' : machine,
296 'rootfs' : rootfs,
297 'tmpdir' : tmpdir,
298 'dir_image' : dir_image,
299 'display' : display,
300 'kernel' : kernel,
301 'boottime' : boottime,
302 'bootlog' : bootlog,
303 'kvm' : kvm,
304 'slirp' : slirp,
305 'dump_dir' : d.getVar("TESTIMAGE_DUMP_DIR"),
306 'serial_ports': len(d.getVar("SERIAL_CONSOLES").split()),
307 'ovmf' : ovmf,
308 }
309
310 if d.getVar("TESTIMAGE_BOOT_PATTERNS"):
311 target_kwargs['boot_patterns'] = get_testimage_boot_patterns(d)
312
313 # TODO: Currently BBPATH is needed for custom loading of targets.
314 # It would be better to find these modules using instrospection.
315 target_kwargs['target_modules_path'] = d.getVar('BBPATH')
316
317 # hardware controlled targets might need further access
318 target_kwargs['powercontrol_cmd'] = d.getVar("TEST_POWERCONTROL_CMD") or None
319 target_kwargs['powercontrol_extra_args'] = d.getVar("TEST_POWERCONTROL_EXTRA_ARGS") or ""
320 target_kwargs['serialcontrol_cmd'] = d.getVar("TEST_SERIALCONTROL_CMD") or None
321 target_kwargs['serialcontrol_extra_args'] = d.getVar("TEST_SERIALCONTROL_EXTRA_ARGS") or ""
322 target_kwargs['testimage_dump_target'] = d.getVar("testimage_dump_target") or ""
323
324 def export_ssh_agent(d):
325 import os
326
327 variables = ['SSH_AGENT_PID', 'SSH_AUTH_SOCK']
328 for v in variables:
329 if v not in os.environ.keys():
330 val = d.getVar(v)
331 if val is not None:
332 os.environ[v] = val
333
334 export_ssh_agent(d)
335
336 # runtime use network for download projects for build
337 export_proxies(d)
338
339 # we need the host dumper in test context
340 host_dumper = OERuntimeTestContextExecutor.getHostDumper(
341 d.getVar("testimage_dump_host"),
342 d.getVar("TESTIMAGE_DUMP_DIR"))
343
344 # the robot dance
345 target = OERuntimeTestContextExecutor.getTarget(
346 d.getVar("TEST_TARGET"), logger, d.getVar("TEST_TARGET_IP"),
347 d.getVar("TEST_SERVER_IP"), **target_kwargs)
348
349 # test context
350 tc = OERuntimeTestContext(td, logger, target, host_dumper,
351 image_packages, extract_dir)
352
353 # Load tests before starting the target
354 test_paths = get_runtime_paths(d)
355 test_modules = d.getVar('TEST_SUITES').split()
356 if not test_modules:
357 bb.fatal('Empty test suite, please verify TEST_SUITES variable')
358
359 tc.loadTests(test_paths, modules=test_modules)
360
361 suitecases = getSuiteCases(tc.suites)
362 if not suitecases:
363 bb.fatal('Empty test suite, please verify TEST_SUITES variable')
364 else:
365 bb.debug(2, 'test suites:\n\t%s' % '\n\t'.join([str(c) for c in suitecases]))
366
367 package_extraction(d, tc.suites)
368
369 results = None
370 complete = False
371 orig_sigterm_handler = signal.signal(signal.SIGTERM, sigterm_exception)
372 try:
373 # We need to check if runqemu ends unexpectedly
374 # or if the worker send us a SIGTERM
375 tc.target.start(params=d.getVar("TEST_QEMUPARAMS"), runqemuparams=d.getVar("TEST_RUNQEMUPARAMS"))
376 import threading
377 try:
378 threading.Timer(int(d.getVar("TEST_OVERALL_TIMEOUT")), handle_test_timeout, (int(d.getVar("TEST_OVERALL_TIMEOUT")),)).start()
379 except ValueError:
380 pass
381 results = tc.runTests()
382 complete = True
383 except (KeyboardInterrupt, BlockingIOError) as err:
384 if isinstance(err, KeyboardInterrupt):
385 bb.error('testimage interrupted, shutting down...')
386 else:
387 bb.error('runqemu failed, shutting down...')
388 if results:
389 results.stop()
390 results = tc.results
391 finally:
392 signal.signal(signal.SIGTERM, orig_sigterm_handler)
393 tc.target.stop()
394
395 # Show results (if we have them)
396 if results:
397 configuration = get_testimage_configuration(d, 'runtime', machine)
398 results.logDetails(get_testimage_json_result_dir(d),
399 configuration,
400 get_testimage_result_id(configuration),
401 dump_streams=d.getVar('TESTREPORT_FULLLOGS'))
402 results.logSummary(pn)
403 if not results or not complete:
404 bb.fatal('%s - FAILED - tests were interrupted during execution' % pn, forcelog=True)
405 if not results.wasSuccessful():
406 bb.fatal('%s - FAILED - check the task log and the ssh log' % pn, forcelog=True)
407
408def get_runtime_paths(d):
409 """
410 Returns a list of paths where runtime test must reside.
411
412 Runtime tests are expected in <LAYER_DIR>/lib/oeqa/runtime/cases/
413 """
414 paths = []
415
416 for layer in d.getVar('BBLAYERS').split():
417 path = os.path.join(layer, 'lib/oeqa/runtime/cases')
418 if os.path.isdir(path):
419 paths.append(path)
420 return paths
421
422def create_index(arg):
423 import subprocess
424
425 index_cmd = arg
426 try:
427 bb.note("Executing '%s' ..." % index_cmd)
428 result = subprocess.check_output(index_cmd,
429 stderr=subprocess.STDOUT,
430 shell=True)
431 result = result.decode('utf-8')
432 except subprocess.CalledProcessError as e:
433 return("Index creation command '%s' failed with return code "
434 '%d:\n%s' % (e.cmd, e.returncode, e.output.decode("utf-8")))
435 if result:
436 bb.note(result)
437 return None
438
439def create_rpm_index(d):
440 import glob
441 # Index RPMs
442 rpm_createrepo = bb.utils.which(os.getenv('PATH'), "createrepo_c")
443 index_cmds = []
444 archs = (d.getVar('ALL_MULTILIB_PACKAGE_ARCHS') or '').replace('-', '_')
445
446 for arch in archs.split():
447 rpm_dir = os.path.join(d.getVar('DEPLOY_DIR_RPM'), arch)
448 idx_path = os.path.join(d.getVar('WORKDIR'), 'oe-testimage-repo', arch)
449
450 if not os.path.isdir(rpm_dir):
451 continue
452
453 lockfilename = os.path.join(d.getVar('DEPLOY_DIR_RPM'), 'rpm.lock')
454 lf = bb.utils.lockfile(lockfilename, False)
455 oe.path.copyhardlinktree(rpm_dir, idx_path)
456 # Full indexes overload a 256MB image so reduce the number of rpms
457 # in the feed by filtering to specific packages needed by the tests.
458 package_list = glob.glob(idx_path + "*/*.rpm")
459
460 for pkg in package_list:
461 if not os.path.basename(pkg).startswith(("rpm", "run-postinsts", "busybox", "bash", "update-alternatives", "libc6", "curl", "musl")):
462 bb.utils.remove(pkg)
463
464 bb.utils.unlockfile(lf)
465 cmd = '%s --update -q %s' % (rpm_createrepo, idx_path)
466
467 # Create repodata
468 result = create_index(cmd)
469 if result:
470 bb.fatal('%s' % ('\n'.join(result)))
471
472def package_extraction(d, test_suites):
473 from oeqa.utils.package_manager import find_packages_to_extract
474 from oeqa.utils.package_manager import extract_packages
475
476 bb.utils.remove(d.getVar("TEST_NEEDED_PACKAGES_DIR"), recurse=True)
477 packages = find_packages_to_extract(test_suites)
478 if packages:
479 bb.utils.mkdirhier(d.getVar("TEST_INSTALL_TMP_DIR"))
480 bb.utils.mkdirhier(d.getVar("TEST_PACKAGED_DIR"))
481 bb.utils.mkdirhier(d.getVar("TEST_EXTRACTED_DIR"))
482 extract_packages(d, packages)
483
484testimage_main[vardepsexclude] += "BB_ORIGENV DATETIME"
485
486python () {
487 if oe.types.boolean(d.getVar("TESTIMAGE_AUTO") or "False"):
488 bb.build.addtask("testimage", "do_build", "do_image_complete", d)
489}
490
491inherit testsdk