yadm/test/test_assert_private_dirs.py

"""Test asserting private directories"""

import os
import re

import pytest

pytestmark = pytest.mark.usefixtures("ds1_copy")
PRIVATE_DIRS = [".gnupg", ".ssh"]


@pytest.mark.parametrize("home", [True, False], ids=["home", "not-home"])
def test_pdirs_missing(runner, yadm_cmd, paths, home):
    """Private dirs (private dirs missing)

    When a git command is run
    And private directories are missing
    Create private directories prior to command
    """

    # confirm directories are missing at start
    for pdir in PRIVATE_DIRS:
        path = paths.work.join(pdir)
        if path.exists():
            path.remove()
        assert not path.exists()

    env = {"DEBUG": "yes"}
    if home:
        env["HOME"] = paths.work

    # run status
    run = runner(command=yadm_cmd("status"), env=env)
    assert run.success
    assert run.err == ""
    assert "On branch master" in run.out

    # confirm directories are created
    # and are protected
    for pdir in PRIVATE_DIRS:
        path = paths.work.join(pdir)
        if home:
            assert path.exists()
            assert oct(path.stat().mode).endswith("00"), "Directory is " "not secured"
        else:
            assert not path.exists()

    # confirm directories are created before command is run:
    if home:
        assert re.search(
            r"Creating.+\.(gnupg|ssh).+Creating.+\.(gnupg|ssh).+Running git command git status", run.out, re.DOTALL
        ), "directories created before command is run"


def test_pdirs_missing_apd_false(runner, yadm_cmd, paths):
    """Private dirs (private dirs missing / yadm.auto-private-dirs=false)

    When a git command is run
    And private directories are missing
    But auto-private-dirs is false
    Do not create private dirs
    """

    # confirm directories are missing at start
    for pdir in PRIVATE_DIRS:
        path = paths.work.join(pdir)
        if path.exists():
            path.remove()
        assert not path.exists()

    # set configuration
    os.system(" ".join(yadm_cmd("config", "--bool", "yadm.auto-private-dirs", "false")))

    # run status
    run = runner(command=yadm_cmd("status"))
    assert run.success
    assert run.err == ""
    assert "On branch master" in run.out

    # confirm directories are STILL missing
    for pdir in PRIVATE_DIRS:
        assert not paths.work.join(pdir).exists()


def test_pdirs_exist_apd_false(runner, yadm_cmd, paths):
    """Private dirs (private dirs exist / yadm.auto-perms=false)

    When a git command is run
    And private directories exist
    And yadm is configured not to auto update perms
    Do not alter directories
    """

    # create permissive directories
    for pdir in PRIVATE_DIRS:
        path = paths.work.join(pdir)
        if not path.isdir():
            path.mkdir()
        path.chmod(0o777)
        assert oct(path.stat().mode).endswith("77"), "Directory is secure."

    # set configuration
    os.system(" ".join(yadm_cmd("config", "--bool", "yadm.auto-perms", "false")))

    # run status
    run = runner(command=yadm_cmd("status"))
    assert run.success
    assert run.err == ""
    assert "On branch master" in run.out

    # created directories are STILL permissive
    for pdir in PRIVATE_DIRS:
        path = paths.work.join(pdir)
        assert oct(path.stat().mode).endswith("77"), "Directory is secure"