Skip to content

💫 Toolkit to help you get started with SDD or any other process!

fix(bundler): reject unsupported catalog payload versions (#4090)

Marsel Safind4ba7536a373
diff --git a/src/specify_cli/bundler/models/catalog.py b/src/specify_cli/bundler/models/catalog.py
index 59a45bcb1..2ef882d57 100644
--- a/src/specify_cli/bundler/models/catalog.py
+++ b/src/specify_cli/bundler/models/catalog.py
@@ -20,6 +20,7 @@ CONFIG_FILENAME = "bundle-catalogs.yml"
# reject an unsupported major version so a file written by a newer/incompatible
# Spec Kit fails fast instead of being parsed under the wrong assumptions.
CONFIG_SCHEMA_VERSION = "1.0"
+CATALOG_SCHEMA_VERSION = "1.0"
class InstallPolicy(str, Enum):
@@ -220,6 +221,16 @@ def load_catalog_payload(data: Any) -> dict[str, CatalogEntry]:
"""Parse a catalog JSON payload into ``{bundle_id: CatalogEntry}``."""
if not isinstance(data, dict):
raise BundlerError("Catalog payload must be a JSON object.")
+ schema_version = data.get("schema_version")
+ if schema_version is not None and (
+ str(schema_version).strip().split(".")[0]
+ != CATALOG_SCHEMA_VERSION.split(".")[0]
+ ):
+ raise BundlerError(
+ f"Unsupported catalog schema version "
+ f"'{str(schema_version).strip()}'; this Spec Kit understands "
+ f"version {CATALOG_SCHEMA_VERSION}."
+ )
bundles_raw = data.get("bundles")
if not isinstance(bundles_raw, dict):
raise BundlerError("Catalog payload is missing a 'bundles' object.")
diff --git a/tests/contract/test_catalog_schema.py b/tests/contract/test_catalog_schema.py
index 0e360ac1a..3fd3a5c53 100644
--- a/tests/contract/test_catalog_schema.py
+++ b/tests/contract/test_catalog_schema.py
@@ -309,6 +309,23 @@ def test_catalog_entry_rejects_non_mapping_provides():
CatalogEntry.from_dict(data)
+def test_load_payload_rejects_unsupported_schema_version():
+ payload = catalog_payload({"demo": catalog_entry_dict("demo")})
+ payload["schema_version"] = "2.0"
+
+ with pytest.raises(BundlerError, match="Unsupported catalog schema version"):
+ load_catalog_payload(payload)
+
+
+def test_load_payload_accepts_matching_or_absent_schema_version():
+ payload = catalog_payload({"demo": catalog_entry_dict("demo")})
+ payload["schema_version"] = "1.5"
+ assert "demo" in load_catalog_payload(payload)
+
+ payload.pop("schema_version")
+ assert "demo" in load_catalog_payload(payload)
+
+
@pytest.mark.parametrize("field", ["requires", "provides"])
@pytest.mark.parametrize("bad", [[], "", 0, False])
def test_catalog_entry_rejects_falsy_non_mapping(field, bad):