Run teardown once after reruns (#205)

Author: lukasNebr

CHANGES.rst

@@ -4,6 +4,11 @@ Changelog
 11.1 (unreleased)
 -----------------
 
+Bug fixes
++++++++++
+
+- Run teardown of session, class, ... scoped fixtures only once after rerunning tests
+
 Features
 ++++++++
 

pytest_rerunfailures.py

@@ -12,6 +12,7 @@
 
 import pytest
 from _pytest.outcomes import fail
+from _pytest.python import Function
 from _pytest.runner import runtestprotocol
 from packaging.version import parse as parse_version
 
@@ -505,6 +506,40 @@ def _get(self, i: str, k: str) -> int:
         return int(self._sock_recv(self.sock))
 
 
+def pytest_runtest_teardown(item, nextitem):
+    reruns = get_reruns_count(item)
+    if reruns is None:
+        # global setting is not specified, and this test is not marked with
+        # flaky
+        return
+
+    # teardown when test not failed or rerun limit exceeded
+    if item.execution_count > reruns or getattr(item, "test_failed", None) is False:
+        item.teardown()
+    else:
+        # clean cashed results from any level of setups
+        _remove_cached_results_from_failed_fixtures(item)
+
+        if PYTEST_GTE_63:
+            for key in list(item.session._setupstate.stack.keys()):
+                if type(key) != Function:
+                    del item.session._setupstate.stack[key]
+        else:
+            for node in list(item.session._setupstate.stack):
+                if type(node) != Function:
+                    item.session._setupstate.stack.remove(node)
+
+        item.teardown()
+
+
+@pytest.hookimpl(hookwrapper=True)
+def pytest_runtest_makereport(item, call):
+    outcome = yield
+    result = outcome.get_result()
+    if call.when == "call":
+        item.test_failed = result.failed
+
+
 def pytest_runtest_protocol(item, nextitem):
     """
     Run the test protocol.

test_pytest_rerunfailures.py

@@ -701,3 +701,91 @@ def test_foo():
 
     time.sleep.assert_called_with(5)
     assert_outcomes(result, passed=0, failed=1, rerun=4)
+
+
+def test_run_session_teardown_once_after_reruns(testdir):
+    testdir.makepyfile(
+        """
+        import logging
+        import pytest
+
+        @pytest.fixture(scope='session')
+        def session_fixture():
+            logging.info('session setup')
+            yield
+            logging.info('session teardown')
+
+        @pytest.fixture(scope='class')
+        def class_fixture():
+            logging.info('class setup')
+            yield
+            logging.info('class teardown')
+
+        @pytest.fixture(scope='function')
+        def function_fixture():
+            logging.info('function setup')
+            yield
+            logging.info('function teardown')
+
+        class TestFoo:
+            @staticmethod
+            def test_foo_1(session_fixture, class_fixture, function_fixture):
+                pass
+
+            @staticmethod
+            def test_foo_2(session_fixture, class_fixture, function_fixture):
+                assert False
+
+        class TestBar:
+            @staticmethod
+            def test_bar_1(session_fixture, class_fixture, function_fixture):
+                assert False
+
+            @staticmethod
+            def test_bar_2(session_fixture, class_fixture, function_fixture):
+                assert False
+
+            @staticmethod
+            def test_bar_3(session_fixture, class_fixture, function_fixture):
+                pass"""
+    )
+    import logging
+
+    logging.info = mock.MagicMock()
+
+    result = testdir.runpytest("--reruns", "2")
+    expected_calls = [
+        mock.call("session setup"),
+        # class TestFoo
+        mock.call("class setup"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("class teardown"),
+        # class TestBar
+        mock.call("class setup"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("function setup"),
+        mock.call("function teardown"),
+        mock.call("class teardown"),
+        mock.call("session teardown"),
+    ]
+
+    logging.info.assert_has_calls(expected_calls, any_order=False)
+    assert_outcomes(result, failed=3, passed=2, rerun=6)