devops-bot-sdk 1.6.40__tar.gz → 1.6.41__tar.gz

{devops_bot_sdk-1.6.40 → devops_bot_sdk-1.6.41}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devops-bot-sdk
-Version: 1.6.40
+Version: 1.6.41
 Summary: DevOps Bot Desktop SDK — thin client for the AgentOS Electron desktop app
 Author: noumanaziz2128
 License-Expression: LicenseRef-Proprietary

{devops_bot_sdk-1.6.40 → devops_bot_sdk-1.6.41}/devops_bot_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: devops-bot-sdk
-Version: 1.6.40
+Version: 1.6.41
 Summary: DevOps Bot Desktop SDK — thin client for the AgentOS Electron desktop app
 Author: noumanaziz2128
 License-Expression: LicenseRef-Proprietary

{devops_bot_sdk-1.6.40 → devops_bot_sdk-1.6.41}/devops_bot_sdk.egg-info/SOURCES.txt

@@ -161,6 +161,7 @@ tests/test_intake_job_outcome.py
 tests/test_intake_plan_review.py
 tests/test_journal.py
 tests/test_local_exec_provider.py
+tests/test_mcp_route_contract.py
 tests/test_memory_guard.py
 tests/test_phase_timer.py
 tests/test_plan_new_command.py

{devops_bot_sdk-1.6.40 → devops_bot_sdk-1.6.41}/sdk/__init__.py

@@ -1,6 +1,6 @@
 """AgentOS Desktop SDK — thin HTTPS/SSE client for the Electron app.
 
-Version: 1.6.38
+Version: 1.6.41
 
 Public surface:
   BackendClient.from_config()        — create client from ~/.agentos/config.toml
@@ -34,7 +34,7 @@ Rules:
   - All data egress through submit_webhook only
 """
 
-__version__ = "1.6.40"   # SINGLE SOURCE OF TRUTH — bump on every change; pyproject,
+__version__ = "1.6.41"   # SINGLE SOURCE OF TRUTH — bump on every change; pyproject,
 __author__  = "AgentOS"   # sdk.client.SDK_VERSION and the UI server version all read this.
 
 from sdk.client import BackendClient

devops_bot_sdk-1.6.41/tests/test_mcp_route_contract.py

