More launcher tests

Author: marcelldls

src/fastcs/main.py

@@ -111,14 +111,14 @@ def _launch(controller_class: type[Controller]) -> typer.Typer:
 
     launch_typer = typer.Typer()
 
-    class _LaunchContext:
+    class LaunchContext:
         def __init__(self, controller_class, fastcs_options):
             self.controller_class = controller_class
             self.fastcs_options = fastcs_options
 
     @launch_typer.callback()
     def create_context(ctx: typer.Context):
-        ctx.obj = _LaunchContext(
+        ctx.obj = LaunchContext(
             controller_class,
             fastcs_options,
         )
@@ -158,9 +158,9 @@ def run(
             instance_options.transport,
         )
 
-        if hasattr(instance_options.transport, "gui"):
+        if "gui" in options_yaml["transport"]:
             instance.create_gui()
-        if hasattr(instance_options.transport, "docs"):
+        if "docs" in options_yaml["transport"]:
             instance.create_docs()
         instance.run()
 

tests/conftest.py

@@ -15,6 +15,14 @@
 from fastcs.mapping import Mapping
 from fastcs.wrappers import command, scan
 
+DATA_PATH = Path(__file__).parent / "data"
+
+
+@pytest.fixture
+def data() -> Path:
+    return DATA_PATH
+
+
 # Prevent pytest from catching exceptions when debugging in vscode so that break on
 # exception works correctly (see: https://github.com/pytest-dev/pytest/issues/7409)
 if os.getenv("PYTEST_RAISE", "0") == "1":

tests/data/config_full.yaml

@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=schema.json
+transport:
+  ioc: {}
+  docs: {}
+  gui: {}
+controller:
+  name: controller-name

tests/data/config_minimal.yaml

@@ -0,0 +1,3 @@
+# yaml-language-server: $schema=schema.json
+transport:
+  dsr: {}

tests/test_main.py

@@ -3,6 +3,7 @@
 
 import pytest
 from pydantic import create_model
+from pytest_mock import MockerFixture
 from typer.testing import CliRunner
 
 from fastcs.controller import Controller
@@ -40,7 +41,23 @@ def __init__(self, arg: SomeConfig, too_many):
 runner = CliRunner()
 
 
-def test_is_hinted_schema():
+def test_single_arg_schema():
+    target_model = create_model(
+        "SingleArg",
+        transport=(EpicsOptions | TangoOptions, ...),
+        __config__={"extra": "forbid"},
+    )
+    target_dict = target_model.model_json_schema()
+
+    app = _launch(SingleArg)
+    result = runner.invoke(app, ["schema"])
+    assert result.exit_code == 0
+    result_dict = json.loads(result.stdout)
+
+    assert result_dict == target_dict
+
+
+def test_is_hinted_schema(data):
     target_model = create_model(
         "IsHinted",
         controller=(SomeConfig, ...),
@@ -56,6 +73,10 @@ def test_is_hinted_schema():
 
     assert result_dict == target_dict
 
+    # # store a schema to use for debugging
+    # with open(data / "schema.json", mode="w") as f:
+    #     json.dump(result_dict, f, indent=2)
+
 
 def test_not_hinted_schema():
     error = (
@@ -78,3 +99,31 @@ def test_over_defined_schema():
     with pytest.raises(LaunchError) as exc_info:
         launch(ManyArgs)
     assert str(exc_info.value) == error
+
+
+def test_launch_minimal(mocker: MockerFixture, data):
+    run = mocker.patch("fastcs.main.FastCS.run")
+    gui = mocker.patch("fastcs.main.FastCS.create_gui")
+    docs = mocker.patch("fastcs.main.FastCS.create_docs")
+
+    app = _launch(SingleArg)
+    result = runner.invoke(app, ["run", str(data / "config_minimal.yaml")])
+    assert result.exit_code == 0
+
+    run.assert_called_once()
+    gui.assert_not_called()
+    docs.assert_not_called()
+
+
+def test_launch_full(mocker: MockerFixture, data):
+    run = mocker.patch("fastcs.main.FastCS.run")
+    gui = mocker.patch("fastcs.main.FastCS.create_gui")
+    docs = mocker.patch("fastcs.main.FastCS.create_docs")
+
+    app = _launch(IsHinted)
+    result = runner.invoke(app, ["run", str(data / "config_full.yaml")])
+    assert result.exit_code == 0
+
+    run.assert_called_once()
+    gui.assert_called_once()
+    docs.assert_called_once()