gh-156376: Make test_environ_path_cwd independent of the ambient environment - #156377
Open
KindPinningFinalBoss wants to merge 1 commit into
Open
gh-156376: Make test_environ_path_cwd independent of the ambient environment#156377KindPinningFinalBoss wants to merge 1 commit into
KindPinningFinalBoss wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
…t environment shutil.which() only inserts the current directory into the search path when _winapi.NeedCurrentDirectoryForExePath() returns true, and that consults the NoDefaultCurrentDirectoryInExePath environment variable. On a machine where that variable is set, TestWhich.test_environ_path_cwd and TestWhichBytes.test_environ_path_cwd failed because which() correctly declined to search the current directory. Unset the variable inside the EnvironmentVarGuard the test already uses, so an ambient value cannot change what the test exercises.
Copy link
Copy Markdown
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead. |
Sorry, something went wrong.
Copy link
Copy Markdown
|
The following commit authors need to sign the Contributor License Agreement: |
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 participant
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.Suggestion cannot be applied right now. Please check back later.
TestWhich.test_environ_path_cwd and TestWhichBytes.test_environ_path_cwd
fail on Windows when NoDefaultCurrentDirectoryInExePath is set in the
environment the test suite runs in.
The test clears PATH so that shutil.which() falls back to the current
directory, then asserts the result is .\<file>. But shutil.which() only
inserts the current directory into the search path when
_win_path_needs_curdir() returns true, which delegates to
_winapi.NeedCurrentDirectoryForExePath(). That API consults
NoDefaultCurrentDirectoryInExePath, so when the variable is present
which() correctly declines to search the current directory and the
assertion fails.
The test already opens an os_helper.EnvironmentVarGuard to set PATH;
this unsets NoDefaultCurrentDirectoryInExePath in the same guard so the
ambient environment cannot change what the test exercises.
TestWhich.test_win_path_needs_curdir in the same class already accounts
for this mechanism by patching _winapi.NeedCurrentDirectoryForExePath.
Verified on Windows 11, main at 04242c0:
No behaviour change to shutil; test-only.