| # SPDX-License-Identifier: GPL-2.0-or-later | |
| # | |
| # Decorators useful in functional tests | |
| import importlib | |
| import os | |
| import platform | |
| import resource | |
| import subprocess | |
| from unittest import skipIf, skipUnless | |
| from .cmd import which | |
| def skipIfMissingEnv(*vars_): | |
| ''' | |
| Decorator to skip execution of a test if the provided | |
| environment variables are not set. | |
| Example: | |
| @skipIfMissingEnv("QEMU_ENV_VAR0", "QEMU_ENV_VAR1") | |
| ''' | |
| missing_vars = [] | |
| for var in vars_: | |
| if os.getenv(var) is None: | |
| missing_vars.append(var) | |
| has_vars = len(missing_vars) == 0 | |
| return skipUnless(has_vars, f"Missing env var(s): {', '.join(missing_vars)}") | |
| def skipIfMissingCommands(*args): | |
| ''' | |
| Decorator to skip execution of a test if the list | |
| of command binaries is not available in $PATH. | |
| Example: | |
| @skipIfMissingCommands("mkisofs", "losetup") | |
| ''' | |
| has_cmds = True | |
| for cmd in args: | |
| if not which(cmd): | |
| has_cmds = False | |
| break | |
| return skipUnless(has_cmds, 'required command(s) "%s" not installed' % | |
| ", ".join(args)) | |
| def skipIfOperatingSystem(*args): | |
| ''' | |
| Decorator to skip execution of a test if the current host | |
| operating system does match one of the prohibited ones. | |
| Example: | |
| @skipIfOperatingSystem("Linux", "Darwin") | |
| ''' | |
| return skipIf(platform.system() in args, | |
| 'running on an OS (%s) that is not able to run this test' % | |
| ", ".join(args)) | |
| def skipUnlessOperatingSystem(*args): | |
| ''' | |
| Decorator to skip execution of a test if the current host | |
| operating system does not match one of the allowed ones. | |
| Example: | |
| @skipUnlessOperatingSystem("Linux", "Darwin") | |
| ''' | |
| return skipUnless(platform.system() in args, | |
| 'not running on one of the required operating systems (%s)' % | |
| ", ".join(args)) | |
| def skipIfNotMachine(*args): | |
| ''' | |
| Decorator to skip execution of a test if the current | |
| host machine does not match one of the permitted machines. | |
| Example: | |
| @skipIfNotMachine("x86_64", "aarch64") | |
| ''' | |
| return skipUnless(platform.machine() in args, | |
| 'not running on one of the required machine(s) "%s"' % | |
| ", ".join(args)) | |
| def skipFlakyTest(bug_url): | |
| ''' | |
| Decorator to skip execution of flaky tests, unless | |
| the $QEMU_TEST_FLAKY_TESTS environment variable is set. | |
| A bug URL must be provided that documents the observed | |
| failure behaviour, so it can be tracked & re-evaluated | |
| in future. | |
| Historical tests may be providing "None" as the bug_url | |
| but this should not be done for new test. | |
| Example: | |
| @skipFlakyTest("https://gitlab.com/qemu-project/qemu/-/issues/NNN") | |
| ''' | |
| if bug_url is None: | |
| bug_url = "FIXME: reproduce flaky test and file bug report or remove" | |
| return skipUnless(os.getenv('QEMU_TEST_FLAKY_TESTS'), | |
| f'Test is unstable: {bug_url}') | |
| def skipUntrustedTest(): | |
| ''' | |
| Decorator to skip execution of tests which are likely | |
| to execute untrusted commands on the host, or commands | |
| which process untrusted code, unless the | |
| $QEMU_TEST_ALLOW_UNTRUSTED_CODE env var is set. | |
| Example: | |
| @skipUntrustedTest() | |
| ''' | |
| return skipUnless(os.getenv('QEMU_TEST_ALLOW_UNTRUSTED_CODE'), | |
| 'Test runs untrusted code / processes untrusted data') | |
| def skipBigDataTest(): | |
| ''' | |
| Decorator to skip execution of tests which need large | |
| data storage (over around 500MB-1GB mark) on the host, | |
| unless the $QEMU_TEST_ALLOW_LARGE_STORAGE environment | |
| variable is set | |
| Example: | |
| @skipBigDataTest() | |
| ''' | |
| return skipUnless(os.getenv('QEMU_TEST_ALLOW_LARGE_STORAGE'), | |
| 'Test requires large host storage space') | |
| def skipSlowTest(): | |
| ''' | |
| Decorator to skip execution of tests which have a really long | |
| runtime (and might e.g. time out if QEMU has been compiled with | |
| debugging enabled) unless the $QEMU_TEST_ALLOW_SLOW | |
| environment variable is set | |
| Example: | |
| @skipSlowTest() | |
| ''' | |
| return skipUnless(os.getenv('QEMU_TEST_ALLOW_SLOW'), | |
| 'Test has a very long runtime and might time out') | |
| def skipIfMissingImports(*args): | |
| ''' | |
| Decorator to skip execution of a test if the list | |
| of python imports is not available. | |
| Example: | |
| @skipIfMissingImports("numpy", "cv2") | |
| ''' | |
| has_imports = True | |
| for impname in args: | |
| try: | |
| importlib.import_module(impname) | |
| except ImportError: | |
| has_imports = False | |
| break | |
| return skipUnless(has_imports, 'required import(s) "%s" not installed' % | |
| ", ".join(args)) | |
| def skipLockedMemoryTest(locked_memory): | |
| ''' | |
| Decorator to skip execution of a test if the system's | |
| locked memory limit is below the required threshold. | |
| Takes required locked memory threshold in kB. | |
| Example: | |
| @skipLockedMemoryTest(2_097_152) | |
| ''' | |
| # get memlock hard limit in bytes | |
| _, ulimit_memory = resource.getrlimit(resource.RLIMIT_MEMLOCK) | |
| return skipUnless( | |
| ulimit_memory == resource.RLIM_INFINITY or ulimit_memory >= locked_memory * 1024, | |
| f'Test required {locked_memory} kB of available locked memory', | |
| ) | |
| ''' | |
| Decorator to skip execution of a test if passwordless | |
| sudo command is not available. | |
| ''' | |
| def skipWithoutSudo(): | |
| proc = subprocess.run(["sudo", "-n", "/bin/true"], | |
| stdin=subprocess.PIPE, | |
| stdout=subprocess.PIPE, | |
| stderr=subprocess.STDOUT, | |
| universal_newlines=True, | |
| check=False) | |
| return skipUnless(proc.returncode == 0, | |
| f'requires password-less sudo access: {proc.stdout}') |