fix(models): check env var before auto-sync, fix tests (#275)

Support MODFLOW_DEVTOOLS_NO_AUTO_SYNC env var for Models API (like Programs API), use it in CI tests. And filter out None recursively before writing TOML to the cache.

Author: wpbonelli

.github/workflows/ci.yml

@@ -104,6 +104,7 @@ jobs:
         working-directory: modflow-devtools/autotest
         env:
           REPOS_PATH: ${{ github.workspace }}
+          MODFLOW_DEVTOOLS_NO_AUTO_SYNC: 1
         # use --dist loadfile to so tests requiring pytest-virtualenv run on the same worker
         run: uv run pytest -v -n auto --dist loadfile --durations 0 --ignore test_download.py --ignore test_models.py
 
@@ -120,6 +121,7 @@ jobs:
           TEST_REF: registry
           TEST_SOURCE: modflow6-testmodels
           TEST_SOURCE_NAME: mf6/test
+          MODFLOW_DEVTOOLS_NO_AUTO_SYNC: 1
         run: uv run pytest -v -n auto --dist loadgroup --durations 0 test_download.py test_models.py
 
   rtd:

autotest/test_models.py

@@ -329,7 +329,8 @@ def test_sync_force(self):
         )
 
         # First sync
-        source.sync(ref=TEST_REF)
+        result_initial = source.sync(ref=TEST_REF)
+        assert len(result_initial.failed) == 0, f"Initial sync failed: {result_initial.failed}"
 
         # Force sync
         result = source.sync(ref=TEST_REF, force=True)
@@ -405,7 +406,8 @@ def synced_registry(self):
             name=TEST_SOURCE_NAME,
             refs=[TEST_REF],
         )
-        source.sync(ref=TEST_REF)
+        result = source.sync(ref=TEST_REF)
+        assert len(result.failed) == 0, f"Fixture sync failed: {result.failed}"
         registry = _DEFAULT_CACHE.load(TEST_SOURCE_NAME, TEST_REF)
         return registry
 
@@ -478,7 +480,12 @@ def test_cli_list_with_cache(self, capsys):
             name=TEST_SOURCE_NAME,
             refs=[TEST_REF],
         )
-        source.sync(ref=TEST_REF)
+        result = source.sync(ref=TEST_REF)
+
+        # Verify sync succeeded before testing list command
+        assert len(result.failed) == 0, f"Sync failed: {result.failed}"
+        assert len(result.synced) == 1, f"Expected 1 synced registry, got {len(result.synced)}"
+        assert (TEST_SOURCE_NAME, TEST_REF) in result.synced
 
         import argparse
 

modflow_devtools/models/__init__.py

@@ -211,8 +211,13 @@ def save(self, registry: ModelRegistry, source: str, ref: str) -> Path:
         cache_dir.mkdir(parents=True, exist_ok=True)
 
         registry_file = cache_dir / _DEFAULT_REGISTRY_FILE_NAME
+
+        # Convert registry to dict and clean None/empty values before serializing to TOML
+        registry_dict = registry.model_dump(mode="json", by_alias=True, exclude_none=True)
+        registry_dict = remap(registry_dict, visit=drop_none_or_empty)
+
         with registry_file.open("wb") as f:
-            tomli_w.dump(registry.model_dump(mode="json", by_alias=True, exclude_none=True), f)
+            tomli_w.dump(registry_dict, f)
 
         return registry_file
 
@@ -1260,8 +1265,9 @@ def _try_best_effort_sync():
         pass
 
 
-# Try to sync on first import
-_try_best_effort_sync()
+# Try to sync on first import (unless disabled)
+if not os.environ.get("MODFLOW_DEVTOOLS_NO_AUTO_SYNC"):
+    _try_best_effort_sync()
 
 # Lazy initialization of default registry
 _default_registry_cache = None