update cli config and include start command

Author: jsurrea

antares-python/.gitignore

@@ -7,3 +7,4 @@ build/
 .coverage
 .coverage.*
 htmlcov/
+antares.log

antares-python/pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
 dev = ["pytest-asyncio>=0.26.0"]
 
 [project.scripts]
-antares = "antares.cli:app"
+antares-cli = "antares.cli:app"
 
 [build-system]
 requires = ["setuptools>=61.0", "wheel"]
@@ -40,7 +40,6 @@ files = ["src"]
 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]
 where = ["src"]
@@ -50,8 +49,8 @@ lint = "ruff check . --fix"
 format = "ruff format ."
 typecheck = "mypy src/"
 test = "pytest"
-coverage = "pytest --cov=src --cov-report=term-missing"
+coverage = "pytest -ra -q --cov=src --cov-report=term-missing"
 build = "python -m build"
 publish = "twine upload dist/* --repository antares-python"
-check = "task lint && task format && task typecheck && task test"
+check = "task lint && task format && task typecheck && task coverage"
 release = "task check && task build && task publish"

antares-python/src/antares/cli.py

@@ -1,6 +1,9 @@
 import asyncio
 import json
 import logging
+import shutil
+import subprocess
+from pathlib import Path
 from typing import NoReturn
 
 import typer
@@ -12,46 +15,67 @@
 from antares.errors import ConnectionError, SimulationError, SubscriptionError
 from antares.logger import setup_logging
 
-app = typer.Typer(name="antares", help="Antares CLI for ship simulation", no_args_is_help=True)
+app = typer.Typer(name="antares-cli", 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) -> NoReturn:
-    logger = logging.getLogger("antares.cli")
-    if json_output:
-        typer.echo(json.dumps({"error": message}), err=True)
-    else:
-        console.print(f"[error]{message}")
-    logger.error("Exiting with error: %s", message)
-    raise typer.Exit(code)
-
-
-def build_client(config_path: str | None, verbose: bool, json_output: bool) -> AntaresClient:
-    setup_logging(level=logging.DEBUG if verbose else logging.INFO)
-    logger = logging.getLogger("antares.cli")
+@app.command()
+def start(
+    executable: str = typer.Option("antares", help="Path to the Antares executable"),
+    config: str | None = typer.Option(None, help="Path to the TOML 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"),
+) -> None:
+    """
+    Start the Antares simulation engine in the background.
+
+    This command attempts to locate and launch the Antares executable either from the system's PATH
+    or from the provided path using the --executable option. If a config path is provided, it is
+    passed to the executable via --config.
+
+    This command does not use the Python client and directly invokes the native binary.
+    """
+    # Locate executable (either absolute path or in system PATH)
+    path = shutil.which(executable) if not Path(executable).exists() else executable
+    if path is None:
+        msg = f"Executable '{executable}' not found in PATH or at specified location."
+        console.print(f"[error]{msg}")
+        raise typer.Exit(1)
+
+    # Prepare command
+    command = [path]
+    if config:
+        command += ["--config", config]
+
+    if verbose:
+        console.print(f"[info]Starting Antares with command: {command}")
 
     try:
