[IMP] tests: refactor unittest classes

Odoo Test environments requires to modify many parts of the unittest
TestCase, Suite and Result.

The main initial reason is to **avoid to postpone result at the end of
the test suite**, because even if it is convenient to have all errors
visible after the tests in some case, odoo logs adds information during
the execution that can be useful to debug when a test fail, to have
context for an error. (see **OdooTestResult**)

We are also fixing the stack trace comming from a unittest and since
there is no proper way to hook inside the TestPartExecutor, a dirty hack
injects anoter result on the outcome to manage the error and complete
the stack trace. This was also a way to avoid to postpone subtest logs
at the end of the test case (see _ErrorCatcher)

`_feedErrorsToResult` was used to test the test suite behavior since
there are many customization and this is quite fragile, especially if
unittest changes behavior in other python version.

**Python 3.11** introduced python/cpython#664448d8 That, in a way, goes
in the same direction of the changed introduced with _ErrorCatcher:
immediately feed errors to resut instead of postponing it. But this also
removes `_feedErrorsToResult` that was used to test this behaviors, as
well as other ones.

Since odoo should remain multi-version, this amount of changes on the
initial behavior become to complicate to keep cross-version and the
(already in our mind for a while) solution to **vendor unittest** will
help to simplify most of our test code base.

This commit modified the vendored unittest files to simplify them as
much as possible to suite our needs.

Since the runner is still the unittest one, we need to inherit from
unittest.Testcase in order to have the right type.

This also means that we still have access to all TestCase methods
without overriding them all. This is convenient for assertion methods as
an example but the initial idea is to vendor our own version of TestCase
to avoid having trouble to adapte our miscommunications to future python
versions. A trade-off must be done to chose what should remain in our
code base. The idea is to keep logic closely linked to our changes in
our code base, mainly around the run method, but also addClassCleanup
wich need to be vendored for python 3.7, but assertions methods are
independent. Any logic can be moved fom unittest to our
vendored version in the future if needed.

Part-of: odoo#112294

Author: Xavier-Do

debian/copyright

