Skip to content

Fix symlink handling in dir_contains_files #5236

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
Flamefire wants to merge 2 commits into
base: develop
Choose a base branch
from
+39 −1
Open

Fix symlink handling in dir_contains_files #5236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
905e3ab
Fix `dir_contains_files` when files are in a symlinked folder
Flamefire Aug 11, 2026
0760124
Make handling of broken symlinks consistent for recursive and non-rec…
Flamefire Aug 11, 2026
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
4 changes: 3 additions & 1 deletion easybuild/tools/filetools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1286,7 +1286,9 @@ def dir_contains_files(path, recursive=True):
:recursive If False only the path itself is considered, else all subdirectories are also searched
"""
if recursive:
return any(files for _root, _dirs, files in os.walk(path))
return any(os.path.isfile(os.path.join(root, file))
for root, _dirs, files in os.walk(path, followlinks=True)
for file in files)
else:
return any(os.path.isfile(os.path.join(path, x)) for x in os.listdir(path))

Expand Down
36 changes: 36 additions & 0 deletions test/framework/filetools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2983,6 +2983,42 @@ def makedirs_in_test(*paths):
self.assertTrue(ft.dir_contains_files(dir_w_dir_and_file))
self.assertTrue(ft.dir_contains_files(dir_w_dir_and_file, recursive=False))

# Folder that is a symlink or contains a symlink to a folder
symlink_dir = makedirs_in_test('symlink_dir')
symlink_empty_folder = os.path.join(symlink_dir, 'to_empty')
ft.symlink(empty_dir, symlink_empty_folder)
self.assertFalse(ft.dir_contains_files(symlink_dir))
self.assertFalse(ft.dir_contains_files(symlink_dir, recursive=False))
self.assertFalse(ft.dir_contains_files(symlink_empty_folder))
self.assertFalse(ft.dir_contains_files(symlink_empty_folder, recursive=False))
symlink_full_folder = os.path.join(symlink_dir, 'to_full')
ft.symlink(dir_w_file, symlink_full_folder)
self.assertTrue(ft.dir_contains_files(symlink_dir))
self.assertFalse(ft.dir_contains_files(symlink_dir, recursive=False))
self.assertTrue(ft.dir_contains_files(symlink_full_folder))
self.assertTrue(ft.dir_contains_files(symlink_full_folder, recursive=False))

dir_w_symlinked_file = makedirs_in_test('dir_w_symlinked_file')
ft.symlink(os.path.join(dir_w_file, 'file.h'), os.path.join(dir_w_symlinked_file, 'file.h'))
self.assertTrue(ft.dir_contains_files(dir_w_symlinked_file))
self.assertTrue(ft.dir_contains_files(dir_w_symlinked_file, recursive=False))

dir_w_symlinked_file_in_subdir = makedirs_in_test('dir_w_symlinked_file_in_subdir', 'subdir')
subdir = os.path.join(dir_w_symlinked_file_in_subdir, 'subdir')
ft.symlink(os.path.join(dir_w_file, 'file.h'),
os.path.join(subdir, 'file.h'))
self.assertTrue(ft.dir_contains_files(dir_w_symlinked_file_in_subdir))
self.assertFalse(ft.dir_contains_files(dir_w_symlinked_file_in_subdir, recursive=False))
self.assertTrue(ft.dir_contains_files(subdir))
self.assertTrue(ft.dir_contains_files(subdir, recursive=False))

# Broken symlink is not considered a file
ft.remove_file(os.path.join(dir_w_file, 'file.h'))
self.assertFalse(ft.dir_contains_files(dir_w_symlinked_file_in_subdir))
self.assertFalse(ft.dir_contains_files(dir_w_symlinked_file_in_subdir, recursive=False))
self.assertFalse(ft.dir_contains_files(subdir))
self.assertFalse(ft.dir_contains_files(subdir, recursive=False))

def test_find_eb_script(self):
"""Test find_eb_script function."""

Expand Down