import os from unittest.mock import ANY, patch from dvc.external_repo import CLONES, external_repo from dvc.objects.stage import stage from dvc.objects.transfer import transfer from dvc.scm.git import Git from dvc.utils import relpath from dvc.utils.fs import makedirs, remove from tests.unit.fs.test_repo import make_subrepo from tests.utils import clean_staging def test_external_repo(erepo_dir, mocker): with erepo_dir.chdir(): with erepo_dir.branch("branch", new=True): erepo_dir.dvc_gen("file", "branch", commit="create file on branch") erepo_dir.dvc_gen("file", "master", commit="create file on master") url = os.fspath(erepo_dir) mock = mocker.patch.object(Git, "clone", wraps=Git.clone) with external_repo(url) as repo: with repo.open_by_relpath("file") as fd: assert fd.read() == "master" with external_repo(url, rev="branch") as repo: with repo.open_by_relpath("file") as fd: assert fd.read() == "branch" assert mock.call_count == 1 def test_source_change(erepo_dir): url = os.fspath(erepo_dir) with external_repo(url) as repo: old_rev = repo.scm.get_rev() erepo_dir.scm_gen("file", "text", commit="a change") with external_repo(url) as repo: new_rev = repo.scm.get_rev() assert old_rev != new_rev def test_cache_reused(erepo_dir, mocker, local_cloud): import dvc.fs.utils erepo_dir.add_remote(config=local_cloud.config) with erepo_dir.chdir(): erepo_dir.dvc_gen("file", "text", commit="add file") erepo_dir.dvc.push() download_spy = mocker.spy(dvc.fs.utils, "transfer") # Use URL to prevent any fishy optimizations url = f"file://{erepo_dir}" with external_repo(url) as repo: repo.fetch() assert download_spy.mock.call_count == 1 # Should not download second time erepo_dir.scm.branch("branch") with external_repo(url, "branch") as repo: repo.fetch() assert download_spy.mock.call_count == 1 def test_known_sha(erepo_dir): erepo_dir.scm.commit("init") url = f"file://{erepo_dir}" with external_repo(url) as repo: rev = repo.scm.get_rev() prev_rev = repo.scm.resolve_rev("HEAD^") # Hits cache with external_repo(url, rev) as repo: pass # No clone, no pull, copies a repo, checks out the known sha with external_repo(url, prev_rev) as repo: pass def test_pull_subdir_file(tmp_dir, erepo_dir): with erepo_dir.chdir(): subdir = erepo_dir / "subdir" subdir.mkdir() (subdir / "file").write_text("contents") erepo_dir.dvc_add(subdir / "file", commit="create file") dest = tmp_dir / "file" with external_repo(os.fspath(erepo_dir)) as repo: repo.repo_fs.download( os.path.join(repo.root_dir, "subdir", "file"), os.fspath(dest), ) assert dest.is_file() assert dest.read_text() == "contents" def test_relative_remote(erepo_dir, tmp_dir): # these steps reproduce the script on this issue: # https://github.com/iterative/dvc/issues/2756 with erepo_dir.chdir(): erepo_dir.dvc_gen("file", "contents", commit="create file") upstream_dir = tmp_dir upstream_url = relpath(upstream_dir, erepo_dir) erepo_dir.add_remote(url=upstream_url) erepo_dir.dvc.push() (erepo_dir / "file").unlink() remove(erepo_dir.dvc.odb.local.cache_dir) url = os.fspath(erepo_dir) with external_repo(url) as repo: assert os.path.isabs(repo.config["remote"]["upstream"]["url"]) assert os.path.isdir(repo.config["remote"]["upstream"]["url"]) with repo.open_by_relpath("file") as fd: assert fd.read() == "contents" def test_shallow_clone_branch(erepo_dir): with erepo_dir.chdir(): with erepo_dir.branch("branch", new=True): erepo_dir.dvc_gen("file", "branch", commit="create file on branch") erepo_dir.dvc_gen("file", "master", commit="create file on master") url = os.fspath(erepo_dir) with patch.object(Git, "clone", wraps=Git.clone) as mock_clone: with external_repo(url, rev="branch") as repo: with repo.open_by_relpath("file") as fd: assert fd.read() == "branch" mock_clone.assert_called_with( url, ANY, shallow_branch="branch", progress=ANY ) _, shallow = CLONES[url] assert shallow with external_repo(url) as repo: with repo.open_by_relpath("file") as fd: assert fd.read() == "master" assert mock_clone.call_count == 1 _, shallow = CLONES[url] assert not shallow def test_shallow_clone_tag(erepo_dir): with erepo_dir.chdir(): erepo_dir.dvc_gen("file", "foo", commit="init") erepo_dir.scm.tag("v1") erepo_dir.dvc_gen("file", "bar", commit="update file") url = os.fspath(erepo_dir) with patch.object(Git, "clone", wraps=Git.clone) as mock_clone: with external_repo(url, rev="v1") as repo: with repo.open_by_relpath("file") as fd: assert fd.read() == "foo" mock_clone.assert_called_with( url, ANY, shallow_branch="v1", progress=ANY ) _, shallow = CLONES[url] assert shallow with external_repo(url, rev="master") as repo: with repo.open_by_relpath("file") as fd: assert fd.read() == "bar" assert mock_clone.call_count == 1 _, shallow = CLONES[url] assert not shallow def test_subrepos_are_ignored(tmp_dir, erepo_dir): subrepo = erepo_dir / "dir" / "subrepo" make_subrepo(subrepo, erepo_dir.scm) with erepo_dir.chdir(): erepo_dir.dvc_gen("dir/foo", "foo", commit="foo") erepo_dir.scm_gen("dir/bar", "bar", commit="bar") with subrepo.chdir(): subrepo.dvc_gen({"file": "file"}, commit="add files on subrepo") with external_repo(os.fspath(erepo_dir)) as repo: repo.repo_fs.download( os.path.join(repo.root_dir, "dir"), os.fspath(tmp_dir / "out"), ) expected_files = {"foo": "foo", "bar": "bar", ".gitignore": "/foo\n"} assert (tmp_dir / "out").read_text() == expected_files # clear cache to test saving to cache cache_dir = tmp_dir / repo.odb.local.cache_dir remove(cache_dir) clean_staging() makedirs(cache_dir) staging, _, obj = stage( repo.odb.local, os.path.join(repo.root_dir, "dir"), repo.repo_fs, "md5", dvcignore=repo.dvcignore, ) transfer( staging, repo.odb.local, {obj.hash_info}, shallow=False, hardlink=True, ) assert set(cache_dir.glob("??/*")) == { cache_dir / "e1" / "d9e8eae5374860ae025ec84cfd85c7.dir", cache_dir / "37" / "b51d194a7513e45b56f6524f2d51f2", cache_dir / "94" / "7d2b84e5aa88170e80dff467a5bfb6", cache_dir / "ac" / "bd18db4cc2f85cedef654fccc4a4d8", } def test_subrepos_are_ignored_for_git_tracked_dirs(tmp_dir, erepo_dir): subrepo = erepo_dir / "dir" / "subrepo" make_subrepo(subrepo, erepo_dir.scm) with erepo_dir.chdir(): scm_files = {"foo": "foo", "bar": "bar", "subdir": {"lorem": "lorem"}} erepo_dir.scm_gen({"dir": scm_files}, commit="add scm dir") with subrepo.chdir(): subrepo.dvc_gen({"file": "file"}, commit="add files on subrepo") with external_repo(os.fspath(erepo_dir)) as repo: repo.repo_fs.download( os.path.join(repo.root_dir, "dir"), os.fspath(tmp_dir / "out"), ) # subrepo files should not be here assert (tmp_dir / "out").read_text() == scm_files