Add tests for early rewrite bailout code and handle patterns with subdirectories
This commit is contained in:
parent
d53e449296
commit
4675912d89
|
@ -67,7 +67,7 @@ class AssertionRewritingHook(object):
|
|||
# flag to guard against trying to rewrite a pyc file while we are already writing another pyc file,
|
||||
# which might result in infinite recursion (#3506)
|
||||
self._writing_pyc = False
|
||||
self._basenames_to_check_rewrite = set('conftest',)
|
||||
self._basenames_to_check_rewrite = {"conftest"}
|
||||
self._marked_for_rewrite_cache = {}
|
||||
self._session_paths_checked = False
|
||||
|
||||
|
@ -75,6 +75,10 @@ class AssertionRewritingHook(object):
|
|||
self.session = session
|
||||
self._session_paths_checked = False
|
||||
|
||||
def _imp_find_module(self, name, path=None):
|
||||
"""Indirection so we can mock calls to find_module originated from the hook during testing"""
|
||||
return imp.find_module(name, path)
|
||||
|
||||
def find_module(self, name, path=None):
|
||||
if self._writing_pyc:
|
||||
return None
|
||||
|
@ -93,7 +97,7 @@ class AssertionRewritingHook(object):
|
|||
pth = path[0]
|
||||
if pth is None:
|
||||
try:
|
||||
fd, fn, desc = imp.find_module(lastname, path)
|
||||
fd, fn, desc = self._imp_find_module(lastname, path)
|
||||
except ImportError:
|
||||
return None
|
||||
if fd is not None:
|
||||
|
@ -179,8 +183,7 @@ class AssertionRewritingHook(object):
|
|||
from this class) is a major slowdown, so, this method tries to
|
||||
filter what we're sure won't be rewritten before getting to it.
|
||||
"""
|
||||
if not self._session_paths_checked and self.session is not None \
|
||||
and hasattr(self.session, '_initialpaths'):
|
||||
if self.session is not None and not self._session_paths_checked:
|
||||
self._session_paths_checked = True
|
||||
for path in self.session._initialpaths:
|
||||
# Make something as c:/projects/my_project/path.py ->
|
||||
|
@ -190,14 +193,18 @@ class AssertionRewritingHook(object):
|
|||
self._basenames_to_check_rewrite.add(os.path.splitext(parts[-1])[0])
|
||||
|
||||
# Note: conftest already by default in _basenames_to_check_rewrite.
|
||||
parts = name.split('.')
|
||||
parts = name.split(".")
|
||||
if parts[-1] in self._basenames_to_check_rewrite:
|
||||
return False
|
||||
|
||||
# For matching the name it must be as if it was a filename.
|
||||
parts[-1] = parts[-1] + '.py'
|
||||
parts[-1] = parts[-1] + ".py"
|
||||
fn_pypath = py.path.local(os.path.sep.join(parts))
|
||||
for pat in self.fnpats:
|
||||
# if the pattern contains subdirectories ("tests/**.py" for example) we can't bail out based
|
||||
# on the name alone because we need to match against the full path
|
||||
if os.path.dirname(pat):
|
||||
return False
|
||||
if fn_pypath.fnmatch(pat):
|
||||
return False
|
||||
|
||||
|
@ -237,7 +244,7 @@ class AssertionRewritingHook(object):
|
|||
state.trace("matched marked file %r (from %r)" % (name, marked))
|
||||
self._marked_for_rewrite_cache[name] = True
|
||||
return True
|
||||
|
||||
|
||||
self._marked_for_rewrite_cache[name] = False
|
||||
return False
|
||||
|
||||
|
@ -289,6 +296,16 @@ class AssertionRewritingHook(object):
|
|||
raise
|
||||
return sys.modules[name]
|
||||
|
||||
def is_package(self, name):
|
||||
try:
|
||||
fd, fn, desc = imp.find_module(name)
|
||||
except ImportError:
|
||||
return False
|
||||
if fd is not None:
|
||||
fd.close()
|
||||
tp = desc[2]
|
||||
return tp == imp.PKG_DIRECTORY
|
||||
|
||||
@classmethod
|
||||
def _register_with_pkg_resources(cls):
|
||||
"""
|
||||
|
|
|
@ -383,6 +383,7 @@ class Session(nodes.FSCollector):
|
|||
self.trace = config.trace.root.get("collection")
|
||||
self._norecursepatterns = config.getini("norecursedirs")
|
||||
self.startdir = py.path.local()
|
||||
self._initialpaths = frozenset()
|
||||
# Keep track of any collected nodes in here, so we don't duplicate fixtures
|
||||
self._node_cache = {}
|
||||
|
||||
|
@ -565,7 +566,6 @@ class Session(nodes.FSCollector):
|
|||
"""Convert a dotted module name to path.
|
||||
|
||||
"""
|
||||
|
||||
try:
|
||||
with _patched_find_module():
|
||||
loader = pkgutil.find_loader(x)
|
||||
|
|
|
@ -1106,22 +1106,21 @@ class TestIssue925(object):
|
|||
|
||||
|
||||
class TestIssue2121:
|
||||
def test_simple(self, testdir):
|
||||
testdir.tmpdir.join("tests/file.py").ensure().write(
|
||||
"""
|
||||
def test_simple_failure():
|
||||
assert 1 + 1 == 3
|
||||
"""
|
||||
)
|
||||
testdir.tmpdir.join("pytest.ini").write(
|
||||
textwrap.dedent(
|
||||
def test_rewrite_python_files_contain_subdirs(self, testdir):
|
||||
testdir.makepyfile(
|
||||
**{
|
||||
"tests/file.py": """
|
||||
def test_simple_failure():
|
||||
assert 1 + 1 == 3
|
||||
"""
|
||||
[pytest]
|
||||
python_files = tests/**.py
|
||||
"""
|
||||
)
|
||||
}
|
||||
)
|
||||
testdir.makeini(
|
||||
"""
|
||||
[pytest]
|
||||
python_files = tests/**.py
|
||||
"""
|
||||
)
|
||||
|
||||
result = testdir.runpytest()
|
||||
result.stdout.fnmatch_lines("*E*assert (1 + 1) == 3")
|
||||
|
||||
|
@ -1153,3 +1152,83 @@ def test_rewrite_infinite_recursion(testdir, pytestconfig, monkeypatch):
|
|||
hook = AssertionRewritingHook(pytestconfig)
|
||||
assert hook.find_module("test_foo") is not None
|
||||
assert len(write_pyc_called) == 1
|
||||
|
||||
|
||||
class TestEarlyRewriteBailout(object):
|
||||
@pytest.fixture
|
||||
def hook(self, pytestconfig, monkeypatch, testdir):
|
||||
"""Returns a patched AssertionRewritingHook instance so we can configure its initial paths and track
|
||||
if imp.find_module has been called.
|
||||
"""
|
||||
import imp
|
||||
|
||||
self.find_module_calls = []
|
||||
self.initial_paths = set()
|
||||
|
||||
class StubSession(object):
|
||||
_initialpaths = self.initial_paths
|
||||
|
||||
def isinitpath(self, p):
|
||||
return p in self._initialpaths
|
||||
|
||||
def spy_imp_find_module(name, path):
|
||||
self.find_module_calls.append(name)
|
||||
return imp.find_module(name, path)
|
||||
|
||||
hook = AssertionRewritingHook(pytestconfig)
|
||||
# use default patterns, otherwise we inherit pytest's testing config
|
||||
hook.fnpats[:] = ["test_*.py", "*_test.py"]
|
||||
monkeypatch.setattr(hook, "_imp_find_module", spy_imp_find_module)
|
||||
hook.set_session(StubSession())
|
||||
testdir.syspathinsert()
|
||||
return hook
|
||||
|
||||
def test_basic(self, testdir, hook):
|
||||
"""
|
||||
Ensure we avoid calling imp.find_module when we know for sure a certain module will not be rewritten
|
||||
to optimize assertion rewriting (#3918).
|
||||
"""
|
||||
testdir.makeconftest(
|
||||
"""
|
||||
import pytest
|
||||
@pytest.fixture
|
||||
def fix(): return 1
|
||||
"""
|
||||
)
|
||||
testdir.makepyfile(test_foo="def test_foo(): pass")
|
||||
testdir.makepyfile(bar="def bar(): pass")
|
||||
foobar_path = testdir.makepyfile(foobar="def foobar(): pass")
|
||||
self.initial_paths.add(foobar_path)
|
||||
|
||||
# conftest files should always be rewritten
|
||||
assert hook.find_module("conftest") is not None
|
||||
assert self.find_module_calls == ["conftest"]
|
||||
|
||||
# files matching "python_files" mask should always be rewritten
|
||||
assert hook.find_module("test_foo") is not None
|
||||
assert self.find_module_calls == ["conftest", "test_foo"]
|
||||
|
||||
# file does not match "python_files": early bailout
|
||||
assert hook.find_module("bar") is None
|
||||
assert self.find_module_calls == ["conftest", "test_foo"]
|
||||
|
||||
# file is an initial path (passed on the command-line): should be rewritten
|
||||
assert hook.find_module("foobar") is not None
|
||||
assert self.find_module_calls == ["conftest", "test_foo", "foobar"]
|
||||
|
||||
def test_pattern_contains_subdirectories(self, testdir, hook):
|
||||
"""If one of the python_files patterns contain subdirectories ("tests/**.py") we can't bailout early
|
||||
because we need to match with the full path, which can only be found by calling imp.find_module.
|
||||
"""
|
||||
p = testdir.makepyfile(
|
||||
**{
|
||||
"tests/file.py": """
|
||||
def test_simple_failure():
|
||||
assert 1 + 1 == 3
|
||||
"""
|
||||
}
|
||||
)
|
||||
testdir.syspathinsert(p.dirpath())
|
||||
hook.fnpats[:] = ["tests/**.py"]
|
||||
assert hook.find_module("file") is not None
|
||||
assert self.find_module_calls == ["file"]
|
||||
|
|
Loading…
Reference in New Issue