aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/markdown/snippets/test-verbose.md6
-rw-r--r--docs/yaml/functions/benchmark.yaml8
-rw-r--r--docs/yaml/functions/test.yaml7
-rw-r--r--mesonbuild/backend/backends.py4
-rw-r--r--mesonbuild/interpreter/interpreter.py4
-rw-r--r--mesonbuild/interpreter/interpreterobjects.py3
-rw-r--r--mesonbuild/mtest.py26
-rw-r--r--test cases/common/206 tap tests/meson.build2
-rw-r--r--unittests/allplatformstests.py7
9 files changed, 51 insertions, 16 deletions
diff --git a/docs/markdown/snippets/test-verbose.md b/docs/markdown/snippets/test-verbose.md
new file mode 100644
index 0000000..6d9aa0f
--- /dev/null
+++ b/docs/markdown/snippets/test-verbose.md
@@ -0,0 +1,6 @@
+## New keyword argument `verbose` for tests and benchmarks
+
+The new keyword argument `verbose` can be used to mark tests and benchmarks
+that must always be logged verbosely on the console. This is particularly
+useful for long-running tests, or when a single Meson test() is wrapping
+an external test harness.
diff --git a/docs/yaml/functions/benchmark.yaml b/docs/yaml/functions/benchmark.yaml
index da465aa..3082fbe 100644
--- a/docs/yaml/functions/benchmark.yaml
+++ b/docs/yaml/functions/benchmark.yaml
@@ -104,3 +104,11 @@ kwargs:
The starting order of tests with identical priorities is
implementation-defined. The default priority is 0, negative numbers are
permitted.
+
+ verbose:
+ type: bool
+ since: 0.62.0
+ default: false
+ description: |
+ if true, forces the test results to be logged as if `--verbose` was passed
+ to `meson test`.
diff --git a/docs/yaml/functions/test.yaml b/docs/yaml/functions/test.yaml
index 96a2b28..bc9ad03 100644
--- a/docs/yaml/functions/test.yaml
+++ b/docs/yaml/functions/test.yaml
@@ -33,6 +33,13 @@ description: |
test(..., env: nomalloc, ...)
```
+ In addition to running individual executables as test cases, `test()`
+ can also be used to invoke an external test harness. In this case,
+ it is best to use `verbose: true` *(since 0.62.0)* and, if supported
+ by the external harness, `protocol: 'tap'` *(since 0.50.0)*. This will
+ ensure that Meson logs each subtest as it runs, instead of including
+ the whole log at the end of the run.
+
Defined tests can be run in a backend-agnostic way by calling
`meson test` inside the build dir, or by using backend-specific
commands, such as `ninja test` or `msbuild RUN_TESTS.vcxproj`.
diff --git a/mesonbuild/backend/backends.py b/mesonbuild/backend/backends.py
index 4f7e8c8..b26779a 100644
--- a/mesonbuild/backend/backends.py
+++ b/mesonbuild/backend/backends.py
@@ -225,6 +225,7 @@ class TestSerialisation:
cmd_is_built: bool
depends: T.List[str]
version: str
+ verbose: bool
def __post_init__(self) -> None:
if self.exe_wrapper is not None:
@@ -1147,7 +1148,8 @@ class Backend:
extra_paths, t.protocol, t.priority,
isinstance(exe, build.Executable),
[x.get_id() for x in depends],
- self.environment.coredata.version)
+ self.environment.coredata.version,
+ t.verbose)
arr.append(ts)
return arr
diff --git a/mesonbuild/interpreter/interpreter.py b/mesonbuild/interpreter/interpreter.py
index 7681834..c83d09e 100644
--- a/mesonbuild/interpreter/interpreter.py
+++ b/mesonbuild/interpreter/interpreter.py
@@ -215,6 +215,7 @@ TEST_KWARGS: T.List[KwargInfo] = [
ENV_KW,
DEPENDS_KW.evolve(since='0.46.0'),
KwargInfo('suite', ContainerTypeInfo(list, str), listify=True, default=['']), # yes, a list of empty string
+ KwargInfo('verbose', bool, default=False, since='0.62.0'),
]
permitted_dependency_kwargs = {
@@ -1972,7 +1973,8 @@ external dependencies (including libraries) must go to "dependencies".''')
kwargs['timeout'],
kwargs['workdir'],
kwargs['protocol'],
- kwargs['priority'])
+ kwargs['priority'],
+ kwargs['verbose'])
def add_test(self, node: mparser.BaseNode, args: T.List, kwargs: T.Dict[str, T.Any], is_base_test: bool):
t = self.make_test(node, args, kwargs)
diff --git a/mesonbuild/interpreter/interpreterobjects.py b/mesonbuild/interpreter/interpreterobjects.py
index 2656f14..9c2481c 100644
--- a/mesonbuild/interpreter/interpreterobjects.py
+++ b/mesonbuild/interpreter/interpreterobjects.py
@@ -636,7 +636,7 @@ class Test(MesonInterpreterObject):
cmd_args: T.List[T.Union[str, mesonlib.File, build.Target]],
env: build.EnvironmentVariables,
should_fail: bool, timeout: int, workdir: T.Optional[str], protocol: str,
- priority: int):
+ priority: int, verbose: bool):
super().__init__()
self.name = name
self.suite = listify(suite)
@@ -651,6 +651,7 @@ class Test(MesonInterpreterObject):
self.workdir = workdir
self.protocol = TestProtocol.from_str(protocol)
self.priority = priority
+ self.verbose = verbose
def get_exe(self) -> T.Union[ExternalProgram, build.Executable, build.CustomTarget]:
return self.exe
diff --git a/mesonbuild/mtest.py b/mesonbuild/mtest.py
index 3fe7f96..4488a8c 100644
--- a/mesonbuild/mtest.py
+++ b/mesonbuild/mtest.py
@@ -600,7 +600,7 @@ class ConsoleLogger(TestLogger):
self.progress_task = asyncio.ensure_future(report_progress())
def start_test(self, harness: 'TestHarness', test: 'TestRun') -> None:
- if harness.options.verbose and test.cmdline:
+ if test.verbose and test.cmdline:
self.flush()
print(harness.format(test, mlog.colorize_console(),
max_left_width=self.max_left_width,
@@ -619,12 +619,12 @@ class ConsoleLogger(TestLogger):
self.request_update()
def shorten_log(self, harness: 'TestHarness', result: 'TestRun') -> str:
- if not harness.options.verbose and not harness.options.print_errorlogs:
+ if not result.verbose and not harness.options.print_errorlogs:
return ''
log = result.get_log(mlog.colorize_console(),
stderr_only=result.needs_parsing)
- if harness.options.verbose:
+ if result.verbose:
return log
lines = log.splitlines()
@@ -634,7 +634,7 @@ class ConsoleLogger(TestLogger):
return str(mlog.bold('Listing only the last 100 lines from a long log.\n')) + '\n'.join(lines[-100:])
def print_log(self, harness: 'TestHarness', result: 'TestRun') -> None:
- if not harness.options.verbose:
+ if not result.verbose:
cmdline = result.cmdline
if not cmdline:
print(result.res.get_command_marker() + result.stdo)
@@ -648,7 +648,7 @@ class ConsoleLogger(TestLogger):
print(self.output_end)
def log_subtest(self, harness: 'TestHarness', test: 'TestRun', s: str, result: TestResult) -> None:
- if harness.options.verbose or (harness.options.print_errorlogs and result.is_bad()):
+ if test.verbose or (harness.options.print_errorlogs and result.is_bad()):
self.flush()
print(harness.format(test, mlog.colorize_console(), max_left_width=self.max_left_width,
prefix=self.sub,
@@ -659,22 +659,22 @@ class ConsoleLogger(TestLogger):
def log(self, harness: 'TestHarness', result: 'TestRun') -> None:
self.running_tests.remove(result)
- if result.res is TestResult.TIMEOUT and harness.options.verbose:
+ if result.res is TestResult.TIMEOUT and result.verbose:
self.flush()
print(f'{result.name} time out (After {result.timeout} seconds)')
if not harness.options.quiet or not result.res.is_ok():
self.flush()
- if harness.options.verbose and not result.is_parallel and result.cmdline:
+ if result.verbose and not result.is_parallel and result.cmdline:
if not result.needs_parsing:
print(self.output_end)
print(harness.format(result, mlog.colorize_console(), max_left_width=self.max_left_width))
else:
print(harness.format(result, mlog.colorize_console(), max_left_width=self.max_left_width),
flush=True)
- if harness.options.verbose or result.res.is_bad():
+ if result.verbose or result.res.is_bad():
self.print_log(harness, result)
- if harness.options.verbose or result.res.is_bad():
+ if result.verbose or result.res.is_bad():
print(flush=True)
self.request_update()
@@ -867,7 +867,7 @@ class TestRun:
return super().__new__(TestRun.PROTOCOL_TO_CLASS[test.protocol])
def __init__(self, test: TestSerialisation, test_env: T.Dict[str, str],
- name: str, timeout: T.Optional[int], is_parallel: bool):
+ name: str, timeout: T.Optional[int], is_parallel: bool, verbose: bool):
self.res = TestResult.PENDING
self.test = test
self._num = None # type: T.Optional[int]
@@ -885,6 +885,7 @@ class TestRun:
self.project = test.project_name
self.junit = None # type: T.Optional[et.ElementTree]
self.is_parallel = is_parallel
+ self.verbose = verbose
def start(self, cmd: T.List[str]) -> None:
self.res = TestResult.RUNNING
@@ -1335,11 +1336,12 @@ class SingleTestRunner:
timeout = self.test.timeout * self.options.timeout_multiplier
is_parallel = test.is_parallel and self.options.num_processes > 1 and not self.options.gdb
- self.runobj = TestRun(test, env, name, timeout, is_parallel)
+ verbose = (test.verbose or self.options.verbose) and not self.options.quiet
+ self.runobj = TestRun(test, env, name, timeout, is_parallel, verbose)
if self.options.gdb:
self.console_mode = ConsoleUser.GDB
- elif self.options.verbose and not is_parallel and not self.runobj.needs_parsing:
+ elif self.runobj.verbose and not is_parallel and not self.runobj.needs_parsing:
self.console_mode = ConsoleUser.STDOUT
else:
self.console_mode = ConsoleUser.LOGGER
diff --git a/test cases/common/206 tap tests/meson.build b/test cases/common/206 tap tests/meson.build
index 5221319..54f4e41 100644
--- a/test cases/common/206 tap tests/meson.build
+++ b/test cases/common/206 tap tests/meson.build
@@ -7,7 +7,7 @@ test('fail', tester, args : ['not ok'], should_fail: true, protocol: 'tap')
test('xfail', tester, args : ['not ok # todo'], protocol: 'tap')
test('xpass', tester, args : ['ok # todo'], should_fail: true, protocol: 'tap')
test('skip', tester, args : ['ok # skip'], protocol: 'tap')
-test('partially skipped', tester, args : ['ok 1\nok 2 # skip'], protocol: 'tap')
+test('partially skipped', tester, args : ['ok 1\nok 2 # skip'], suite: ['verbose'], protocol: 'tap', verbose: true)
test('partially skipped (real-world example)', cat, args : [files('issue7515.txt')], protocol: 'tap')
test('skip comment', tester, args : ['ok # Skipped: with a comment'], protocol: 'tap')
test('skip failure', tester, args : ['not ok # skip'], should_fail: true, protocol: 'tap')
diff --git a/unittests/allplatformstests.py b/unittests/allplatformstests.py
index 4a7fbb5..0b86690 100644
--- a/unittests/allplatformstests.py
+++ b/unittests/allplatformstests.py
@@ -570,6 +570,13 @@ class AllPlatformTests(BasePlatformTests):
self.build()
self._run(self.mtest_command + ['--repeat=2'])
+ def test_verbose(self):
+ testdir = os.path.join(self.common_test_dir, '206 tap tests')
+ self.init(testdir)
+ self.build()
+ out = self._run(self.mtest_command + ['--suite', 'verbose'])
+ self.assertIn('1/1 subtest 1', out)
+
def test_testsetups(self):
if not shutil.which('valgrind'):
raise SkipTest('Valgrind not installed.')