Make pytest-odoo compatible with pytest-subtests

Author: petrus-v

README.rst

@@ -53,3 +53,5 @@ You can use the ``ODOO_RC`` environment variable using an odoo configuration fil
 
 The plugin is also compatible with distributed run provided by the `pytest-xdist <https://pypi.org/project/pytest-xdist/>`_ library. When tests are distributed, a copy of the database is created for each worker at the start of the test session.
 This is useful to avoid concurrent access to the same database, which can lead to deadlocks. The provided database is therefore used only as template. At the end of the tests, all the created databases are dropped.
+
+The plugin is also compatible with `pytest-subtests <https://pypi.org/project/pytest-subtests/>`_ library. When test use the `subTest` context manager you'll get a nice output for each sub-tests failing.

pytest_odoo.py

@@ -88,8 +88,8 @@ def pytest_cmdline_main(config):
             raise Exception(
                 "please provide a database name in the Odoo configuration file"
             )
-        disable_odoo_test_retry()
         support_subtest()
+        disable_odoo_test_retry()
         monkey_patch_resolve_pkg_root_and_module_name()
         odoo.service.server.start(preload=[], stop=True)
         # odoo.service.server.start() modifies the SIGINT signal by its own
@@ -106,7 +106,6 @@ def pytest_cmdline_main(config):
     else:
         yield
 
-
 @pytest.fixture(scope="module", autouse=True)
 def load_http(request):
     if request.config.getoption("--odoo-http"):
@@ -203,6 +202,22 @@ def resolve_pkg_root_and_module_name(
     _pytest.pathlib.resolve_pkg_root_and_module_name= resolve_pkg_root_and_module_name
 
 
+def support_subtest():
+    """Odoo from version 16.0 re-define its own TestCase.subTest context manager
+
+    Odoo assume the usage of OdooTestResult which is not our case
+    using with pytest-odoo. So this fallback to the unitest.TestCase.subTest
+    Context manager
+    """        
+    try:
+        from odoo.tests.case import TestCase
+        TestCase.subTest = UnitTestTestCase.subTest
+        TestCase.run = UnitTestTestCase.run
+    except ImportError:
+        # Odoo <= 15.0
+        pass
+
+
 def disable_odoo_test_retry():
     """Odoo BaseCase.run method overload TestCase.run and manage
     a retry mechanism that breaks using pytest launcher.
@@ -216,22 +231,6 @@ def disable_odoo_test_retry():
         # Odoo <= 15.0
         pass
 
-def support_subtest():
-    """Odoo from version 16.0 re-define its own TestCase.subTest context manager
-
-    Odoo assume the usage of OdooTestResult which is not our case
-    using with pytest-odoo. So this fallback to the unitest.TestCase.subTest
-    Context manager
-    """
-    try:
-        from odoo.tests.case import TestCase
-        TestCase.subTest = UnitTestTestCase.subTest
-
-        from odoo.tests.case import _Outcome
-        _Outcome.result_supports_subtests = False
-    except ImportError:
-        # Odoo <= 15.0
-        pass
 
 def _find_manifest_path(collection_path: Path) -> Path:
     """Try to locate an Odoo manifest file in the collection path."""

tests/mock/odoo/odoo/tests/__init__.py

@@ -1,8 +1,13 @@
+from . import case
+
 from unittest.mock import MagicMock
 common = MagicMock()
-from . import case
 
 class BaseCase(case.TestCase):
 
-    def run(*args, **kwargs):
+    def run(self, *args, **kwargs):
         super().run(*args, **kwargs)
+        self._call_something()
+
+    def _call_something(self):
+        pass

tests/mock/odoo/odoo/tests/case.py

@@ -2,11 +2,13 @@
 
 
 class TestCase:
-    
+
     @contextlib.contextmanager
     def subTest(self, **kwargs):
         """Simulate odoo TestCase.subTest from version 15.0"""
 
+    def run(self, *args, **kwargs):
+        self._call_a_method()
 
-class _Outcome:
-    pass
+    def _call_a_method(self):
+        pass

tests/test_pytest_odoo.py

@@ -2,6 +2,7 @@
 from contextlib import contextmanager
 from pathlib import Path
 from unittest import TestCase
+from unittest.mock import patch
 
 from _pytest import pathlib as pytest_pathlib
 from pytest_odoo import (
@@ -98,7 +99,9 @@ def restore_basecase_run():
         self.addCleanup(restore_basecase_run)
 
         disable_odoo_test_retry()
-        self.assertFalse(hasattr(BaseCase, "run"))
+        with patch("odoo.tests.BaseCase._call_something") as mock:
+            BaseCase().run()
+            mock.assert_not_called()
 
 
     def test_disable_odoo_test_retry_ignore_run_doesnt_exists(self):
@@ -114,9 +117,10 @@ def restore_basecase_run():
         del BaseCase.run
 
         disable_odoo_test_retry()
-        self.assertFalse(hasattr(BaseCase, "run"))
-
 
+        with patch("odoo.tests.BaseCase._call_something") as mock:
+            BaseCase().run()
+            mock.assert_not_called()
 
     def test_import_error(self):
         from odoo import tests
@@ -135,30 +139,19 @@ def test_support_subtest(self):
         from odoo.tests import case
 
         original_test_case = case.TestCase
-        original_outcome = case._Outcome
 
         def restore():
             case.TestCase = original_test_case
-            case._Outcome = original_outcome
 
         self.addCleanup(restore)
         support_subtest()
+
         from odoo.tests import BaseCase
+        from odoo.tests.case import TestCase as OdooTestCase
 
+        self.assertTrue(OdooTestCase.subTest is TestCase.subTest)
         self.assertTrue(BaseCase.subTest is TestCase.subTest)
-
-    def test_support_subtest_no_base_case(self):
-        from odoo import tests
-
-        original_BaseCase = tests.BaseCase
-
-        def restore_basecase():
-            tests.BaseCase = original_BaseCase
-
-        self.addCleanup(restore_basecase)
-
-        del tests.BaseCase
-        support_subtest()
+        self.assertTrue(OdooTestCase.run is TestCase.run)
 
     def test_support_subtest_import_error(self):
         from odoo.tests import case