-        settings = load_config(config_path)
-        if verbose:
-            console.print(f"[info]Using settings: {settings.model_dump()}")
-            logger.debug("Loaded settings: %s", settings.model_dump())
-        return AntaresClient(
-            base_url=settings.base_url,
-            tcp_host=settings.tcp_host,
-            tcp_port=settings.tcp_port,
-            timeout=settings.timeout,
-            auth_token=settings.auth_token,
-        )
+        process = subprocess.Popen(command, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
     except Exception as e:
-        handle_error(f"Failed to load configuration: {e}", code=1, json_output=json_output)
+        msg = f"Failed to start Antares: {e}"
+        if json_output:
+            typer.echo(json.dumps({"error": msg}), err=True)
+        else:
+            console.print(f"[error]{msg}")
+        raise typer.Exit(2) from e
+
+    msg = f"Antares started in background with PID {process.pid}"
+    if json_output:
+        typer.echo(json.dumps({"message": msg, "pid": process.pid}))
+    else:
+        console.print(f"[success]{msg}")
 
 
 @app.command()
 def reset(
-    config: str = typer.Option(None),
-    verbose: bool = typer.Option(False, "--verbose", "-v"),
+    config: str = typer.Option(None, help="Path to the TOML 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"),
 ) -> None:
+    """
+    Reset the current simulation state.
+    """
     client = build_client(config, verbose, json_output)
     try:
         client.reset_simulation()
@@ -65,10 +89,13 @@ def reset(
 def add_ship(
     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"),
+    config: str = typer.Option(None, help="Path to the TOML 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"),
 ) -> None:
+    """
+    Add a ship to the simulation with the specified parameters.
+    """
     client = build_client(config, verbose, json_output)
     try:
         ship = ShipConfig(initial_position=(x, y))
@@ -81,11 +108,14 @@ def add_ship(
 
 @app.command()
 def subscribe(
-    config: str = typer.Option(None),
-    verbose: bool = typer.Option(False, "--verbose", "-v"),
+    config: str = typer.Option(None, help="Path to the TOML 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"),
     log_file: str = typer.Option("antares.log", help="Path to log file"),
 ) -> None:
+    """
+    Subscribe to simulation events and print them to the console.
+    """
     setup_logging(log_file=log_file, level=logging.DEBUG if verbose else logging.INFO)
     logger = logging.getLogger("antares.cli")
 
@@ -103,3 +133,36 @@ async def _sub() -> None:
             handle_error(str(e), code=3, json_output=json_output)
 
     asyncio.run(_sub())
+
+
+def handle_error(message: str, code: int, json_output: bool = False) -> NoReturn:
+    """
+    Handle errors by logging and printing them to the console.
+    """
+    logger = logging.getLogger("antares.cli")
+    if json_output:
+        typer.echo(json.dumps({"error": message}), err=True)
+    else:
+        console.print(f"[error]{message}")
+    logger.error("Exiting with error: %s", message)
+    raise typer.Exit(code)
+
+
+def build_client(config_path: str | None, verbose: bool, json_output: bool) -> AntaresClient:
+    """
+    Build the Antares client using the provided configuration file.
+    """
+
+    try:
+        settings = load_config(config_path)
+        if verbose:
+            console.print(f"[info]Using settings: {settings.model_dump()}")
+        return AntaresClient(
+            host=settings.host,
+            http_port=settings.http_port,
+            tcp_port=settings.tcp_port,
+            timeout=settings.timeout,
+            auth_token=settings.auth_token,
+        )
+    except Exception as e:
+        handle_error(f"Failed to load configuration: {e}", code=1, json_output=json_output)

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

@@ -25,12 +25,16 @@ def __init__(
         # Merge provided arguments with environment/.env via AntaresSettings
         self._settings = AntaresSettings(**filtered_kwargs)
 
+        base_url = f"http://{self._settings.host}:{self._settings.http_port}"
         self._rest = RestClient(
-            base_url=self._settings.base_url,
+            base_url=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.host,
+            port=self._settings.tcp_port,
+        )
 
     def reset_simulation(self) -> None:
         """

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

@@ -1,6 +1,6 @@
 import httpx
 
-from antares.errors import ConnectionError, SimulationError
+from antares.errors import ConnectionError, ShipConfigError, SimulationError
 from antares.models.ship import ShipConfig
 
 
@@ -56,4 +56,4 @@ def add_ship(self, ship: ShipConfig) -> None:
         except httpx.RequestError as e:
             raise ConnectionError(f"Could not reach Antares API: {e}") from e
         except httpx.HTTPStatusError as e:
-            raise SimulationError(f"Add ship failed: {e.response.text}") from e
+            raise ShipConfigError(f"Add ship failed: {e.response.text}") from e

antares-python/src/antares/config.py

@@ -7,9 +7,9 @@ class AntaresSettings(BaseSettings):
     Supports environment variables and `.env` file loading.
     """
 
-    base_url: str = "http://localhost:8000"
-    tcp_host: str = "localhost"
-    tcp_port: int = 9000
+    host: str = "localhost"
+    http_port: int = 9000
+    tcp_port: int = 9001
     timeout: float = 5.0
     auth_token: str | None = None
 

antares-python/tests/client/test_rest.py

@@ -2,7 +2,7 @@
 import pytest
 
 from antares.client.rest import RestClient
-from antares.errors import ConnectionError, SimulationError
+from antares.errors import ConnectionError, ShipConfigError, SimulationError
 from antares.models.ship import ShipConfig
 
 
@@ -42,7 +42,7 @@ def test_add_ship_invalid_response(mocker):
     )
     ship = ShipConfig(initial_position=(0, 0))
     client = RestClient(base_url="http://localhost")
-    with pytest.raises(SimulationError):
+    with pytest.raises(ShipConfigError):
         client.add_ship(ship)
 
 

antares-python/tests/test_cli.py

@@ -1,4 +1,5 @@
 import asyncio
+import subprocess
 
 import pytest
 from typer.testing import CliRunner
@@ -14,8 +15,8 @@ def fake_config(tmp_path):
     config_file = tmp_path / "config.toml"
     config_file.write_text("""
 [antares]
-base_url = "http://test.local"
-tcp_host = "127.0.0.1"
+host = "localhost"
+http_port = 9000
 tcp_port = 9001
 timeout = 2.0
 auth_token = "fake-token"
@@ -134,3 +135,69 @@ async def __anext__(self):
 
     assert result.exit_code == 0
     assert '{"event": "test"}' in result.output
+
+
+def test_start_success(mocker):
+    mock_which = mocker.patch("shutil.which", return_value="/usr/local/bin/antares")
+    mock_popen = mocker.patch("subprocess.Popen", return_value=mocker.Mock(pid=1234))
+
+    result = runner.invoke(app, ["start"])
+    assert result.exit_code == 0
+    assert "Antares started in background with PID 1234" in result.output
+    mock_which.assert_called_once()
+    mock_popen.assert_called_once_with(
+        ["/usr/local/bin/antares"], stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL
+    )
+
+
+def test_start_executable_not_found(mocker):
+    mocker.patch("shutil.which", return_value=None)
+
+    result = runner.invoke(app, ["start", "--executable", "fake-antares"])
+    assert result.exit_code == 1
+    assert "Executable 'fake-antares' not found" in result.output
+
+
+def test_start_popen_failure(mocker):
+    mocker.patch("shutil.which", return_value="/usr/bin/antares")
+    mocker.patch("subprocess.Popen", side_effect=OSError("boom"))
+
+    result = runner.invoke(app, ["start"])
+    expected_exit_code = 2
+    assert result.exit_code == expected_exit_code
+    assert "Failed to start Antares" in result.output
+
+
+def test_start_popen_failure_with_json_verbose(mocker):
+    mocker.patch("shutil.which", return_value="/usr/bin/antares")
+    mocker.patch("subprocess.Popen", side_effect=OSError("boom"))
+
+    result = runner.invoke(app, ["start", "--json", "-v"])
+
+    expected_exit_code = 2
+    assert result.exit_code == expected_exit_code
+    assert '{"error":' in result.stdout or result.stderr
+    assert "Failed to start Antares: boom" in result.output
+
+
+def test_start_with_json_output(mocker):
+    mocker.patch("shutil.which", return_value="/usr/bin/antares")
+    mocker.patch("subprocess.Popen", return_value=mocker.Mock(pid=4321))
+
+    result = runner.invoke(app, ["start", "--json"])
+    assert result.exit_code == 0
+    assert '{"message":' in result.output
+    assert '"pid": 4321' in result.output
+
+
+def test_start_with_config(mocker):
+    mocker.patch("shutil.which", return_value="/usr/local/bin/antares")
+    mock_popen = mocker.patch("subprocess.Popen", return_value=mocker.Mock(pid=5678))
+
+    result = runner.invoke(app, ["start", "--config", "config.toml"])
+    assert result.exit_code == 0
+    mock_popen.assert_called_once_with(
+        ["/usr/local/bin/antares", "--config", "config.toml"],
+        stdout=subprocess.DEVNULL,
+        stderr=subprocess.DEVNULL,
+    )