-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve handling of pyargs #3010
Changes from 1 commit
b62fd79
dc19624
3ca1e4b
1e29553
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Fix conversion of pyargs to filename to not convert symlinks and not use deprecated features on Python 3. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,8 @@ | |
import os | ||
import sys | ||
|
||
import six | ||
|
||
import _pytest._code | ||
import py | ||
import pytest | ||
|
@@ -645,6 +647,69 @@ def join_pythonpath(*dirs): | |
"*1 passed*" | ||
]) | ||
|
||
@pytest.mark.skipif(not hasattr(os, "symlink"), reason="requires symlinks") | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This assumes if the python/os supports symlinks, so does the filesystem the temporary directory is created. This is not a given, but as this is in testing only, and generally this is the case (both in CI and locally) in most workflows, I think this is good enough. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree 😁 |
||
def test_cmdline_python_package_symlink(self, testdir, monkeypatch): | ||
""" | ||
test --pyargs option with packages with path containing symlink can | ||
have conftest.py in their package (#2985) | ||
""" | ||
monkeypatch.delenv('PYTHONDONTWRITEBYTECODE', raising=False) | ||
|
||
search_path = ["lib", os.path.join("local", "lib")] | ||
|
||
dirname = "lib" | ||
d = testdir.mkdir(dirname) | ||
foo = d.mkdir("foo") | ||
foo.ensure("__init__.py") | ||
lib = foo.mkdir('bar') | ||
lib.ensure("__init__.py") | ||
lib.join("test_bar.py"). \ | ||
write("def test_bar(): pass\n" | ||
"def test_other(a_fixture):pass") | ||
lib.join("conftest.py"). \ | ||
write("import pytest\n" | ||
"@pytest.fixture\n" | ||
"def a_fixture():pass") | ||
|
||
d_local = testdir.mkdir("local") | ||
symlink_location = os.path.join(str(d_local), "lib") | ||
if six.PY2: | ||
os.symlink(str(d), symlink_location) | ||
else: | ||
os.symlink(str(d), symlink_location, target_is_directory=True) | ||
|
||
# The structure of the test directory is now: | ||
# . | ||
# ├── local | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I tried to keep close to the actual issue, and kept the virtualenv structure. |
||
# │ └── lib -> ../world | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this comment is incorrect, there's no |
||
# └── lib | ||
# └── foo | ||
# ├── __init__.py | ||
# └── bar | ||
# ├── __init__.py | ||
# ├── conftest.py | ||
# └── test_world.py | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ditto here, the code above is creating |
||
|
||
def join_pythonpath(*dirs): | ||
cur = py.std.os.environ.get('PYTHONPATH') | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You can use |
||
if cur: | ||
dirs += (cur,) | ||
return os.pathsep.join(str(p) for p in dirs) | ||
|
||
monkeypatch.setenv('PYTHONPATH', join_pythonpath(*search_path)) | ||
for p in search_path: | ||
monkeypatch.syspath_prepend(p) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @blueyed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @cryvate
Which one do you mean? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @blueyed |
||
|
||
# module picked up in symlink-ed directory: | ||
result = testdir.runpytest("--pyargs", "-v", "foo.bar") | ||
testdir.chdir() | ||
assert result.ret == 0 | ||
result.stdout.fnmatch_lines([ | ||
"*lib/foo/bar/test_bar.py::test_bar*PASSED*", | ||
"*lib/foo/bar/test_bar.py::test_other*PASSED*", | ||
"*2 passed*" | ||
]) | ||
|
||
def test_cmdline_python_package_not_exists(self, testdir): | ||
result = testdir.runpytest("--pyargs", "tpkgwhatv") | ||
assert result.ret | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a little concerned about patching this globally like it is done here... who knows what we might break by patching this.
I would rather be conservative and patch this only while we are calling
find_loader
in the lines below this one. I think a nice way to implement this would be by using acontextmanager
:And
_patched_find_module
can be implemented like so:We can then even use
_patched_find_module()
's docstring to better explain what's going on.