test_app_dirs.py

import dataclasses
import pathlib
import typing as t
from unihan_etl._internal.app_dirs import AppDirs
from appdirs import AppDirs as BaseAppDirs
import pytest


AppDirsInitParams = t.Dict[str, t.Any]
ExpectedAppDirsParam = t.Mapping[str, t.Union[str, pathlib.Path]]


class AppDirFixture(t.NamedTuple):
    # pytest
    test_id: str

    # Environment vars
    env: t.Dict[str, str]

    # Configuration
    options: t.Mapping[str, t.Any]

    app_dirs_init_params: AppDirsInitParams

    # Expected
    expected_app_dirs: ExpectedAppDirsParam


APP_DIR_FIXURES = [
    AppDirFixture(
        test_id="basic",
        env={},
        options={},
        app_dirs_init_params={},
        expected_app_dirs={},
    ),
    AppDirFixture(
        test_id="env-xdg-config-home",
        env={"XDG_CONFIG_HOME": "{tmp_path}/.config"},
        options={},
        app_dirs_init_params={},
        expected_app_dirs={
            "user_config_dir": pathlib.Path("{tmp_path}/.config"),
        },
    ),
    AppDirFixture(
        test_id="env-xdg-cache-home",
        env={"XDG_CACHE_HOME": "{tmp_path}/.cache"},
        options={},
        app_dirs_init_params={},
        expected_app_dirs={
            "user_cache_dir": pathlib.Path("{tmp_path}/.cache"),
        },
    ),
    AppDirFixture(
        test_id="direct-override-user-cache-dir",
        env={},
        options={},
        app_dirs_init_params={"user_cache_dir": "{tmp_path}/.cache"},
        expected_app_dirs={
            "user_cache_dir": pathlib.Path("{tmp_path}/.cache"),
        },
    ),
]


@pytest.mark.parametrize(
    list(AppDirFixture._fields),
    APP_DIR_FIXURES,
    ids=[test.test_id for test in APP_DIR_FIXURES],
)
def test_basic(
    monkeypatch: pytest.MonkeyPatch,
    tmp_path: pathlib.Path,
    test_id: str,
    env: t.Dict[str, str],
    options: t.Mapping[str, t.Any],
    app_dirs_init_params: AppDirsInitParams,
    expected_app_dirs: ExpectedAppDirsParam,
) -> None:
    # Setup
    for k, v in env.items():
        monkeypatch.setenv(k, v.format(tmp_path=str(tmp_path)))

    for k, v in app_dirs_init_params.items():
        app_dirs_init_params[k] = v.format(tmp_path=str(tmp_path))

    # Initialize
    _app_dirs = BaseAppDirs()
    app_dirs = AppDirs(_app_dirs=_app_dirs, **app_dirs_init_params)

    # Assert
    for field in dataclasses.fields(app_dirs):
        assert isinstance(getattr(app_dirs, field.name), pathlib.Path)

    for exp_k, exp_v in expected_app_dirs.items():
        if isinstance(exp_v, pathlib.Path):
            exp_v = pathlib.Path(str(exp_v).format(tmp_path=str(tmp_path)))
        if isinstance(exp_v, str):
            exp_v = exp_v.format(tmp_path=str(tmp_path))
        assert getattr(app_dirs, exp_k) == exp_v