Merge pull request #470 from simvue-io/hotfix/fix-wrong-windows-warning

Fix incorrect warning for Windows users

Author: kzscisoft

.github/workflows/test_client_windows.yml

@@ -27,4 +27,4 @@ jobs:
         export SIMVUE_TOKEN=${{ secrets.SIMVUE_TOKEN }}
         poetry install --all-extras
         poetry run python -m pip install torch
-        poetry run pytest tests/unit/ tests/refactor/ -m 'not scenario'
+        poetry run pytest tests/unit/ tests/refactor/ -m 'not scenario' -m 'not unix'

simvue/executor.py

@@ -196,9 +196,9 @@ def callback_function(status_code: int, std_out: str, std_err: str) -> None:
         if not self._runner.name:
             raise RuntimeError("Cannot add process, expected Run instance to have name")
 
-        if sys.platform == "win32" and completion_callback:
+        if sys.platform == "win32" and completion_trigger:
             logger.warning(
-                "Completion callback for 'add_process' may fail on Windows due to "
+                "Completion trigger for 'add_process' may fail on Windows "
                 "due to function pickling restrictions"
             )
 

simvue/run.py

@@ -720,7 +720,7 @@ def callback_function(status_code: int, std_out: str, std_err: str) -> None:
         """
         if platform.system() == "Windows" and completion_trigger:
             raise RuntimeError(
-                "Use of 'completion_callback' on Windows based operating systems is unsupported "
+                "Use of 'completion_trigger' on Windows based operating systems is unsupported "
                 "due to function pickling restrictions for multiprocessing"
             )
 

tests/refactor/test_executor.py

@@ -17,9 +17,12 @@ def test_executor_add_process(
     request: pytest.FixtureRequest
 ) -> None:
     import logging
+    trigger = multiprocessing.Event()
+
+    def completion_callback(*_, trigger=trigger, **__):
+        trigger.set()
     logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
     run = simvue.Run()
-    completion_trigger = multiprocessing.Event()
     run.init(
         f"test_executor_{'success' if successful else 'fail'}",
         tags=["simvue_client_unit_tests", request.node.name.replace("[", "_").replace("]", "_")],
@@ -29,10 +32,10 @@ def test_executor_add_process(
         identifier=f"test_add_process_{'success' if successful else 'fail'}",
         c=f"exit {0 if successful else 1}",
         executable="bash" if sys.platform != "win32" else "powershell",
-        completion_trigger=completion_trigger
+        completion_callback=completion_callback
     )
 
-    while not completion_trigger.is_set():
+    while not trigger.is_set():
         time.sleep(1)
 
     if successful:
@@ -43,6 +46,7 @@ def test_executor_add_process(
 
 
 @pytest.mark.executor
+@pytest.mark.unix
 def test_executor_multiprocess(request: pytest.FixtureRequest) -> None:
     triggers: dict[int, multiprocessing.synchronize.Event] = {}
     callbacks: dict[int, typing.Callable] = {}
@@ -149,6 +153,7 @@ def completion_callback(*_, success: dict[str, bool]=success, **__):
     assert success["complete"]
 
 @pytest.mark.executor
+@pytest.mark.unix
 def test_completion_trigger_set(request: pytest.FixtureRequest) -> None:
     trigger = multiprocessing.Event()