04d620d91f
Salvage of #35508 (@dchenk), rebased onto current main. Resolved the tests/tools/test_stage2_hook_puid_pgid.py conflict (kept both the envdir-creation regression test on main and the new config-migration tests). Docker image upgrades replace code under $INSTALL_DIR but preserve $HERMES_HOME on the mounted volume, so the persisted config.yaml never received the schema migrations that non-Docker `hermes update` runs (#35406). This adds scripts/docker_config_migrate.py, invoked from stage2-hook after first-boot seeding and before gateway services start: it backs up config.yaml + .env, runs migrate_config(interactive=False), and honors HERMES_SKIP_CONFIG_MIGRATION=1 for manual control. Also fixes a latent bug in check_config_version(): it called load_config() which deep-merges DEFAULT_CONFIG, so a legacy config with no raw _config_version falsely reported as already-current. It now reads the raw on-disk file so legacy configs are correctly detected for migration. Differs from #35508 as submitted (Option B cleanup): dropped the `_config_version` line added to cli-config.yaml.example and removed the accompanying test_cli_config_example_declares_latest_version change-detector test. The example is a copy-template and has no business asserting a schema version; check_config_version() reads the user's real config.yaml, not the example. This removes a second sync point that drifts on every version bump. Closes #35508. Fixes #35406. Co-authored-by: Dmitriy Cherchenko <17372886+dchenk@users.noreply.github.com>
120 lines
3.8 KiB
Python
120 lines
3.8 KiB
Python
from __future__ import annotations
|
|
|
|
import os
|
|
import subprocess
|
|
import sys
|
|
from pathlib import Path
|
|
|
|
import yaml
|
|
|
|
from hermes_cli.config import DEFAULT_CONFIG
|
|
|
|
REPO_ROOT = Path(__file__).resolve().parents[2]
|
|
SCRIPT = REPO_ROOT / "scripts" / "docker_config_migrate.py"
|
|
|
|
|
|
def _run_migration(hermes_home: Path, **env_overrides: str) -> subprocess.CompletedProcess[str]:
|
|
env = os.environ.copy()
|
|
env.update(
|
|
{
|
|
"HERMES_HOME": str(hermes_home),
|
|
"HERMES_SKIP_CHMOD": "1",
|
|
"PYTHONPATH": str(REPO_ROOT),
|
|
}
|
|
)
|
|
env.update(env_overrides)
|
|
return subprocess.run(
|
|
[sys.executable, str(SCRIPT)],
|
|
cwd=str(REPO_ROOT),
|
|
env=env,
|
|
capture_output=True,
|
|
text=True,
|
|
)
|
|
|
|
|
|
def test_docker_config_migrate_backs_up_and_migrates_legacy_config(tmp_path: Path) -> None:
|
|
config_path = tmp_path / "config.yaml"
|
|
env_path = tmp_path / ".env"
|
|
config_path.write_text(
|
|
yaml.safe_dump(
|
|
{
|
|
"_config_version": 11,
|
|
"custom_providers": [
|
|
{
|
|
"name": "Local API",
|
|
"base_url": "http://localhost:8080/v1",
|
|
"api_key": "test-key",
|
|
}
|
|
],
|
|
}
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
env_path.write_text("OPENROUTER_API_KEY=test\n", encoding="utf-8")
|
|
|
|
proc = _run_migration(tmp_path)
|
|
|
|
assert proc.returncode == 0, proc.stderr
|
|
assert "Migrating config schema 11 ->" in proc.stdout
|
|
raw = yaml.safe_load(config_path.read_text(encoding="utf-8"))
|
|
assert raw["_config_version"] == DEFAULT_CONFIG["_config_version"]
|
|
assert "custom_providers" not in raw
|
|
assert raw["providers"]["local-api"]["api"] == "http://localhost:8080/v1"
|
|
assert list(tmp_path.glob("config.yaml.bak-*"))
|
|
assert list(tmp_path.glob(".env.bak-*"))
|
|
|
|
|
|
def test_docker_config_migrate_backs_up_and_migrates_unversioned_config(tmp_path: Path) -> None:
|
|
config_path = tmp_path / "config.yaml"
|
|
config_path.write_text(
|
|
yaml.safe_dump(
|
|
{
|
|
"custom_providers": [
|
|
{
|
|
"name": "Local API",
|
|
"base_url": "http://localhost:8080/v1",
|
|
"api_key": "test-key",
|
|
}
|
|
],
|
|
}
|
|
),
|
|
encoding="utf-8",
|
|
)
|
|
|
|
proc = _run_migration(tmp_path)
|
|
|
|
assert proc.returncode == 0, proc.stderr
|
|
assert "Migrating config schema 0 ->" in proc.stdout
|
|
raw = yaml.safe_load(config_path.read_text(encoding="utf-8"))
|
|
assert raw["_config_version"] == DEFAULT_CONFIG["_config_version"]
|
|
assert "custom_providers" not in raw
|
|
assert raw["providers"]["local-api"]["api"] == "http://localhost:8080/v1"
|
|
assert list(tmp_path.glob("config.yaml.bak-*"))
|
|
|
|
|
|
def test_docker_config_migrate_does_not_rewrite_invalid_yaml(tmp_path: Path) -> None:
|
|
config_path = tmp_path / "config.yaml"
|
|
original = "model: [unterminated\n"
|
|
config_path.write_text(original, encoding="utf-8")
|
|
|
|
proc = _run_migration(tmp_path)
|
|
|
|
assert proc.returncode == 0, proc.stderr
|
|
assert "Migrating config schema" not in proc.stdout
|
|
assert "hermes config:" in proc.stderr
|
|
assert config_path.read_text(encoding="utf-8") == original
|
|
assert not list(tmp_path.glob("*.bak-*"))
|
|
|
|
|
|
def test_docker_config_migrate_skip_env_leaves_config_unchanged(tmp_path: Path) -> None:
|
|
config_path = tmp_path / "config.yaml"
|
|
original = yaml.safe_dump({"_config_version": 11})
|
|
config_path.write_text(original, encoding="utf-8")
|
|
|
|
proc = _run_migration(tmp_path, HERMES_SKIP_CONFIG_MIGRATION="1")
|
|
|
|
assert proc.returncode == 0, proc.stderr
|
|
assert "skipping config migration" in proc.stdout
|
|
assert config_path.read_text(encoding="utf-8") == original
|
|
assert not list(tmp_path.glob("*.bak-*"))
|