# pylint: disable=import-outside-toplevel

if name != 'Form':

raise AttributeError(name)

from .form import Form

warnings.warn(

"Since 18.0: odoo.tests.common.Form is deprecated, use odoo.tests.Form",

category=DeprecationWarning,

stacklevel=2,

)

db = odoo.tools.config['db_name']

# If the database name is not provided on the command-line,

# use the one on the thread (which means if it is provided on

# the command-line, this will break when installing another

# database from XML-RPC).

if not db and hasattr(threading.current_thread(), 'dbname'):

return threading.current_thread().dbname

""" Decorator for standalone test functions. This is somewhat dedicated to

tests that install, upgrade or uninstall some modules, which is currently

forbidden in regular test cases. The function is registered under the given

``tags`` and the corresponding Odoo module name.

"""

def register(func):

# register func by odoo module name

if func.__module__.startswith('odoo.addons.'):

module = func.__module__.split('.')[2]

standalone_tests[module].append(func)

# register func with aribitrary name, if any

for tag in tags:

standalone_tests[tag].append(func)

standalone_tests['all'].append(func)

return func

def decorator(func):

def wrapped_f(self, *args, **kwargs):

if not skip:

xmls = func(self, *args, **kwargs)

_validate_xml(self.env, url, path, xmls)

return wrapped_f

""" Helper function to create a new test user. It allows to quickly create

users given its login and groups (being a comma separated list of xml ids).

Kwargs are directly propagated to the create to further customize the

created user.

User creation uses a potentially customized environment using the context

parameter allowing to specify a custom context. It can be used to force a

specific behavior and/or simplify record creation. An example is to use

mail-related context keys in mail tests to speedup record creation.

Some specific fields are automatically filled to avoid issues

* groups_id: it is filled using groups function parameter;

* name: "login (groups)" by default as it is required;

* email: it is either the login (if it is a valid email) or a generated

string 'x.x@example.com' (x being the first login letter). This is due

to email being required for most odoo operations;

"""

if not login:

raise ValueError('New users require at least a login')

if not groups:

raise ValueError('New users require at least user groups')

if context is None:

context = {}

groups_id = [Command.set(kwargs.pop('groups_id', False) or [env.ref(g.strip()).id for g in groups.split(',')])]

create_values = dict(kwargs, login=login, groups_id=groups_id)

# automatically generate a name as "Login (groups)" to ease user comprehension

if not create_values.get('name'):

create_values['name'] = '%s (%s)' % (login, groups)

# automatically give a password equal to login

if not create_values.get('password'):

create_values['password'] = login + 'x' * (8 - len(login))

# generate email if not given as most test require an email

if 'email' not in create_values:

if single_email_re.match(login):

create_values['email'] = login

else:

create_values['email'] = '%s.%s@example.com' % (login[0], login[0])

# ensure company_id + allowed company constraint works if not given at create

if 'company_id' in create_values and 'company_ids' not in create_values:

create_values['company_ids'] = [(4, create_values['company_id'])]

def __init__(self, model, domain):

self._model = model

self._domain = domain

def __enter__(self):

self._before = self._model.search(self._domain, order='id')

self._after = None

return self

def __exit__(self, exc_type, exc_value, exc_traceback):

if exc_type is None:

self._after = self._model.search(self._domain, order='id') - self._before

@property

def records(self):

if self._after is None:

return self._model.search(self._domain, order='id') - self._before

""" Metaclass of test case classes to assign default 'test_tags':

'standard', 'at_install' and the name of the module.

"""

def __init__(cls, name, bases, attrs):

super(MetaCase, cls).__init__(name, bases, attrs)

# assign default test tags

if cls.__module__.startswith('odoo.addons.'):

if getattr(cls, 'test_tags', None) is None:

cls.test_tags = {'standard', 'at_install'}

cls.test_module = cls.__module__.split('.')[2]

cls.test_class = cls.__name__

