riscv
/
qemu
mirror of https://gitea.goldendeliverer.com/riscv/qemu.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

tests/functional: Fix problems in decorators.py reported by pylint 

The documentation strings should follow the function definition
lines, not precede them.

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Signed-off-by: Thomas Huth <thuth@redhat.com>
Message-ID: <20251015095454.1575318-3-thuth@redhat.com>
pull/307/head
Thomas Huth 10 months ago
parent
1a6ccf45eb
commit
9641b01357
1 changed files with 87 additions and 89 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 176
      tests/functional/qemu_test/decorators.py

176
tests/functional/qemu_test/decorators.py
View File

@ -10,136 +10,134 @@ from unittest import skipIf, skipUnless
from .cmd import which
'''
Decorator to skip execution of a test if the provided
environment variables are not set.
Example:
@skipIfMissingEnv("QEMU_ENV_VAR0", "QEMU_ENV_VAR1")
'''
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) == None:
if os.getenv(var) is None:
missing_vars.append(var)
has_vars = True if len(missing_vars) == 0 else False
has_vars = len(missing_vars) == 0
return skipUnless(has_vars, f"Missing env var(s): {', '.join(missing_vars)}")
'''
Decorator to skip execution of a test if the list
of command binaries is not available in $PATH.
Example:
@skipIfMissingCommands("mkisofs", "losetup")
'''
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
if not which(cmd):
has_cmds = False
break
return skipUnless(has_cmds, 'required command(s) "%s" not installed' %
", ".join(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")
'''
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))
'''
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")
'''
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))
'''
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.
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.
Historical tests may be providing "None" as the bug_url
but this should not be done for new test.
Example:
Example:
@skipFlakyTest("https://gitlab.com/qemu-project/qemu/-/issues/NNN")
'''
def skipFlakyTest(bug_url):
@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}')
'''
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()
'''
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')
'''
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
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:
Example:
@skipBigDataTest()
'''
def skipBigDataTest():
@skipBigDataTest()
'''
return skipUnless(os.getenv('QEMU_TEST_ALLOW_LARGE_STORAGE'),
'Test requires large host storage space')
'''
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
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:
Example:
@skipSlowTest()
'''
def skipSlowTest():
@skipSlowTest()
'''
return skipUnless(os.getenv('QEMU_TEST_ALLOW_SLOW'),
'Test has a very long runtime and might time out')
'''
Decorator to skip execution of a test if the list
of python imports is not available.
Example:
@skipIfMissingImports("numpy", "cv2")
'''
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:
@ -151,15 +149,15 @@ def skipIfMissingImports(*args):
return skipUnless(has_imports, 'required import(s) "%s" not installed' %
", ".join(args))
'''
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)
'''
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)

Write Preview
Loading…
Cancel
Save