improve tests coverage

Author: jsurrea

antares-python/antares.log

@@ -9,12 +9,16 @@ readme = "README.md"
 requires-python = ">=3.13"
 dependencies = [
     "pydantic>=2.11.3",
+    "pydantic-settings>=2.8.1",
     "httpx>=0.28.1",
     "typer>=0.15.2",
     "rich>=13.0",
     "tomli>=2.2.1",
 ]
 
+[project.optional-dependencies]
+dev = ["pytest-asyncio>=0.26.0"]
+
 [project.scripts]
 antares = "antares.cli:app"
 
@@ -34,6 +38,8 @@ files = ["src"]
 
 [tool.pytest.ini_options]
 pythonpath = "src"
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
 addopts = "-ra -q -ra -q --cov=src --cov-report=term-missing"
 
 [tool.setuptools.packages.find]
@@ -47,5 +53,5 @@ test = "pytest"
 coverage = "pytest --cov=src --cov-report=term-missing"
 build = "python -m build"
 publish = "twine upload dist/* --repository antares-python"
-check = "task lint && task typecheck && task test"
+check = "task lint && task format && task typecheck && task test"
 release = "task check && task build && task publish"

antares-python/pyproject.toml

@@ -1,26 +1,18 @@
-import sys
 import asyncio
 import json
-import typer
 import logging
+
+import typer
 from rich.console import Console
 from rich.theme import Theme
 
-from antares import ShipConfig, AntaresClient
+from antares import AntaresClient, ShipConfig
 from antares.config_loader import load_config
-from antares.errors import (
-    ConnectionError,
-    SimulationError,
-    SubscriptionError
-)
+from antares.errors import ConnectionError, SimulationError, SubscriptionError
 from antares.logger import setup_logging
 
-app = typer.Typer(name="antares", help="Antares CLI for ship simulation")
-console = Console(theme=Theme({
-    "info": "green",
-    "warn": "yellow",
-    "error": "bold red"
-}))
+app = typer.Typer(name="antares", help="Antares CLI for ship simulation", no_args_is_help=True)
+console = Console(theme=Theme({"info": "green", "warn": "yellow", "error": "bold red"}))
 
 
 def handle_error(message: str, code: int, json_output: bool = False):
@@ -57,7 +49,7 @@ def build_client(config_path: str | None, verbose: bool, json_output: bool) -> A
 def reset(
     config: str = typer.Option(None),
     verbose: bool = typer.Option(False, "--verbose", "-v"),
-    json_output: bool = typer.Option(False, "--json", help="Output in JSON format")
+    json_output: bool = typer.Option(False, "--json", help="Output in JSON format"),
 ):
     client = build_client(config, verbose, json_output)
     try:
@@ -70,11 +62,11 @@ def reset(
 
 @app.command()
 def add_ship(
-    x: float,
-    y: float,
-    config: str = typer.Option(None),
-    verbose: bool = typer.Option(False, "--verbose", "-v"),
-    json_output: bool = typer.Option(False, "--json", help="Output in JSON format")
+    x: float = typer.Option(..., help="X coordinate of the ship"),
+    y: float = typer.Option(..., help="Y coordinate of the ship"),
+    config: str = typer.Option(None, help="Path to the configuration file"),
+    verbose: bool = typer.Option(False, "--verbose", "-v", help="Enable verbose output"),
+    json_output: bool = typer.Option(False, "--json", help="Output in JSON format"),
 ):
     client = build_client(config, verbose, json_output)
     try:
@@ -91,7 +83,7 @@ def subscribe(
     config: str = typer.Option(None),
     verbose: bool = typer.Option(False, "--verbose", "-v"),
     json_output: bool = typer.Option(False, "--json", help="Output in JSON format"),
-    log_file: str = typer.Option("antares.log", help="Path to log file")
+    log_file: str = typer.Option("antares.log", help="Path to log file"),
 ):
     setup_logging(log_file=log_file, level=logging.DEBUG if verbose else logging.INFO)
     logger = logging.getLogger("antares.cli")

antares-python/src/antares/cli.py

@@ -20,23 +20,24 @@ def __init__(
         Accepts config overrides directly or falls back to environment-based configuration.
         """
 
+        overrides = {
+            "base_url": base_url,
+            "tcp_host": tcp_host,
+            "tcp_port": tcp_port,
+            "timeout": timeout,
+            "auth_token": auth_token,
+        }
+        clean_overrides = {k: v for k, v in overrides.items() if v is not None}
+
         # Merge provided arguments with environment/.env via AntaresSettings
-        self._settings = AntaresSettings(
-            base_url=base_url,
-            tcp_host=tcp_host,
-            tcp_port=tcp_port,
-            timeout=timeout,
-            auth_token=auth_token,
-        )
+        self._settings = AntaresSettings(**clean_overrides)
 
         self._rest = RestClient(
             base_url=self._settings.base_url,
             timeout=self._settings.timeout,
             auth_token=self._settings.auth_token,
         )
-        self._tcp = TCPSubscriber(
-            host=self._settings.tcp_host, port=self._settings.tcp_port
-        )
+        self._tcp = TCPSubscriber(host=self._settings.tcp_host, port=self._settings.tcp_port)
 
     def reset_simulation(self) -> None:
         """

antares-python/src/antares/client/__init__.py

@@ -9,9 +9,7 @@ class RestClient:
     Internal client for interacting with the Antares simulation REST API.
     """
 
-    def __init__(
-        self, base_url: str, timeout: float = 5.0, auth_token: str | None = None
-    ) -> None:
+    def __init__(self, base_url: str, timeout: float = 5.0, auth_token: str | None = None) -> None:
         """
         Initializes the REST client.
 

antares-python/src/antares/client/rest.py

@@ -1,4 +1,4 @@
-from pydantic import BaseSettings, Field
+from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
 class AntaresSettings(BaseSettings):
@@ -7,12 +7,14 @@ class AntaresSettings(BaseSettings):
     Supports environment variables and `.env` file loading.
     """
 
-    base_url: str = Field(..., env="ANTARES_BASE_URL")
-    tcp_host: str = Field("localhost", env="ANTARES_TCP_HOST")
-    tcp_port: int = Field(9000, env="ANTARES_TCP_PORT")
-    timeout: float = Field(5.0, env="ANTARES_TIMEOUT")
-    auth_token: str | None = Field(None, env="ANTARES_AUTH_TOKEN")
+    base_url: str
+    tcp_host: str = "localhost"
+    tcp_port: int = 9000
+    timeout: float = 5.0
+    auth_token: str | None = None
 
-    class Config:
-        env_file = ".env"
-        case_sensitive = False
+    model_config = SettingsConfigDict(
+        env_file=".env",
+        env_prefix="ANTARES_",
+        case_sensitive=False,
+    )

antares-python/src/antares/config.py

@@ -1,7 +1,9 @@
 import logging
 from pathlib import Path
+
 from rich.logging import RichHandler
 
+
 def setup_logging(log_file: str = "antares.log", level: int = logging.INFO) -> None:
     """Configure logging to both rich console and a file."""
     Path(log_file).parent.mkdir(parents=True, exist_ok=True)
@@ -12,6 +14,6 @@ def setup_logging(log_file: str = "antares.log", level: int = logging.INFO) -> N
         datefmt="[%Y-%m-%d %H:%M:%S]",
         handlers=[
             RichHandler(rich_tracebacks=True, show_path=False),
-            logging.FileHandler(log_file, encoding="utf-8")
-        ]
+            logging.FileHandler(log_file, encoding="utf-8"),
+        ],
     )

antares-python/src/antares/logger.py

@@ -21,7 +21,7 @@ def test_add_ship_delegates(mocker):
 
 @pytest.mark.asyncio
 async def test_subscribe_delegates(monkeypatch):
-    async def fake_subscribe():
+    async def fake_subscribe(_self):
         yield {"event": "test"}
 
     monkeypatch.setattr("antares.client.tcp.TCPSubscriber.subscribe", fake_subscribe)

antares-python/tests/client/test_client.py

@@ -7,7 +7,8 @@
 
 
 def test_reset_simulation_success(mocker):
-    mock_post = mocker.patch("httpx.post", return_value=httpx.Response(200))
+    mock_request = httpx.Request("POST", "http://localhost/simulation/reset")
+    mock_post = mocker.patch("httpx.post", return_value=httpx.Response(200, request=mock_request))
     client = RestClient(base_url="http://localhost")
     client.reset_simulation()
     mock_post.assert_called_once()
@@ -21,15 +22,24 @@ def test_reset_simulation_failure(mocker):
 
 
 def test_add_ship_success(mocker):
-    mock_post = mocker.patch("httpx.post", return_value=httpx.Response(200))
+    mock_request = httpx.Request("POST", "http://localhost/simulation/ships")
+    mock_post = mocker.patch("httpx.post", return_value=httpx.Response(200, request=mock_request))
     ship = ShipConfig(initial_position=(0, 0))
     client = RestClient(base_url="http://localhost")
     client.add_ship(ship)
     mock_post.assert_called_once()
 
 
 def test_add_ship_invalid_response(mocker):
-    mocker.patch("httpx.post", return_value=httpx.Response(400, content=b"bad request"))
+    mock_request = httpx.Request("POST", "http://localhost/simulation/ships")
+    mocker.patch(
+        "httpx.post",
+        return_value=httpx.Response(
+            400,
+            content=b"bad request",
+            request=mock_request,
+        ),
+    )
     ship = ShipConfig(initial_position=(0, 0))
     client = RestClient(base_url="http://localhost")
     with pytest.raises(SimulationError):

antares-python/tests/client/test_rest.py

@@ -8,26 +8,31 @@
 
 @pytest.mark.asyncio
 async def test_subscribe_success(monkeypatch):
+    # Simulated lines returned from the TCP stream
+    lines = [b'{"event": "ok"}\n', b'{"event": "done"}\n', b""]
+
+    async def fake_readline():
+        return lines.pop(0)
+
+    # Simulate EOF after all lines are read
+    eof_flags = [False, False, True]
+
     fake_reader = AsyncMock()
-    fake_reader.readline = AsyncMock(
-        side_effect=[b'{"event": "ok"}\n', b'{"event": "done"}\n', b""]
-    )
-    fake_reader.at_eof = MagicMock(return_value=False)
+    fake_reader.readline = AsyncMock(side_effect=fake_readline)
+    fake_reader.at_eof = MagicMock(side_effect=eof_flags)
 
-    monkeypatch.setattr(
-        "asyncio.open_connection", AsyncMock(return_value=(fake_reader, None))
-    )
+    # Patch asyncio.open_connection to return our mocked reader
+    monkeypatch.setattr("asyncio.open_connection", AsyncMock(return_value=(fake_reader, None)))
 
     subscriber = TCPSubscriber("localhost", 1234, reconnect=False)
+
     events = [event async for event in subscriber.subscribe()]
     assert events == [{"event": "ok"}, {"event": "done"}]
 
 
 @pytest.mark.asyncio
 async def test_subscribe_failure(monkeypatch):
-    monkeypatch.setattr(
-        "asyncio.open_connection", AsyncMock(side_effect=ConnectionRefusedError())
-    )
+    monkeypatch.setattr("asyncio.open_connection", AsyncMock(side_effect=ConnectionRefusedError()))
 
     subscriber = TCPSubscriber("localhost", 1234, reconnect=False)
     with pytest.raises(SubscriptionError):