Adjust --fail-on-flaky behavior to improve exit status handling (#288)

Author: ricardo-passthrough

CHANGES.rst

@@ -4,7 +4,12 @@ Changelog
 15.1 (unreleased)
 -----------------
 
-- Nothing changed yet.
+Bug fixes
++++++++++
+
+- Fix ``--fail-on-flaky`` option to fail the test run with custom exit code
+  only when reruns are detected.
+  (`#287 <https://github.com/pytest-dev/pytest-rerunfailures/issues/287>`_)
 
 
 15.0 (2024-11-20)

src/pytest_rerunfailures.py

@@ -629,5 +629,10 @@ def pytest_sessionfinish(session, exitstatus):
         return
 
     if session.config.option.fail_on_flaky:
-        if session.config.getvalue("reruns") > 0:
-            session.exitstatus = 7
+        for item in session.items:
+            if not hasattr(item, "execution_count"):
+                # no rerun requested
+                continue
+            if item.execution_count > 1:
+                session.exitstatus = 7
+                break

tests/test_pytest_rerunfailures.py

@@ -199,6 +199,63 @@ def test_run_fails_with_code_1_after_consistent_test_failure_even_with_fail_on_f
     assert result.ret == 1
 
 
+def test_run_mark_and_fail_on_flaky_fails_with_custom_error_code_after_pass_on_rerun(
+    testdir,
+):
+    testdir.makepyfile(f"""
+        import pytest
+
+        @pytest.mark.flaky(reruns=1)
+        def test_fail():
+            {temporary_failure()}
+    """)
+    result = testdir.runpytest("--fail-on-flaky")
+    assert_outcomes(result, passed=1, rerun=1)
+    assert result.ret == 7
+
+
+def test_run_fails_with_code_1_after_test_failure_with_fail_on_flaky_and_mark(
+    testdir,
+):
+    testdir.makepyfile("""
+        import pytest
+
+        @pytest.mark.flaky(reruns=2)
+        def test_fail():
+            assert False
+    """)
+    result = testdir.runpytest("--fail-on-flaky")
+    assert_outcomes(result, passed=0, failed=1, rerun=2)
+    assert result.ret == 1
+
+
+def test_run_with_mark_and_fail_on_flaky_succeeds_if_all_tests_pass_without_reruns(
+    testdir,
+):
+    testdir.makepyfile("""
+        import pytest
+
+        @pytest.mark.flaky(reruns=2)
+        def test_marked_pass():
+            assert True
+
+        def test_unmarked_pass():
+            assert True
+    """)
+    result = testdir.runpytest("--fail-on-flaky")
+    assert_outcomes(result, passed=2, rerun=0)
+    assert result.ret == pytest.ExitCode.OK
+
+
+def test_run_with_fail_on_flaky_succeeds_if_all_tests_pass_without_reruns(
+    testdir,
+):
+    testdir.makepyfile("def test_pass(): assert True")
+    result = testdir.runpytest("--reruns", "1", "--fail-on-flaky")
+    assert_outcomes(result, passed=1, rerun=0)
+    assert result.ret == pytest.ExitCode.OK
+
+
 @pytest.mark.skipif(not has_xdist, reason="requires xdist with crashitem")
 def test_rerun_passes_after_temporary_test_crash(testdir):
     # note: we need two tests because there is a bug where xdist