Merge branch 'main' into 1451_change_config_overwriteability

Author: shree-iyengar-dls

.github/workflows/_container.yml

@@ -88,7 +88,7 @@ jobs:
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
 
       - name: install helm
-        uses: Azure/setup-helm@1a275c3b69536ee54be43f2070a358922e12c8d4 # v4
+        uses: Azure/setup-helm@dda3372f752e03dde6b3237bc9431cdc2f7a02a2 # v5
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
         id: install

Dockerfile

@@ -34,7 +34,7 @@ RUN --mount=type=cache,target=/root/.cache/uv \
     uv sync --locked --no-editable --no-dev --managed-python
 
 # The runtime stage copies the built venv into a runtime container
-FROM ubuntu:noble AS runtime
+FROM ubuntu:resolute AS runtime
 
 # Add apt-get system dependecies for runtime here if needed
 RUN DEBIAN_FRONTEND=noninteractive apt-get update && apt-get install -y --no-install-recommends \

src/blueapi/cli/cli.py

@@ -81,6 +81,19 @@ def is_str_dict(val: Any) -> TypeGuard[TaskParameters]:
     invoke_without_command=True, context_settings={"auto_envvar_prefix": "BLUEAPI"}
 )
 @click.version_option(version=__version__, prog_name="blueapi")
+@click.option(
+    "-h",
+    "--host",
+    type=str,
+    help=textwrap.dedent(
+        """
+        Hostname for the blueapi instance to use
+
+        Value should be the full URL including scheme (and port if non-default),
+        eg `--host http://localhost:8000`
+        """
+    ),
+)
 @click.option(
     "-c", "--config", type=Path, help="Path to configuration YAML file", multiple=True
 )
@@ -100,7 +113,10 @@ def is_str_dict(val: Any) -> TypeGuard[TaskParameters]:
 )
 @click.pass_context
 def main(
-    ctx: click.Context, config: tuple[Path, ...], log_level: str | None = None
+    ctx: click.Context,
+    config: tuple[Path, ...],
+    host: str | None = None,
+    log_level: str | None = None,
 ) -> None:
     # if no command is supplied, run with the options passed
 
@@ -112,7 +128,8 @@ def main(
         config_loader.use_values_from_yaml(*config)
     except FileNotFoundError as fnfe:
         raise ClickException(f"Config file not found: {fnfe.filename}") from fnfe
-
+    if host:
+        config_loader.use_values({"api": {"url": host}})
     if log_level:
         config_loader.use_values({"logging": {"level": log_level}})
 

src/blueapi/service/main.py

@@ -621,20 +621,18 @@ async def log_request_details(
 ) -> Response:
     """Middleware to log all request's host, method, path, status and request and
     body"""
+    log = LOGGER.debug if request.url.path == "/healthz" else LOGGER.info
     request_body = await request.body()
     client = request.client or Address("Unknown", -1)
     log_message = f"{client.host}:{client.port} {request.method} {request.url.path}"
     extra = {
         "request_body": request_body,
     }
-    LOGGER.debug(log_message, extra=extra)
+    log(log_message, extra=extra)
 
     response = await call_next(request)
     log_message += f" {response.status_code}"
-    if request.url.path == "/healthz":
-        LOGGER.debug(log_message, extra=extra)
-    else:
-        LOGGER.info(log_message, extra=extra)
+    log(log_message, extra=extra)
 
     return response
 

tests/unit_tests/cli/test_cli.py

@@ -1430,3 +1430,45 @@ def test_log_level_override(flag: str, level: str, runner: CliRunner):
         runner.invoke(main, [flag])
         mock_log.getLogger().setLevel.assert_called_once_with(level)
         mock_log.StreamHandler().setLevel.assert_called_once_with(level)
+
+
+@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

tests/unit_tests/service/test_main.py

@@ -1,5 +1,5 @@
 from unittest import mock
-from unittest.mock import Mock
+from unittest.mock import Mock, call
 
 import pytest
 from fastapi import FastAPI, Request
@@ -29,31 +29,36 @@ async def root():
     assert response.headers["X-BlueAPI-VERSION"] == __version__
 
 
-async def test_log_request_details():
+@pytest.mark.parametrize("path,level", [("/", "info"), ("/healthz", "debug")])
+async def test_log_request_details(path: str, level: str):
     with mock.patch("blueapi.service.main.LOGGER") as logger:
         app = FastAPI()
         app.middleware("http")(log_request_details)
 
-        @app.post("/")
+        @app.post(path)
         async def root():
             return {"message": "Hello World"}
 
         client = TestClient(app)
-        response = client.post("/", content="foo")
+        response = client.post(path, content="foo")
 
         assert response.status_code == 200
-        logger.debug.assert_called_once_with(
-            "testclient:50000 POST /",
-            extra={
-                "request_body": b"foo",
-            },
-        )
-
-        logger.info.assert_called_once_with(
-            "testclient:50000 POST / 200",
-            extra={
-                "request_body": b"foo",
-            },
+        log_level = getattr(logger, level)
+        log_level.assert_has_calls(
+            [
+                call(
+                    f"testclient:50000 POST {path}",
+                    extra={
+                        "request_body": b"foo",
+                    },
+                ),
+                call(
+                    f"testclient:50000 POST {path} 200",
+                    extra={
+                        "request_body": b"foo",
+                    },
+                ),
+            ]
         )