mirror of
https://github.com/Stone-Red-Code/dvc.git
synced 2026-11-02 07:18:25 +01:00
362 lines
12 KiB
Python
362 lines
12 KiB
Python
import logging
|
|
import os
|
|
|
|
import mock
|
|
import pytest
|
|
|
|
from dvc.cache import Cache
|
|
from dvc.exceptions import ConfirmRemoveError, PathMissingError
|
|
from dvc.external_repo import IsADVCRepoError
|
|
from dvc.main import main
|
|
from dvc.repo import Repo
|
|
from dvc.repo.get import GetDVCFileError
|
|
from dvc.system import System
|
|
from dvc.utils.fs import makedirs
|
|
from tests.unit.tree.test_repo import make_subrepo
|
|
|
|
|
|
def test_get_repo_file(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen("file", "contents", commit="create file")
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", "file_imported")
|
|
|
|
assert os.path.isfile("file_imported")
|
|
assert (tmp_dir / "file_imported").read_text() == "contents"
|
|
|
|
|
|
def test_get_repo_file_replace_without_confirmation(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen("file", "contents", commit="create file")
|
|
erepo_dir.dvc_gen(
|
|
"file2", "something different", commit="create file2"
|
|
)
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", "file_imported")
|
|
# getting another file with a name that already exists in Repo.
|
|
with pytest.raises(ConfirmRemoveError):
|
|
Repo.get(os.fspath(erepo_dir), "file2", "file_imported")
|
|
|
|
assert os.path.isfile("file_imported")
|
|
assert (tmp_dir / "file_imported").read_text() == "contents"
|
|
|
|
|
|
def test_get_repo_file_replace_yes(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen("file", "contents", commit="create file")
|
|
erepo_dir.dvc_gen(
|
|
"file2", "something different", commit="create file2"
|
|
)
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", "file_imported")
|
|
# getting another file with a name that already exists in Repo.
|
|
with mock.patch("dvc.prompt.confirm", return_value=True):
|
|
Repo.get(os.fspath(erepo_dir), "file2", "file_imported")
|
|
|
|
assert os.path.isfile("file_imported")
|
|
assert (tmp_dir / "file_imported").read_text() == "something different"
|
|
|
|
|
|
def test_get_repo_file_replace_no(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen("file", "contents", commit="create file")
|
|
erepo_dir.dvc_gen(
|
|
"file2", "something different", commit="create file2"
|
|
)
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", "file_imported")
|
|
# getting another file with a name that already exists in Repo.
|
|
with mock.patch("dvc.prompt.confirm", return_value=False):
|
|
with pytest.raises(ConfirmRemoveError):
|
|
Repo.get(os.fspath(erepo_dir), "file2", "file_imported")
|
|
|
|
assert os.path.isfile("file_imported")
|
|
assert (tmp_dir / "file_imported").read_text() == "contents"
|
|
|
|
|
|
def test_get_repo_dir(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen({"dir": {"file": "contents"}}, commit="create dir")
|
|
|
|
Repo.get(os.fspath(erepo_dir), "dir", "dir_imported")
|
|
|
|
assert (tmp_dir / "dir_imported").read_text() == {"file": "contents"}
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"erepo", [pytest.lazy_fixture("git_dir"), pytest.lazy_fixture("erepo_dir")]
|
|
)
|
|
def test_get_git_file(tmp_dir, erepo):
|
|
src = "some_file"
|
|
dst = "some_file_imported"
|
|
|
|
erepo.scm_gen({src: "hello"}, commit="add a regular file")
|
|
|
|
Repo.get(os.fspath(erepo), src, dst)
|
|
|
|
assert (tmp_dir / dst).read_text() == "hello"
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"erepo", [pytest.lazy_fixture("git_dir"), pytest.lazy_fixture("erepo_dir")]
|
|
)
|
|
def test_get_git_dir(tmp_dir, erepo):
|
|
src = "some_directory"
|
|
dst = "some_directory_imported"
|
|
|
|
erepo.scm_gen(
|
|
{src: {"dir": {"file.txt": "hello"}}}, commit="add a regular dir"
|
|
)
|
|
|
|
Repo.get(os.fspath(erepo), src, dst)
|
|
|
|
assert (tmp_dir / dst).read_text() == {"dir": {"file.txt": "hello"}}
|
|
|
|
|
|
def test_cache_type_is_properly_overridden(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
with erepo_dir.dvc.config.edit() as conf:
|
|
conf["cache"]["type"] = "symlink"
|
|
erepo_dir.dvc.cache = Cache(erepo_dir.dvc)
|
|
erepo_dir.scm_add(
|
|
[erepo_dir.dvc.config.files["repo"]], "set cache type to symlinks"
|
|
)
|
|
erepo_dir.dvc_gen("file", "contents", "create file")
|
|
assert System.is_symlink(erepo_dir / "file")
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", "file_imported")
|
|
|
|
assert not System.is_symlink("file_imported")
|
|
assert (tmp_dir / "file_imported").read_text() == "contents"
|
|
|
|
|
|
def test_get_repo_rev(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir(), erepo_dir.branch("branch", new=True):
|
|
erepo_dir.dvc_gen("file", "contents", commit="create file on branch")
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", "file_imported", rev="branch")
|
|
assert (tmp_dir / "file_imported").read_text() == "contents"
|
|
|
|
|
|
def test_get_from_non_dvc_repo(tmp_dir, git_dir):
|
|
git_dir.scm_gen({"some_file": "contents"}, commit="create file")
|
|
|
|
Repo.get(os.fspath(git_dir), "some_file", "file_imported")
|
|
assert (tmp_dir / "file_imported").read_text() == "contents"
|
|
|
|
|
|
def test_get_a_dvc_file(tmp_dir, erepo_dir):
|
|
with pytest.raises(GetDVCFileError):
|
|
Repo.get(os.fspath(erepo_dir), "some_file.dvc")
|
|
|
|
|
|
# https://github.com/iterative/dvc/pull/2837#discussion_r352123053
|
|
def test_get_full_dvc_path(tmp_dir, erepo_dir, tmp_path_factory):
|
|
path = tmp_path_factory.mktemp("ext")
|
|
external_data = path / "ext_data"
|
|
external_data.write_text("ext_data")
|
|
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc.add(os.fspath(external_data), external=True)
|
|
erepo_dir.scm_add("ext_data.dvc", commit="add external data")
|
|
|
|
Repo.get(
|
|
os.fspath(erepo_dir), os.fspath(external_data), "ext_data_imported"
|
|
)
|
|
assert (tmp_dir / "ext_data_imported").read_text() == "ext_data"
|
|
|
|
|
|
def test_non_cached_output(tmp_dir, erepo_dir):
|
|
src = "non_cached_file"
|
|
dst = src + "_imported"
|
|
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc.run(
|
|
outs_no_cache=[src],
|
|
cmd="echo hello > non_cached_file",
|
|
single_stage=True,
|
|
)
|
|
erepo_dir.scm_add([src, src + ".dvc"], commit="add non-cached output")
|
|
|
|
Repo.get(os.fspath(erepo_dir), src, dst)
|
|
|
|
assert (tmp_dir / dst).is_file()
|
|
# NOTE: using strip() to account for `echo` differences on win and *nix
|
|
assert (tmp_dir / dst).read_text().strip() == "hello"
|
|
|
|
|
|
# https://github.com/iterative/dvc/pull/2837#discussion_r352123053
|
|
def test_absolute_file_outside_repo(tmp_dir, erepo_dir):
|
|
with pytest.raises(PathMissingError):
|
|
Repo.get(os.fspath(erepo_dir), "/root/")
|
|
|
|
|
|
def test_absolute_file_outside_git_repo(tmp_dir, git_dir):
|
|
with pytest.raises(PathMissingError):
|
|
Repo.get(os.fspath(git_dir), "/root/")
|
|
|
|
|
|
def test_unknown_path(tmp_dir, erepo_dir):
|
|
with pytest.raises(PathMissingError):
|
|
Repo.get(os.fspath(erepo_dir), "a_non_existing_file")
|
|
|
|
|
|
@pytest.mark.parametrize("dname", [".", "dir", "dir/subdir"])
|
|
def test_get_to_dir(tmp_dir, erepo_dir, dname):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen("file", "contents", commit="create file")
|
|
|
|
makedirs(dname, exist_ok=True)
|
|
|
|
Repo.get(os.fspath(erepo_dir), "file", dname)
|
|
|
|
assert (tmp_dir / dname).is_dir()
|
|
assert (tmp_dir / dname / "file").read_text() == "contents"
|
|
|
|
|
|
def test_get_from_non_dvc_master(tmp_dir, git_dir):
|
|
with git_dir.chdir(), git_dir.branch("branch", new=True):
|
|
git_dir.init(dvc=True)
|
|
git_dir.dvc_gen("some_file", "some text", commit="create some file")
|
|
|
|
Repo.get(os.fspath(git_dir), "some_file", out="some_dst", rev="branch")
|
|
|
|
assert (tmp_dir / "some_dst").read_text() == "some text"
|
|
|
|
|
|
def test_get_file_from_dir(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen(
|
|
{
|
|
"dir": {
|
|
"1": "1",
|
|
"2": "2",
|
|
"subdir": {"foo": "foo", "bar": "bar"},
|
|
}
|
|
},
|
|
commit="create dir",
|
|
)
|
|
|
|
Repo.get(os.fspath(erepo_dir), os.path.join("dir", "1"))
|
|
assert (tmp_dir / "1").read_text() == "1"
|
|
|
|
Repo.get(os.fspath(erepo_dir), os.path.join("dir", "2"), out="file")
|
|
assert (tmp_dir / "file").read_text() == "2"
|
|
|
|
Repo.get(os.fspath(erepo_dir), os.path.join("dir", "subdir"))
|
|
assert (tmp_dir / "subdir" / "foo").read_text() == "foo"
|
|
assert (tmp_dir / "subdir" / "bar").read_text() == "bar"
|
|
|
|
Repo.get(
|
|
os.fspath(erepo_dir), os.path.join("dir", "subdir", "foo"), out="X"
|
|
)
|
|
assert (tmp_dir / "X").read_text() == "foo"
|
|
|
|
|
|
def test_get_url_positive(tmp_dir, erepo_dir, caplog, local_cloud):
|
|
erepo_dir.add_remote(config=local_cloud.config)
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen("foo", "foo")
|
|
erepo_dir.dvc.push()
|
|
|
|
caplog.clear()
|
|
with caplog.at_level(logging.ERROR, logger="dvc"):
|
|
assert main(["get", os.fspath(erepo_dir), "foo", "--show-url"]) == 0
|
|
assert caplog.text == ""
|
|
|
|
|
|
def test_get_url_not_existing(tmp_dir, erepo_dir, caplog):
|
|
with caplog.at_level(logging.ERROR, logger="dvc"):
|
|
assert (
|
|
main(
|
|
[
|
|
"get",
|
|
os.fspath(erepo_dir),
|
|
"not-existing-file",
|
|
"--show-url",
|
|
]
|
|
)
|
|
== 1
|
|
)
|
|
assert "failed to show URL" in caplog.text
|
|
|
|
|
|
def test_get_url_git_only_repo(tmp_dir, scm, caplog):
|
|
tmp_dir.scm_gen({"foo": "foo"}, commit="initial")
|
|
|
|
with caplog.at_level(logging.ERROR):
|
|
assert main(["get", os.fspath(tmp_dir), "foo", "--show-url"]) == 1
|
|
assert "failed to show URL" in caplog.text
|
|
|
|
|
|
def test_get_pipeline_tracked_outs(
|
|
tmp_dir, dvc, scm, git_dir, run_copy, local_remote
|
|
):
|
|
from dvc.dvcfile import PIPELINE_FILE, PIPELINE_LOCK
|
|
|
|
tmp_dir.gen("foo", "foo")
|
|
run_copy("foo", "bar", name="copy-foo-bar")
|
|
dvc.push()
|
|
|
|
dvc.scm.add([PIPELINE_FILE, PIPELINE_LOCK])
|
|
dvc.scm.commit("add pipeline stage")
|
|
|
|
with git_dir.chdir():
|
|
Repo.get("file:///{}".format(os.fspath(tmp_dir)), "bar", out="baz")
|
|
assert (git_dir / "baz").read_text() == "foo"
|
|
|
|
|
|
def test_get_mixed_dir(tmp_dir, erepo_dir):
|
|
with erepo_dir.chdir():
|
|
erepo_dir.dvc_gen(os.path.join("dir", "foo"), "foo", commit="foo")
|
|
erepo_dir.scm_gen(os.path.join("dir", "bar"), "bar", commit="bar")
|
|
|
|
Repo.get(os.fspath(erepo_dir), "dir")
|
|
assert (tmp_dir / "dir").read_text() == {
|
|
".gitignore": "/foo\n",
|
|
"foo": "foo",
|
|
"bar": "bar",
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize("is_dvc", [True, False])
|
|
@pytest.mark.parametrize("files", [{"foo": "foo"}, {"dir": {"bar": "bar"}}])
|
|
def test_get_from_subrepos(tmp_dir, erepo_dir, is_dvc, files):
|
|
subrepo = erepo_dir / "subrepo"
|
|
make_subrepo(subrepo, erepo_dir.scm)
|
|
gen = subrepo.dvc_gen if is_dvc else subrepo.scm_gen
|
|
with subrepo.chdir():
|
|
gen(files, commit="add files in subrepo")
|
|
|
|
key = next(iter(files))
|
|
Repo.get(os.fspath(erepo_dir), f"subrepo/{key}", out="out")
|
|
|
|
assert (tmp_dir / "out").read_text() == files[key]
|
|
|
|
|
|
def test_granular_get_from_subrepos(tmp_dir, erepo_dir):
|
|
subrepo = erepo_dir / "subrepo"
|
|
make_subrepo(subrepo, erepo_dir.scm)
|
|
with subrepo.chdir():
|
|
subrepo.dvc_gen({"dir": {"bar": "bar"}}, commit="files in subrepo")
|
|
|
|
path = os.path.join("subrepo", "dir", "bar")
|
|
Repo.get(os.fspath(erepo_dir), path, out="out")
|
|
assert (tmp_dir / "out").read_text() == "bar"
|
|
|
|
|
|
def test_try_to_get_complete_repo(tmp_dir, dvc, erepo_dir):
|
|
subrepo = erepo_dir / "subrepo"
|
|
make_subrepo(subrepo, erepo_dir.scm)
|
|
with subrepo.chdir():
|
|
subrepo.dvc_gen({"dir": {"bar": "bar"}}, commit="files in subrepo")
|
|
|
|
expected_message = "Cannot fetch a complete DVC repository"
|
|
with pytest.raises(IsADVCRepoError) as exc_info:
|
|
Repo.get(os.fspath(erepo_dir), "subrepo", out="out")
|
|
assert f"{expected_message} 'subrepo'" == str(exc_info.value)
|
|
|
|
with pytest.raises(IsADVCRepoError) as exc_info:
|
|
Repo.get(os.fspath(erepo_dir), ".", out="out")
|
|
assert expected_message == str(exc_info.value)
|