2013-10-11 17:28:32 +00:00
|
|
|
# testing/exclusions.py
|
2014-09-30 16:15:32 +00:00
|
|
|
# Copyright (C) 2005-2014 the SQLAlchemy authors and contributors
|
|
|
|
# <see AUTHORS file>
|
2013-10-11 17:28:32 +00:00
|
|
|
#
|
|
|
|
# This module is part of SQLAlchemy and is released under
|
|
|
|
# the MIT License: http://www.opensource.org/licenses/mit-license.php
|
|
|
|
|
|
|
|
|
|
|
|
import operator
|
|
|
|
from .plugin.plugin_base import SkipTest
|
|
|
|
from ..util import decorator
|
|
|
|
from . import config
|
|
|
|
from .. import util
|
|
|
|
import contextlib
|
|
|
|
import inspect
|
|
|
|
|
2014-09-30 16:15:32 +00:00
|
|
|
|
2013-10-11 17:28:32 +00:00
|
|
|
class skip_if(object):
|
|
|
|
def __init__(self, predicate, reason=None):
|
|
|
|
self.predicate = _as_predicate(predicate)
|
|
|
|
self.reason = reason
|
|
|
|
|
|
|
|
_fails_on = None
|
|
|
|
|
|
|
|
def __add__(self, other):
|
|
|
|
def decorate(fn):
|
|
|
|
return other(self(fn))
|
|
|
|
return decorate
|
|
|
|
|
|
|
|
@property
|
|
|
|
def enabled(self):
|
|
|
|
return self.enabled_for_config(config._current)
|
|
|
|
|
|
|
|
def enabled_for_config(self, config):
|
|
|
|
return not self.predicate(config)
|
|
|
|
|
|
|
|
@contextlib.contextmanager
|
|
|
|
def fail_if(self, name='block'):
|
|
|
|
try:
|
|
|
|
yield
|
|
|
|
except Exception as ex:
|
|
|
|
if self.predicate(config._current):
|
|
|
|
print(("%s failed as expected (%s): %s " % (
|
|
|
|
name, self.predicate, str(ex))))
|
|
|
|
else:
|
|
|
|
raise
|
|
|
|
else:
|
|
|
|
if self.predicate(config._current):
|
|
|
|
raise AssertionError(
|
|
|
|
"Unexpected success for '%s' (%s)" %
|
|
|
|
(name, self.predicate))
|
|
|
|
|
|
|
|
def __call__(self, fn):
|
|
|
|
@decorator
|
|
|
|
def decorate(fn, *args, **kw):
|
|
|
|
if self.predicate(config._current):
|
|
|
|
if self.reason:
|
|
|
|
msg = "'%s' : %s" % (
|
2014-09-30 16:15:32 +00:00
|
|
|
fn.__name__,
|
|
|
|
self.reason
|
|
|
|
)
|
2013-10-11 17:28:32 +00:00
|
|
|
else:
|
|
|
|
msg = "'%s': %s" % (
|
2014-09-30 16:15:32 +00:00
|
|
|
fn.__name__, self.predicate
|
|
|
|
)
|
2013-10-11 17:28:32 +00:00
|
|
|
raise SkipTest(msg)
|
|
|
|
else:
|
|
|
|
if self._fails_on:
|
|
|
|
with self._fails_on.fail_if(name=fn.__name__):
|
|
|
|
return fn(*args, **kw)
|
|
|
|
else:
|
|
|
|
return fn(*args, **kw)
|
|
|
|
return decorate(fn)
|
|
|
|
|
|
|
|
def fails_on(self, other, reason=None):
|
|
|
|
self._fails_on = skip_if(other, reason)
|
|
|
|
return self
|
|
|
|
|
|
|
|
def fails_on_everything_except(self, *dbs):
|
|
|
|
self._fails_on = skip_if(fails_on_everything_except(*dbs))
|
|
|
|
return self
|
|
|
|
|
2014-09-30 16:15:32 +00:00
|
|
|
|
2013-10-11 17:28:32 +00:00
|
|
|
class fails_if(skip_if):
|
|
|
|
def __call__(self, fn):
|
|
|
|
@decorator
|
|
|
|
def decorate(fn, *args, **kw):
|
|
|
|
with self.fail_if(name=fn.__name__):
|
|
|
|
return fn(*args, **kw)
|
|
|
|
return decorate(fn)
|
|
|
|
|
|
|
|
|
|
|
|
def only_if(predicate, reason=None):
|
|
|
|
predicate = _as_predicate(predicate)
|
|
|
|
return skip_if(NotPredicate(predicate), reason)
|
|
|
|
|
|
|
|
|
|
|
|
def succeeds_if(predicate, reason=None):
|
|
|
|
predicate = _as_predicate(predicate)
|
|
|
|
return fails_if(NotPredicate(predicate), reason)
|
|
|
|
|
|
|
|
|
|
|
|
class Predicate(object):
|
|
|
|
@classmethod
|
|
|
|
def as_predicate(cls, predicate):
|
|
|
|
if isinstance(predicate, skip_if):
|
|
|
|
return NotPredicate(predicate.predicate)
|
|
|
|
elif isinstance(predicate, Predicate):
|
|
|
|
return predicate
|
|
|
|
elif isinstance(predicate, list):
|
|
|
|
return OrPredicate([cls.as_predicate(pred) for pred in predicate])
|
|
|
|
elif isinstance(predicate, tuple):
|
|
|
|
return SpecPredicate(*predicate)
|
|
|
|
elif isinstance(predicate, util.string_types):
|
|
|
|
tokens = predicate.split(" ", 2)
|
|
|
|
op = spec = None
|
|
|
|
db = tokens.pop(0)
|
|
|
|
if tokens:
|
|
|
|
op = tokens.pop(0)
|
|
|
|
if tokens:
|
|
|
|
spec = tuple(int(d) for d in tokens.pop(0).split("."))
|
|
|
|
return SpecPredicate(db, op, spec)
|
|
|
|
elif util.callable(predicate):
|
|
|
|
return LambdaPredicate(predicate)
|
|
|
|
else:
|
|
|
|
assert False, "unknown predicate type: %s" % predicate
|
|
|
|
|
|
|
|
|
|
|
|
class BooleanPredicate(Predicate):
|
|
|
|
def __init__(self, value, description=None):
|
|
|
|
self.value = value
|
|
|
|
self.description = description or "boolean %s" % value
|
|
|
|
|
|
|
|
def __call__(self, config):
|
|
|
|
return self.value
|
|
|
|
|
|
|
|
def _as_string(self, negate=False):
|
|
|
|
if negate:
|
|
|
|
return "not " + self.description
|
|
|
|
else:
|
|
|
|
return self.description
|
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
return self._as_string()
|
|
|
|
|
|
|
|
|
|
|
|
class SpecPredicate(Predicate):
|
|
|
|
def __init__(self, db, op=None, spec=None, description=None):
|
|
|
|
self.db = db
|
|
|
|
self.op = op
|
|
|
|
self.spec = spec
|
|
|
|
self.description = description
|
|
|
|
|
|
|
|
_ops = {
|
2014-09-30 16:15:32 +00:00
|
|
|
'<': operator.lt,
|
|
|
|
'>': operator.gt,
|
|
|
|
'==': operator.eq,
|
|
|
|
'!=': operator.ne,
|
|
|
|
'<=': operator.le,
|
|
|
|
'>=': operator.ge,
|
|
|
|
'in': operator.contains,
|
|
|
|
'between': lambda val, pair: val >= pair[0] and val <= pair[1],
|
|
|
|
}
|
2013-10-11 17:28:32 +00:00
|
|
|
|
|
|
|
def __call__(self, config):
|
|
|
|
engine = config.db
|
|
|
|
|
|
|
|
if "+" in self.db:
|
|
|
|
dialect, driver = self.db.split('+')
|
|
|
|
else:
|
|
|
|
dialect, driver = self.db, None
|
|
|
|
|
|
|
|
if dialect and engine.name != dialect:
|
|
|
|
return False
|
|
|
|
if driver is not None and engine.driver != driver:
|
|
|
|
return False
|
|
|
|
|
|
|
|
if self.op is not None:
|
|
|
|
assert driver is None, "DBAPI version specs not supported yet"
|
|
|
|
|
|
|
|
version = _server_version(engine)
|
|
|
|
oper = hasattr(self.op, '__call__') and self.op \
|
2014-09-30 16:15:32 +00:00
|
|
|
or self._ops[self.op]
|
2013-10-11 17:28:32 +00:00
|
|
|
return oper(version, self.spec)
|
|
|
|
else:
|
|
|
|
return True
|
|
|
|
|
|
|
|
def _as_string(self, negate=False):
|
|
|
|
if self.description is not None:
|
|
|
|
return self.description
|
|
|
|
elif self.op is None:
|
|
|
|
if negate:
|
|
|
|
return "not %s" % self.db
|
|
|
|
else:
|
|
|
|
return "%s" % self.db
|
|
|
|
else:
|
|
|
|
if negate:
|
|
|
|
return "not %s %s %s" % (
|
2014-09-30 16:15:32 +00:00
|
|
|
self.db,
|
|
|
|
self.op,
|
|
|
|
self.spec
|
|
|
|
)
|
2013-10-11 17:28:32 +00:00
|
|
|
else:
|
|
|
|
return "%s %s %s" % (
|
2014-09-30 16:15:32 +00:00
|
|
|
self.db,
|
|
|
|
self.op,
|
|
|
|
self.spec
|
|
|
|
)
|
2013-10-11 17:28:32 +00:00
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
return self._as_string()
|
|
|
|
|
|
|
|
|
|
|
|
class LambdaPredicate(Predicate):
|
|
|
|
def __init__(self, lambda_, description=None, args=None, kw=None):
|
|
|
|
spec = inspect.getargspec(lambda_)
|
|
|
|
if not spec[0]:
|
|
|
|
self.lambda_ = lambda db: lambda_()
|
|
|
|
else:
|
|
|
|
self.lambda_ = lambda_
|
|
|
|
self.args = args or ()
|
|
|
|
self.kw = kw or {}
|
|
|
|
if description:
|
|
|
|
self.description = description
|
|
|
|
elif lambda_.__doc__:
|
|
|
|
self.description = lambda_.__doc__
|
|
|
|
else:
|
|
|
|
self.description = "custom function"
|
|
|
|
|
|
|
|
def __call__(self, config):
|
|
|
|
return self.lambda_(config)
|
|
|
|
|
|
|
|
def _as_string(self, negate=False):
|
|
|
|
if negate:
|
|
|
|
return "not " + self.description
|
|
|
|
else:
|
|
|
|
return self.description
|
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
return self._as_string()
|
|
|
|
|
|
|
|
|
|
|
|
class NotPredicate(Predicate):
|
|
|
|
def __init__(self, predicate):
|
|
|
|
self.predicate = predicate
|
|
|
|
|
|
|
|
def __call__(self, config):
|
|
|
|
return not self.predicate(config)
|
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
return self.predicate._as_string(True)
|
|
|
|
|
|
|
|
|
|
|
|
class OrPredicate(Predicate):
|
|
|
|
def __init__(self, predicates, description=None):
|
|
|
|
self.predicates = predicates
|
|
|
|
self.description = description
|
|
|
|
|
|
|
|
def __call__(self, config):
|
|
|
|
for pred in self.predicates:
|
|
|
|
if pred(config):
|
|
|
|
self._str = pred
|
|
|
|
return True
|
|
|
|
return False
|
|
|
|
|
|
|
|
_str = None
|
|
|
|
|
|
|
|
def _eval_str(self, negate=False):
|
|
|
|
if self._str is None:
|
|
|
|
if negate:
|
|
|
|
conjunction = " and "
|
|
|
|
else:
|
|
|
|
conjunction = " or "
|
|
|
|
return conjunction.join(p._as_string(negate=negate)
|
2014-09-30 16:15:32 +00:00
|
|
|
for p in self.predicates)
|
2013-10-11 17:28:32 +00:00
|
|
|
else:
|
|
|
|
return self._str._as_string(negate=negate)
|
|
|
|
|
|
|
|
def _negation_str(self):
|
|
|
|
if self.description is not None:
|
|
|
|
return "Not " + (self.description % {"spec": self._str})
|
|
|
|
else:
|
|
|
|
return self._eval_str(negate=True)
|
|
|
|
|
|
|
|
def _as_string(self, negate=False):
|
|
|
|
if negate:
|
|
|
|
return self._negation_str()
|
|
|
|
else:
|
|
|
|
if self.description is not None:
|
|
|
|
return self.description % {"spec": self._str}
|
|
|
|
else:
|
|
|
|
return self._eval_str()
|
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
return self._as_string()
|
|
|
|
|
|
|
|
_as_predicate = Predicate.as_predicate
|
|
|
|
|
|
|
|
|
|
|
|
def _is_excluded(db, op, spec):
|
|
|
|
return SpecPredicate(db, op, spec)(config._current)
|
|
|
|
|
|
|
|
|
|
|
|
def _server_version(engine):
|
|
|
|
"""Return a server_version_info tuple."""
|
|
|
|
|
|
|
|
# force metadata to be retrieved
|
|
|
|
conn = engine.connect()
|
|
|
|
version = getattr(engine.dialect, 'server_version_info', ())
|
|
|
|
conn.close()
|
|
|
|
return version
|
|
|
|
|
|
|
|
|
|
|
|
def db_spec(*dbs):
|
|
|
|
return OrPredicate(
|
2014-09-30 16:15:32 +00:00
|
|
|
[Predicate.as_predicate(db) for db in dbs]
|
|
|
|
)
|
2013-10-11 17:28:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
def open():
|
|
|
|
return skip_if(BooleanPredicate(False, "mark as execute"))
|
|
|
|
|
|
|
|
|
|
|
|
def closed():
|
|
|
|
return skip_if(BooleanPredicate(True, "marked as skip"))
|
|
|
|
|
2014-09-30 16:15:32 +00:00
|
|
|
|
2013-10-11 17:28:32 +00:00
|
|
|
def fails():
|
|
|
|
return fails_if(BooleanPredicate(True, "expected to fail"))
|
|
|
|
|
2014-09-30 16:15:32 +00:00
|
|
|
|
2013-10-11 17:28:32 +00:00
|
|
|
@decorator
|
|
|
|
def future(fn, *arg):
|
|
|
|
return fails_if(LambdaPredicate(fn), "Future feature")
|
|
|
|
|
|
|
|
|
|
|
|
def fails_on(db, reason=None):
|
|
|
|
return fails_if(SpecPredicate(db), reason)
|
|
|
|
|
|
|
|
|
|
|
|
def fails_on_everything_except(*dbs):
|
|
|
|
return succeeds_if(
|
2014-09-30 16:15:32 +00:00
|
|
|
OrPredicate([
|
2013-10-11 17:28:32 +00:00
|
|
|
SpecPredicate(db) for db in dbs
|
|
|
|
])
|
2014-09-30 16:15:32 +00:00
|
|
|
)
|
2013-10-11 17:28:32 +00:00
|
|
|
|
|
|
|
|
|
|
|
def skip(db, reason=None):
|
|
|
|
return skip_if(SpecPredicate(db), reason)
|
|
|
|
|
|
|
|
|
|
|
|
def only_on(dbs, reason=None):
|
|
|
|
return only_if(
|
2014-09-30 16:15:32 +00:00
|
|
|
OrPredicate([SpecPredicate(db) for db in util.to_list(dbs)])
|
2013-10-11 17:28:32 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
def exclude(db, op, spec, reason=None):
|
|
|
|
return skip_if(SpecPredicate(db, op, spec), reason)
|
|
|
|
|
|
|
|
|
|
|
|
def against(config, *queries):
|
|
|
|
assert queries, "no queries sent!"
|
|
|
|
return OrPredicate([
|
2014-09-30 16:15:32 +00:00
|
|
|
Predicate.as_predicate(query)
|
|
|
|
for query in queries
|
|
|
|
])(config)
|