dvc/tests/unit/objects/db/test_local.py

import errno
import os

import pytest

from dvc.fs.local import LocalFileSystem
from dvc.hash_info import HashInfo
from dvc.objects.db.local import LocalObjectDB
from dvc.objects.file import HashFile
from dvc.path_info import PathInfo


def test_status_download_optimization(mocker, dvc):
    """When comparing the status to pull a remote cache,
    And the desired files to fetch are already on the local cache,
    Don't check the existence of the desired files on the remote cache
    """
    from dvc.objects.status import compare_status

    odb = LocalObjectDB(LocalFileSystem(), PathInfo("."))
    objs = {
        HashFile(
            None, odb.fs, HashInfo("md5", "acbd18db4cc2f85cedef654fccc4a4d8")
        ),
        HashFile(
            None, odb.fs, HashInfo("md5", "37b51d194a7513e45b56f6524f2d51f2")
        ),
    }

    local_exists = [obj.hash_info.value for obj in objs]
    mocker.patch.object(odb, "hashes_exist", return_value=local_exists)

    src_odb = mocker.Mock()

    compare_status(src_odb, odb, objs, check_deleted=False)
    assert src_odb.hashes_exist.call_count == 0


@pytest.mark.parametrize("link_name", ["hardlink", "symlink"])
def test_is_protected(tmp_dir, dvc, link_name):
    odb = dvc.odb.local
    fs = odb.fs
    link_method = getattr(fs, link_name)

    (tmp_dir / "foo").write_text("foo")

    foo = PathInfo(tmp_dir / "foo")
    link = PathInfo(tmp_dir / "link")

    link_method(foo, link)

    assert not odb.is_protected(foo)
    assert not odb.is_protected(link)

    odb.protect(foo)

    assert odb.is_protected(foo)
    assert odb.is_protected(link)

    odb.unprotect(link)

    assert not odb.is_protected(link)
    if os.name == "nt" and link_name == "hardlink":
        # NOTE: NTFS doesn't allow deleting read-only files, which forces us to
        # set write perms on the link, which propagates to the source.
        assert not odb.is_protected(foo)
    else:
        assert odb.is_protected(foo)


@pytest.mark.parametrize("err", [errno.EPERM, errno.EACCES, errno.EROFS])
def test_protect_ignore_errors(tmp_dir, dvc, mocker, err):
    tmp_dir.gen("foo", "foo")

    mock_chmod = mocker.patch(
        "os.chmod", side_effect=OSError(err, "something")
    )
    dvc.odb.local.protect(PathInfo("foo"))
    assert mock_chmod.called


@pytest.mark.parametrize("err", [errno.EPERM, errno.EACCES, errno.EROFS])
def test_set_exec_ignore_errors(tmp_dir, dvc, mocker, err):
    tmp_dir.gen("foo", "foo")

    mock_chmod = mocker.patch(
        "os.chmod", side_effect=OSError(err, "something")
    )
    dvc.odb.local.set_exec(PathInfo("foo"))
    assert mock_chmod.called


def test_staging_file(tmp_dir, dvc):
    from dvc.objects import check, save
    from dvc.objects.stage import get_staging, stage

    tmp_dir.gen("foo", "foo")
    fs = LocalFileSystem()

    local_odb = dvc.odb.local
    staging_odb = get_staging(local_odb)
    obj = stage(local_odb, tmp_dir / "foo", fs, "md5")

    for odb in (local_odb, staging_odb):
        path_info = odb.hash_to_path_info(obj.hash_info.value)
        assert not odb.fs.exists(path_info)

    # check for file after staging should fail since files are not added on
    # stage()
    with pytest.raises(FileNotFoundError):
        check(local_odb, obj)
    with pytest.raises(FileNotFoundError):
        check(staging_odb, obj)

    save(local_odb, obj)
    check(local_odb, obj)
    with pytest.raises(FileNotFoundError):
        check(staging_odb, obj)

    path_info = local_odb.hash_to_path_info(obj.hash_info.value)
    assert fs.exists(path_info)


def test_staging_dir(tmp_dir, dvc):
    from dvc.objects import check, save
    from dvc.objects.stage import get_staging, stage

    tmp_dir.gen({"dir": {"foo": "foo", "bar": "bar"}})
    fs = LocalFileSystem()
    local_odb = dvc.odb.local
    staging_odb = get_staging(local_odb)

    obj = stage(local_odb, tmp_dir / "dir", fs, "md5")

    path_info = local_odb.hash_to_path_info(obj.hash_info.value)
    assert not local_odb.fs.exists(path_info)
    path_info = staging_odb.hash_to_path_info(obj.hash_info.value)
    assert staging_odb.fs.exists(path_info)

    # check for raw object after staging should pass only when using the
    # staging odb
    raw = HashFile(obj.path_info, obj.fs, obj.hash_info)
    with pytest.raises(FileNotFoundError):
        check(local_odb, raw)
    check(staging_odb, raw)

    # checking the entire tree should fail since individual file entries are
    # not added on stage()
    with pytest.raises(FileNotFoundError):
        check(staging_odb, obj)

    save(local_odb, obj)
    check(local_odb, obj)

    path_info = local_odb.hash_to_path_info(obj.hash_info.value)
    assert fs.exists(path_info)