Add optional condition to marker

Author: BeyondEvil

CHANGES.rst

@@ -15,6 +15,9 @@ Other changes
 - Check for the resultlog by feature and not by version as pytest master does
   not provide a consistent version.
 
+- Add ``condition`` keyword argument to the re-run marker. (Thanks to `@BeyondEvil`_ for the PR)
+
+.. _@BeyondEvil: https://github.com/BeyondEvil
 
 9.1.1 (2020-09-29)
 ------------------

README.rst

@@ -99,6 +99,17 @@ You can also specify the re-run delay time in the marker:
       import random
       assert random.choice([True, False])
 
+You can also specify an optional ``condition`` in the re-run marker:
+
+.. code-block:: python
+
+   @pytest.mark.flaky(reruns=5, condition=sys.platform.startswith("win32"))
+   def test_example():
+      import random
+      assert random.choice([True, False])
+
+Note that the test will re-run for any ``condition`` that is truthy.
+
 Output
 ------
 

pytest_rerunfailures.py

@@ -175,6 +175,16 @@ def get_reruns_delay(item):
     return delay
 
 
+def get_reruns_condition(item):
+    rerun_marker = _get_marker(item)
+
+    condition = True
+    if rerun_marker is not None and "condition" in rerun_marker.kwargs:
+        condition = rerun_marker.kwargs["condition"]
+
+    return condition
+
+
 def _remove_cached_results_from_failed_fixtures(item):
     """
     Note: remove all cached_result attribute from every fixture
@@ -221,6 +231,19 @@ def _should_hard_fail_on_error(session_config, report):
     return True
 
 
+def _should_not_rerun(item, report, reruns):
+    xfail = hasattr(report, "wasxfail")
+    is_terminal_error = _should_hard_fail_on_error(item.session.config, report)
+    condition = get_reruns_condition(item)
+    return (
+        item.execution_count > reruns
+        or not report.failed
+        or xfail
+        or is_terminal_error
+        or not condition
+    )
+
+
 def pytest_runtest_protocol(item, nextitem):
     """
     Note: when teardown fails, two reports are generated for the case, one for
@@ -247,15 +270,8 @@ def pytest_runtest_protocol(item, nextitem):
         reports = runtestprotocol(item, nextitem=nextitem, log=False)
 
         for report in reports:  # 3 reports: setup, call, teardown
-            is_terminal_error = _should_hard_fail_on_error(item.session.config, report)
             report.rerun = item.execution_count - 1
-            xfail = hasattr(report, "wasxfail")
-            if (
-                item.execution_count > reruns
-                or not report.failed
-                or xfail
-                or is_terminal_error
-            ):
+            if _should_not_rerun(item, report, reruns):
                 # last run or no failure detected, log normally
                 item.ihook.pytest_runtest_logreport(report=report)
             else:

test_pytest_rerunfailures.py

@@ -32,7 +32,7 @@ def check_outcome_field(outcomes, field_name, expected_value):
 
 
 def assert_outcomes(
-    result, passed=1, skipped=0, failed=0, error=0, xfailed=0, xpassed=0, rerun=0,
+    result, passed=1, skipped=0, failed=0, error=0, xfailed=0, xpassed=0, rerun=0
 ):
     outcomes = result.parseoutcomes()
     check_outcome_field(outcomes, "passed", passed)
@@ -511,3 +511,35 @@ def test_only_rerun_flag(testdir, only_rerun_texts, should_rerun):
     assert_outcomes(
         result, passed=num_passed, failed=num_failed, rerun=num_reruns_actual
     )
+
+
+@pytest.mark.parametrize(
+    "condition, expected_reruns",
+    [
+        (1 == 1, 2),
+        (1 == 2, 0),
+        (True, 2),
+        (False, 0),
+        (1, 2),
+        (0, 0),
+        ("'non-empty'", 2),
+        ("''", 0),
+        (["list"], 2),
+        ([], 0),
+        ({"dict": 1}, 2),
+        ({}, 0),
+        (None, 0),
+    ],
+)
+def test_reruns_with_condition_marker(testdir, condition, expected_reruns):
+    testdir.makepyfile(
+        f"""
+        import pytest
+
+        @pytest.mark.flaky(reruns=2, condition={condition})
+        def test_fail_two():
+            assert False"""
+    )
+
+    result = testdir.runpytest()
+    assert_outcomes(result, passed=0, failed=1, rerun=expected_reruns)