tests: headless pyorerun for no viz on CI.

Author: Ipuch

.github/workflows/run_tests.yml

@@ -39,6 +39,8 @@ jobs:
 
       - name: Run the actual tests
         run: pytest -v --color=yes --cov-report term-missing --cov=pyorerun tests
+        env:
+          PYORERUN_HEADLESS: "1"
 
       - name: Upload coverage to Codecov
         run: codecov

pyorerun/multi_frame_rate_phase_rerun.py

@@ -1,3 +1,5 @@
+import os
+
 import numpy as np
 import rerun as rr
 
@@ -81,7 +83,8 @@ def rerun_by_frame(
             return
 
         if init:
-            rr.init(f"{name}_{0}", spawn=True if not notebook else False)
+            spawn = not notebook and os.environ.get("PYORERUN_HEADLESS", "0").lower() not in ("1", "true", "yes")
+            rr.init(f"{name}_{0}", spawn=spawn)
 
         for phase_rerun in self.phase_reruns:
             frame = 0
@@ -115,7 +118,8 @@ def rerun(
             return
 
         if init:
-            rr.init(f"{name}_{0}", spawn=True if not notebook else False)
+            spawn = not notebook and os.environ.get("PYORERUN_HEADLESS", "0").lower() not in ("1", "true", "yes")
+            rr.init(f"{name}_{0}", spawn=spawn)
 
         for phase_rerun in self.phase_reruns:
             frame = 0

pyorerun/multi_phase_rerun.py

@@ -1,3 +1,5 @@
+import os
+
 import numpy as np
 import rerun as rr  # NOTE: `rerun`, not `rerun-sdk`!
 import rerun.blueprint as rrb
@@ -82,7 +84,8 @@ def all_windows(self) -> list[str]:
         return [windows for phase in self.rerun_biorbd_phases for windows in phase.keys()]
 
     def rerun_by_frame(self, server_name: str = "multi_phase_animation", notebook=False) -> None:
-        rr.init(server_name, spawn=True if not notebook else False)
+        spawn = not notebook and os.environ.get("PYORERUN_HEADLESS", "0").lower() not in ("1", "true", "yes")
+        rr.init(server_name, spawn=spawn)
         for i, phase in enumerate(self.rerun_biorbd_phases):
             for j, (window, rr_phase) in enumerate(phase.items()):
 
@@ -95,7 +98,8 @@ def rerun_by_frame(self, server_name: str = "multi_phase_animation", notebook=Fa
                 rr_phase.rerun_by_frame(init=False, clear_last_node=more_phases_after_this_one)
 
     def rerun(self, server_name: str = "multi_phase_animation", notebook=False) -> None:
-        rr.init(server_name, spawn=True if not notebook else False)
+        spawn = not notebook and os.environ.get("PYORERUN_HEADLESS", "0").lower() not in ("1", "true", "yes")
+        rr.init(server_name, spawn=spawn)
         for i, phase in enumerate(self.rerun_biorbd_phases):
             for j, (window, rr_phase) in enumerate(phase.items()):
 

pyorerun/phase_rerun.py

@@ -1,3 +1,5 @@
+import os
+
 import numpy as np
 import rerun as rr
 import rerun.blueprint as rrb
@@ -239,8 +241,9 @@ def rerun_by_frame(
         self, name: str = "animation_phase", init: bool = True, clear_last_node: bool = False, notebook: bool = False
     ) -> None:
         if init:
-            rr.init(f"{name}_{self.phase}", spawn=True if not notebook else False)
-            rr.init(f"{name}_{self.phase}", spawn=True if not notebook else False)
+            spawn = not notebook and os.environ.get("PYORERUN_HEADLESS", "0").lower() not in ("1", "true", "yes")
+            rr.init(f"{name}_{self.phase}", spawn=spawn)
+            rr.init(f"{name}_{self.phase}", spawn=spawn)
             rr.log("/", rr.ViewCoordinates.RIGHT_HAND_Y_UP, static=True)
             rr.send_blueprint(
                 rrb.Blueprint(
@@ -275,7 +278,8 @@ def rerun(
         self, name: str = "animation_phase", init: bool = True, clear_last_node: bool = False, notebook: bool = False
     ) -> None:
         if init:
-            rr.init(f"{name}_{self.phase}", spawn=True if not notebook else False)
+            spawn = not notebook and os.environ.get("PYORERUN_HEADLESS", "0").lower() not in ("1", "true", "yes")
+            rr.init(f"{name}_{self.phase}", spawn=spawn)
             rr.log("/", rr.ViewCoordinates.RIGHT_HAND_Y_UP, static=True)
             rr.send_blueprint(
                 rrb.Blueprint(