add: fix issue when adding already tracked symlinked files #4778
Conversation
This file contains 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
pmrowla
commented
Oct 23, 2020
dvc/utils/__init__.py
Outdated
| @@ -367,7 +367,7 @@ def resolve_paths(repo, out): | |||
| if ( | |||
| not scheme | |||
| and abspath.isin_or_eq(repo.root_dir) | |||
| and not contains_symlink_up_to(abspath, repo.root_dir) | |||
| and not contains_symlink_up_to(dirname, repo.root_dir) | |||
There was a problem hiding this comment.
We want to place the .dvc files into cwd() when the path leading up to the output contains a link, rather than when the output itself is a link, so we only need to check up to dirname here rather than abspath.
If the output itself is a symlink, it should not matter to DVC, as we will end up copying the file contents into DVC cache, and then replacing the original link with our own link or copy to the DVC cache entry. In that case, it is still safe for us to place the .dvc into the same directory as the original symlink.
pmrowla
force-pushed
the
4654-add-symlink
branch
from
4ea0d56 to
108e309
Compare
pmrowla
changed the title
pared
approved these changes
Oct 23, 2020
|
|
||
| # Test that subsequent add succeeds | ||
| # See https://github.com/iterative/dvc/issues/4654 | ||
| dvc.add(os.path.join("dir", "foo")) |
pmrowla
changed the title
pmrowla
force-pushed
the
4654-add-symlink
branch
from
108e309 to
9b77273
Compare
pmrowla
commented
Oct 26, 2020
Comment on lines
-425
to
-470
| class SymlinkAddTestBase(TestDvc): | ||
| def _get_data_dir(self): | ||
| raise NotImplementedError | ||
|
|
||
| def _prepare_external_data(self): | ||
| data_dir = self._get_data_dir() | ||
|
|
||
| data_file_name = "data_file" | ||
| external_data_path = os.path.join(data_dir, data_file_name) | ||
| with open(external_data_path, "w+") as f: | ||
| f.write("data") | ||
|
|
||
| link_name = "data_link" | ||
| System.symlink(data_dir, link_name) | ||
| return data_file_name, link_name | ||
|
|
||
| def _test(self): | ||
| data_file_name, link_name = self._prepare_external_data() | ||
|
|
||
| ret = main(["add", os.path.join(link_name, data_file_name)]) | ||
| self.assertEqual(0, ret) | ||
|
|
||
| stage_file = data_file_name + DVC_FILE_SUFFIX | ||
| self.assertTrue(os.path.exists(stage_file)) | ||
|
|
||
| d = load_yaml(stage_file) | ||
| relative_data_path = posixpath.join(link_name, data_file_name) | ||
| self.assertEqual(relative_data_path, d["outs"][0]["path"]) | ||
|
|
||
|
|
||
| class TestShouldAddDataFromExternalSymlink(SymlinkAddTestBase): | ||
| def _get_data_dir(self): | ||
| return self.mkdtemp() | ||
|
|
||
| def test(self): | ||
| self._test() | ||
|
|
||
|
|
||
| class TestShouldAddDataFromInternalSymlink(SymlinkAddTestBase): | ||
| def _get_data_dir(self): | ||
| return self.DATA_DIR | ||
|
|
||
| def test(self): | ||
| self._test() | ||
|
|
||
|
|
There was a problem hiding this comment.
These cases are covered by the new pytest based tests
pmrowla
changed the title
efiop
reviewed
Oct 26, 2020
dvc/utils/__init__.py
Outdated
| ): | ||
| raise DvcException( | ||
| "Cannot add files inside symlinked directories to DVC." |
There was a problem hiding this comment.
Looks like we should make it a bit more helpful. Maybe a link to troubleshooting doc?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏
Will fix #4654.
dvc add <symlinked_file>now works as expected. The DVC file will be placed in the same directory as the original symlinkdvc add'ing symlinked a directory or a file inside a symlinked directory is now forbidden.Docs PR: iterative/dvc.org#1890