Based of a feature of AUH this is a plugin to run a testimage directly with packages installed that you are working on via devtool.
Inputs would be a: - target image - target packages - optional test suites to run (defaulting to all test suites) The tool will take care to make sure it also installs the minimal necessary dependencies to be able to run ptest on the target image. Logs will be captured and stored in the devtool workspace for easy access. An oe-selftest is added to test the plugin. V2: Dropped the hard dependency on using ext4 as a filesystem for the test image, now it can be used with any filesystem supported by the testimage plugin. Furthermore now the correct test suite is installed. V3: processed review comments: - Runtime-heavy behavior was tied to using a larger image and plugin-side forcing. - The updated selftest now targets core-image-ptest-<pkg> and completes much faster locally. - Plugin no longer sets global config in a bbappend (DISTRO_FEATURES, runqemu params), matching reviewer guidance. - The plugin now also supports running with a custom test suite, which is useful for testing specific test cases without having to run the entire test suite. Signed-off-by: Tom Geelen <[email protected]> --- meta/lib/oeqa/selftest/cases/devtool.py | 64 +++++++++++ scripts/lib/devtool/test_image.py | 141 ++++++++++++++++++++++++ 2 files changed, 205 insertions(+) create mode 100644 scripts/lib/devtool/test_image.py diff --git a/meta/lib/oeqa/selftest/cases/devtool.py b/meta/lib/oeqa/selftest/cases/devtool.py index d1209dd94e..baa3509da2 100644 --- a/meta/lib/oeqa/selftest/cases/devtool.py +++ b/meta/lib/oeqa/selftest/cases/devtool.py @@ -1932,6 +1932,70 @@ class DevtoolBuildImageTests(DevtoolBase): if reqpkgs: self.fail('The following packages were not present in the image as expected: %s' % ', '.join(reqpkgs)) + +class DevtoolTestImageTests(DevtoolBase): + + @OETestTag("runqemu") + def test_devtool_test_image_ptest(self): + """Test devtool test-image plugin.""" + + machine = get_bb_var('MACHINE') + if not machine or not machine.startswith('qemu'): + self.skipTest('This test only works with qemu machines') + + self.assertTrue(not os.path.exists(self.workspacedir), + 'This test cannot be run with a workspace directory under the build directory') + + self.append_config('DISTRO_FEATURES:append = " ptest"') + self.append_config('IMAGE_CLASSES += " testimage"') + self.append_config('TEST_RUNQEMUPARAMS:append = " slirp"') + + recipe = 'python3-atomicwrites' + image = 'core-image-ptest-%s' % recipe + + # Ensure selected test package is ptest-capable. + ptest_path = get_bb_var('PTEST_PATH', recipe) + self.assertTrue(ptest_path, + 'Selected package %s does not appear to inherit ptest' % recipe) + + self.track_for_cleanup(self.workspacedir) + self.add_command_to_tearDown('bitbake-layers remove-layer */workspace') + + # Ensure we're starting from a clean state + bitbake('%s -c clean' % image) + + result = runCmd('devtool test-image %s -p %s --test-suites "ping ssh ptest"' % (image, recipe), ignore_status=True) + if result.status != 0 and 'runqemu - ERROR - Unknown path arg' in result.output: + self.skipTest('runqemu in this environment does not accept testimage rootfs path args') + self.assertEqual(result.status, 0, + 'devtool test-image failed unexpectedly:\n%s' % result.output) + + # Check that requested package and its ptest package were installed + deploy_dir_image = get_bb_var('DEPLOY_DIR_IMAGE') + self.assertTrue(deploy_dir_image, 'Unable to get DEPLOY_DIR_IMAGE') + + manifests = sorted(glob.glob(os.path.join(deploy_dir_image, '%s*.manifest' % image))) + self.assertTrue(manifests, 'Image manifest not found for %s in %s' % (image, deploy_dir_image)) + manifest = manifests[-1] + self.assertExists(manifest, 'Image manifest not found: %s' % manifest) + + pkgs = set() + with open(manifest, 'r') as f: + for line in f: + splitval = line.split() + if splitval: + pkgs.add(splitval[0]) + + self.assertIn(recipe, pkgs) + self.assertIn(recipe + '-ptest', pkgs) + + match = re.search(r'Logs are in (\S+)', result.output) + if match: + logdir = match.group(1) + else: + logdir = os.path.join(self.workspacedir, 'testimage-logs') + self.assertTrue(os.path.isdir(logdir), 'Expected logs directory not found: %s' % logdir) + class DevtoolUpgradeTests(DevtoolBase): def setUp(self): diff --git a/scripts/lib/devtool/test_image.py b/scripts/lib/devtool/test_image.py new file mode 100644 index 0000000000..c34ddeeecd --- /dev/null +++ b/scripts/lib/devtool/test_image.py @@ -0,0 +1,141 @@ +# Development tool - test-image plugin +# +# Copyright (C) 2026 Authors +# +# SPDX-License-Identifier: GPL-2.0-only + +"""Devtool plugin containing the test-image subcommand. + +Builds a target image, installs specified package(s) from the workspace or +layer, and runs the image's test suite via the BitBake `testimage` task. +""" + +import os +import logging + +from devtool import DevtoolError +from devtool.build_image import build_image_task + +logger = logging.getLogger('devtool') + + +def _create_ptest_recipe_appends(config, package_names): + """Create temporary per-package appends forcing PTEST_ENABLED=1. + + Returns list of created file paths for cleanup. + """ + created = [] + appends_dir = os.path.join(config.workspace_path, 'appends') + os.makedirs(appends_dir, exist_ok=True) + + for pn in sorted(set(package_names)): + appendfile = os.path.join(appends_dir, f'{pn}_%.bbappend') + if os.path.exists(appendfile): + logger.debug('Using existing append %s', appendfile) + continue + with open(appendfile, 'w') as afile: + afile.write('PTEST_ENABLED = "1"\n') + created.append(appendfile) + + return created + + +def test_image(args, config, basepath, workspace): + """Entry point for the devtool 'test-image' subcommand.""" + + if not args.package: + raise DevtoolError('Package(s) to install must be specified via -p/--package') + + package_names = [p.strip() for p in args.package.split(',') if p.strip()] + if not package_names: + raise DevtoolError('No valid package name(s) provided') + + if args.imagename: + imagename = args.imagename + else: + if len(package_names) != 1: + raise DevtoolError('Image recipe must be specified when testing multiple packages') + imagename = f'core-image-ptest-{package_names[0]}' + + install_pkgs = package_names + + logdir = os.path.join(config.workspace_path, 'testimage-logs') + try: + os.makedirs(logdir, exist_ok=True) + except Exception as exc: + raise DevtoolError(f'Failed to create test logs directory {logdir}: {exc}') + + pkg_append = ' '.join(sorted(set(install_pkgs))) + ptest_pkg_append = ' '.join(f'{pn}-ptest' for pn in sorted(set(install_pkgs))) + extra_append = [ + f'TEST_LOG_DIR = "{logdir}"', + 'IMAGE_CLASSES += " testimage"', + 'IMAGE_FEATURES += "allow-empty-password empty-root-password allow-root-login"', + 'IMAGE_INSTALL:append = " ptest-runner sshd"', + # Ensure requested packages (and -ptest where available) are installed + f'IMAGE_INSTALL:append = " {pkg_append}"', + f'IMAGE_INSTALL:append = " {ptest_pkg_append}"', + ] + if args.test_suites: + suites = ' '.join(args.test_suites.split()) + if suites: + extra_append.append(f'TEST_SUITES = "{suites}"') + + temp_ptest_appends = _create_ptest_recipe_appends(config, package_names) + + logger.info('Running testimage for %s with packages: %s', + imagename, ' '.join(install_pkgs)) + try: + result, _outputdir = build_image_task( + config, + basepath, + workspace, + imagename, + add_packages=None, + extra_append=extra_append, + ) + if result == 0: + result, _outputdir = build_image_task( + config, + basepath, + workspace, + imagename, + add_packages=None, + task='testimage', + extra_append=extra_append, + ) + finally: + for appendfile in temp_ptest_appends: + if os.path.exists(appendfile): + os.unlink(appendfile) + + if result == 0: + logger.info('Testimage completed. Logs are in %s', logdir) + return result + + +def register_commands(subparsers, context): + """Register devtool subcommands from the test-image plugin""" + parser = subparsers.add_parser( + 'test-image', + help='Build image, install package(s), and run selected test suites', + description=( + 'Builds an image, installs specified package(s), and runs the\n' + 'BitBake testimage task. Use --test-suites to limit runtime suites\n' + '(for example: "ping ssh ptest").' + ), + group='testbuild', + order=-9, + ) + parser.add_argument('imagename', help='Image recipe to test (defaults to core-image-ptest-<package>)', nargs='?') + parser.add_argument( + '-p', '--package', '--packages', + help='Package(s) to install into the image (comma-separated)', + metavar='PACKAGES', + ) + parser.add_argument( + '--test-suites', + help='Override TEST_SUITES for this invocation (space-separated)', + metavar='SUITES', + ) + parser.set_defaults(func=test_image) -- 2.43.0
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#232602): https://lists.openembedded.org/g/openembedded-core/message/232602 Mute This Topic: https://lists.openembedded.org/mt/118180713/21656 Group Owner: [email protected] Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