@@ -0,0 +1,209 @@
+"""The `/api/ui/*` routes an external MCP client drives, frozen as a contract.
+
+``devops-bot-ai`` exposes 17 of this panel's routes as Model Context Protocol
+tools (`modules/mcp/catalog.py`, design in that repo's
+`docs/PRD_MCP_VPS_TOOLS.md`). Its catalogue hard-codes the bare path suffix, the
+HTTP verb and the query-parameter NAMES of each one, because ``_call_sdk`` builds
+``f"{sdk_url}/api/ui/{path}"`` and forwards ``params`` verbatim.
+
+That makes an ordinary, reasonable-looking rename here — ``loop-status`` to
+``loop_status``, ``lines`` to ``limit``, ``GET /tasks`` to ``GET /task-files`` —
+a production break in a DIFFERENT repository, per user, with no failing test on
+either side. The panel's own UI would be updated in the same commit and look
+fine; the first symptom would be an AI agent telling someone their VPS cannot be
+reached.
+
+So this file is a tripwire, not a behaviour test. It asserts only what the remote
+catalogue actually depends on. Changing one of these is allowed — it is a
+coordinated change with `modules/mcp/catalog.py`, and this test failing by name
+is how you find that out before shipping.
+"""
+from __future__ import annotations
+
+import pytest
+
+fastapi = pytest.importorskip("fastapi")
+
+from sdk import config  # noqa: E402
+from sdk.ui import security  # noqa: E402
+from sdk.ui.api import require_token, router  # noqa: E402
+
+#: (method, path) exactly as `modules/mcp/catalog.py` spells it, `/api/ui/`
+#: prefix stripped. 10 reads then 7 writes, matching the catalogue's own order.
+MCP_CONSUMED_ROUTES: tuple[tuple[str, str], ...] = (
+    ("GET", "/health"),
+    ("GET", "/status"),
+    ("GET", "/loop-status"),
+    ("GET", "/logs"),
+    ("GET", "/system/inventory"),
+    ("GET", "/dashboard"),
+    ("GET", "/jobs/{job_id}"),
+    ("GET", "/agents/all"),
+    ("GET", "/tasks"),
+    ("GET", "/agents/schedules"),
+    ("POST", "/agents/run"),
+    ("POST", "/agents/chat"),
+    ("POST", "/run"),
+    ("POST", "/resume"),
+    ("POST", "/stop"),
+    ("POST", "/git"),          # both open_vps_pull_request and push_vps_branch
+    ("POST", "/git"),
+)
+
+#: Query parameters the remote catalogue sends BY NAME. A rename here is
+#: silently dropped by FastAPI (the default is used instead), so the tool keeps
+#: "working" while ignoring everything the model asked for — the worst failure
+#: shape available, because nothing errors.
+MCP_QUERY_PARAMS: tuple[tuple[str, str, object], ...] = (
+    ("/logs", "lines", 200),
+    ("/dashboard", "period", "7d"),
+    ("/agents/all", "department_id", ""),
+)
+
+
+#: The router carries its own `/api/ui` prefix, so `route.path` is the full
+#: path. The table above holds the bare suffix the remote catalogue stores.
+_PREFIX = router.prefix
+
+
+def _routes() -> dict[tuple[str, str], object]:
+    """(method, bare suffix) -> route, with the `/api/ui` prefix stripped."""
+    out = {}
+    for route in router.routes:
+        path = getattr(route, "path", "")
+        suffix = path[len(_PREFIX):] if path.startswith(_PREFIX) else path
+        for method in getattr(route, "methods", set()) or set():
+            out[(method, suffix)] = route
+    return out
+
+
+def _client():
+    app = fastapi.FastAPI()
+    app.include_router(router)
+    app.dependency_overrides[require_token] = lambda: None
+    from fastapi.testclient import TestClient
+
+    return TestClient(app)
+
+
+class TestRoutesExist:
+    @pytest.mark.parametrize("method,path", sorted(set(MCP_CONSUMED_ROUTES)))
+    def test_the_route_is_still_served_at_this_exact_spelling(self, method, path):
+        assert (method, path) in _routes(), (
+            f"{method} /api/ui{path} is consumed as an MCP tool by devops-bot-ai "
+            f"(modules/mcp/catalog.py). Renaming or removing it breaks that tool "
+            f"in production with no error on either side — update the catalogue "
+            f"in the same change."
+        )
+
+    def test_the_count_has_not_silently_changed(self):
+        """17 tools, 16 distinct routes — the two git tools share POST /git."""
+        assert len(MCP_CONSUMED_ROUTES) == 17
+        assert len(set(MCP_CONSUMED_ROUTES)) == 16
+
+
+class TestQueryParameterNames:
+    @pytest.mark.parametrize("path,name,default", MCP_QUERY_PARAMS)
+    def test_the_parameter_name_and_default_are_unchanged(self, path, name, default):
+        route = _routes()[("GET", path)]
+        params = {
+            p.name: p for p in route.dependant.query_params  # type: ignore[attr-defined]
+        }
+        assert name in params, (
+            f"GET /api/ui{path} no longer accepts '{name}'. The MCP catalogue "
+            f"sends it by name; FastAPI drops an unknown query param silently, "
+            f"so the tool would keep answering while ignoring its arguments."
+        )
+        assert params[name].default == default
+
+    def test_the_logs_bound_the_catalogue_publishes_is_the_one_enforced(self):
+        """The remote JSON Schema advertises 1..5000 to the model. If the route
+        narrows that, a model asking for a legal value gets a 422 it cannot
+        interpret."""
+        client = _client()
+        assert client.get("/api/ui/logs?lines=5000").status_code != 422
+        assert client.get("/api/ui/logs?lines=5001").status_code == 422
+        assert client.get("/api/ui/logs?lines=0").status_code == 422
+
+
+class TestJobPolling:
+    def test_the_job_id_is_a_path_parameter_named_job_id(self):
+        """`get_vps_job` interpolates the id into the path, and validates it
+        against `^[0-9a-f]{32}$` precisely because it lands there."""
+        route = _routes()[("GET", "/jobs/{job_id}")]
+        names = {p.name for p in route.dependant.path_params}  # type: ignore[attr-defined]
+        assert names == {"job_id"}
+
+    def test_job_ids_are_still_32_char_lowercase_hex(self):
+        """The remote side validates the shape before interpolating it. A change
+        to uuid4() *with* dashes, or to an incrementing integer, would make every
+        legitimate poll fail argument validation before it ever left that repo."""
+        from sdk.ui import jobs
+
+        async def _noop():
+            return {"ok": True}
+
+        import asyncio
+
+        async def _run():
+            job_id = jobs.start(_noop())
+            await asyncio.sleep(0)
+            return job_id
+
+        job_id = asyncio.run(_run())
+        assert len(job_id) == 32
+        assert job_id == job_id.lower()
+        assert all(c in "0123456789abcdef" for c in job_id)
+
+
+class TestBodylessStop:
+    def test_stop_accepts_a_request_with_no_body_at_all(self):
+        """`action_router._build_empty` returns None and the proxy sends
+        `json=None`. A required request model here would 422 every stop."""
+        route = _routes()[("POST", "/stop")]
+        assert route.dependant.body_params == []  # type: ignore[attr-defined]
+        assert _client().post("/api/ui/stop").status_code != 422
+
+
+class TestEveryConsumedRouteIsStillTokenGated:
+    @pytest.mark.parametrize("method,path", sorted(set(MCP_CONSUMED_ROUTES)))
+    def test_the_route_still_requires_the_api_token(self, method, path):
+        """These are now reachable by an external product, not just the panel's
+        own page. A route that loses `_auth` becomes readable by anything that
+        can reach port 8765 from an allowlisted address."""
+        route = _routes()[(method, path)]
+        names = {
+            getattr(d.call, "__name__", "") for d in route.dependant.dependencies  # type: ignore[attr-defined]
+        }
+        assert "require_token" in names, f"{method} /api/ui{path} is no longer token-gated"
+
+
+class TestTokenTransport:
+    def test_a_bearer_prefixed_token_is_accepted(self):
+        """The MCP consumer (`ai-draftsman-ml-b2b`) sends `Authorization: Bearer
+        co_…` by default — it does not know about this panel's bare-token
+        convention, and the backend forwards the header as it received it."""
+        assert security.extract_token({"authorization": "Bearer co_abc_123"}, {}) == "co_abc_123"
+
+    def test_a_bare_token_is_still_accepted(self):
+        """The backend's own proxies forward the caller's token verbatim, with
+        no prefix. Both forms must keep working — this is the one place they
+        meet."""
+        assert security.extract_token({"authorization": "co_abc_123"}, {}) == "co_abc_123"
+
+    def test_the_prefix_match_is_case_insensitive(self):
+        assert security.extract_token({"authorization": "bearer co_abc_123"}, {}) == "co_abc_123"
+
+
+class TestBackendReachability:
+    def test_the_backend_egress_ips_stay_permanently_allowlisted(self):
+        """Every MCP tool call arrives FROM the backend, so these addresses are
+        the whole path. They are permanent (not removable through the API) on
+        purpose: a user disabling one through the panel would cut off a product
+        integration they never configured from here and cannot see."""
+        permanent = config.permanent_allowed_ips()
+        for ip in config._DEFAULT_ALLOWED_IPS:
+            assert ip in permanent, (
+                f"{ip} is a devops-bot-ai egress address; dropping it stops every "
+                f"backend-driven call, including all MCP tools."
+            )