gridfleet-testkit 0.5.0__tar.gz → 0.6.0__tar.gz

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to the GridFleet testkit (`gridfleet-testkit` on PyPI) are documented here.
 
+## [0.6.0](https://github.com/quidow/gridfleet/compare/gridfleet-testkit-v0.5.0...gridfleet-testkit-v0.6.0) (2026-05-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* **backend:** clients sending {drain: true|false} to /api/devices/ {id}/maintenance, /api/devices/bulk/enter-maintenance, or the group bulk equivalent must drop the field. The enter-maintenance behaviour is unchanged from drain=false (always stop the node).
+
+### Features
+
+* **backend:** device state model drift fixes (D1-D6) ([#144](https://github.com/quidow/gridfleet/issues/144)) ([09556fd](https://github.com/quidow/gridfleet/commit/09556fdac8ddb458f1655f9001f25240443062fb))
+
 ## [0.5.0](https://github.com/quidow/gridfleet/compare/gridfleet-testkit-v0.4.0...gridfleet-testkit-v0.5.0) (2026-05-08)
 
 

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gridfleet-testkit
-Version: 0.5.0
+Version: 0.6.0
 Summary: Supported pytest and run-orchestration helpers for GridFleet integrations
 Project-URL: Homepage, https://github.com/quidow/gridfleet
 Project-URL: Repository, https://github.com/quidow/gridfleet

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/gridfleet_testkit/__init__.py

@@ -47,7 +47,7 @@ from .sessions import build_error_session_payload
 try:
     __version__ = version("gridfleet-testkit")
 except PackageNotFoundError:
-    __version__ = "0.5.0"
+    __version__ = "0.6.0"
 
 __all__ = [
     "GRIDFLEET_API_URL",

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/gridfleet_testkit/client.py

@@ -600,6 +600,27 @@ class GridFleetClient:
             return None
         return cast("dict[str, Any]", resp.json())
 
+    def notify_session_finished(
+        self,
+        session_id: str,
+        *,
+        suppress_errors: bool = True,
+    ) -> None:
+        """Tell the manager the WebDriver session has ended.
+
+        Idempotent on the backend — repeated calls are a no-op once the
+        Session row is marked ended.
+        """
+        try:
+            resp = httpx.post(
+                f"{self.base_url}/sessions/{session_id}/finished",
+                timeout=5,
+                auth=self._auth,
+            )
+            resp.raise_for_status()
+        except (httpx.HTTPError, TypeError, ValueError) as exc:
+            _raise_or_warn("notify session finished", suppress_errors, exc)
+
     def update_session_status(
         self,
         session_id: str,
@@ -629,7 +650,12 @@ class GridFleetClient:
         run_id: str | None = None,
         suppress_errors: bool = True,
     ) -> dict[str, Any] | None:
-        """Extract session metadata from an Appium driver and register it."""
+        """Extract session metadata from an Appium driver and register it.
+
+        Also wraps ``driver.quit`` so that the first call after a successful
+        registration fires :meth:`notify_session_finished` automatically.
+        Errors from notify are suppressed — they must never break the caller.
+        """
         capabilities = getattr(driver, "capabilities", {})
         if not isinstance(capabilities, dict):
             capabilities = {}
@@ -638,7 +664,7 @@ class GridFleetClient:
             raise RuntimeError("Created Appium driver did not expose a session ID")
         device_id = capabilities.get("appium:gridfleet:deviceId") or capabilities.get("gridfleet:deviceId")
         connection_target = capabilities.get("appium:udid") or capabilities.get("appium:deviceName")
-        return self.register_session(
+        result = self.register_session(
             session_id=session_id,
             test_name=test_name,
             device_id=device_id if isinstance(device_id, str) and device_id else None,
@@ -647,6 +673,31 @@ class GridFleetClient:
             run_id=run_id,
             suppress_errors=suppress_errors,
         )
+        self._wrap_quit_for_notify(driver, session_id)
+        return result
+
+    def _wrap_quit_for_notify(self, driver: Any, session_id: str) -> None:
+        """Replace ``driver.quit`` with a wrapper that also notifies the manager.
+
+        The notify fires at most once per registration: after the first quit
+        succeeds, subsequent quit() calls run the underlying quit but do
+        NOT post to /finished again. The underlying quit still runs every
+        call.
+
+        Raises AttributeError if the driver lacks a quit method.
+        """
+        original_quit = driver.quit
+        notified: dict[str, bool] = {"done": False}
+
+        def wrapped_quit(*args: Any, **kwargs: Any) -> Any:
+            try:
+                return original_quit(*args, **kwargs)
+            finally:
+                if not notified["done"]:
+                    notified["done"] = True
+                    self.notify_session_finished(session_id, suppress_errors=True)
+
+        driver.quit = wrapped_quit
 
     def complete_run(self, run_id: str) -> dict[str, Any]:
         resp = httpx.post(

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gridfleet-testkit"
-version = "0.5.0"
+version = "0.6.0"
 description = "Supported pytest and run-orchestration helpers for GridFleet integrations"
 readme = "README.md"
 license = "Apache-2.0"

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/tests/test_client.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 import signal
-from typing import Any
+from typing import Any, ClassVar
 
 import httpx
 import pytest
@@ -806,19 +806,19 @@ def test_register_session_from_driver_extracts_gridfleet_capabilities(monkeypatc
 
     monkeypatch.setattr(GridFleetClient, "register_session", fake_register_session)
 
-    driver = type(
-        "Driver",
-        (),
-        {
-            "session_id": "sess-1",
-            "capabilities": {
-                "appium:gridfleet:deviceId": "dev-1",
-                "appium:udid": "SERIAL123",
-                "appium:platform": "android_mobile",
-                "platformName": "Android",
-            },
-        },
-    )()
+    class FakeDriver:
+        session_id = "sess-1"
+        capabilities: ClassVar[dict[str, object]] = {
+            "appium:gridfleet:deviceId": "dev-1",
+            "appium:udid": "SERIAL123",
+            "appium:platform": "android_mobile",
+            "platformName": "Android",
+        }
+
+        def quit(self) -> None:
+            return None
+
+    driver = FakeDriver()
     client = GridFleetClient("http://manager/api")
 
     assert client.register_session_from_driver(driver, test_name="test_login", run_id="run-1") == {"ok": True}
@@ -1643,3 +1643,109 @@ def test_register_run_cleanup_idempotent_under_explicit_double_call(monkeypatch)
     cleanup_fn()  # second invocation must be a no-op
 
     assert client.calls == ["complete:run-double"]
+
+
+# --- Task 7: notify_session_finished and driver.quit wrap ---
+
+
+def test_notify_session_finished_calls_endpoint(monkeypatch):
+    """notify_session_finished posts to /api/sessions/{id}/finished."""
+    recorded: dict[str, Any] = {}
+
+    def fake_post(
+        url: str,
+        *,
+        timeout: int,
+        auth: Any = None,
+    ) -> DummyResponse:
+        recorded["url"] = url
+        recorded["timeout"] = timeout
+        return DummyResponse(None, status_code=204)
+
+    monkeypatch.setattr("gridfleet_testkit.client.httpx.post", fake_post)
+
+    client = GridFleetClient("http://localhost:8000/api")
+    client.notify_session_finished("abc-123", suppress_errors=False)
+
+    assert recorded["url"] == "http://localhost:8000/api/sessions/abc-123/finished"
+    assert recorded["timeout"] == 5
+
+
+def test_register_session_from_driver_wraps_quit_to_notify(monkeypatch):
+    """After register_session_from_driver, driver.quit() also fires notify."""
+    post_calls: list[str] = []
+    quit_called = {"n": 0}
+
+    def fake_post(
+        url: str,
+        *,
+        json: dict[str, Any] | None = None,
+        timeout: int = 5,
+        auth: Any = None,
+    ) -> DummyResponse:
+        post_calls.append(url)
+        if url.endswith("/sessions"):
+            return DummyResponse({"id": "session-xyz"}, status_code=201)
+        if url.endswith("/finished"):
+            return DummyResponse(None, status_code=204)
+        return DummyResponse({})
+
+    monkeypatch.setattr("gridfleet_testkit.client.httpx.post", fake_post)
+
+    class FakeDriver:
+        session_id = "session-xyz"
+        capabilities: ClassVar[dict[str, object]] = {}
+
+        def quit(self) -> None:
+            quit_called["n"] += 1
+
+    driver = FakeDriver()
+    client = GridFleetClient("http://localhost:8000/api")
+    client.register_session_from_driver(driver, test_name="t", suppress_errors=False)
+
+    driver.quit()
+    assert quit_called["n"] == 1
+    finished_calls = [u for u in post_calls if u.endswith("/finished")]
+    assert len(finished_calls) == 1
+
+
+def test_register_session_from_driver_quit_wrap_is_idempotent(monkeypatch):
+    """Calling driver.quit() twice does not fire two notify requests, but underlying quit runs both times."""
+    post_calls: list[str] = []
+
+    def fake_post(
+        url: str,
+        *,
+        json: dict[str, Any] | None = None,
+        timeout: int = 5,
+        auth: Any = None,
+    ) -> DummyResponse:
+        post_calls.append(url)
+        if url.endswith("/sessions"):
+            return DummyResponse({"id": "session-xyz"}, status_code=201)
+        if url.endswith("/finished"):
+            return DummyResponse(None, status_code=204)
+        return DummyResponse({})
+
+    monkeypatch.setattr("gridfleet_testkit.client.httpx.post", fake_post)
+
+    class FakeDriver:
+        session_id = "session-xyz"
+        capabilities: ClassVar[dict[str, object]] = {}
+        quit_count = 0
+
+        def quit(self) -> None:
+            type(self).quit_count += 1
+
+    driver = FakeDriver()
+    client = GridFleetClient("http://localhost:8000/api")
+    client.register_session_from_driver(driver, test_name="t", suppress_errors=False)
+
+    driver.quit()
+    driver.quit()  # second call: must NOT post /finished again, but MUST run quit
+
+    # /finished posted exactly once
+    finished_calls = [u for u in post_calls if u.endswith("/finished")]
+    assert len(finished_calls) == 1
+    # underlying quit ran twice
+    assert FakeDriver.quit_count == 2

{gridfleet_testkit-0.5.0 → gridfleet_testkit-0.6.0}/uv.lock

@@ -136,7 +136,7 @@ wheels = [
 
 [[package]]
 name = "gridfleet-testkit"
-version = "0.5.0"
+version = "0.6.0"
 source = { editable = "." }
 dependencies = [
     { name = "httpx" },