test: Update tests for new exception hierarchy

Author: Alexj9837

tests/system_tests/test_blueapi_system.py

@@ -15,7 +15,9 @@
     BlueapiRestClient,
     BlueskyRemoteControlError,
     BlueskyRequestError,
+    NotFoundError,
     ServiceUnavailableError,
+    UnauthorisedAccessError,
 )
 from blueapi.config import (
     ApplicationConfig,
@@ -217,7 +219,7 @@ def test_cannot_access_endpoints(
         "get_oidc_config"
     )  # get_oidc_config can be accessed without auth
     for get_method in blueapi_rest_client_get_methods:
-        with pytest.raises(BlueskyRemoteControlError, match=r"<Response \[401\]>"):
+        with pytest.raises(UnauthorisedAccessError, match=r"<Response \[401\]>"):
             getattr(client_without_auth._rest, get_method)()
 
 
@@ -243,7 +245,7 @@ def test_get_plans_by_name(client: BlueapiClient, expected_plans: PlanResponse):
 
 
 def test_get_non_existent_plan(rest_client: BlueapiRestClient):
-    with pytest.raises(KeyError, match="{'detail': 'Item not found'}"):
+    with pytest.raises(NotFoundError):
         rest_client.get_plan("Not exists")
 
 
@@ -268,12 +270,12 @@ def test_get_device_by_name(
 
 
 def test_get_non_existent_device(rest_client: BlueapiRestClient):
-    with pytest.raises(KeyError, match="{'detail': 'Item not found'}"):
+    with pytest.raises(NotFoundError):
         rest_client.get_device("Not exists")
 
 
 def test_client_non_existent_device(client: BlueapiClient):
-    with pytest.raises(AttributeError, match="No device named 'missing' available"):
+    with pytest.raises(AttributeError):
         _ = client.devices.missing
 
 
@@ -295,7 +297,7 @@ def test_instrument_session_propagated(rest_client: BlueapiRestClient):
 
 
 def test_create_task_validation_error(rest_client: BlueapiRestClient):
-    with pytest.raises(BlueskyRequestError, match="Internal Server Error"):
+    with pytest.raises(BlueskyRequestError):
         rest_client.create_task(
             TaskRequest(
                 name="Not-exists",
@@ -336,12 +338,12 @@ def test_get_task_by_id(rest_client: BlueapiRestClient):
 
 
 def test_get_non_existent_task(rest_client: BlueapiRestClient):
-    with pytest.raises(KeyError, match="{'detail': 'Item not found'}"):
+    with pytest.raises(NotFoundError):
         rest_client.get_task("Not-exists")
 
 
 def test_delete_non_existent_task(rest_client: BlueapiRestClient):
-    with pytest.raises(KeyError, match="{'detail': 'Item not found'}"):
+    with pytest.raises(NotFoundError):
         rest_client.clear_task("Not-exists")
 
 

tests/unit_tests/cli/test_cli.py

@@ -118,9 +118,8 @@ def test_connection_error_caught_by_wrapper_func(
 def test_authentication_error_caught_by_wrapper_func(
     mock_requests: Mock, runner: CliRunner
 ):
-    mock_requests.side_effect = BlueskyRemoteControlError("<Response [401]>")
+    mock_requests.side_effect = UnauthorisedAccessError(message="<Response [401]>")
     result = runner.invoke(main, ["controller", "plans"])
-
     assert (
         result.output
         == "Error: Access denied. Please check your login status and try again.\n"
@@ -129,12 +128,11 @@ def test_authentication_error_caught_by_wrapper_func(
 
 @patch("blueapi.client.rest.requests.Session.request")
 def test_remote_error_raised_by_wrapper_func(mock_requests: Mock, runner: CliRunner):
-    mock_requests.side_effect = BlueskyRemoteControlError("Response [450]")
-
+    mock_requests.side_effect = BlueskyRemoteControlError(message="Response [450]")
     result = runner.invoke(main, ["controller", "plans"])
     assert (
         isinstance(result.exception, BlueskyRemoteControlError)
-        and result.exception.args == ("Response [450]",)
+        and result.exception.args[1] == "Response [450]"
         and result.exit_code == 1
     )
 
@@ -680,7 +678,7 @@ def test_env_reload_server_side_error(runner: CliRunner):
     assert isinstance(result.exception, BlueskyRemoteControlError), (
         "Expected a BlueskyRemoteError from cli runner"
     )
-    assert result.exception.args[0] == "Failed to tear down the environment"
+    assert result.exception.args[1] == "Failed to tear down the environment"
 
     # Check if the endpoints were hit as expected
     assert len(responses.calls) == 1  # +1 for the DELETE call
@@ -716,20 +714,25 @@ def test_env_reload_server_side_error(runner: CliRunner):
             "Error: Incorrect parameters supplied\n    Missing value for 'foo'\n",
         ),
         (
-            BlueskyRemoteControlError("Server error"),
-            "Error: server error with this message: Server error\n",
+            BlueskyRemoteControlError(message="Server error"),
+            "Error: remote control error: Server error\n",
         ),
         (
             ValueError("Error parsing parameters"),
             "Error: task could not run: Error parsing parameters\n",
         ),
+        (
+            BlueskyStreamingError("streaming failed"),
+            "Error: streaming error: streaming failed\n",
+        ),
     ],
     ids=[
         "unknown_plan",
         "unauthorised_access",
         "invalid_parameters",
         "remote_control",
         "value_error",
+        "streaming_error",
     ],
 )
 def test_error_handling(exception, error_message, runner: CliRunner):

tests/unit_tests/client/test_client.py

@@ -19,7 +19,11 @@
     PlanCache,
 )
 from blueapi.client.event_bus import AnyEvent, EventBusClient
-from blueapi.client.rest import BlueapiRestClient, BlueskyRemoteControlError
+from blueapi.client.rest import (
+    BlueapiRestClient,
+    BlueskyRemoteControlError,
+    NotFoundError,
+)
 from blueapi.config import MissingStompConfigurationError
 from blueapi.core import DataEvent
 from blueapi.service.model import (
@@ -98,7 +102,14 @@ def mock_rest() -> BlueapiRestClient:
     mock.get_plans.return_value = PLANS
     mock.get_plan.side_effect = lambda n: {p.name: p for p in PLANS.plans}[n]
     mock.get_devices.return_value = DEVICES
-    mock.get_device.side_effect = lambda n: {d.name: d for d in DEVICES.devices}[n]
+    device_map = {d.name: d for d in DEVICES.devices}
+
+    def get_device(n: str):
+        if n not in device_map:
+            raise NotFoundError(404, "<Response [404]>")
+        return device_map[n]
+
+    mock.get_device.side_effect = get_device
     mock.get_state.return_value = WorkerState.IDLE
     mock.get_task.return_value = TASK
     mock.get_all_tasks.return_value = TASKS
@@ -214,7 +225,7 @@ def test_create_and_start_task_fails_if_task_creation_fails(
     client: BlueapiClient,
     mock_rest: Mock,
 ):
-    mock_rest.create_task.side_effect = BlueskyRemoteControlError("No can do")
+    mock_rest.create_task.side_effect = BlueskyRemoteControlError(message="No can do")
     with pytest.raises(BlueskyRemoteControlError):
         client.create_and_start_task(
             TaskRequest(name="baz", instrument_session="cm12345-1")
@@ -238,7 +249,9 @@ def test_create_and_start_task_fails_if_task_start_fails(
     mock_rest: Mock,
 ):
     mock_rest.create_task.return_value = TaskResponse(task_id="baz")
-    mock_rest.update_worker_task.side_effect = BlueskyRemoteControlError("No can do")
+    mock_rest.update_worker_task.side_effect = BlueskyRemoteControlError(
+        message="No can do"
+    )
     with pytest.raises(BlueskyRemoteControlError):
         client.create_and_start_task(
             TaskRequest(name="baz", instrument_session="cm12345-1")

tests/unit_tests/client/test_rest.py

@@ -11,6 +11,7 @@
     BlueskyRemoteControlError,
     BlueskyRequestError,
     InvalidParametersError,
+    NotFoundError,
     ParameterError,
     UnauthorisedAccessError,
     UnknownPlanError,
@@ -39,8 +40,9 @@ def rest_with_auth(oidc_config: OIDCConfig, tmp_path) -> BlueapiRestClient:
 @pytest.mark.parametrize(
     "code,expected_exception",
     [
-        (404, KeyError),
-        (401, BlueskyRemoteControlError),
+        (404, NotFoundError),
+        (401, UnauthorisedAccessError),
+        (403, UnauthorisedAccessError),
         (450, BlueskyRemoteControlError),
         (500, BlueskyRemoteControlError),
     ],
@@ -63,9 +65,9 @@ def test_rest_error_code(
     "code,content,expected_exception",
     [
         (200, None, None),
-        (401, None, UnauthorisedAccessError()),
-        (403, None, UnauthorisedAccessError()),
-        (404, None, UnknownPlanError()),
+        (401, None, UnauthorisedAccessError(401, "")),
+        (403, None, UnauthorisedAccessError(403, "")),
+        (404, None, UnknownPlanError(404, "")),
         (
             422,
             """{
@@ -87,6 +89,11 @@ def test_rest_error_code(
                 ]
             ),
         ),
+        (
+            422,
+            '{"detail": "not a list"}',
+            BlueskyRequestError(422, ""),
+        ),
         (450, "non-standard", BlueskyRequestError(450, "non-standard")),
         (500, "internal_error", BlueskyRequestError(500, "internal_error")),
     ],
@@ -102,8 +109,11 @@ def test_create_task_exceptions(
     response.json.side_effect = lambda: json.loads(content) if content else None
     err = _create_task_exceptions(response)
     assert isinstance(err, type(expected_exception))
-    if expected_exception is not None:
-        assert err.args == expected_exception.args
+    if isinstance(expected_exception, InvalidParametersError):
+        assert isinstance(err, InvalidParametersError)
+        assert err.errors == expected_exception.errors
+    elif expected_exception is not None:
+        assert err.args[0] == code
 
 
 def test_auth_request_functionality(