stubtest: Fix wrong assumption about relative path #12282
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Have you read the Contributing Guidelines?
yes
Description
Fixes #11019
run_stubtest
creates temp directory and prependsys.path
with relative path (dot.
) wrongly assuming that the dot will be resolved to absolute path on every import attempt.But in Python dot(
.
) in sys.path is actually resolved by PathFinder and cached insys.path_importer_cache
like:later calls for
find_module
return None and import oftest_module
fails. This resulted in only the first test in stubtest's suite passed in non-pytest-xdist environments.This issue was hidden with bug or feature in pytest-xdist < 2.3.0:
pytest-dev/pytest-xdist#421
It was fixed in pytest-xdist 2.3.0:
pytest-dev/pytest-xdist#667
sys.path for pytest-xdist < 2.3.0
'.', 'project_path', ''
sys.path for pytest-xdist >= 2.3.0 or without xdist
'.', 'project_path'
Proposed fix
In Python for denoting cwd the empty path
''
can be used as a special case, but for readabilitysys.path
is prepended with resolved absolute path of temp directory. Also it's essential to restore backsys.path
after a test to not break subsequent tests.