robotcode-runner 2.7.0__py3-none-any.whl → 2.8.0.dev548__py3-none-any.whl

robotcode/runner/cli/discover/discover.py

@@ -1,3 +1,4 @@
+import dataclasses
 import os
 import platform
 import re
@@ -10,6 +11,7 @@ from typing import (
     Dict,
     Iterable,
     List,
+    Mapping,
     MutableMapping,
     Optional,
     Tuple,
@@ -39,6 +41,7 @@ from robotcode.core.uri import Uri
 from robotcode.core.utils.cli import show_hidden_arguments
 from robotcode.core.utils.dataclasses import from_json
 from robotcode.core.utils.path import normalized_path
+from robotcode.modifiers.metadata_modifiers import metadata_entries
 from robotcode.plugin import (
     Application,
     OutputFormat,
@@ -49,10 +52,16 @@ from robotcode.plugin.click_helper.types import add_options
 from robotcode.robot.utils import RF_VERSION
 
 from .._markdown import make_md_highlighter
-from .._search import SearchMatcher, make_search_matcher
+from .._robot_version import RobotVersionCommand, RobotVersionOption
+from .._search import (
+    SearchMatcher,
+    get_test_metadata,
+    make_search_matcher,
+    named_metadata,
+)
 from ..robot import ROBOT_OPTIONS, ROBOT_VERSION_OPTIONS, RobotFrameworkEx, handle_robot_options
 from . import _render
-from ._models import Info, ResultItem, Statistics, TagsResult, TestItem
+from ._models import Info, MetadataResult, ResultItem, Statistics, TagsResult, TestItem
 
 # Robot Framework 6.1 introduced `--parseinclude`. Before that, the `--suite`
 # option implicitly restricted which files were parsed, so an explicit include
@@ -69,8 +78,9 @@ DISCOVER_SEARCH_OPTIONS = [
         help=(
             "Only include items where TEXT case-insensitively matches the "
             "name, full name, source path, documentation, template name, "
-            "timeout, any tag (normalisation-aware), the parent suite's "
-            "Documentation / Metadata, or anything inside the test body "
+            "timeout, any tag (normalisation-aware), test metadata names and "
+            "values, the parent suite's Documentation / Metadata, or anything "
+            "inside the test body "
             "— keyword names, keyword arguments, assigned variables, "
             "FOR/WHILE/IF conditions, VAR/RETURN values, EXCEPT patterns, "
             "GROUP names. Mutually exclusive with `--search-regex`."
@@ -264,6 +274,8 @@ class Collector(SuiteVisitor):
         self.test_and_tasks: List[TestItem] = []
         self.tags: Dict[str, List[TestItem]] = defaultdict(list)
         self.normalized_tags: Dict[str, List[TestItem]] = defaultdict(list)
+        # Suite items carry no metadata; `discover metadata` lists it separately.
+        self.suite_metadata: List[Tuple[TestItem, Dict[str, str]]] = []
         self.statistics = Statistics()
         self._collected: List[MutableMapping[str, Any]] = [NormalizedDict(ignore="_")]
 
@@ -289,7 +301,7 @@ class Collector(SuiteVisitor):
                 name=suite.name,
                 longname=suite.longname,
                 uri=str(Uri.from_path(absolute_path)) if absolute_path else None,
-                source=str(suite.source),
+                source=str(suite.source) if suite.source else None,
                 rel_source=get_rel_source(suite.source),
                 range=(
                     Range(
@@ -307,6 +319,9 @@ class Collector(SuiteVisitor):
             raise ValueError(f"Error while parsing suite {suite.source}: {e}") from e
 
         self.suites.append(item)
+        suite_metadata = named_metadata(suite.metadata)
+        if suite_metadata:
+            self.suite_metadata.append((item, suite_metadata))
 
         if self._current.children is None:
             self._current.children = []
@@ -356,6 +371,7 @@ class Collector(SuiteVisitor):
                     end=Position(line=test.lineno - 1, character=0),
                 ),
                 tags=sorted(set(normalize(str(t), ignore="_") for t in test.tags)) if test.tags else None,
+                metadata=get_test_metadata(test) or None,
                 rpa=self._current.rpa,
             )
         except ValueError as e:
@@ -477,6 +493,8 @@ def handle_options(
     exclude_by_longname: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
     search_matcher: Optional[SearchMatcher] = None,
+    by_test_metadata: Tuple[str, ...] = (),
+    exclude_by_test_metadata: Tuple[str, ...] = (),
 ) -> Tuple[TestSuite, Collector, Optional[Dict[str, List[Diagnostic]]]]:
     root_folder, profile, cmd_options = handle_robot_options(app, robot_options_and_args)
 
@@ -500,6 +518,8 @@ def handle_options(
                 by_longname,
                 exclude_by_longname,
                 search_matcher=search_matcher,
+                by_test_metadata=by_test_metadata,
+                exclude_by_test_metadata=exclude_by_test_metadata,
             ).parse_arguments((*cmd_options, "--runemptysuite", *robot_options_and_args))
 
             settings = RobotSettings(options)
@@ -572,6 +592,29 @@ def handle_options(
         raise UnknownError("Unexpected error happened.")
 
 
+def _show_options(*, default: bool) -> List[Any]:
+    """The flags of `all`, `tests` and `tasks` that add the tags and metadata lines in TEXT mode."""
+    return [
+        click.option(
+            "--show-tags / --no-show-tags",
+            "show_tags",
+            default=default,
+            show_default=True,
+            help="Show the tags that are present.",
+        ),
+        click.option(
+            "--show-metadata / --no-show-metadata",
+            "show_metadata",
+            default=default,
+            show_default=True,
+            # test metadata exists since Robot Framework 7.5
+            cls=RobotVersionOption,
+            since=(7, 5),
+            help="Show the metadata of tests and tasks.",
+        ),
+    ]
+
+
 def _filters_applied(search_substring: Optional[str], search_regex: Optional[str]) -> Optional[Dict[str, str]]:
     if search_substring:
         return {"search": search_substring}
@@ -585,13 +628,7 @@ def _filters_applied(search_substring: Optional[str], search_regex: Optional[str
     add_help_option=True,
     epilog="Use `-- --help` to see `robot` help.",
 )
-@click.option(
-    "--tags / --no-tags",
-    "show_tags",
-    default=True,
-    show_default=True,
-    help="Show the tags that are present.",
-)
+@add_options(*_show_options(default=True))
 @add_options(*ROBOT_OPTIONS)
 @add_options(*DISCOVER_SEARCH_OPTIONS)
 @click.option(
@@ -606,10 +643,13 @@ def all(
     app: Application,
     full_paths: bool,
     show_tags: bool,
+    show_metadata: bool,
     search_substring: Optional[str],
     search_regex: Optional[str],
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     """\
@@ -629,7 +669,13 @@ def all(
 
     matcher = make_search_matcher(search_substring, search_regex)
     _suite, collector, diagnostics = handle_options(
-        app, by_longname, exclude_by_longname, robot_options_and_args, search_matcher=matcher
+        app,
+        by_longname,
+        exclude_by_longname,
+        robot_options_and_args,
+        search_matcher=matcher,
+        by_test_metadata=by_test_metadata,
+        exclude_by_test_metadata=exclude_by_test_metadata,
     )
 
     if collector.all.children:
@@ -639,6 +685,7 @@ def all(
                     collector.all.children[0],
                     collector.statistics,
                     show_tags=show_tags,
+                    show_metadata=show_metadata,
                     full_paths=full_paths,
                     highlight=make_md_highlighter(search_substring, search_regex),
                     search_substring=search_substring,
@@ -666,15 +713,24 @@ def _test_or_tasks(
     app: Application,
     full_paths: bool,
     show_tags: bool,
+    show_metadata: bool,
     search_substring: Optional[str],
     search_regex: Optional[str],
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     matcher = make_search_matcher(search_substring, search_regex)
     _suite, collector, diagnostics = handle_options(
-        app, by_longname, exclude_by_longname, robot_options_and_args, search_matcher=matcher
+        app,
+        by_longname,
+        exclude_by_longname,
+        robot_options_and_args,
+        search_matcher=matcher,
+        by_test_metadata=by_test_metadata,
+        exclude_by_test_metadata=exclude_by_test_metadata,
     )
 
     if collector.all.children:
@@ -685,6 +741,7 @@ def _test_or_tasks(
                     collector.statistics,
                     selected_type=selected_type,
                     show_tags=show_tags,
+                    show_metadata=show_metadata,
                     full_paths=full_paths,
                     highlight=make_md_highlighter(search_substring, search_regex),
                     search_substring=search_substring,
@@ -713,13 +770,7 @@ def _test_or_tasks(
     add_help_option=True,
     epilog="Use `-- --help` to see `robot` help.",
 )
-@click.option(
-    "--tags / --no-tags",
-    "show_tags",
-    default=False,
-    show_default=True,
-    help="Show the tags that are present.",
-)
+@add_options(*_show_options(default=False))
 @click.option(
     "--full-paths / --no-full-paths",
     "full_paths",
@@ -734,10 +785,13 @@ def tests(
     app: Application,
     full_paths: bool,
     show_tags: bool,
+    show_metadata: bool,
     search_substring: Optional[str],
     search_regex: Optional[str],
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     """\
@@ -760,10 +814,13 @@ def tests(
         app,
         full_paths,
         show_tags,
+        show_metadata,
         search_substring,
         search_regex,
         by_longname,
         exclude_by_longname,
+        by_test_metadata,
+        exclude_by_test_metadata,
         robot_options_and_args,
     )
 
@@ -773,13 +830,7 @@ def tests(
     add_help_option=True,
     epilog="Use `-- --help` to see `robot` help.",
 )
-@click.option(
-    "--tags / --no-tags",
-    "show_tags",
-    default=False,
-    show_default=True,
-    help="Show the tags that are present.",
-)
+@add_options(*_show_options(default=False))
 @click.option(
     "--full-paths / --no-full-paths",
     "full_paths",
@@ -794,10 +845,13 @@ def tasks(
     app: Application,
     full_paths: bool,
     show_tags: bool,
+    show_metadata: bool,
     search_substring: Optional[str],
     search_regex: Optional[str],
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     """\
@@ -819,10 +873,13 @@ def tasks(
         app,
         full_paths,
         show_tags,
+        show_metadata,
         search_substring,
         search_regex,
         by_longname,
         exclude_by_longname,
+        by_test_metadata,
+        exclude_by_test_metadata,
         robot_options_and_args,
     )
 
@@ -849,6 +906,8 @@ def suites(
     search_regex: Optional[str],
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     """\
@@ -868,7 +927,13 @@ def suites(
 
     matcher = make_search_matcher(search_substring, search_regex)
     _suite, collector, diagnostics = handle_options(
-        app, by_longname, exclude_by_longname, robot_options_and_args, search_matcher=matcher
+        app,
+        by_longname,
+        exclude_by_longname,
+        robot_options_and_args,
+        search_matcher=matcher,
+        by_test_metadata=by_test_metadata,
+        exclude_by_test_metadata=exclude_by_test_metadata,
     )
 
     if collector.all.children:
@@ -890,7 +955,8 @@ def suites(
         else:
             app.print_data(
                 ResultItem(
-                    collector.suites,
+                    # a flat list: the suites without their nested suites and tests
+                    [dataclasses.replace(suite, children=None) for suite in collector.suites],
                     diagnostics,
                     filters_applied=_filters_applied(search_substring, search_regex),
                     supports_parse_include=SUPPORTS_PARSE_INCLUDE,
@@ -945,6 +1011,8 @@ def tags(
     search_regex: Optional[str],
     by_longname: Tuple[str, ...],
     exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
     robot_options_and_args: Tuple[str, ...],
 ) -> None:
     """\
@@ -965,7 +1033,13 @@ def tags(
 
     matcher = make_search_matcher(search_substring, search_regex)
     _suite, collector, diagnostics = handle_options(
-        app, by_longname, exclude_by_longname, robot_options_and_args, search_matcher=matcher
+        app,
+        by_longname,
+        exclude_by_longname,
+        robot_options_and_args,
+        search_matcher=matcher,
+        by_test_metadata=by_test_metadata,
+        exclude_by_test_metadata=exclude_by_test_metadata,
     )
 
     if collector.all.children:
@@ -995,6 +1069,149 @@ def tags(
             )
 
 
+def _metadata_index(
+    items: Iterable[Tuple[TestItem, Optional[Mapping[str, str]]]],
+) -> Dict[str, Dict[str, List[TestItem]]]:
+    """name → value → items, built from the same entries `--by-test-metadata`
+    matches. Names and values that compare equal are one entry, shown in the
+    first spelling found; both are sorted by their normalised form."""
+    names: Dict[str, Tuple[str, Dict[str, Tuple[str, List[TestItem]]]]] = {}
+    for item, metadata in items:
+        for name, line in metadata_entries(metadata or {}):
+            _name, values = names.setdefault(normalize(name, ignore="_"), (name, {}))
+            _value, value_items = values.setdefault(normalize(line, ignore="_"), (line, []))
+            if not value_items or value_items[-1] is not item:
+                value_items.append(item)
+    return {
+        name: {value: value_items for _, (value, value_items) in sorted(values.items())}
+        for _, (name, values) in sorted(names.items())
+    }
+
+
+@discover.command(
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+    add_help_option=True,
+    epilog="Use `-- --help` to see `robot` help.",
+    # test metadata exists since Robot Framework 7.5
+    cls=RobotVersionCommand,
+    since=(7, 5),
+)
+@click.option(
+    "--values / --no-values",
+    "show_values",
+    default=False,
+    show_default=True,
+    help="Show the values of each metadata name.",
+)
+@click.option(
+    "--tests / --no-tests",
+    "show_tests",
+    default=False,
+    show_default=True,
+    help="Show the tests that have the metadata.",
+)
+@click.option(
+    "--tasks / --no-tasks",
+    "show_tasks",
+    default=False,
+    show_default=True,
+    help="Show the tasks that have the metadata.",
+)
+@click.option(
+    "--suites / --no-suites",
+    "show_suites",
+    default=False,
+    show_default=True,
+    help="Show the suites that have the metadata.",
+)
+@click.option(
+    "--full-paths / --no-full-paths",
+    "full_paths",
+    default=False,
+    show_default=True,
+    help="Show full paths instead of relative.",
+)
+@add_options(*ROBOT_OPTIONS)
+@add_options(*DISCOVER_SEARCH_OPTIONS)
+@pass_application
+def metadata(
+    app: Application,
+    show_values: bool,
+    show_tests: bool,
+    show_tasks: bool,
+    show_suites: bool,
+    full_paths: bool,
+    search_substring: Optional[str],
+    search_regex: Optional[str],
+    by_longname: Tuple[str, ...],
+    exclude_by_longname: Tuple[str, ...],
+    by_test_metadata: Tuple[str, ...],
+    exclude_by_test_metadata: Tuple[str, ...],
+    robot_options_and_args: Tuple[str, ...],
+) -> None:
+    """\
+    Discover the metadata of tests, tasks and suites with the selected
+    configuration, profiles, options and arguments.
+
+    Test and task metadata is what `--by-test-metadata` selects by; suite
+    metadata, including `--metadata` given to Robot, is listed in its own
+    section.
+
+    \b
+    Examples:
+    ```
+    robotcode discover metadata
+    robotcode discover metadata --values --tests
+    robotcode --format json discover metadata
+    ```
+    """
+
+    matcher = make_search_matcher(search_substring, search_regex)
+    _suite, collector, diagnostics = handle_options(
+        app,
+        by_longname,
+        exclude_by_longname,
+        robot_options_and_args,
+        search_matcher=matcher,
+        by_test_metadata=by_test_metadata,
+        exclude_by_test_metadata=exclude_by_test_metadata,
+    )
+
+    if collector.all.children:
+        test_metadata = _metadata_index((item, item.metadata) for item in collector.test_and_tasks)
+        suite_metadata = _metadata_index(collector.suite_metadata)
+
+        if app.config.output_format is None or app.config.output_format == OutputFormat.TEXT:
+            app.echo_as_markdown(
+                _render.render_metadata(
+                    test_metadata,
+                    suite_metadata,
+                    collector.statistics,
+                    show_values=show_values,
+                    show_tests=show_tests,
+                    show_tasks=show_tasks,
+                    show_suites=show_suites,
+                    full_paths=full_paths,
+                    highlight=make_md_highlighter(search_substring, search_regex),
+                    search_substring=search_substring,
+                    search_regex=search_regex,
+                    diagnostics=diagnostics,
+                    show_diagnostics=app.show_diagnostics,
+                    root_folder=app.root_folder,
+                )
+            )
+
+        else:
+            app.print_data(
+                MetadataResult(
+                    test_metadata,
+                    suite_metadata,
+                    filters_applied=_filters_applied(search_substring, search_regex),
+                ),
+                remove_defaults=True,
+            )
+
+
 @discover.command(add_help_option=True)
 @pass_application
 def info(app: Application) -> None:
@@ -1086,8 +1303,10 @@ def files(
     # Match the other discover subcommands: chdir into root_folder so
     # `get_rel_source` produces paths relative to the project root rather
     # than to whatever the caller's process cwd happens to be.
-    with app.chdir(root_folder):
-        search_paths = set(
+    with app.chdir(root_folder) as orig_folder:
+        # Without duplicates, in the given order: the files come out in the order of the paths. Paths from the
+        # command line count from the folder the command was started in, the configured ones from the root.
+        search_paths = dict.fromkeys(
             (
                 (
                     [*(app.config.default_paths if app.config.default_paths else ())]
@@ -1097,7 +1316,7 @@ def files(
                     else [profile.paths]
                 )
                 if not paths
-                else [str(p) for p in paths]
+                else [str(p if orig_folder is None else Path(orig_folder, p)) for p in paths]
             )
         )
         if not search_paths:

robotcode/runner/cli/libdoc.py

@@ -6,6 +6,7 @@ from robot.libdoc import USAGE, LibDoc
 from robot.version import get_full_version
 
 from robotcode.plugin import Application, pass_application
+from robotcode.plugin.click_helper.exit_codes import robot_exit_codes
 from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import LibDocProfile
 from robotcode.robot.config.utils import get_config_files
@@ -35,6 +36,7 @@ class LibDocEx(LibDoc):
         return super().main(arguments, **options)
 
 
+@robot_exit_codes
 @click.command(
     context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
     add_help_option=True,
@@ -80,11 +82,11 @@ def libdoc(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         except (TypeError, ValueError) as e:
             raise click.ClickException(str(e)) from e
 
-        libdoc_options = profile.libdoc
-        if libdoc_options is None:
-            libdoc_options = LibDocProfile()
-
-        libdoc_options.add_options(profile)
+        # Of the settings outside of `[libdoc]`, only `python-path` means the same for `libdoc`; `name` and `quiet`
+        # there are `robot` options. `[libdoc]` comes last, so it wins and its `extend-` settings add to it.
+        libdoc_options = LibDocProfile(python_path=profile.python_path)
+        if profile.libdoc is not None:
+            libdoc_options.add_options(profile.libdoc)
 
         options = libdoc_options.build_command_line()
 

robotcode/runner/cli/rebot.py

@@ -7,6 +7,7 @@ from robot.rebot import USAGE, Rebot
 from robot.version import get_full_version
 
 from robotcode.plugin import Application, pass_application
+from robotcode.plugin.click_helper.exit_codes import robot_exit_codes
 from robotcode.robot.config.loader import load_robot_config_from_path
 from robotcode.robot.config.model import RebotProfile
 from robotcode.robot.config.utils import get_config_files
@@ -14,6 +15,25 @@ from robotcode.robot.utils import RF_VERSION
 
 from ..__version__ import __version__
 
+# The settings that Robot Framework does not pass from `robot` to `rebot` after a run (`not_copied` in
+# `RobotSettings.get_rebot_settings`).
+NOT_PASSED_TO_REBOT = (
+    "includes",
+    "excludes",
+    "tests",
+    "suites",
+    "parse_include",
+    "name",
+    "doc",
+    "metadata",
+    "set_tag",
+    "output",
+    "log_level",
+    "timestamp_outputs",
+    "console",
+    "quiet",
+)
+
 
 class RebotEx(Rebot):
     def __init__(self, dry: bool) -> None:
@@ -27,7 +47,7 @@ class RebotEx(Rebot):
             line_end = "\n"
             raise Information(
                 "Dry run, not executing any commands. "
-                f"Would execute libdoc with the following options and arguments:\n"
+                f"Would execute rebot with the following options and arguments:\n"
                 f"{line_end.join((*(f'{k} = {v!r}' for k, v in options.items()), *arguments))}"
             )
 
@@ -37,6 +57,7 @@ class RebotEx(Rebot):
         return super().main(datasources, **options)
 
 
+@robot_exit_codes
 @click.command(
     context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
     add_help_option=True,
@@ -82,11 +103,17 @@ def rebot(app: Application, robot_options_and_args: Tuple[str, ...]) -> None:
         except (TypeError, ValueError) as e:
             raise click.ClickException(str(e)) from e
 
-        rebot_options = profile.rebot
-        if rebot_options is None:
-            rebot_options = RebotProfile()
-
+        # Of the settings outside of `[rebot]`, `rebot` gets the ones that Robot Framework passes to it after a
+        # run; `[rebot]` comes last, so it wins and its `extend-` settings add to them.
+        rebot_options = RebotProfile()
         rebot_options.add_options(profile)
+        for name in NOT_PASSED_TO_REBOT:
+            setattr(rebot_options, name, None)
+        # as Robot Framework does, `run-empty-suite` becomes `process-empty-suite`
+        if profile.run_empty_suite is not None:
+            rebot_options.process_empty_suite = profile.run_empty_suite
+        if profile.rebot is not None:
+            rebot_options.add_options(profile.rebot)
 
         try:
             options = rebot_options.build_command_line()

robotcode/runner/cli/results/_models.py

@@ -76,6 +76,7 @@ class TestResultItem(CamelSnakeMixin):
     message: str
     full_message: Optional[str] = None
     tags: Optional[List[str]] = None
+    metadata: Optional[Dict[str, str]] = None
     elapsed_seconds: Optional[float] = None
     start_time: Optional[str] = None
     source: Optional[str] = None
@@ -152,6 +153,9 @@ class LogTest(CamelSnakeMixin):
     # suite. Lets the TEXT renderer group tests under suite headers and
     # JSON consumers cross-reference `LogResult.suites`.
     suite: Optional[str] = None
+    # The test's `[Metadata]` (Robot Framework 7.5+), same shape as
+    # `LogSuite.metadata`.
+    metadata: Optional[Dict[str, str]] = None
 
 
 @dataclass

robotcode/runner/cli/results/_render.py

@@ -29,6 +29,7 @@ from .._markdown import (
     make_md_highlighter,
     md_escape,
     md_table,
+    metadata_md,
     path_paren,
     timing_suffix,
 )
@@ -51,7 +52,8 @@ from ._models import (
 # `show`); `LogTest` is the `log`-specific record carrying a body tree.
 # Both expose the fields the per-test renderers need (`full_name`,
 # `status`, `message`, `source`, `rel_source`, `lineno`, `elapsed_seconds`,
-# `start_time`), so we treat them interchangeably at the renderer level.
+# `start_time`, `metadata`), so we treat them interchangeably at the renderer
+# level.
 _TestLike = Union[TestResultItem, LogTest]
 
 _LEVEL_ORDER = {"TRACE": 0, "DEBUG": 1, "INFO": 2, "WARN": 3, "ERROR": 4, "FAIL": 5}
@@ -172,6 +174,7 @@ def render_show(
     data: ShowResult,
     *,
     show_tags: bool,
+    show_metadata: bool = False,
     full_paths: bool = False,
     show_timing: bool = False,
     sort_field: Optional[str] = None,
@@ -197,6 +200,8 @@ def render_show(
         if show_tags and t.tags:
             tags = ", ".join(highlight_md(md_escape(tag), highlight) for tag in t.tags)
             out.append(f"  - _Tags:_ {tags}")
+        if show_metadata and t.metadata:
+            out.append(f"  - _Metadata:_ {metadata_md(t.metadata, highlight)}")
 
     if data.truncated:
         out.append("")
@@ -490,6 +495,9 @@ def _test_header_md(
     head += _source_paren(t, full_paths=full_paths)
     head += f" {bold_status(t.status)}"
     head += timing_suffix(t.elapsed_seconds, t.start_time, show_timing=show_timing)
+    if t.metadata:
+        # a paragraph, not a list: a list would merge with the list of the test body below
+        head += f"\n\n_Metadata:_ {metadata_md(t.metadata, highlight)}"
     return head