chore: add parallel test execution

- Add pytest-xdist to dev dependencies
- Make server tests use a different port
- Add parallel test execution on the CI
- Update contributing doc

Author: Thibault-Pelletier

.github/workflows/test_and_merge.yml

@@ -70,7 +70,7 @@ jobs:
           pip install .[dev]
           playwright install
           playwright install-deps
-          pytest -s ./tests --cov=trame_slicer --cov-report=json --cov-report=term-missing
+          pytest -s ./tests -n auto --cov=trame_slicer --cov-report=json --cov-report=term-missing
 
       - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v4

CONTRIBUTING.md

@@ -23,7 +23,7 @@ environment :
 1. Install playwright browsers using the `playwright install` command
 1. [Linux] Install playwright dependencies using the `playwright install-deps`
    command
-1. Run the tests using the pytest module `python -m pytest tests`
+1. Run the tests using the pytest module `python -m pytest tests -n auto`
 
 Test coverage is automatically generated and available in the CI / codecov when
 creating pull requests.

pyproject.toml

@@ -57,6 +57,7 @@ dev = [
     "pytest-asyncio",
     "pytest-cov",
     "pytest-playwright",
+    "pytest-xdist",
     "pytest-xprocess",
 ]
 

tests/examples/test_medical_viewer_layout.py

@@ -13,4 +13,4 @@ def test_can_be_displayed(a_server, a_server_port):
             VLabel("Drawer content")
             VSlider()
 
-    a_server.start(a_server_port)
+    a_server.start(port=a_server_port)

tests/test_layout_grid.py

@@ -23,7 +23,7 @@ class EmptyView:
     singleton_tag: str
 
 
-def test_layout_component_can_display_server_configured_templates(a_server):
+def test_layout_component_can_display_server_configured_templates(a_server, a_server_port):
     with ViewLayout(a_server, "red_view"):
         Div(style="background-color: red;", classes="fill-height")
 
@@ -50,10 +50,10 @@ def test_layout_component_can_display_server_configured_templates(a_server):
             )
         )
 
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
-def test_layout_component_is_compatible_with_size(a_server):
+def test_layout_component_is_compatible_with_size(a_server, a_server_port):
     with ViewLayout(a_server, "red_view"):
         Div(style="background-color: red;", classes="fill-height")
 
@@ -86,7 +86,7 @@ def test_layout_component_is_compatible_with_size(a_server):
             )
         )
 
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
 @pytest.fixture

tests/test_view_manager.py

@@ -105,6 +105,7 @@ def test_view_manager_with_default_factories_created_nodes_are_added_to_slicer_s
     a_2d_view,
     a_3d_view,
     a_server,
+    a_server_port,
 ):
     a_view_manager.register_factory(RemoteSliceViewFactory(a_server))
     a_view_manager.register_factory(RemoteThreeDViewFactory(a_server))
@@ -119,22 +120,18 @@ def test_view_manager_with_default_factories_created_nodes_are_added_to_slicer_s
     threed_nodes: vtkCollection = a_slicer_app.scene.GetNodesByClass("vtkMRMLViewNode")
     assert threed_nodes.GetNumberOfItems() == 1
     assert threed_nodes.GetItemAsObject(0) == threed_view.get_view_node()
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
-def test_view_manager_created_views_are_added_to_template(
-    a_view_manager,
-    a_3d_view,
-    a_server,
-):
+def test_view_manager_created_views_are_added_to_template(a_view_manager, a_3d_view, a_server, a_server_port):
     a_view_manager.register_factory(RemoteThreeDViewFactory(a_server))
 
     view = a_view_manager.create_view(a_3d_view)
     view.render_window().Render()
     with VAppLayout(a_server):
         client.ServerTemplate(name=a_3d_view.singleton_tag)
 
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
 def test_a_2d_view_factory_creates_views_with_the_right_properties(
@@ -159,6 +156,7 @@ def test_2d_factory_views_have_sliders_and_reset_camera_connected_to_slicer(
     a_server,
     a_2d_view,
     a_volume_node,
+    a_server_port,
 ):
     factory = RemoteSliceViewFactory(a_server, populate_view_ui_f=create_vertical_slice_view_gutter_ui)
     a_view_manager.register_factory(factory)
@@ -188,21 +186,17 @@ def test_2d_factory_views_have_sliders_and_reset_camera_connected_to_slicer(
     view.set_slice_value(42)
     assert slider_state.data.value == 42.0
 
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
-def test_3d_view_factory_has_reset_camera_button(
-    a_view_manager,
-    a_server,
-    a_3d_view,
-):
+def test_3d_view_factory_has_reset_camera_button(a_view_manager, a_server, a_3d_view, a_server_port):
     factory = RemoteThreeDViewFactory(a_server, populate_view_ui_f=create_vertical_view_gutter_ui)
     a_view_manager.register_factory(factory)
     a_view_manager.create_view(a_3d_view)
     view = factory.get_factory_view(a_3d_view.singleton_tag)
     vuetify_view_str = str(view.vuetify_view)
     assert "VBtn" in vuetify_view_str
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
 @pytest.mark.parametrize(
@@ -275,7 +269,13 @@ def custom_view_layout_configuration() -> dict[str, Layout]:
     }
 
 
-def test_view_manager_is_compatible_with_non_slicer_views(a_view_manager, a_server, a_slicer_app, a_volume_node):
+def test_view_manager_is_compatible_with_non_slicer_views(
+    a_view_manager,
+    a_server,
+    a_slicer_app,
+    a_volume_node,
+    a_server_port,
+):
     # Register view factories
     a_view_manager.register_factory(RemoteSliceViewFactory(a_server))
     a_view_manager.register_factory(RemoteThreeDViewFactory(a_server))
@@ -300,7 +300,7 @@ def test_view_manager_is_compatible_with_non_slicer_views(a_view_manager, a_serv
     display_manager.show_volume(a_volume_node)
 
     # Start server
-    a_server.start()
+    a_server.start(port=a_server_port)
 
 
 def test_get_view_is_compatible_with_view_node_instance(a_view_manager, a_server, a_2d_view):