griip-core-dev 0.5.6.dev25546__py3-none-any.whl

griip_core/hardware/tests/test_vrmcs_registration.py

@@ -0,0 +1,179 @@
+"""Tests for find_compatible_registration."""
+
+from __future__ import annotations
+
+from unittest.mock import MagicMock
+
+import pytest
+
+from griip_core.hardware.vrmcs_registration import adopt_existing_registration, find_compatible_registration
+
+
+def _robot_info(robot_id: str, ip: str) -> MagicMock:
+    info = MagicMock()
+    info.id = robot_id
+    info.driver_params.params = {"ip": ip}
+    return info
+
+
+def _robot_instance(robot_id: str, ip: str) -> MagicMock:
+    instance = MagicMock()
+    instance.id = robot_id
+    instance.driver_params.params = {"ip": ip}
+    return instance
+
+
+def _mock_client(robots: list[MagicMock] | None = None, list_raises: Exception | None = None) -> MagicMock:
+    client = MagicMock()
+    if list_raises is not None:
+        client.stub.ListRobots.side_effect = list_raises
+    else:
+        list_response = MagicMock()
+        list_response.robots = robots if robots is not None else []
+        client.stub.ListRobots.return_value = list_response
+    return client
+
+
+class TestFindCompatibleRegistration:
+    def test_returns_none_when_no_robots_registered(self) -> None:
+        client = _mock_client(robots=[])
+        assert find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1") is None
+
+    def test_returns_exact_id_match(self) -> None:
+        a = _robot_info("abc", "10.0.0.2")
+        b = _robot_info("xyz", "10.0.0.1")
+        client = _mock_client(robots=[a, b])
+
+        match = find_compatible_registration(client, robot_id="xyz", robot_ip="10.0.0.1")
+
+        assert match is b
+
+    def test_exact_id_match_wins_even_when_id_is_zero(self) -> None:
+        placeholder = _robot_info("0", "10.0.0.1")
+        uuid = _robot_info("ff83ba12", "10.0.0.1")
+        client = _mock_client(robots=[placeholder, uuid])
+
+        match = find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1")
+
+        assert match is placeholder
+
+    def test_ip_match_prefers_non_zero_when_id_differs(self) -> None:
+        placeholder = _robot_info("0", "10.0.0.1")
+        uuid = _robot_info("ff83ba12", "10.0.0.1")
+        client = _mock_client(robots=[placeholder, uuid])
+
+        match = find_compatible_registration(client, robot_id="some-other-id", robot_ip="10.0.0.1")
+
+        assert match is uuid
+
+    def test_falls_back_to_zero_when_only_zero_matches_ip_and_flag_enabled(self) -> None:
+        placeholder = _robot_info("0", "10.0.0.1")
+        client = _mock_client(robots=[placeholder])
+
+        match = find_compatible_registration(
+            client,
+            robot_id="some-other-id",
+            robot_ip="10.0.0.1",
+            allow_legacy_zero_id_match=True,
+        )
+
+        assert match is placeholder
+
+    def test_legacy_zero_id_rejected_by_default(self) -> None:
+        placeholder = _robot_info("0", "10.0.0.1")
+        client = _mock_client(robots=[placeholder])
+
+        match = find_compatible_registration(client, robot_id="some-other-id", robot_ip="10.0.0.1")
+
+        assert match is None
+
+    def test_returns_none_when_no_id_or_ip_match(self) -> None:
+        other = _robot_info("uuid-1", "10.0.0.99")
+        client = _mock_client(robots=[other])
+
+        match = find_compatible_registration(client, robot_id="some-other-id", robot_ip="10.0.0.1")
+
+        assert match is None
+
+    def test_returns_none_when_list_robots_raises(self) -> None:
+        client = _mock_client(list_raises=RuntimeError("pydantic blew up"))
+
+        match = find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1")
+
+        assert match is None
+
+    def test_quiet_suppresses_warnings(self, caplog: pytest.LogCaptureFixture) -> None:
+        client = _mock_client(list_raises=RuntimeError("boom"))
+
+        with caplog.at_level("WARNING", logger="griip_core.hardware.vrmcs_registration"):
+            find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1", quiet=True)
+
+        assert caplog.records == []
+
+    def test_exact_id_match_skipped_when_ip_differs(self) -> None:
+        wrong_ip = _robot_info("0", "10.0.0.99")
+        client = _mock_client(robots=[wrong_ip])
+
+        match = find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1")
+
+        assert match is None
+
+    def test_exact_id_match_with_wrong_ip_falls_through_to_ip_step(self) -> None:
+        wrong_ip = _robot_info("0", "10.0.0.99")
+        right_ip = _robot_info("ff83ba12", "10.0.0.1")
+        client = _mock_client(robots=[wrong_ip, right_ip])
+
+        match = find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1")
+
+        assert match is right_ip
+
+    def test_exact_id_match_accepts_empty_registered_ip(self) -> None:
+        legacy = _robot_info("0", "")
+        client = _mock_client(robots=[legacy])
+
+        match = find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1")
+
+        assert match is legacy
+
+    def test_require_ip_match_false_returns_exact_id_regardless_of_ip(self) -> None:
+        wrong_ip = _robot_info("0", "10.0.0.99")
+        client = _mock_client(robots=[wrong_ip])
+
+        match = find_compatible_registration(client, robot_id="0", robot_ip="10.0.0.1", require_ip_match=False)
+
+        assert match is wrong_ip
+
+
+class TestAdoptExistingRegistration:
+    def test_explicit_zero_id_adopts_exact_zero_registration(self) -> None:
+        placeholder = _robot_info("0", "10.0.0.1")
+        uuid = _robot_info("ff83ba12", "10.0.0.1")
+        client = _mock_client(robots=[placeholder, uuid])
+        instance = _robot_instance("0", "10.0.0.1")
+
+        adopted = adopt_existing_registration(
+            client,
+            instance,
+            log=MagicMock(),
+            allow_legacy_zero_id_match=True,
+        )
+
+        assert adopted is True
+        assert instance.id == "0"
+
+    def test_auto_id_prefers_non_zero_ip_match_over_zero_placeholder(self) -> None:
+        placeholder = _robot_info("0", "10.0.0.1")
+        uuid = _robot_info("ff83ba12", "10.0.0.1")
+        client = _mock_client(robots=[placeholder, uuid])
+        instance = _robot_instance("0", "10.0.0.1")
+
+        adopted = adopt_existing_registration(
+            client,
+            instance,
+            log=MagicMock(),
+            allow_legacy_zero_id_match=True,
+            prefer_ip_match=True,
+        )
+
+        assert adopted is True
+        assert instance.id == "ff83ba12"