Allow Namespace pydantic model to have a null metadata_ entry (#1063)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Peyton Murray <[email protected]>

Author: 3 people

conda-store-server/conda_store_server/_internal/schema.py

@@ -81,7 +81,7 @@ def from_list(cls, lst):
 class Namespace(BaseModel):
     id: int
     name: Annotated[str, StringConstraints(pattern=f"^[{ALLOWED_CHARACTERS}]+$")]  # noqa: F722
-    metadata_: Dict[str, Any] = None
+    metadata_: Optional[Dict[str, Any]] = None
     role_mappings: List[NamespaceRoleMapping] = []
     model_config = ConfigDict(from_attributes=True)
 

conda-store-server/tests/_internal/server/views/test_api.py

@@ -175,6 +175,23 @@ def test_api_list_namespace_auth(testclient, seed_conda_store, authenticate):
     assert sorted([_.name for _ in r.data]) == ["default", "namespace1", "namespace2"]
 
 
+def test_api_list_namespace_including_missing_metadata_(
+    testclient, seed_namespace_with_edge_cases, authenticate
+):
+    """Test that a namespace with metadata_ = None can be retrieved.
+
+    See https://github.com/conda-incubator/conda-store/issues/1062
+    for additional context.
+    """
+    response = testclient.get("api/v1/namespace")
+    response.raise_for_status()
+
+    r = schema.APIListNamespace.model_validate(response.json())
+    assert r.status == schema.APIStatus.OK
+    namespaces = [_.name for _ in r.data]
+    assert "namespace_missing_meta" in namespaces
+
+
 def test_api_get_namespace_unauth(testclient, seed_conda_store):
     response = testclient.get("api/v1/namespace/default")
     response.raise_for_status()

conda-store-server/tests/conftest.py

@@ -417,6 +417,18 @@ def alembic_config(conda_store):
     return {"file": ini_file}
 
 
+@pytest.fixture
+def seed_namespace_with_edge_cases(db: Session, conda_store):
+    namespaces = [
+        orm.Namespace(name="normal_namespace"),
+        orm.Namespace(name="namespace_missing_meta", metadata_=None),
+    ]
+
+    for namespace in namespaces:
+        db.add(namespace)
+    db.commit()
+
+
 def _seed_conda_store(
     db: Session,
     conda_store,