Skip to content

change copy_file function to raise an error when trying to copy non-existing file #3836

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

Merged
merged 9 commits into from
Sep 21, 2021
Merged

change copy_file function to raise an error when trying to copy non-existing file #3836

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
88034ab
Explicitly check if a file exist when copying
Sep 15, 2021
a7dde5f
Do not check if path is a file
Sep 15, 2021
a9745d9
Added check if path is a broken symlink
Sep 15, 2021
90c2467
Added test for copy of non-existing file
Sep 16, 2021
c951010
Do not raise exception in dry run mode
Sep 17, 2021
f0ab458
Added import of 'update_build_options'
Sep 17, 2021
9313e40
Fixed so that copy_file adheres to dry run
Sep 17, 2021
07e131e
Merge branch 'develop' into ensure_path_exist_copy_file
boegel Sep 17, 2021
23dc203
Merge branch 'ensure_path_exist_copy_file' of github.com:nordmoen/eas…
boegel Sep 17, 2021
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
12 changes: 8 additions & 4 deletions easybuild/tools/filetools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2270,6 +2270,9 @@ def copy_file(path, target_path, force_in_dry_run=False):
:param target_path: path to copy the file to
:param force_in_dry_run: force copying of file during dry run
"""
# NOTE: 'exists' will return False if 'path' is a broken symlink
if not os.path.exists(path) and not os.path.islink(path):
raise EasyBuildError("Could not copy '%s' it does not exist!" % path)
if not force_in_dry_run and build_option('extended_dry_run'):
dry_run_msg("copied file %s to %s" % (path, target_path))
else:
Expand All @@ -2285,13 +2288,14 @@ def copy_file(path, target_path, force_in_dry_run=False):
_log.info("Copied contents of file %s to %s", path, target_path)
else:
mkdir(os.path.dirname(target_path), parents=True)
if os.path.exists(path):
shutil.copy2(path, target_path)
elif os.path.islink(path):
if os.path.islink(path):
# special care for copying broken symlinks
link_target = os.readlink(path)
symlink(link_target, target_path)
_log.info("%s copied to %s", path, target_path)
_log.info("created symlink from %s to %s", path, target_path)
else:
shutil.copy2(path, target_path)
_log.info("%s copied to %s", path, target_path)
except (IOError, OSError, shutil.Error) as err:
raise EasyBuildError("Failed to copy file %s to %s: %s", path, target_path, err)

Expand Down
4 changes: 4 additions & 0 deletions test/framework/filetools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1661,6 +1661,10 @@ def test_copy_file(self):
self.assertTrue(ft.read_file(to_copy) == ft.read_file(target_path))
self.assertEqual(txt, '')

# Test that a non-existing file raises an exception
src, target = os.path.join(self.test_prefix, 'this_file_does_not_exist'), os.path.join(self.test_prefix, 'toy')
self.assertErrorRegex(EasyBuildError, "Could not copy *", ft.copy_file, src, target)

def test_copy_files(self):
"""Test copy_files function."""
test_ecs = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'easyconfigs', 'test_ecs')
Expand Down