snap-pac/tests/test_script.py

from configparser import ConfigParser
import tempfile
from pathlib import Path
import os

import pytest

from scripts.snap_pac import (
   SnapperCmd, check_important_commands, check_important_packages, get_pre_number, get_snapper_configs,
   get_userdata, main, setup_config_parser, get_description
)


@pytest.fixture
def config():
    config = ConfigParser()
    config["DEFAULT"] = {
        "snapshot": False,
        "cleanup_algorithm": "number",
        "pre_description": "foo",
        "post_description":  "bar",
        "desc_limit": 72,
        "important_packages": [],
        "important_commands": [],
        "userdata": []
    }
    config["root"] = {
        "snapshot": True
    }
    config["home"] = {
        "snapshot": True,
        "desc_limit": 3,
        "post_description": "a really long description"
    }
    return config


@pytest.fixture
def prefile():
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("1234")
        name = f.name
    return Path(name)


@pytest.mark.parametrize("snapper_cmd, actual_cmd", [
    (
        SnapperCmd("root", "pre", "number", "foo"),
        "snapper --config root create --type pre --cleanup-algorithm number --print-number --description \"foo\""
    ),
    (
        SnapperCmd("root", "post", "number", "bar", False, 1234),
        "snapper --config root create --type post --cleanup-algorithm number --print-number"
        " --description \"bar\" --pre-number 1234"
    ),
    (
        SnapperCmd("root", "post", "number", "bar", True, 1234),
        "snapper --no-dbus --config root create --type post --cleanup-algorithm number --print-number"
        " --description \"bar\" --pre-number 1234"
    ),
    (
        SnapperCmd("root", "post", "number", "bar", False, 1234, "important=yes"),
        "snapper --config root create --type post --cleanup-algorithm number --print-number"
        " --description \"bar\" --userdata \"important=yes\" --pre-number 1234"
    ),
    (
        SnapperCmd("root", "post", "number", "bar", False, 1234, "foo=bar,important=yes"),
        "snapper --config root create --type post --cleanup-algorithm number --print-number"
        " --description \"bar\" --userdata \"foo=bar,important=yes\" --pre-number 1234"
    )
])
def test_snapper_cmd(snapper_cmd, actual_cmd):
    assert str(snapper_cmd) == actual_cmd


def test_get_snapper_configs():
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("## Path: System/Snapper\n")
        f.write("\n")
        f.write("## Type:        string\n")
        f.write("## Default:     \"\"\n")
        f.write("# List of snapper configurations.\n")
        f.write("SNAPPER_CONFIGS=\"home root foo bar\"\n")
        name = f.name
    assert get_snapper_configs(Path(name)) == ["home", "root", "foo", "bar"]


def test_skip_snap_pac():
    os.environ["SNAP_PAC_SKIP"] = "y"
    assert main("foo", "bar", "yep") is False


def test_setup_config_parser(config):
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("[home]\n")
        f.write("snapshot = True\n")
        f.write("desc_limit = 3\n")
        f.write("post_description = a really long description\n")
        name = f.name
    config2 = setup_config_parser(name, "foo", ["bar"])
    assert config == config2


def test_get_pre_number_pre(prefile):
    assert get_pre_number("pre", prefile) is None


def test_get_pre_number_post(prefile):
    assert get_pre_number("post", prefile) == "1234"


def test_no_prefile():
    with pytest.raises(FileNotFoundError):
        get_pre_number("post", Path("/tmp/foo-pre-file-not-found"))


@pytest.mark.parametrize("snapshot_type, description", [("pre", "foo"), ("post", "a r")])
def test_get_description(snapshot_type, description, config):
    assert get_description(snapshot_type, config, "home") == description


def test_important_commands():
    parent_cmd = "pacman -Syu"
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("[DEFAULT]\n")
        f.write("important_commands = [\"pacman -Syu\"]\n")
        name = f.name
    config = setup_config_parser(name, parent_cmd, ["bar"])
    important = check_important_commands(config, "root", parent_cmd)
    assert important


def test_important_packages():
    packages = ["bar", "linux", "vim"]
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("[DEFAULT]\n")
        f.write("important_packages = [\"linux\"]\n")
        name = f.name
    config = setup_config_parser(name, "pacman -S", packages)
    important = check_important_packages(config, "root", packages)
    assert important


def test_load_userdata():
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("[DEFAULT]\n")
        f.write("userdata = [\"foo=bar\", \"requestid=42\"]\n")
        name = f.name
    config = setup_config_parser(name, "pacman -Syu", ["bar"])
    userdata = get_userdata(config, "root", False)
    assert userdata == "foo=bar,requestid=42"


def test_load_userdata_and_important():
    with tempfile.NamedTemporaryFile("w", delete=False) as f:
        f.write("[DEFAULT]\n")
        f.write("userdata = [\"foo=bar\", \"requestid=42\"]\n")
        name = f.name
    config = setup_config_parser(name, "pacman -Syu", ["bar"])
    userdata = get_userdata(config, "root", True)
    assert userdata == "foo=bar,important=yes,requestid=42"