@@ -321,6 +321,10 @@ Files: addons/web/static/lib/popper/*
 Copyright: 2016 Federico Zivolo
 License: MIT
 
+Files: odoo/odoo/tests/case.py odoo/odoo/tests/result.py odoo/odoo/tests/suite.py
+Copyright: (c) 1999-2003 Steve Purcell; (c) 2003-2010 Python Software Foundation
+License: PSF
+
 Files: addons/web/static/lib/py.js/*
 Copyright: 2012
 License: DWTFYW

odoo/addons/base/tests/test_mimetypes.py

@@ -126,8 +126,3 @@ def test_mimetype_get_extension(self):
         self.assertEqual(get_extension('filename.not_alnum'), '')
         self.assertEqual(get_extension('filename.with space'), '')
         self.assertEqual(get_extension('filename.notAnExtension'), '')
-
-
-
-if __name__ == '__main__':
-    unittest.main()

odoo/addons/base/tests/test_test_suite.py

@@ -4,23 +4,29 @@
 import difflib
 import logging
 import re
+import sys
 from contextlib import contextmanager
-from unittest import TestCase
+from unittest import SkipTest, skip
 from unittest.mock import patch
 
-from odoo.tests.common import TransactionCase
+from odoo.tests.common import BaseCase, TransactionCase
 from odoo.tests.common import users, warmup
-from odoo.tests.runner import OdooTestResult
+from odoo.tests.result import OdooTestResult
+from odoo.tests.case import TestCase
 
 _logger = logging.getLogger(__name__)
 
 from odoo.tests import MetaCase
 
 
-class TestTestSuite(TestCase, metaclass=MetaCase):
+if sys.version_info >= (3, 8):
+    # this is mainly to ensure that simple tests will continue to work even if BaseCase should be used
+    # this only works if doClassCleanup is available on testCase because of the vendoring of suite.py.
+    # this test will only work in python 3.8 +
+    class TestTestSuite(TestCase, metaclass=MetaCase):
 
-    def test_test_suite(self):
-        """ Check that OdooSuite handles unittest.TestCase correctly. """
+        def test_test_suite(self):
+            """ Check that OdooSuite handles unittest.TestCase correctly. """
 
 
 class TestRunnerLoggingCommon(TransactionCase):
@@ -37,7 +43,7 @@ def setUp(self):
         self.expected_first_frame_methods = None
         return super().setUp()
 
-    def _feedErrorsToResult(self, result, errors):
+    def _addError(self, result, test, exc_info):
         # We use this hook to catch the logged error. It is initially called
         # post tearDown, and logs the actual errors. Because of our hack
         # tests.common._ErrorCatcher, the errors are logged directly. This is
@@ -48,11 +54,10 @@ def _feedErrorsToResult(self, result, errors):
             self.test_result = result
             # while we are here, let's check that the first frame of the stack
             # is always inside the test method
-            for error in errors:
-                _, exc_info = error
-                if exc_info:
-                    tb = exc_info[2]
-                    self._check_first_frame(tb)
+
+            if exc_info:
+                tb = exc_info[2]
+                self._check_first_frame(tb)
 
             # intercept all ir_logging. We cannot use log catchers or other
             # fancy stuff because makeRecord is too low level.
@@ -70,7 +75,7 @@ def handle(logger, record):
 
             fake_result = OdooTestResult()
             with patch('logging.Logger.makeRecord', makeRecord), patch('logging.Logger.handle', handle):
-                super()._feedErrorsToResult(fake_result, errors)
+                super()._addError(fake_result, test, exc_info)
 
             self._check_log_records(log_records)
 
@@ -112,9 +117,9 @@ def _assert_log_equal(self, log_record, key, expected):
             value = self._clean_message(value)
         if value != expected:
             if key != 'msg':
-                self._log_error(f"Key `{key}` => `{value}` is not equal to `{expected}` \n {log_record['str']}")
+                self._log_error(f"Key `{key}` => `{value}` is not equal to `{expected}` \n {log_record['msg']}")
             else:
-                diff = '\n'.join(difflib.ndiff(value.splitlines(), expected.splitlines()))
+                diff = '\n'.join(difflib.ndiff(expected.splitlines(), value.splitlines()))
                 self._log_error(f"Key `{key}` did not matched expected:\n{diff}")
 
     def _log_error(self, message):
@@ -134,6 +139,9 @@ def _clean_message(self, message):
 
 class TestRunnerLogging(TestRunnerLoggingCommon):
 
+    def test_has_add_error(self):
+        self.assertTrue(hasattr(self, '_addError'))
+
     def test_raise(self):
         raise Exception('This is an error')
 
@@ -171,6 +179,8 @@ def make_message(message):
     @users('__system__')
     @warmup
     def test_with_decorators(self):
+        # note, this test may be broken with a decorator in decorator=5.0.5 since the behaviour changed
+        # but decoratorx was not introduced yet.
         message = (
 '''ERROR: Subtest TestRunnerLogging.test_with_decorators (login='__system__')
 Traceback (most recent call last):
@@ -448,3 +458,72 @@ def test_raises_teardown(self):
         with self.subTest():
             raise Exception('This is a second subTest error')
         raise Exception('This is a test error')
+
+
+class TestSubtests(BaseCase):
+
+    def test_nested_subtests(self):
+        with self.subTest(a=1, x=2):
+            with self.subTest(b=3, x=4):
+                self.assertEqual(self._subtest._subDescription(), '(b=3, x=4, a=1)')
+            with self.subTest(b=5, x=6):
+                self.assertEqual(self._subtest._subDescription(), '(b=5, x=6, a=1)')
+
+
+class TestClassSetup(BaseCase):
+
+    @classmethod
+    def setUpClass(cls):
+        raise SkipTest('Skip this class')
+
+    def test_method(self):
+        pass
+
+
+class TestClassTeardown(BaseCase):
+
+    @classmethod
+    def tearDownClass(cls):
+        raise SkipTest('Skip this class')
+
+    def test_method(self):
+        pass
+
+
+class Test01ClassCleanups(BaseCase):
+    """
+    The purpose of this test combined with Test02ClassCleanupsCheck is to check that
+    class cleanup work. class cleanup where introduced in python3.8 but tests should
+    remain compatible with python 3.7
+    """
+    executed = False
+    cleanup = False
+
+    @classmethod
+    def setUpClass(cls):
+        cls.executed = True
+
+        def doCleanup():
+            cls.cleanup = True
+        cls.addClassCleanup(doCleanup)
+
+    def test_dummy(self):
+        pass
+
+
+class Test02ClassCleanupsCheck(BaseCase):
+    def test_classcleanups(self):
+        self.assertTrue(Test01ClassCleanups.executed, "This test only makes sence when executed after Test01ClassCleanups")
+        self.assertTrue(Test01ClassCleanups.cleanup, "TestClassCleanup shoudl have been cleanuped")
+
+
+@skip
+class TestSkipClass(BaseCase):
+    def test_classcleanups(self):
+        raise Exception('This should be skipped')
+
+
+class TestSkipMethof(BaseCase):
+    @skip
+    def test_skip_method(self):
+        raise Exception('This should be skipped')

odoo/addons/base/tests/test_tests_tags.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
 # Part of Odoo. See LICENSE file for full copyright and licensing details.
 
-from odoo.tests.common import TransactionCase, tagged, TagsSelector, BaseCase
+from odoo.tests.common import TransactionCase, tagged, BaseCase
+from odoo.tests.tag_selector import TagsSelector
 
 
 @tagged('nodatabase')

odoo/modules/loading.py

@@ -326,7 +326,7 @@ def load_module_graph(cr, graph, status=None, perform_checks=True,
         if test_results and not test_results.wasSuccessful():
             _logger.error(
                 "Module %s: %d failures, %d errors of %d tests",
-                module_name, len(test_results.failures), len(test_results.errors),
+                module_name, test_results.failures_count, test_results.errors_count,
                 test_results.testsRun
             )
 

odoo/modules/registry.py

@@ -114,7 +114,7 @@ def init(self, db_name):
         self._sql_constraints = set()
         self._init = True
         self._database_translated_fields = ()  # names of translated fields in database
-        self._assertion_report = odoo.tests.runner.OdooTestResult()
+        self._assertion_report = odoo.tests.result.OdooTestResult()
         self._fields_by_model = None
         self._ordinary_tables = None
         self._constraint_queue = deque()

odoo/service/server.py

@@ -22,6 +22,8 @@
 import werkzeug.serving
 from werkzeug.debug import DebuggedApplication
 
+from ..tests import loader
+
 if os.name == 'posix':
     # Unix only for workers
     import fcntl
@@ -58,7 +60,6 @@
 from odoo.release import nt_service_name
 from odoo.tools import config
 from odoo.tools import stripped_sys_argv, dumpstacks, log_ormcache_stats
-from ..tests import loader, runner
 
 _logger = logging.getLogger(__name__)
 
@@ -579,7 +580,7 @@ def run(self, preload=None, stop=False):
 
         if stop:
             if config['test_enable']:
-                logger = odoo.tests.runner._logger
+                logger = odoo.tests.result._logger
                 with Registry.registries._lock:
                     for db, registry in Registry.registries.d.items():
                         report = registry._assertion_report
@@ -1267,7 +1268,8 @@ def _reexec(updated_modules=None):
     os.execve(sys.executable, args, os.environ)
 
 def load_test_file_py(registry, test_file):
-    from odoo.tests.common import OdooSuite
+    # pylint: disable=import-outside-toplevel
+    from odoo.tests.suite import OdooSuite
     threading.current_thread().testing = True
     try:
         test_path, _ = os.path.splitext(os.path.abspath(test_file))

odoo/tests/__init__.py

@@ -1,3 +1,10 @@
+"""
+Odoo unit testing framework, based on Python unittest.
+
+Some files as case.py, resut.py, suite.py are higly modified versions of unitest
+See https://github.com/python/cpython/tree/3.10/Lib/unittest for reference files.
+"""
+
 from . import common
 from .common import *
 from . import test_parse_inline_template