@openhands/extensions 0.9.0 → 0.10.0

package/tests/test_integration_catalog_in_sync.py

@@ -4,9 +4,12 @@ from __future__ import annotations
 
 import json
 import subprocess
+from copy import deepcopy
 from pathlib import Path
 
 import openhands_extensions
+import pytest
+from pydantic import ValidationError
 
 ROOT = Path(__file__).resolve().parents[1]
 CATALOG_DIR = ROOT / "integrations" / "catalog"
@@ -23,7 +26,17 @@ def _catalog_files() -> dict[str, dict]:
 
 def _catalog_entries() -> list[dict]:
     entries = list(_catalog_files().values())
-    return sorted(entries, key=lambda entry: (-(entry.get("popularityRank") if entry.get("popularityRank") is not None else -1), entry["id"]))
+    return sorted(
+        entries,
+        key=lambda entry: (
+            -(
+                entry.get("popularityRank")
+                if entry.get("popularityRank") is not None
+                else -1
+            ),
+            entry["id"],
+        ),
+    )
 
 
 def _supports_mcp(entry: dict) -> bool:
@@ -31,8 +44,10 @@ def _supports_mcp(entry: dict) -> bool:
 
 
 def _supports_oauth(entry: dict) -> bool:
-    return any(option.get("auth", {}).get("strategy") == "oauth2" for option in entry["connectionOptions"])
-
+    return any(
+        option.get("auth", {}).get("strategy") == "oauth2"
+        for option in entry["connectionOptions"]
+    )
 
 
 def test_catalog_directory_is_hand_authored_source_of_truth() -> None:
@@ -84,6 +99,95 @@ def test_python_list_integration_catalog_returns_raw_entries() -> None:
         assert "runtimeAvailability" not in entry
 
 
+def test_python_list_integration_catalog_models_returns_typed_entries() -> None:
+    entries = openhands_extensions.list_integration_catalog()
+    models = openhands_extensions.list_integration_catalog_models()
+
+    assert [model.model_dump(exclude_none=True) for model in models] == entries
+    assert all(
+        isinstance(model, openhands_extensions.IntegrationCatalogEntry)
+        for model in models
+    )
+    assert (
+        openhands_extensions.get_integration_catalog_entry_model(entries[0]["id"])
+        == models[0]
+    )
+    assert openhands_extensions.get_integration_catalog_entry_model("missing") is None
+
+    with pytest.raises(ValidationError):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(
+            {**entries[0], "unexpected": True}
+        )
+
+
+def test_http_catalog_options_require_both_urls() -> None:
+    entry = next(
+        entry
+        for entry in _catalog_entries()
+        if any(option["provider"] == "http" for option in entry["connectionOptions"])
+    )
+    option = next(
+        option for option in entry["connectionOptions"] if option["provider"] == "http"
+    )
+
+    for field in ("apiBaseUrl", "openApiUrl"):
+        invalid = deepcopy(entry)
+        invalid_option = next(
+            item for item in invalid["connectionOptions"] if item["id"] == option["id"]
+        )
+        invalid_option["http"].pop(field)
+        with pytest.raises(ValidationError, match=field):
+            openhands_extensions.IntegrationCatalogEntry.model_validate(invalid)
+
+
+def test_catalog_models_require_connectability_and_install_metadata() -> None:
+    entry = next(entry for entry in _catalog_entries() if entry["id"] == "slack")
+
+    missing_docs = deepcopy(entry)
+    missing_docs.pop("docsUrl")
+    with pytest.raises(ValidationError, match="docsUrl"):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(missing_docs)
+
+    missing_field_type = deepcopy(entry)
+    missing_field_type["connectionOptions"][1]["transport"]["envFields"][0].pop("type")
+    with pytest.raises(ValidationError, match="type"):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(missing_field_type)
+
+    missing_required_marker = deepcopy(entry)
+    missing_required_marker["connectionOptions"][1]["transport"]["envFields"][0].pop(
+        "required"
+    )
+    with pytest.raises(ValidationError, match="required"):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(
+            missing_required_marker
+        )
+
+    missing_principal_mapping = deepcopy(entry)
+    missing_principal_mapping["connectionOptions"][0]["connectionModel"][
+        "identityMapping"
+    ].pop("externalPrincipalIdPath")
+    with pytest.raises(ValidationError, match="externalPrincipalIdPath"):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(
+            missing_principal_mapping
+        )
+
+    null_instead_of_omission = deepcopy(entry)
+    null_instead_of_omission["notes"] = None
+    with pytest.raises(ValidationError, match="must be omitted"):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(
+            null_instead_of_omission
+        )
+
+    invalid_identity_path = deepcopy(entry)
+    invalid_identity_path["connectionOptions"][0]["connectionModel"]["identityMapping"][
+        "externalPrincipalIdPath"
+    ] = "not/a/path"
+    with pytest.raises(ValidationError, match="pattern"):
+        openhands_extensions.IntegrationCatalogEntry.model_validate(
+            invalid_identity_path
+        )
+
+
 def test_logo_metadata_is_serializable_and_language_agnostic() -> None:
     entries = openhands_extensions.list_integration_catalog()
     with_logo = [entry for entry in entries if entry.get("logoUrl")]
@@ -130,7 +234,9 @@ def test_js_reads_the_same_catalog_as_python() -> None:
         "import { getIntegrationCatalogEntry } from './integrations/index.js';\n"
         f"process.stdout.write(JSON.stringify(getIntegrationCatalogEntry({json.dumps(sample_id)})));"
     )
-    assert json.loads(sample) == openhands_extensions.get_integration_catalog_entry(sample_id)
+    assert json.loads(sample) == openhands_extensions.get_integration_catalog_entry(
+        sample_id
+    )
 
 
 def _js_filter(mcp, oauth) -> list[str]:
@@ -155,7 +261,9 @@ def test_filter_mcp_only() -> None:
 
 
 def test_filter_oauth_only() -> None:
-    py_ids = {e["id"] for e in openhands_extensions.list_integration_catalog(oauth=True)}
+    py_ids = {
+        e["id"] for e in openhands_extensions.list_integration_catalog(oauth=True)
+    }
     js_ids = set(_js_filter("undefined", "true"))
     all_oauth = {
         e["id"]
@@ -168,7 +276,8 @@ def test_filter_oauth_only() -> None:
 
 def test_filter_oauth_not_mcp() -> None:
     py_ids = {
-        e["id"] for e in openhands_extensions.list_integration_catalog(oauth=True, mcp=False)
+        e["id"]
+        for e in openhands_extensions.list_integration_catalog(oauth=True, mcp=False)
     }
     js_ids = set(_js_filter("false", "true"))
     expected = {
@@ -197,7 +306,9 @@ def test_accessors_return_independent_copies() -> None:
     sample = openhands_extensions.get_integration_catalog_entry(sample_id)
     assert sample is not None
     sample["__mutated"] = True
-    assert "__mutated" not in openhands_extensions.get_integration_catalog_entry(sample_id)
+    assert "__mutated" not in openhands_extensions.get_integration_catalog_entry(
+        sample_id
+    )
 
     snapshot = openhands_extensions.INTEGRATION_CATALOG_SNAPSHOT
     snapshot["integrations"][0]["__mutated"] = True