"""Takes some xml and normalize it to make it comparable to other xml

in particular, blank text is removed, and the output is pretty-printed

:param str arch_string: the string representing an XML arch

:param str parser_method: an string representing which lxml.Parser class to use

when normalizing both archs. Takes either "xml" or "html"

:return: the normalized arch

:rtype str:

"""

Parser = None

if parser_method == 'xml':

Parser = etree.XMLParser

elif parser_method == 'html':

Parser = etree.HTMLParser

parser = Parser(remove_blank_text=True)

arch_string = etree.fromstring(arch_string, parser=parser)

""" Subclass of TestCase for Odoo-specific code. This class is abstract and

expects self.registry, self.cr and self.uid to be initialized by subclasses.

"""

longMessage = True # more verbose error message by default: https://www.odoo.com/r/Vmh

warm = True # False during warm-up phase (see :func:`warmup`)

_python_version = sys.version_info

_tests_run_count = int(os.environ.get('ODOO_TEST_FAILURE_RETRIES', 0)) + 1

def __init__(self, methodName='runTest'):

super().__init__(methodName)

self.addTypeEqualityFunc(etree._Element, self.assertTreesEqual)

self.addTypeEqualityFunc(html.HtmlElement, self.assertTreesEqual)

@classmethod

def _request_handler(cls, s: Session, r: PreparedRequest, /, **kw):

# allow localhost requests

# TODO: also check port?

url = werkzeug.urls.url_parse(r.url)

if url.host in (HOST, 'localhost'):

return _super_send(s, r, **kw)

if url.scheme == 'file':

return _super_send(s, r, **kw)

_logger.getChild('requests').info(

"Blocking un-mocked external HTTP request %s %s", r.method, r.url)

raise BlockedRequest(f"External requests verboten (was {r.method} {r.url})")

def run(self, result):

testMethod = getattr(self, self._testMethodName)

if getattr(testMethod, '_retry', True) and getattr(self, '_retry', True):

tests_run_count = self._tests_run_count

else:

tests_run_count = 1

_logger.info('Auto retry disabled for %s', self)

quiet_log = None

for retry in range(tests_run_count):

result.had_failure = False # reset in case of retry without soft_fail

if retry:

_logger.runbot(f'Retrying a failed test: {self}')

if retry < tests_run_count-1:

with warnings.catch_warnings(), \

result.soft_fail(), \

lower_logging(25, logging.INFO) as quiet_log:

super().run(result)

if not (result.had_failure or quiet_log.had_error_log):

break

else: # last try

super().run(result)

if not result.wasSuccessful() and BaseCase._tests_run_count != 1:

_logger.runbot('Disabling auto-retry after a failed test')

BaseCase._tests_run_count = 1

@classmethod

def setUpClass(cls):

def check_remaining_patchers():

for patcher in _patch._active_patches:

_logger.warning("A patcher (targeting %s.%s) was remaining active at the end of %s, disabling it...", patcher.target, patcher.attribute, cls.__name__)

patcher.stop()

cls.addClassCleanup(check_remaining_patchers)

super().setUpClass()

if 'standard' in cls.test_tags:

# if the method is passed directly `patch` discards the session

# object which we need

# pylint: disable=unnecessary-lambda

patcher = patch.object(

requests.sessions.Session,

'send',

lambda s, r, **kwargs: cls._request_handler(s, r, **kwargs),

)

patcher.start()

cls.addClassCleanup(patcher.stop)

def cursor(self):

return self.registry.cursor()

@property

def uid(self):

""" Get the current uid. """

return self.env.uid

@uid.setter

def uid(self, user):

""" Set the uid by changing the test's environment. """

self.env = self.env(user=user)

def ref(self, xid):

""" Returns database ID for the provided :term:`external identifier`,

shortcut for ``_xmlid_lookup``

:param xid: fully-qualified :term:`external identifier`, in the form

:samp:`{module}.{identifier}`

:raise: ValueError if not found

:returns: registered id

"""

return self.browse_ref(xid).id

def browse_ref(self, xid):

