Skip to content

bpo-39986: Make test_listdir from test_os more robust #19035

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.

Sign up for GitHub

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

Open
MatzeB wants to merge 1 commit into
base: main
Choose a base branch
from
Open

bpo-39986: Make test_listdir from test_os more robust #19035

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
bpo-39986: Make test_listdir from test_os more robust 
The test_listdir test of test_os assumed that calling listdir on the
root directory twice gives the same results, however this can fail if
unrelated process create files in the root directory in between the two
calls. This changes the test to create a temporary directory with two
files inside and call listdir on this temporary directory instead.
  • Loading branch information
@MatzeB
MatzeB committed Mar 17, 2020
commit 3b66bf49e1f40850daa3738c272a3ed378db87a6
7 changes: 5 additions & 2 deletions Lib/test/test_os.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2206,8 +2206,11 @@ def test_listdir(self):
# test listdir without arguments
current_directory = os.getcwd()
try:
os.chdir(os.sep)
self.assertEqual(set(os.listdir()), set(os.listdir(os.sep)))
with tempfile.TemporaryDirectory() as tmpdir:
os.chdir(tmpdir)
open("a.txt", "w").close()
open("test_file.foo", "w").close()

@iritkatriel iritkatriel Jan 15, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you write something in the files just to make sure they are created on all platforms?

self.assertEqual(set(os.listdir()), set(os.listdir(tmpdir)))

@iritkatriel iritkatriel Jan 15, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to check that the file you created are in the output?

Comment on lines +2209 to +2213

@serhiy-storchaka serhiy-storchaka Feb 28, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is already a directory with a known content: self.dir.

Suggested change
with tempfile.TemporaryDirectory() as tmpdir:
os.chdir(tmpdir)
open("a.txt", "w").close()
open("test_file.foo", "w").close()
self.assertEqual(set(os.listdir()), set(os.listdir(tmpdir)))
os.chdir(self.dir)
self.assertEqual(set(os.listdir()), expected)

finally:
os.chdir(current_directory)

Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Tests/2020-03-16-19-38-15.bpo-39986.xK3wOi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Make test_os test_listdir test robust against root directory changing while
the test runs.