Add tests for utils module

Author: callumforrester

src/dodal/utils.py

@@ -80,16 +80,16 @@ def make_all_devices(module: Union[str, ModuleType, None] = None) -> Dict[str, A
 
 def collect_factories(module: ModuleType) -> Iterable[Callable[..., Any]]:
     for var in module.__dict__.values():
-        if callable(var) and is_device_factory(var):
+        if callable(var) and _is_device_factory(var):
             yield var
 
 
-def is_device_factory(func: Callable[..., Any]) -> bool:
+def _is_device_factory(func: Callable[..., Any]) -> bool:
     return_type = signature(func).return_annotation
-    return is_device_type(return_type)
+    return _is_device_type(return_type)
 
 
-def is_device_type(obj: Type[Any]) -> bool:
+def _is_device_type(obj: Type[Any]) -> bool:
     is_class = inspect.isclass(obj)
     follows_protocols = any(
         map(lambda protocol: isinstance(obj, protocol), BLUESKY_PROTOCOLS)

tests/__init__.py

@@ -0,0 +1,26 @@
+from unittest.mock import patch
+
+from dodal.utils import collect_factories, get_hostname, make_all_devices
+
+
+def test_finds_device_factories() -> None:
+    import tests.fake_beamline as fake_beamline
+
+    factories = set(collect_factories(fake_beamline))
+
+    from tests.fake_beamline import device_a, device_b, device_c
+
+    assert {device_a, device_b, device_c} == factories
+
+
+def test_makes_devices() -> None:
+    import tests.fake_beamline as fake_beamline
+
+    devices = make_all_devices(fake_beamline)
+    assert {"readable", "motor", "cryo"} == devices.keys()
+
+
+def test_get_hostname() -> None:
+    with patch("dodal.utils.socket.gethostname") as mock:
+        mock.return_value = "a.b.c"
+        assert get_hostname() == "a"

tests/devices/unit_tests/test_utils.py

@@ -0,0 +1,28 @@
+from unittest.mock import MagicMock
+
+from bluesky.protocols import Readable
+from ophyd import EpicsMotor
+
+from dodal.devices.cryostream import Cryo
+
+
+def device_a() -> Readable:
+    return _mock_with_name("readable")
+
+
+def device_b() -> EpicsMotor:
+    return _mock_with_name("motor")
+
+
+def device_c() -> Cryo:
+    return _mock_with_name("cryo")
+
+
+def not_device() -> int:
+    return 5
+
+
+def _mock_with_name(name: str) -> MagicMock:
+    mock = MagicMock()
+    mock.name = name
+    return mock