""" Returns a record object for the provided

:term:`external identifier`

:param xid: fully-qualified :term:`external identifier`, in the form

:samp:`{module}.{identifier}`

:raise: ValueError if not found

:returns: :class:`~odoo.models.BaseModel`

"""

assert "." in xid, "this method requires a fully qualified parameter, in the following form: 'module.identifier'"

return self.env.ref(xid)

def patch(self, obj, key, val):

""" Do the patch ``setattr(obj, key, val)``, and prepare cleanup. """

patcher = patch.object(obj, key, val) # this is unittest.mock.patch

patcher.start()

self.addCleanup(patcher.stop)

@classmethod

def classPatch(cls, obj, key, val):

""" Do the patch ``setattr(obj, key, val)``, and prepare cleanup. """

patcher = patch.object(obj, key, val) # this is unittest.mock.patch

patcher.start()

cls.addClassCleanup(patcher.stop)

def startPatcher(self, patcher):

mock = patcher.start()

self.addCleanup(patcher.stop)

return mock

@classmethod

def startClassPatcher(cls, patcher):

mock = patcher.start()

cls.addClassCleanup(patcher.stop)

return mock

@contextmanager

def with_user(self, login):

""" Change user for a given test, like with self.with_user() ... """

old_uid = self.uid

try:

user = self.env['res.users'].sudo().search([('login', '=', login)])

assert user, "Login %s not found" % login

# switch user

self.uid = user.id

self.env = self.env(user=self.uid)

yield

finally:

# back

self.uid = old_uid

self.env = self.env(user=self.uid)

@contextmanager

def debug_mode(self):

""" Enable the effects of debug mode (in particular for group ``base.group_no_one``). """

request = Mock(

httprequest=Mock(host='localhost'),

db=self.env.cr.dbname,

env=self.env,

session=DotDict(odoo.http.get_default_session(), debug='1'),

)

try:

self.env.flush_all()

self.env.invalidate_all()

odoo.http._request_stack.push(request)

yield

self.env.flush_all()

self.env.invalidate_all()

finally:

popped_request = odoo.http._request_stack.pop()

if popped_request is not request:

raise Exception('Wrong request stack cleanup.')

@contextmanager

def _assertRaises(self, exception, *, msg=None):

""" Context manager that clears the environment upon failure. """

with ExitStack() as init:

if hasattr(self, 'env'):

init.enter_context(self.env.cr.savepoint())

if issubclass(exception, AccessError):

# The savepoint() above calls flush(), which leaves the

# record cache with lots of data. This can prevent

# access errors to be detected. In order to avoid this

# issue, we clear the cache before proceeding.

self.env.cr.clear()

with ExitStack() as inner:

cm = inner.enter_context(super().assertRaises(exception, msg=msg))

# *moves* the cleanups from init to inner, this ensures the

# savepoint gets rolled back when `yield` raises `exception`,

# but still allows the initialisation to be protected *and* not

# interfered with by `assertRaises`.

inner.push(init.pop_all())

yield cm

def assertRaises(self, exception, func=None, *args, **kwargs):

if func:

with self._assertRaises(exception):

func(*args, **kwargs)

else:

return self._assertRaises(exception, **kwargs)

def _patchExecute(self, actual_queries, flush=True):

Cursor_execute = Cursor.execute

def execute(self, query, params=None, log_exceptions=None):

actual_queries.append(query.code if isinstance(query, SQL) else query)

return Cursor_execute(self, query, params, log_exceptions)

if flush:

self.env.flush_all()

self.env.cr.flush()

with (

patch('odoo.sql_db.Cursor.execute', execute),

patch.object(self.env.registry, 'unaccent', lambda x: x),

):

yield actual_queries

if flush:

self.env.flush_all()

self.env.cr.flush()

@contextmanager

def assertQueries(self, expected, flush=True):

""" Check the queries made by the current cursor. ``expected`` is a list

of strings representing the expected queries being made. Query strings

are matched against each other, ignoring case and whitespaces.

"""

actual_queries = []

yield from self._patchExecute(actual_queries, flush)

