Fix: get_log_files() in xprocess/pytest_xprocess.py filters directory... - #165
Open
M001N wants to merge 1 commit into
Open
Fix: get_log_files() in xprocess/pytest_xprocess.py filters directory...#165M001N wants to merge 1 commit into
M001N wants to merge 1 commit into
Conversation
…t-dev#135) get_log_files() filtered candidate log files by name suffix only, without checking whether the entry was actually a file. A process working directory containing a subdirectory literally named 'log' (or otherwise ending in 'log') would be included in the returned list, causing callers to crash with IsADirectoryError when they tried to open() it. Add an os.path.isfile() check alongside the existing suffix filter. Add a self-contained regression test using tmp_path that reproduces the exact scenario from the issue.
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
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.
Summary
Added an os.path.isfile() check alongside the existing suffix filter:
if f.endswith("log") and os.path.isfile(os.path.join(proc_dir, f)), so directories are excluded from the returned log-file list.Problem
pytest-dev/pytest-xprocess issue reference: #135
Root Cause
get_log_files() in xprocess/pytest_xprocess.py filters directory entries with
if f.endswith("log")only, never checking whether the entry is a regular file. A subdirectory whose name ends in 'log' (e.g. one named exactly 'log') passes this filter and is returned alongside real log files.Testing
PASS - new regression test passes; full scoped suite (excluding the 3 known-flaky subprocess-based files) shows 25 passed, 3 skipped (skips are pre-existing, platform-gated SIGTERM test on win32), 0 failed.
Related Issue
#135