JezK
Edit File: config.py
# testing/config.py # Copyright (C) 2005-2023 the SQLAlchemy authors and contributors # <see AUTHORS file> # # This module is part of SQLAlchemy and is released under # the MIT License: https://www.opensource.org/licenses/mit-license.php import collections from .. import util requirements = None db = None db_url = None db_opts = None file_config = None test_schema = None test_schema_2 = None any_async = False _current = None ident = "main" _fixture_functions = None # installed by plugin_base def combinations(*comb, **kw): r"""Deliver multiple versions of a test based on positional combinations. This is a facade over pytest.mark.parametrize. :param \*comb: argument combinations. These are tuples that will be passed positionally to the decorated function. :param argnames: optional list of argument names. These are the names of the arguments in the test function that correspond to the entries in each argument tuple. pytest.mark.parametrize requires this, however the combinations function will derive it automatically if not present by using ``inspect.getfullargspec(fn).args[1:]``. Note this assumes the first argument is "self" which is discarded. :param id\_: optional id template. This is a string template that describes how the "id" for each parameter set should be defined, if any. The number of characters in the template should match the number of entries in each argument tuple. Each character describes how the corresponding entry in the argument tuple should be handled, as far as whether or not it is included in the arguments passed to the function, as well as if it is included in the tokens used to create the id of the parameter set. If omitted, the argument combinations are passed to parametrize as is. If passed, each argument combination is turned into a pytest.param() object, mapping the elements of the argument tuple to produce an id based on a character value in the same position within the string template using the following scheme:: i - the given argument is a string that is part of the id only, don't pass it as an argument n - the given argument should be passed and it should be added to the id by calling the .__name__ attribute r - the given argument should be passed and it should be added to the id by calling repr() s - the given argument should be passed and it should be added to the id by calling str() a - (argument) the given argument should be passed and it should not be used to generated the id e.g.:: @testing.combinations( (operator.eq, "eq"), (operator.ne, "ne"), (operator.gt, "gt"), (operator.lt, "lt"), id_="na" ) def test_operator(self, opfunc, name): pass The above combination will call ``.__name__`` on the first member of each tuple and use that as the "id" to pytest.param(). """ return _fixture_functions.combinations(*comb, **kw) def combinations_list(arg_iterable, **kw): "As combination, but takes a single iterable" return combinations(*arg_iterable, **kw) class _variation_base(object): __slots__ = ("name", "argname") def __init__(self, case, argname, case_names): self.name = case self.argname = argname for casename in case_names: setattr(self, casename, casename == case) def __bool__(self): return self.name == self.argname def __nonzero__(self): return not self.__bool__() def variation(argname, cases): """a helper around testing.combinations that provides a single namespace that can be used as a switch. e.g.:: @testing.variation("querytyp", ["select", "subquery", "legacy_query"]) @testing.variation("lazy", ["select", "raise", "raise_on_sql"]) def test_thing( self, querytyp, lazy, decl_base ): class Thing(decl_base): __tablename__ = 'thing' # use name directly rel = relationship("Rel", lazy=lazy.name) # use as a switch if querytyp.select: stmt = select(Thing) elif querytyp.subquery: stmt = select(Thing).subquery() elif querytyp.legacy_query: stmt = Session.query(Thing) else: assert False The variable provided is a slots object of boolean variables, as well as the name of the case itself under the attribute ".name" """ case_names = [ argname if c is True else "not_" + argname if c is False else c for c in cases ] typ = type( argname, (_variation_base,), { "__slots__": tuple(case_names), }, ) return combinations( *[ (casename, typ(casename, argname, case_names)) for casename in case_names ], id_="ia", argnames=argname ) def fixture(*arg, **kw): return _fixture_functions.fixture(*arg, **kw) def get_current_test_name(): return _fixture_functions.get_current_test_name() def mark_base_test_class(): return _fixture_functions.mark_base_test_class() class Config(object): def __init__(self, db, db_opts, options, file_config): self._set_name(db) self.db = db self.db_opts = db_opts self.options = options self.file_config = file_config self.test_schema = "test_schema" self.test_schema_2 = "test_schema_2" self.is_async = db.dialect.is_async and not util.asbool( db.url.query.get("async_fallback", False) ) _stack = collections.deque() _configs = set() def _set_name(self, db): if db.dialect.server_version_info: svi = ".".join(str(tok) for tok in db.dialect.server_version_info) self.name = "%s+%s_[%s]" % (db.name, db.driver, svi) else: self.name = "%s+%s" % (db.name, db.driver) @classmethod def register(cls, db, db_opts, options, file_config): """add a config as one of the global configs. If there are no configs set up yet, this config also gets set as the "_current". """ global any_async cfg = Config(db, db_opts, options, file_config) # if any backends include an async driver, then ensure # all setup/teardown and tests are wrapped in the maybe_async() # decorator that will set up a greenlet context for async drivers. any_async = any_async or cfg.is_async cls._configs.add(cfg) return cfg @classmethod def set_as_current(cls, config, namespace): global db, _current, db_url, test_schema, test_schema_2, db_opts _current = config db_url = config.db.url db_opts = config.db_opts test_schema = config.test_schema test_schema_2 = config.test_schema_2 namespace.db = db = config.db @classmethod def push_engine(cls, db, namespace): assert _current, "Can't push without a default Config set up" cls.push( Config( db, _current.db_opts, _current.options, _current.file_config ), namespace, ) @classmethod def push(cls, config, namespace): cls._stack.append(_current) cls.set_as_current(config, namespace) @classmethod def pop(cls, namespace): if cls._stack: # a failed test w/ -x option can call reset() ahead of time _current = cls._stack[-1] del cls._stack[-1] cls.set_as_current(_current, namespace) @classmethod def reset(cls, namespace): if cls._stack: cls.set_as_current(cls._stack[0], namespace) cls._stack.clear() @classmethod def all_configs(cls): return cls._configs @classmethod def all_dbs(cls): for cfg in cls.all_configs(): yield cfg.db def skip_test(self, msg): skip_test(msg) def skip_test(msg): raise _fixture_functions.skip_test_exception(msg) def async_test(fn): return _fixture_functions.async_test(fn)