Test coverage

Author: tpoliaw

tests/unit_tests/client/test_client.py

@@ -20,7 +20,7 @@
 )
 from blueapi.client.event_bus import AnyEvent, EventBusClient
 from blueapi.client.rest import BlueapiRestClient, BlueskyRemoteControlError
-from blueapi.config import MissingStompConfigurationError
+from blueapi.config import MissingStompConfigurationError, StompConfig, TcpUrl
 from blueapi.core import DataEvent
 from blueapi.service.model import (
     DeviceModel,
@@ -385,6 +385,27 @@ def test_cannot_run_task_without_message_bus(client: BlueapiClient, mock_rest: M
         client.run_task(TaskRequest(name="foo", instrument_session="cm12345-1"))
 
 
+@patch("blueapi.client.client.EventBusClient")
+def test_run_task_with_stomp_config_from_server(
+    ebc: Mock, client: BlueapiClient, mock_rest: Mock
+):
+    mock_rest.get_stomp_config.return_value = StompConfig(
+        enabled=True, url=TcpUrl("tcp://localhost:9876"), auth=None
+    )
+    mock_rest.create_task.return_value = TaskResponse(task_id="foo")
+    mock_rest.update_worker_task.return_value = TaskResponse(task_id="foo")
+    events = MagicMock(spec=EventBusClient, name="EventBusClient")
+    ctx = Mock(correlation_id="foo")
+    events.subscribe_to_all_events.side_effect = lambda on_event: on_event(
+        COMPLETE_EVENT, ctx
+    )
+    ebc.from_stomp_config.return_value = events
+
+    client.run_task(TaskRequest(name="foo", instrument_session="cm12345-1"))
+
+    mock_rest.get_stomp_config.assert_called_once()
+
+
 def test_run_task_sets_up_control(
     client_with_events: BlueapiClient,
     mock_rest: Mock,

tests/unit_tests/client/test_rest.py

@@ -16,7 +16,7 @@
     UnknownPlanError,
     _create_task_exceptions,
 )
-from blueapi.config import OIDCConfig
+from blueapi.config import OIDCConfig, TcpUrl
 from blueapi.service.authentication import SessionCacheManager, SessionManager
 from blueapi.service.model import EnvironmentResponse
 
@@ -196,3 +196,47 @@ def test_parameter_error_other_string():
         input=34,
     )
     assert str(p1) == "Invalid value 34 for field field_one.0: error_message"
+
+
+@responses.activate
+def test_get_stomp_config(rest: BlueapiRestClient):
+    responses.add(
+        responses.GET,
+        "http://localhost:8000/config/stomp",
+        json={
+            "enabled": True,
+            "url": "tcp://messagebus.example.com",
+            "auth": {"username": "foo", "password": "bar"},
+        },
+        status=200,
+    )
+    stomp = rest.get_stomp_config()
+    assert stomp is not None
+    assert stomp.enabled
+    assert stomp.url == TcpUrl("tcp://messagebus.example.com")
+    assert stomp.auth is not None
+    assert stomp.auth.username == "foo"
+    assert stomp.auth.password.get_secret_value() == "bar"
+
+
+@responses.activate
+def test_get_no_stomp_config(rest: BlueapiRestClient):
+    responses.add(
+        responses.GET,
+        "http://localhost:8000/config/stomp",
+        status=204,
+    )
+    stomp = rest.get_stomp_config()
+    assert stomp is None
+
+
+@responses.activate
+def test_get_stomp_config_from_old_server(rest: BlueapiRestClient):
+    responses.add(
+        responses.GET,
+        "http://localhost:8000/config/stomp",
+        json={},  # Weird default handling for 404 - See #1409
+        status=404,
+    )
+    stomp = rest.get_stomp_config()
+    assert stomp is None

tests/unit_tests/service/test_rest_api.py

@@ -14,7 +14,13 @@
 from pydantic_core import InitErrorDetails
 from super_state_machine.errors import TransitionError
 
-from blueapi.config import ApplicationConfig, CORSConfig, OIDCConfig, RestConfig
+from blueapi.config import (
+    ApplicationConfig,
+    CORSConfig,
+    OIDCConfig,
+    RestConfig,
+    StompConfig,
+)
 from blueapi.core.bluesky_types import Plan
 from blueapi.service import main
 from blueapi.service.interface import (
@@ -709,6 +715,27 @@ def test_get_without_authentication(mock_runner: Mock, client: TestClient) -> No
     assert response.json() == {"detail": "Not authenticated"}
 
 
+def test_stomp_config_not_found_when_stomp_is_disabled(
+    mock_runner: Mock, client: TestClient
+):
+    mock_runner.run.return_value = None
+    response = client.get("/config/stomp")
+    assert response.status_code == status.HTTP_204_NO_CONTENT
+    assert response.text == ""
+
+
+def test_get_stomp_config(
+    mock_runner: Mock,
+    mock_authn_server,
+    client: TestClient,
+):
+    stomp_config = StompConfig(enabled=False)
+    mock_runner.run.return_value = stomp_config
+    response = client.get("/config/stomp")
+    assert response.status_code == status.HTTP_200_OK
+    assert response.json() == stomp_config.model_dump(mode="json")
+
+
 def test_oidc_config_not_found_when_auth_is_disabled(
     mock_runner: Mock, client: TestClient
 ):

tests/unit_tests/test_cli.py

@@ -1404,3 +1404,45 @@ def test_config_schema(
 def test_task_parameter_type(value, result):
     t = ParametersType()
     assert t.convert(value, None, None) == result
+
+
+@responses.activate
+def test_host_option(runner: CliRunner):
+    response = responses.add(
+        responses.GET,
+        "http://override.example.com:5678/plans",
+        json={"plans": []},
+        status=200,
+    )
+
+    res = runner.invoke(
+        main,
+        ["--host", "http://override.example.com:5678", "controller", "plans"],
+    )
+    assert response.call_count == 1
+    assert res.exit_code == 0
+
+
+@responses.activate
+def test_host_overrides_config(runner: CliRunner):
+    config_path = "tests/unit_tests/example_yaml/rest_config.yaml"
+    response = responses.add(
+        responses.GET,
+        "http://override.example.com:5678/plans",
+        json={"plans": []},
+        status=200,
+    )
+
+    res = runner.invoke(
+        main,
+        [
+            "--host",
+            "http://override.example.com:5678",
+            "--config",
+            config_path,
+            "controller",
+            "plans",
+        ],
+    )
+    assert response.call_count == 1
+    assert res.exit_code == 0