if not self.warm:

return

self.assertEqual(

len(actual_queries), len(expected),

"\n---- actual queries:\n%s\n---- expected queries:\n%s" % (

"\n".join(actual_queries), "\n".join(expected),

)

)

for actual_query, expect_query in zip(actual_queries, expected):

self.assertEqual(

"".join(actual_query.lower().split()),

"".join(expect_query.lower().split()),

"\n---- actual query:\n%s\n---- not like:\n%s" % (actual_query, expect_query),

)

@contextmanager

def assertQueriesContain(self, expected, flush=True):

""" Check the queries made by the current cursor. ``expected`` is a list

of strings representing the expected queries being made. Query strings

are matched against each other, ignoring case and whitespaces.

"""

actual_queries = []

yield from self._patchExecute(actual_queries, flush)

if not self.warm:

return

self.assertEqual(

len(actual_queries), len(expected),

"\n---- actual queries:\n%s\n---- expected queries:\n%s" % (

"\n".join(actual_queries), "\n".join(expected),

)

)

for actual_query, expect_query in zip(actual_queries, expected):

self.assertIn(

"".join(expect_query.lower().split()),

"".join(actual_query.lower().split()),

"\n---- actual query:\n%s\n---- doesn't contain:\n%s" % (actual_query, expect_query),

)

@contextmanager

def assertQueryCount(self, default=0, flush=True, **counters):

""" Context manager that counts queries. It may be invoked either with

one value, or with a set of named arguments like ``login=value``::

with self.assertQueryCount(42):

...

with self.assertQueryCount(admin=3, demo=5):

...

The second form is convenient when used with :func:`users`.

"""

if self.warm:

# mock random in order to avoid random bus gc

with patch('random.random', lambda: 1):

login = self.env.user.login

expected = counters.get(login, default)

if flush:

self.env.flush_all()

self.env.cr.flush()

count0 = self.cr.sql_log_count

yield

if flush:

self.env.flush_all()

self.env.cr.flush()

count = self.cr.sql_log_count - count0

if count != expected:

# add some info on caller to allow semi-automatic update of query count

frame, filename, linenum, funcname, lines, index = inspect.stack()[2]

filename = filename.replace('\\', '/')

if "/odoo/addons/" in filename:

filename = filename.rsplit("/odoo/addons/", 1)[1]

if count > expected:

msg = "Query count more than expected for user %s: %d > %d in %s at %s:%s"

# add a subtest in order to continue the test_method in case of failures

with self.subTest():

self.fail(msg % (login, count, expected, funcname, filename, linenum))

else:

logger = logging.getLogger(type(self).__module__)

msg = "Query count less than expected for user %s: %d < %d in %s at %s:%s"

logger.info(msg, login, count, expected, funcname, filename, linenum)

else:

# flush before and after during warmup, in order to reproduce the

# same operations, otherwise the caches might not be ready!

if flush:

self.env.flush_all()

self.env.cr.flush()

yield

if flush:

self.env.flush_all()

self.env.cr.flush()

def assertRecordValues(

self,

records: odoo.models.BaseModel,

expected_values: list[dict],

*,

field_names: Optional[Iterable[str]] = None,

) -> None:

''' Compare a recordset with a list of dictionaries representing the expected results.

This method performs a comparison element by element based on their index.

Then, the order of the expected values is extremely important.

.. note::

- ``None`` expected values can be used for empty fields.

- x2many fields are expected by ids (so the expected value should be

a ``list[int]``

- many2one fields are expected by id (so the expected value should

be an ``int``

:param records: The records to compare.

:param expected_values: Items to check the ``records`` against.

:param field_names: list of fields to check during comparison, if

unspecified all expected_values must have the same

keys and all are checked

'''

if not field_names:

field_names = expected_values[0].keys()

for i, v in enumerate(expected_values):

self.assertEqual(

v.keys(), field_names,

f"All expected values must have the same keys, found differences between records 0 and {i}",

)

expected_reformatted = []

for vs in expected_values:

r = {}

