mirror of
https://github.com/Ar9av/obsidian-wiki.git
synced 2026-09-14 20:36:34 +08:00
Arnav
77d74e0261
* feat(config): resolve global config from an XDG-style location (#172) The global config lived at ~/.obsidian-wiki, which isn't XDG-compliant. It now resolves to $XDG_CONFIG_HOME/obsidian-wiki (default ~/.config/obsidian-wiki). Existing installs are unaffected: if ~/.obsidian-wiki is present and the XDG path is not, the legacy directory is used as-is. No migration is required, and nothing moves on upgrade. Once the XDG path exists it wins, so `mv ~/.obsidian-wiki ~/.config/obsidian-wiki` is all a migration takes. Resolution is implemented identically in Python (cli.py), bash (setup.sh, scripts/daily-update.sh, scripts/wiki-notify.sh), and the Config Resolution Protocol that every skill defers to, so vault-scoped state and named `config.<name>` profiles stay in one place. * fix(config): stop setup from wiping user-added config keys `write_config` rewrote the global config with only the three setup-managed keys, so every `obsidian-wiki setup` — including the one a pip upgrade prompts for — silently destroyed anything else in the file: OBSIDIAN_LINK_FORMAT, QMD_WIKI_COLLECTION, WIKI_SKIP_PROJECTS, sync settings, and comments. Setup now owns only OBSIDIAN_VAULT_PATH, OBSIDIAN_WIKI_REPO and OBSIDIAN_WIKI_VERSION, updating those in place and carrying every other line over untouched. Duplicate definitions of a managed key collapse to one. Predates the XDG change (same behavior on main) but is fixed here because this branch already touches config writing, and the XDG work makes re-running setup more likely. Also pins PYTHONPATH in both new test files so they exercise this checkout rather than whatever obsidian_wiki happens to be installed.
104 lines
3.0 KiB
Python
104 lines
3.0 KiB
Python
"""Global config directory resolution: XDG-first with legacy fallback."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
|
|
REPO_ROOT = Path(__file__).resolve().parents[1]
|
|
|
|
|
|
def _env(home: Path) -> dict[str, str]:
|
|
env = os.environ.copy()
|
|
env["HOME"] = str(home)
|
|
# Pin the import to this checkout — a separately installed obsidian_wiki
|
|
# would otherwise shadow it depending on the working directory.
|
|
env["PYTHONPATH"] = str(REPO_ROOT)
|
|
return env
|
|
|
|
|
|
def _resolve(home: Path, xdg_config_home: str | None = None) -> Path:
|
|
"""Resolve GLOBAL_CONFIG_DIR in a subprocess with the given HOME/XDG env."""
|
|
env = _env(home)
|
|
if xdg_config_home is None:
|
|
env.pop("XDG_CONFIG_HOME", None)
|
|
else:
|
|
env["XDG_CONFIG_HOME"] = xdg_config_home
|
|
proc = subprocess.run(
|
|
[sys.executable, "-c", "from obsidian_wiki.cli import GLOBAL_CONFIG_DIR; print(GLOBAL_CONFIG_DIR)"],
|
|
capture_output=True,
|
|
text=True,
|
|
env=env,
|
|
check=True,
|
|
)
|
|
return Path(proc.stdout.strip())
|
|
|
|
|
|
def test_fresh_install_uses_xdg_default(tmp_path: Path) -> None:
|
|
home = tmp_path / "home"
|
|
home.mkdir()
|
|
|
|
assert _resolve(home) == home / ".config" / "obsidian-wiki"
|
|
|
|
|
|
def test_xdg_config_home_is_honored(tmp_path: Path) -> None:
|
|
home = tmp_path / "home"
|
|
home.mkdir()
|
|
xdg = tmp_path / "xdg"
|
|
|
|
assert _resolve(home, str(xdg)) == xdg / "obsidian-wiki"
|
|
|
|
|
|
def test_existing_legacy_dir_keeps_working(tmp_path: Path) -> None:
|
|
"""An install that predates the XDG move must not be stranded."""
|
|
home = tmp_path / "home"
|
|
legacy = home / ".obsidian-wiki"
|
|
legacy.mkdir(parents=True)
|
|
(legacy / "config").write_text('OBSIDIAN_VAULT_PATH="/tmp/vault"\n', encoding="utf-8")
|
|
|
|
assert _resolve(home) == legacy
|
|
|
|
|
|
def test_xdg_dir_wins_once_it_exists(tmp_path: Path) -> None:
|
|
"""After migrating, the XDG path takes over even if the legacy dir lingers."""
|
|
home = tmp_path / "home"
|
|
legacy = home / ".obsidian-wiki"
|
|
legacy.mkdir(parents=True)
|
|
xdg = home / ".config" / "obsidian-wiki"
|
|
xdg.mkdir(parents=True)
|
|
|
|
assert _resolve(home) == xdg
|
|
|
|
|
|
def test_empty_xdg_config_home_falls_back_to_default(tmp_path: Path) -> None:
|
|
home = tmp_path / "home"
|
|
home.mkdir()
|
|
|
|
assert _resolve(home, "") == home / ".config" / "obsidian-wiki"
|
|
|
|
|
|
def test_legacy_config_is_still_read_end_to_end(tmp_path: Path) -> None:
|
|
"""`info` must report the legacy config when that is the active location."""
|
|
home = tmp_path / "home"
|
|
legacy = home / ".obsidian-wiki"
|
|
legacy.mkdir(parents=True)
|
|
vault = tmp_path / "vault"
|
|
vault.mkdir()
|
|
(legacy / "config").write_text(f'OBSIDIAN_VAULT_PATH="{vault}"\n', encoding="utf-8")
|
|
|
|
env = _env(home)
|
|
env.pop("XDG_CONFIG_HOME", None)
|
|
proc = subprocess.run(
|
|
[sys.executable, "-m", "obsidian_wiki.cli", "info"],
|
|
capture_output=True,
|
|
text=True,
|
|
env=env,
|
|
)
|
|
|
|
assert proc.returncode == 0
|
|
assert str(legacy / "config") in proc.stdout
|
|
assert "(not written yet)" not in proc.stdout
|