make the console work properly

README.md

@@ -154,6 +154,8 @@ running tests in parallel using [pytest-xdist](https://pytest-xdist.readthedocs.
 
 # config
 
+pass `--capture=no` to make `logger.console` work properly. 
+
 since this is a pytest plugin, you should avoid using robot options that have pytest equivalents:
 
 | instead of...                           | use...                                | notes                                                                                                                                                   |

pytest_robotframework/_internal/pytest/plugin.py

@@ -2,8 +2,12 @@
 
 from __future__ import annotations
 
+import contextlib
+import os
+import urllib.parse
 from ast import Assert, Call, Constant, Expr, If, Raise, copy_location, stmt
 from pathlib import Path
+from typing import IO
 
 import pytest
 from _pytest.assertion import rewrite
@@ -15,6 +19,7 @@
 from _pytest.main import resolve_collection_argument
 from pytest import (
     Collector,
+    Config,
     StashKey,
     TempPathFactory,
     TestReport,
@@ -81,6 +86,7 @@
 if TYPE_CHECKING:
     from types import TracebackType
 
+    from _pytest.terminal import TerminalReporter
     from pluggy import PluginManager
     from pytest import CallInfo, Item, Parser, Session
 
@@ -314,6 +320,7 @@ def _robot_collect(session: Session):
         "exitonerror": True,
         "prerunmodifier": [RobotSuiteCollector(session)],
         "listener": None,
+        "console": "quiet",
     }
     _run_robot(session, robot_options)
 
@@ -436,53 +443,67 @@ def option_names(settings: Mapping[str, tuple[str, object]]) -> list[str]:
             # if there were no outputs there were probably no tests run or some other error occured,
             # so silently skip this
             if outputs:
-                rebot = Rebot()
-                # if tests from different suites were run, the top level suite can have a different
-                # name. rebot will refuse to merge if the top level suite names don't match, so we
-                # need to set them all to the same name before merging them.
-                if len(outputs) > 1:
-                    merged_suite_name = cast(str, ExecutionResult(*outputs).suite.name)  # pyright:ignore[reportUnknownMemberType]
-                    for output in outputs:
-                        _ = cast(int, rebot.main([output], output=output, name=merged_suite_name))  # pyright:ignore[reportUnknownMemberType]
-                rebot_options = merge_robot_options(
-                    {
-                        # rebot doesn't recreate the output.xml unless you sepecify it
-                        # explicitly. we want to do this because our usage of rebot is an
-                        # implementation detail and we want the output to appear the same
-                        # regardless of whether the user is running with xdist
-                        "output": "output.xml"
-                    },
-                    {
-                        # filter out any robot args that aren't valid rebot args
-                        key: value
-                        for key, value in robot_args.items()
-                        if key
-                        in option_names(
-                            RebotSettings._extra_cli_opts  # pyright:ignore[reportPrivateUsage]
-                        )
-                        or key
-                        in option_names(
-                            _BaseSettings._cli_opts  # pyright:ignore[reportPrivateUsage,reportUnknownArgumentType,reportUnknownMemberType]
-                        )
-                    },
-                )
 
-                # we need to always set the loglevel to TRACE, despite whatever it was set to
-                # when running robot. otherwise if the loglevel was changed to DEBUG or TRACE
-                # programmatically inside a test, they would not appear in the merged output
-                log_level_value = robot_args["loglevel"]
-                default_log_level = (
-                    log_level_value.split(":")[1] if ":" in log_level_value else "INFO"
-                )
-                rebot_options["loglevel"] = f"TRACE:{default_log_level}"
-
-                _ = rebot.main(  # pyright:ignore[reportUnknownVariableType,reportUnknownMemberType]
-                    outputs,
-                    # merge is deliberately specified here instead of in the merged dict because it
-                    # should never be overwritten
-                    merge=True,
-                    **rebot_options,
-                )
+                def redirector(file: IO[str]) -> contextlib._RedirectStream[IO[str]]:  # pyright: ignore[reportPrivateUsage]
+                    # Here we create a jenkem huffer because you can't control rebots console output
+                    #  Rebot uses __stdout__, which doesn't have an implementation in contextlib
+                    result = contextlib._RedirectStream(file)  # pyright: ignore[reportPrivateUsage]
+                    result._stream = "__stdout__"  # pyright: ignore[reportAttributeAccessIssue]
+                    return result
+
+                with Path(os.devnull).open("w", encoding="UTF8") as devull, redirector(devull):
+                    rebot = Rebot()
+                    # if tests from different suites were run, the top level suite can have a
+                    # different name. rebot will refuse to merge if the top level suite names
+                    # don't match, so we need to set them all to the same name before merging them.
+                    if len(outputs) > 1:
+                        merged_suite_name = cast(str, ExecutionResult(*outputs).suite.name)  # pyright:ignore[reportUnknownMemberType]
+                        for output in outputs:
+                            _ = cast(
+                                int,
+                                rebot.main(  # pyright:ignore[reportUnknownMemberType]
+                                    [output], output=output, name=merged_suite_name, stdout=None
+                                ),
+                            )
+                    rebot_options = merge_robot_options(
+                        {
+                            # rebot doesn't recreate the output.xml unless you sepecify it
+                            # explicitly. we want to do this because our usage of rebot is an
+                            # implementation detail and we want the output to appear the same
+                            # regardless of whether the user is running with xdist
+                            "output": "output.xml"
+                        },
+                        {
+                            # filter out any robot args that aren't valid rebot args
+                            key: value
+                            for key, value in robot_args.items()
+                            if key
+                            in option_names(
+                                RebotSettings._extra_cli_opts  # pyright:ignore[reportPrivateUsage]
+                            )
+                            or key
+                            in option_names(
+                                _BaseSettings._cli_opts  # pyright:ignore[reportPrivateUsage,reportUnknownArgumentType,reportUnknownMemberType]
+                            )
+                        },
+                    )
+
+                    # we need to always set the loglevel to TRACE, despite whatever it was set to
+                    # when running robot. otherwise if the loglevel was changed to DEBUG or TRACE
+                    # programmatically inside a test, they would not appear in the merged output
+                    log_level_value = robot_args["loglevel"]
+                    default_log_level = (
+                        log_level_value.split(":")[1] if ":" in log_level_value else "INFO"
+                    )
+                    rebot_options["loglevel"] = f"TRACE:{default_log_level}"
+
+                    _ = rebot.main(  # pyright:ignore[reportUnknownVariableType,reportUnknownMemberType]
+                        outputs,
+                        # merge is deliberately specified here instead of in the merged dict because
+                        # it should never be overwritten
+                        merge=True,
+                        **rebot_options,
+                    )
             else:
                 # this means robot was never run in any of the workers because there was no items,
                 # so we run it here to generate an empty log file to be consistent with what would
@@ -630,6 +651,16 @@ def pytest_runtest_protocol(item: Item):
     return None
 
 
+@hookimpl(tryfirst=True)
+def pytest_terminal_summary(terminalreporter: TerminalReporter, config: Config):
+    log_file = str(config.rootpath / cast(str, config.option.robot_log))  # pyright: ignore[reportAny]
+    log_uri = "file:///" + urllib.parse.quote(log_file.replace("\\", "/"), safe="/:")
+    terminalreporter.line("")
+    terminalreporter.line("Robot Framework Output Files:", bold=True)
+    terminalreporter.line(f"Log: {log_file}")
+    terminalreporter.line(f"Log URI: {log_uri}")
+
+
 @patch_method(ErrorDetails)
 def _is_robot_traceback(  # pyright: ignore[reportUnusedFunction]
     _old_method: object, _self: ErrorDetails, tb: TracebackType

pytest_robotframework/_internal/robot/utils.py

@@ -20,7 +20,7 @@
 from pytest import Item, Session, StashKey
 from robot import model, running
 from robot.api.interfaces import ListenerV2, ListenerV3, Parser
-from robot.conf.settings import _BaseSettings  # pyright:ignore[reportPrivateUsage]
+from robot.conf.settings import RobotSettings, _BaseSettings  # pyright:ignore[reportPrivateUsage]
 from robot.running.context import _ExecutionContext  # pyright:ignore[reportPrivateUsage]
 from robot.version import VERSION
 from typing_extensions import override
@@ -98,6 +98,8 @@ class RobotOptions(TypedDict):
     prerebotmodifier: list[str | model.SuiteVisitor]
     randomize: Literal["ALL", "SUITES", "TESTS", "NONE"]
     console: Literal["verbose", "dotted", "quiet", "none"]
+    """the default in robot is `"verbose", however pytest-robotframework changes the default to
+    `"quiet"`, if you change this, then pytest and robot outputs will overlap."""
     dotted: bool
     quiet: bool
     consolewidth: int
@@ -241,6 +243,8 @@ def cli_defaults(settings_class: Callable[[dict[str, object]], _BaseSettings]) -
     # the cwd gets updated, robot will still run with the outdated cwd.
     # we set it in this wacky way to make sure it never overrides user preferences
     _BaseSettings._cli_opts["OutputDir"] = ("outputdir", ".")  # pyright:ignore[reportUnknownMemberType,reportPrivateUsage]
+    # Need to set this so that there aren't two competing frameworks dumping into the console
+    RobotSettings._extra_cli_opts["ConsoleType"] = ("console", "quiet")  # pyright:ignore[reportUnknownMemberType,reportPrivateUsage,reportArgumentType]
     # https://github.com/DetachHead/basedpyright#note-about-casting-with-typeddicts
     return cast(  # pyright:ignore[reportInvalidCast]
         RobotOptions,

tests/fixtures/test_python/test_console_output.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+
+def test_amongus():
+    pass

tests/fixtures/test_python/test_console_summary.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from robot.api import logger
+
+
+def test_amongus():
+    logger.console("\nI'm console 🚽")
+    logger.warn("I'm warning")
+
+
+def test_amongus2():
+    logger.console("\nI'm console 🚽")
+    logger.warn("I'm warning")

tests/test_python.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import os
+import re
 from pathlib import Path
 from re import search
 from typing import TYPE_CHECKING, List, cast
@@ -884,3 +886,39 @@ def test_class_three_tests_one_fail(pr: PytestRobotTester):
     """this test is for an xdist issue. needs to have one more tests than there are workers"""
     pr.run_and_assert_result(passed=2, failed=1)
     pr.assert_log_file_exists()
+
+
+def test_console_summary(pr: PytestRobotTester):
+    result = pr.run_pytest(subprocess=True)
+    sep = re.escape(os.sep)
+    assert re.search(
+        f"""
+Robot Framework Output Files:
+Log: .*{sep}test_console_summary0{sep}log.html
+Log URI: .*/test_console_summary0/log.html
+""",
+        "\n".join(result.outlines),
+    )
+
+
+def test_console_output(pr: PytestRobotTester):
+    if pr.xdist:
+        result = pr.run_pytest("--capture=no", subprocess=True)
+        assert "Output:" not in "\n".join(result.outlines)
+    else:
+        result = pr.run_pytest("--collect-only", subprocess=True)
+        assert "0 tests, 0 passed, 0 failed" not in result.outlines
+        assert "Output:  None" not in result.outlines
+
+        result = pr.run_pytest("--capture=no", "--collect-only", subprocess=True)
+        assert "0 tests, 0 passed, 0 failed" not in result.outlines
+        assert "Output:  None" not in result.outlines
+
+        result = pr.run_pytest("--capture=no", subprocess=True)
+        assert "I'm console 🚽" in result.outlines
+        assert "[ WARN ] I'm warning" in result.errlines
+
+        result = pr.run_pytest(
+            "--quiet", "--capture=no", "--robot-console=verbose", subprocess=True
+        )
+        assert "Output:  output.xml" in result.outlines