for f in field_names:

t = records._fields[f].type

if t in ('one2many', 'many2many'):

r[f] = sorted(vs[f])

elif t == 'float':

r[f] = float(vs[f])

elif t == 'integer':

r[f] = int(vs[f])

elif vs[f] is None:

r[f] = False

else:

r[f] = vs[f]

expected_reformatted.append(r)

record_reformatted = []

for record in records:

r = {}

for field_name in field_names:

record_value = record[field_name]

match (field := record._fields[field_name]).type:

case 'many2one':

record_value = record_value.id

case 'one2many' | 'many2many':

record_value = sorted(record_value.ids)

case 'float' if digits := field.get_digits(record.env):

record_value = Approx(record_value, digits[1], decorate=False)

case 'monetary' if currency_field_name := field.get_currency_field(record):

# don't round if there's no currency set

if c := record[currency_field_name]:

record_value = Approx(record_value, c, decorate=False)

r[field_name] = record_value

record_reformatted.append(r)

try:

self.assertSequenceEqual(expected_reformatted, record_reformatted, seq_type=list)

return

except AssertionError as e:

standardMsg, _, diffMsg = str(e).rpartition('\n')

if 'self.maxDiff' not in diffMsg:

raise

# move out of handler to avoid exception chaining

diffMsg = "".join(difflib.unified_diff(

pprint.pformat(expected_reformatted).splitlines(keepends=True),

pprint.pformat(record_reformatted).splitlines(keepends=True),

fromfile="expected", tofile="records",

))

self.fail(self._formatMessage(None, standardMsg + '\n' + diffMsg))

# turns out this thing may not be quite as useful as we thought...

def assertItemsEqual(self, a, b, msg=None):

self.assertCountEqual(a, b, msg=None)

def assertTreesEqual(self, n1, n2, msg=None):

self.assertIsNotNone(n1, msg)

self.assertIsNotNone(n2, msg)

self.assertEqual(n1.tag, n2.tag, msg)

# Because lxml.attrib is an ordereddict for which order is important

# to equality, even though *we* don't care

self.assertEqual(dict(n1.attrib), dict(n2.attrib), msg)

self.assertEqual((n1.text or u'').strip(), (n2.text or u'').strip(), msg)

self.assertEqual((n1.tail or u'').strip(), (n2.tail or u'').strip(), msg)

for c1, c2 in izip_longest(n1, n2):

self.assertTreesEqual(c1, c2, msg)

def _assertXMLEqual(self, original, expected, parser="xml"):

"""Asserts that two xmls archs are equal

:param original: the xml arch to test

:type original: str

:param expected: the xml arch of reference

:type expected: str

:param parser: an string representing which lxml.Parser class to use

when normalizing both archs. Takes either "xml" or "html"

:type parser: str

"""

self.maxDiff = 10000

if original:

original = _normalize_arch_for_assert(original, parser)

if expected:

expected = _normalize_arch_for_assert(expected, parser)

self.assertEqual(original, expected)

def assertXMLEqual(self, original, expected):

return self._assertXMLEqual(original, expected)

def assertHTMLEqual(self, original, expected):

return self._assertXMLEqual(original, expected, 'html')

def profile(self, description='', **kwargs):

test_method = getattr(self, '_testMethodName', 'Unknown test method')

if not hasattr(self, 'profile_session'):

self.profile_session = profiler.make_session(test_method)

if 'db' not in kwargs:

kwargs['db'] = self.env.cr.dbname

