c13fa886d9
Use load_module on the import hook to load the rewritten module. This allows the removal of the complicated code related to copying pyc files in and out of the cache location. It also plays more nicely with parallel py.test processes like the ones found in xdist.
106 lines
3.8 KiB
Python
106 lines
3.8 KiB
Python
"""
|
|
support for presenting detailed information in failing assertions.
|
|
"""
|
|
import py
|
|
import sys
|
|
import pytest
|
|
from _pytest.monkeypatch import monkeypatch
|
|
from _pytest.assertion import util
|
|
|
|
def pytest_addoption(parser):
|
|
group = parser.getgroup("debugconfig")
|
|
group.addoption('--assert', action="store", dest="assertmode",
|
|
choices=("rewrite", "reinterp", "plain",),
|
|
default="rewrite", metavar="MODE",
|
|
help="""control assertion debugging tools.
|
|
'plain' performs no assertion debugging.
|
|
'reinterp' reinterprets assert statements after they failed to provide assertion expression information.
|
|
'rewrite' (the default) rewrites assert statements in test modules on import
|
|
to provide assert expression information. """)
|
|
group.addoption('--no-assert', action="store_true", default=False,
|
|
dest="noassert", help="DEPRECATED equivalent to --assert=plain")
|
|
group.addoption('--nomagic', action="store_true", default=False,
|
|
dest="nomagic", help="DEPRECATED equivalent to --assert=plain")
|
|
|
|
class AssertionState:
|
|
"""State for the assertion plugin."""
|
|
|
|
def __init__(self, config, mode):
|
|
self.mode = mode
|
|
self.trace = config.trace.root.get("assertion")
|
|
|
|
def pytest_configure(config):
|
|
mode = config.getvalue("assertmode")
|
|
if config.getvalue("noassert") or config.getvalue("nomagic"):
|
|
mode = "plain"
|
|
if mode == "rewrite":
|
|
try:
|
|
import ast
|
|
except ImportError:
|
|
mode = "reinterp"
|
|
if mode != "plain":
|
|
_load_modules(mode)
|
|
def callbinrepr(op, left, right):
|
|
hook_result = config.hook.pytest_assertrepr_compare(
|
|
config=config, op=op, left=left, right=right)
|
|
for new_expl in hook_result:
|
|
if new_expl:
|
|
return '\n~'.join(new_expl)
|
|
m = monkeypatch()
|
|
config._cleanup.append(m.undo)
|
|
m.setattr(py.builtin.builtins, 'AssertionError',
|
|
reinterpret.AssertionError)
|
|
m.setattr(util, '_reprcompare', callbinrepr)
|
|
hook = None
|
|
if mode == "rewrite":
|
|
hook = rewrite.AssertionRewritingHook()
|
|
sys.meta_path.append(hook)
|
|
warn_about_missing_assertion(mode)
|
|
config._assertstate = AssertionState(config, mode)
|
|
config._assertstate.hook = hook
|
|
config._assertstate.trace("configured with mode set to %r" % (mode,))
|
|
|
|
def pytest_unconfigure(config):
|
|
hook = config._assertstate.hook
|
|
if hook is not None:
|
|
sys.meta_path.remove(hook)
|
|
|
|
def pytest_collection(session):
|
|
# this hook is only called when test modules are collected
|
|
# so for example not in the master process of pytest-xdist
|
|
# (which does not collect test modules)
|
|
hook = session.config._assertstate.hook
|
|
if hook is not None:
|
|
hook.set_session(session)
|
|
|
|
def pytest_sessionfinish(session):
|
|
hook = session.config._assertstate.hook
|
|
if hook is not None:
|
|
hook.session = None
|
|
|
|
def _load_modules(mode):
|
|
"""Lazily import assertion related code."""
|
|
global rewrite, reinterpret
|
|
from _pytest.assertion import reinterpret
|
|
if mode == "rewrite":
|
|
from _pytest.assertion import rewrite
|
|
|
|
def warn_about_missing_assertion(mode):
|
|
try:
|
|
assert False
|
|
except AssertionError:
|
|
pass
|
|
else:
|
|
if mode == "rewrite":
|
|
specifically = ("assertions which are not in test modules "
|
|
"will be ignored")
|
|
else:
|
|
specifically = "failing tests may report as passing"
|
|
|
|
sys.stderr.write("WARNING: " + specifically +
|
|
" because assert statements are not executed "
|
|
"by the underlying Python interpreter "
|
|
"(are you using python -O?)\n")
|
|
|
|
pytest_assertrepr_compare = util.assertrepr_compare
|