Add GUI utilities for test management and enhance I/O tests

(cherry picked from commit cf92d1da445fe7db1ee3a78131c05daffc29c935)

Author: PierreRaybaut

cdl/tests/sigima_tests/common/io1_unit_test.py

@@ -16,7 +16,7 @@
 from sigima_.io import read_images, read_signals
 from sigima_.io.image import funcs as image_funcs
 from sigima_.obj import ImageObj, SignalObj
-from sigima_.tests import helpers
+from sigima_.tests import guiutils, helpers
 
 
 def __read_objs(fname: str) -> list[ImageObj] | list[SignalObj]:
@@ -32,70 +32,66 @@ def __read_objs(fname: str) -> list[ImageObj] | list[SignalObj]:
 
 
 @helpers.try_open_test_data("Testing TXT file reader", "*.txt")
-def open_txt(fname: str | None = None, request: pytest.FixtureRequest = None) -> None:
+def open_txt(fname: str | None = None) -> None:
     """Testing TXT files"""
     objs = __read_objs(fname)
     for obj in objs:
         execenv.print(obj)
-    if request is not None and request.config.getoption("--gui"):
+    if guiutils.is_gui_enabled():
         from sigima_.tests import vistools  # pylint: disable=import-outside-toplevel
 
-        vistools.view_curves_and_images(objs)
+        vistools.view_curves_and_images(objs, title="TXT file")
 
 
 @helpers.try_open_test_data("Testing CSV file reader", "*.csv")
-def open_csv(fname: str | None = None, request: pytest.FixtureRequest = None) -> None:
+def open_csv(fname: str | None = None) -> None:
     """Testing CSV files"""
     objs = __read_objs(fname)
     for obj in objs:
         execenv.print(obj)
-    if request is not None and request.config.getoption("--gui"):
+    if guiutils.is_gui_enabled():
         from sigima_.tests import vistools  # pylint: disable=import-outside-toplevel
 
-        vistools.view_curves_and_images(objs)
+        vistools.view_curves_and_images(objs, title="CSV file")
 
 
 @helpers.try_open_test_data("Testing MAT-File reader", "*.mat")
-def open_mat(fname: str | None = None, request: pytest.FixtureRequest = None) -> None:
+def open_mat(fname: str | None = None) -> None:
     """Testing MAT files"""
     objs = __read_objs(fname)
     for obj in objs:
         execenv.print(obj)
-    if request is not None and request.config.getoption("--gui"):
+    if guiutils.is_gui_enabled():
         from sigima_.tests import vistools  # pylint: disable=import-outside-toplevel
 
-        if isinstance(objs[0], SignalObj):
-            vistools.view_curves(objs)
-        else:
-            vistools.view_images(objs)
+        vistools.view_curves_and_images(objs, title="MAT file")
 
 
 @helpers.try_open_test_data("Testing SIF file handler", "*.sif")
-def open_sif(fname: str | None = None, request: pytest.FixtureRequest = None) -> None:
+def open_sif(fname: str | None = None) -> None:
     """Testing SIF files"""
     execenv.print(image_funcs.SIFFile(fname))
     datalist = image_funcs.imread_sif(fname)
-    if request is not None and request.config.getoption("--gui"):
+    if guiutils.is_gui_enabled():
         from sigima_.tests import vistools  # pylint: disable=import-outside-toplevel
 
         vistools.view_images(datalist)
 
 
 @helpers.try_open_test_data("Testing SCOR-DATA file handler", "*.scor-data")
-def open_scordata(
-    fname: str | None = None, request: pytest.FixtureRequest = None
-) -> None:
+def open_scordata(fname: str | None = None) -> None:
     """Testing SCOR-DATA files"""
     execenv.print(image_funcs.SCORFile(fname))
     data = image_funcs.imread_scor(fname)
-    if request is not None and request.config.getoption("--gui"):
+    if guiutils.is_gui_enabled():
         from sigima_.tests import vistools  # pylint: disable=import-outside-toplevel
 
-        vistools.view_images(data)
+        vistools.view_images(data, title="SCOR-DATA file")
 
 
-def test_io1() -> None:
+def test_io1(request: pytest.FixtureRequest | None = None) -> None:
     """I/O test"""
+    guiutils.set_current_request(request)
     with qt_app_context():
         open_txt()
         open_csv()
@@ -105,4 +101,4 @@ def test_io1() -> None:
 
 
 if __name__ == "__main__":
-    test_io1()
+    test_io1(request=guiutils.DummyRequest(gui=True))

cdl/tests/sigima_tests/common/io3_unit_test.py