return profiler.Profiler(

description='%s uid:%s %s %s' % (test_method, self.env.user.id, 'warm' if self.warm else 'cold', description),

profile_session=self.profile_session,

"""

A string-like object comparable to other strings but where the substring

'...' can match anything in the other string.

Example of usage:

self.assertEqual("SELECT field1, field2, field3 FROM model", Like('SELECT ... FROM model'))

self.assertIn(Like('Company ... (SF)'), ['TestPartner', 'Company 8 (SF)', 'SomeAdress'])

self.assertEqual([

'TestPartner',

'Company 8 (SF)',

'Anything else'

], [

'TestPartner',

Like('Company ... (SF)'),

Like('...'),

])

In case of mismatch, here is an example of error message

AssertionError: Lists differ: ['TestPartner', 'Company 8 (LA)', 'Anything else'] != ['TestPartner', ~Company ... (SF), ~...]

First differing element 1:

'Company 8 (LA)'

~Company ... (SF)~

- ['TestPartner', 'Company 8 (LA)', 'Anything else']

+ ['TestPartner', ~Company ... (SF), ~...]

"""

def __init__(self, pattern):

self.pattern = pattern

self.regex = '.*'.join([re.escape(part.strip()) for part in self.pattern.split('...')])

def __eq__(self, other):

return re.fullmatch(self.regex, other.strip(), re.DOTALL)

def __repr__(self):

"""A wrapper for approximate float comparisons. Uses float_compare under

the hood.

Most of the time, :meth:`TestCase.assertAlmostEqual` is more useful, but it

doesn't work for all helpers.

"""

def __init__(self, value: float, rounding: int | float | odoo.addons.base.models.res_currency.Currency, /, decorate: bool) -> None: # noqa: PYI041

self.value = value

self.decorate = decorate

if isinstance(rounding, int):

self.cmp = partial(float_compare, precision_digits=rounding)

elif isinstance(rounding, float):

self.cmp = partial(float_compare, precision_rounding=rounding)

else:

self.cmp = rounding.compare_amounts

def __repr__(self) -> str:

if self.decorate:

return f"~{self.value!r}"

return repr(self.value)

def __eq__(self, other: object) -> bool | NotImplemented:

if not isinstance(other, (float, int)):

return NotImplemented

""" Test class in which all test methods are run in a single transaction,

but each test method is run in a sub-transaction managed by a savepoint.

The transaction's cursor is always closed without committing.

The data setup common to all methods should be done in the class method

`setUpClass`, so that it is done once for all test methods. This is useful

for test cases containing fast tests but with significant database setup

common to all cases (complex in-db test data).

After being run, each test method cleans up the record cache and the

registry cache. However, there is no cleanup of the registry models and

fields. If a test modifies the registry (custom models and/or fields), it

should prepare the necessary cleanup (`self.registry.reset_changes()`).

"""

registry: Registry = None

env: api.Environment = None

cr: Cursor = None

muted_registry_logger = mute_logger(odoo.modules.registry._logger.name)

freeze_time = None

@classmethod

def _gc_filestore(cls):

# attachment can be created or unlink during the tests.

# they can addup during test and take some disc space.

# since cron are not running during tests, we need to gc manually

# We need to check the status of the file system outside of the test cursor

with Registry(get_db_name()).cursor() as cr:

gc_env = api.Environment(cr, odoo.SUPERUSER_ID, {})

gc_env['ir.attachment']._gc_file_store_unsafe()

@classmethod

def setUpClass(cls):

super().setUpClass()

cls.addClassCleanup(cls._gc_filestore)

cls.registry = Registry(get_db_name())

cls.registry_start_invalidated = cls.registry.registry_invalidated

cls.registry_start_sequence = cls.registry.registry_sequence

cls.registry_cache_sequences = dict(cls.registry.cache_sequences)

def reset_changes():

if (cls.registry_start_sequence != cls.registry.registry_sequence) or cls.registry.registry_invalidated:

with cls.registry.cursor() as cr:

cls.registry.setup_models(cr)

cls.registry.registry_invalidated = cls.registry_start_invalidated

cls.registry.registry_sequence = cls.registry_start_sequence

with cls.muted_registry_logger:

cls.registry.clear_all_caches()

cls.registry.cache_invalidated.clear()

cls.registry.cache_sequences = cls.registry_cache_sequences

cls.addClassCleanup(reset_changes)

def signal_changes():

if not cls.registry.ready:

_logger.info('Skipping signal changes during tests')

return

_logger.info('Simulating signal changes during tests')

if cls.registry.registry_invalidated:

cls.registry.registry_sequence += 1

for cache_name in cls.registry.cache_invalidated or ():

cls.registry.cache_sequences[cache_name] += 1

cls.registry.registry_invalidated = False

cls.registry.cache_invalidated.clear()

cls._signal_changes_patcher = patch.object(cls.registry, 'signal_changes', signal_changes)

cls.startClassPatcher(cls._signal_changes_patcher)

cls.cr = cls.registry.cursor()

cls.addClassCleanup(cls.cr.close)

if cls.freeze_time:

cls.startClassPatcher(freezegun.freeze_time(cls.freeze_time))

def forbidden(*args, **kwars):

traceback.print_stack()

raise AssertionError('Cannot commit or rollback a cursor from inside a test, this will lead to a broken cursor when trying to rollback the test. Please rollback to a specific savepoint instead or open another cursor if really necessary')

cls.commit_patcher = patch.object(cls.cr, 'commit', forbidden)

cls.startClassPatcher(cls.commit_patcher)

cls.rollback_patcher = patch.object(cls.cr, 'rollback', forbidden)

cls.startClassPatcher(cls.rollback_patcher)

cls.close_patcher = patch.object(cls.cr, 'close', forbidden)

cls.startClassPatcher(cls.close_patcher)

cls.env = api.Environment(cls.cr, odoo.SUPERUSER_ID, {})

# speedup CryptContext. Many user an password are done during tests, avoid spending time hasing password with many rounds

def _crypt_context(self): # noqa: ARG001

return CryptContext(

['pbkdf2_sha512', 'plaintext'],

pbkdf2_sha512__rounds=1,

)

cls._crypt_context_patcher = patch('odoo.addons.base.models.res_users.Users._crypt_context', _crypt_context)

cls.startClassPatcher(cls._crypt_context_patcher)

def setUp(self):

super().setUp()

# restore environments after the test to avoid invoking flush() with an

# invalid environment (inexistent user id) from another test

envs = self.env.transaction.envs

for env in list(envs):

self.addCleanup(env.clear)

# restore the set of known environments as it was at setUp

self.addCleanup(envs.update, list(envs))

self.addCleanup(envs.clear)

self.addCleanup(self.muted_registry_logger(self.registry.clear_all_caches))

# This prevents precommit functions and data from piling up

# until cr.flush is called in 'assertRaises' clauses

# (these are not cleared in self.env.clear or envs.clear)

cr = self.env.cr

def _reset(cb, funcs, data):

cb._funcs = funcs

cb.data = data

for callback in [cr.precommit, cr.postcommit, cr.prerollback, cr.postrollback]:

self.addCleanup(_reset, callback, deque(callback._funcs), dict(callback.data))

# flush everything in setUpClass before introducing a savepoint

self.env.flush_all()

self._savepoint_id = next(savepoint_seq)

self.cr.execute('SAVEPOINT test_%d' % self._savepoint_id)

""" TestCase in which all test methods are run in the same transaction,

the transaction is started with the first test method and rolled back at

the end of the last.

"""

@classmethod

def __init_subclass__(cls):

super().__init_subclass__()

if issubclass(cls, TransactionCase):

_logger.warning("%s inherits from both TransactionCase and SingleTransactionCase")

@classmethod

def setUpClass(cls):

super().setUpClass()

cls.registry = Registry(get_db_name())

cls.addClassCleanup(cls.registry.reset_changes)

cls.addClassCleanup(cls.registry.clear_all_caches)

cls.cr = cls.registry.cursor()

cls.addClassCleanup(cls.cr.close)

cls.env = api.Environment(cls.cr, odoo.SUPERUSER_ID, {})

def setUp(self):

super(SingleTransactionCase, self).setUp()

def done(f):

try:

try:

r = f.result()

except Exception as e:

f = coro.throw(e)

else:

f = coro.send(r)

except StopIteration:

return

assert isinstance(f, Future), f"coroutine must yield futures, got {f}"

f.add_done_callback(done)