Refactor test runs handling in config module to improve directory structure and YAML file management

Author: luisggc

sqlcompare/compare/comparator.py

@@ -353,16 +353,14 @@ def compare(
         runs = load_test_runs()
 
         # Save metadata for later analysis
-        # For DuckDB connections (file-based tests), save "duckdb"
-        # For remote databases (Snowflake, etc.), save the connection name
-        conn_name = self.connection if isinstance(self.connection, str) else "duckdb"
-
+        # Save the connection as-is (can be None, connection ID, or URL)
+        # When None, it will resolve to the default connection on inspection
         run_data = {
             "tables": tables,
             "index_cols": list(self.index_cols),
             "cols_prev": self.cols_prev,
             "cols_new": self.cols_new,
-            "conn": conn_name,
+            "conn": self.connection,
         }
 
         runs[diff_id] = run_data

sqlcompare/config.py

@@ -3,11 +3,12 @@
 import os
 from pathlib import Path
 from typing import Any
+import yaml
 
 
 def _config_dir() -> Path:
     return Path(
-        os.getenv("SQLCOMPARE_CONFIG_DIR", Path.home() / ".config" / "data-toolkit")
+        os.getenv("SQLCOMPARE_CONFIG_DIR", Path.home() / ".config" / "sqlcompare")
     )
 
 
@@ -23,8 +24,8 @@ def load_config() -> dict[str, Any]:
     }
 
 
-def _runs_file() -> Path:
-    return _config_dir() / "db_test_runs.yaml"
+def _runs_dir() -> Path:
+    return _config_dir() / "runs"
 
 
 def get_tests_folder() -> Path:
@@ -35,39 +36,32 @@ def get_tests_folder() -> Path:
 
 
 def load_test_runs() -> dict[str, Any]:
-    path = _runs_file()
-    if not path.exists():
+    runs_dir = _runs_dir()
+    if not runs_dir.exists():
         return {}
-    payload = _read_yaml(path)
-    if not payload:
-        return {}
-    if not isinstance(payload, dict):
-        raise ValueError("Expected mapping in db_test_runs.yaml")
-    return payload
+
+    runs = {}
+    for yaml_file in runs_dir.glob("*.yaml"):
+        run_id = yaml_file.stem  # filename without extension
+        payload = _read_yaml(yaml_file)
+        if payload:
+            runs[run_id] = payload
+
+    return runs
 
 
 def save_test_runs(runs: dict[str, Any]) -> None:
-    path = _runs_file()
-    path.parent.mkdir(parents=True, exist_ok=True)
-    _write_yaml(path, runs)
+    runs_dir = _runs_dir()
+    runs_dir.mkdir(parents=True, exist_ok=True)
 
+    for run_id, run_data in runs.items():
+        file_path = runs_dir / f"{run_id}.yaml"
+        _write_yaml(file_path, run_data)
 
-def _read_yaml(path: Path) -> dict[str, Any] | None:
-    try:
-        import yaml
-    except ImportError:
-        import json
 
-        return json.loads(path.read_text(encoding="utf-8"))
+def _read_yaml(path: Path) -> dict[str, Any] | None:
     return yaml.safe_load(path.read_text(encoding="utf-8"))
 
 
 def _write_yaml(path: Path, payload: dict[str, Any]) -> None:
-    try:
-        import yaml
-    except ImportError:
-        import json
-
-        path.write_text(json.dumps(payload, indent=2), encoding="utf-8")
-        return
     path.write_text(yaml.safe_dump(payload, sort_keys=True), encoding="utf-8")