@@ -46,7 +46,6 @@ def read_data(filename: str) -> np.ndarray:
                 np.ndarray: image data
             """
             # Implement reading logic here
-            pass
 
     return MyImageFormat
 
@@ -62,8 +61,7 @@ def test_add_image_format() -> None:
     execenv.print("OK")
     execenv.print(f"New number of image formats:      {n2}")
     assert (
-        sum([isinstance(fmt, image_class) for fmt in ImageIORegistry.get_formats()])
-        == 1
+        sum(isinstance(fmt, image_class) for fmt in ImageIORegistry.get_formats()) == 1
     )
     finfo = image_class.FORMAT_INFO
     finfo_str = "\n".join([(" " * 4) + line for line in str(finfo).splitlines()])
@@ -88,7 +86,6 @@ class MySignalFormat(SignalFormatBase):
             writeable=False,
         )
 
-        @staticmethod
         def read_xydata(self, filename: str) -> np.ndarray:
             """Read data and metadata from file, write metadata to object, return xydata
 
@@ -99,7 +96,7 @@ def read_xydata(self, filename: str) -> np.ndarray:
                 NumPy array xydata
             """
             # Implement reading logic here
-            pass
+            print(f"Reading data from {filename}")
 
     return MySignalFormat
 
@@ -115,7 +112,7 @@ def test_add_signal_format() -> None:
     execenv.print("OK")
     execenv.print(f"New number of signal formats:      {n2}")
     assert (
-        sum([isinstance(fmt, signal_class) for fmt in SignalIORegistry.get_formats()])
+        sum(isinstance(fmt, signal_class) for fmt in SignalIORegistry.get_formats())
         == 1
     )
     finfo = signal_class.FORMAT_INFO

cdl/tests/sigima_tests/images/operation_unit_test.py

@@ -24,6 +24,7 @@
 import sigima_.obj
 import sigima_.param
 from sigima_.env import execenv
+from sigima_.tests import guiutils
 from sigima_.tests.data import create_noisygauss_image
 from sigima_.tests.helpers import check_array_result
 
@@ -154,6 +155,7 @@ def test_image_product() -> None:
 @pytest.mark.validation
 def test_image_division(request: pytest.FixtureRequest = None) -> None:
     """Image division test."""
+    guiutils.set_current_request(request)
     execenv.print("*** Testing image division:")
     for ima1, ima2 in __iterate_image_couples():
         ima2.data = np.ones_like(ima2.data)
@@ -162,7 +164,7 @@ def test_image_division(request: pytest.FixtureRequest = None) -> None:
         exp = ima1.data.astype(float) / ima2.data.astype(float)
         ima3 = sigima_image.division(ima1, ima2)
         if not np.allclose(ima3.data, exp):
-            if request.config.getoption("--gui"):
+            if guiutils.is_gui_enabled():
                 # pylint: disable=import-outside-toplevel
                 from guidata.qthelpers import qt_app_context
 
@@ -459,7 +461,7 @@ def test_image_rotate() -> None:
     test_image_addition()
     test_image_average()
     test_image_product()
-    test_image_division()
+    test_image_division(request=guiutils.DummyRequest(gui=True))
     test_image_difference()
     test_image_quadratic_difference()
     test_image_addition_constant()

sigima_/io/image/formats.py

@@ -313,10 +313,10 @@ def read_data(filename: str) -> np.ndarray:
 
 
 class XYZImageFormat(ImageFormatBase):
-    """Object representing Dürr NDT XYZ image file type"""
+    """Object representing Dürr NDT XYZ image file type"""
 
     FORMAT_INFO = FormatInfo(
-        name="Dürr NDT",
+        name="Dürr NDT",
         extensions="*.xyz",
         readable=True,
         writeable=False,

sigima_/tests/guiutils.py

@@ -0,0 +1,39 @@
+# Copyright (c) DataLab Platform Developers, BSD 3-Clause license, see LICENSE file.
+
+"""
+Utilities to manage GUI activation for tests executed with pytest
+or as standalone scripts.
+"""
+
+import types
+
+import pytest
+
+CURRENT_REQUEST: pytest.FixtureRequest | None = None
+
+
+def set_current_request(request: pytest.FixtureRequest | None) -> None:
+    """Store the current pytest request object (for use in is_gui_enabled)"""
+    global CURRENT_REQUEST  # pylint: disable=global-statement
+    CURRENT_REQUEST = request
+
+
+def is_gui_enabled() -> bool:
+    """
+    Return True if GUI mode is enabled (i.e. pytest was run with --gui),
+    or if a DummyRequest with --gui was set (for __main__ execution).
+    """
+    return bool(CURRENT_REQUEST and CURRENT_REQUEST.config.getoption("--gui"))
+
+
+class DummyRequest:
+    """
+    Dummy request object to simulate pytest --gui when running a test manually.
+
+    Example usage:
+        test_x(request=DummyRequest(gui=True))
+    """
+
+    def __init__(self, gui: bool = True):
+        self.config = types.SimpleNamespace()
+        self.config.getoption = lambda name: gui if name == "--gui" else None