Add option to avoid capturing logs for passed tests (#41)

Fix #39

Author: cj-timothy-sampson

CHANGELOG.rst

@@ -1,8 +1,9 @@
 Next (tbd)
 -------------------
 
-* `#16 <https://github.com/pytest-dev/pytest-reportlog/issues/15>`_: switch recommended file extension to `jsonl <https://jsonlines.org/>`__.
+* `#15 <https://github.com/pytest-dev/pytest-reportlog/issues/15>`_: switch recommended file extension to `jsonl <https://jsonlines.org/>`__.
 * `#17 <https://github.com/pytest-dev/pytest-reportlog/issues/17>`_: add compression support for ``.bz2``/``.gz``/``.xz`` log file extensions.
+* `#39 <https://github.com/pytest-dev/pytest-reportlog/issues/39>`_: new ``--report-log-exclude-logs-on-passed-tests`` option allows not capturing logs of passing tests.
 
 
 0.3.0 (2023-04-26)

src/pytest_reportlog/plugin.py

@@ -15,6 +15,12 @@ def pytest_addoption(parser):
         default=None,
         help="Path to line-based json objects of test session events.",
     )
+    group.addoption(
+        "--report-log-exclude-logs-on-passed-tests",
+        action="store_true",
+        default=False,
+        help="Don't capture logs for passing tests",
+    )
 
 
 def pytest_configure(config):
@@ -83,6 +89,21 @@ def pytest_runtest_logreport(self, report):
         data = self._config.hook.pytest_report_to_serializable(
             config=self._config, report=report
         )
+        if (
+            self._config.option.report_log_exclude_logs_on_passed_tests
+            and data.get("outcome", "") == "passed"
+        ):
+            data["sections"] = [
+                s
+                for s in data["sections"]
+                if s[0]
+                not in [
+                    "Captured log setup",
+                    "Captured log call",
+                    "Captured log teardown",
+                ]
+            ]
+
         self._write_json_data(data)
 
     def pytest_warning_recorded(self, warning_message, when, nodeid, location):

tests/test_reportlog.py

@@ -105,6 +105,43 @@ def test_warning():
         assert isinstance(rep, BaseReport)
 
 
+@pytest.mark.parametrize(
+    "exclude", [True, False], ids=["exclude on pass", "include logs on pass"]
+)
+def test_exclude_logs_for_passing_tests(testdir, tmp_path, exclude):
+    passing_log_entry = "THIS TEST PASSED!"
+    failing_log_entry = "THIS TEST FAILED!"
+    testdir.makepyfile(
+        f"""
+        import logging
+
+        logger = logging.getLogger(__name__)
+
+        def test_ok():
+            logger.warning("{passing_log_entry}")
+
+        def test_fail():
+            logger.warning("{failing_log_entry}")
+            assert 0
+        """
+    )
+    fn = tmp_path / "result.log"
+    if exclude:
+        result = testdir.runpytest(
+            f"--report-log={fn}", "--report-log-exclude-logs-on-passed-tests"
+        )
+    else:
+        result = testdir.runpytest(f"--report-log={fn}")
+    result.stdout.fnmatch_lines("*1 failed, 1 passed*")
+
+    log = fn.read_text("UTF-8")
+    if exclude:
+        assert passing_log_entry not in log
+    else:
+        assert passing_log_entry in log
+    assert failing_log_entry in log
+
+
 def test_xdist_integration(testdir, tmp_path):
     pytest.importorskip("xdist")
     testdir.makepyfile(