Make 'devices' default name for device manager in CLI

Author: tpoliaw

src/dodal/cli.py

@@ -45,8 +45,8 @@ def main(ctx: click.Context) -> None:
     "attempt any I/O. Useful as a a dry-run.",
     default=False,
 )
-@click.option("-n", "--name")
-def connect(beamline: str, all: bool, sim_backend: bool, name: str | None) -> None:
+@click.option("-n", "--name", "device_manager", default="devices")
+def connect(beamline: str, all: bool, sim_backend: bool, device_manager: str) -> None:
     """Initialises a beamline module, connects to all devices, reports
     any connection issues."""
 
@@ -70,18 +70,14 @@ def connect(beamline: str, all: bool, sim_backend: bool, name: str | None) -> No
     # because the alternatives is handling the fact that only some devices may
     # be lazy.
 
-    if name:
-        if (manager := getattr(mod, name, None)) and isinstance(manager, DeviceManager):
-            devices, instance_exceptions, connect_exceptions = (
-                manager.build_and_connect(
-                    mock=sim_backend,
-                )
-            )
-        else:
-            raise ValueError(
-                f"Name '{name}' could not be found or is not a DeviceManager"
-            )
+    if (manager := getattr(mod, device_manager, None)) and isinstance(
+        manager, DeviceManager
+    ):
+        devices, instance_exceptions, connect_exceptions = manager.build_and_connect(
+            mock=sim_backend,
+        )
     else:
+        print(f"No device manager named '{device_manager}' found in {mod}")
         _spoof_path_provider()
         devices, instance_exceptions = make_all_devices(
             full_module_path,

tests/test_cli.py

@@ -298,18 +298,17 @@ def test_cli_connect_when_devices_error(
         )
 
 
+@patch("dodal.cli.importlib")
+@patch("dodal.cli.make_all_devices")
+@patch("dodal.cli._connect_devices")
 @patch.dict(os.environ, clear=True)
-def test_missing_device_manager(runner: CliRunner):
-    with patch("dodal.cli.importlib"):
-        with pytest.raises(
-            ValueError,
-            match="Name 'devices' could not be found or is not a DeviceManager",
-        ):
-            print("Invoking connect")
-            runner.invoke(
-                main, ["connect", "-n", "devices", "i22"], catch_exceptions=False
-            )
-            print("Ran connect")
+def test_missing_device_manager(connect, make, imp, runner: CliRunner):
+    # If the device manager cannot be found, it should fall back to the
+    # make_all_devices + _connect_devices approach.
+    make.return_value = ({}, {})
+    runner.invoke(main, ["connect", "-n", "devices", "i22"])
+    make.assert_called_once()
+    connect.assert_called_once()
 
 
 @patch.dict(os.environ, clear=True)