Test data paths were added multiple times to cdl.utils.tests.TST_PATH

Fix #84

Author: PierreRaybaut

.vscode/launch.json

@@ -84,6 +84,9 @@
             ],
             "env": {
                 // "DEBUG": "1",
+                // The `CDL_DATA` environment variable is set here just for checking
+                // that the data path is not added twice to the test data path list:
+                "CDL_DATA": "${workspaceFolder}/cdl/data/tests",
                 "LANG": "en",
                 "QT_COLOR_MODE": "light",
             }

CHANGELOG.md

@@ -2,6 +2,18 @@
 
 See DataLab [roadmap page](https://datalab-platform.com/en/contributing/roadmap.html) for future and past milestones.
 
+## DataLab Version 0.16.3 ##
+
+🛠️ Bug fixes:
+
+* Fixed [Issue #84](https://github.com./DataLab-Platform/DataLab/issues/84) - Build issues with V0.16.1: `signal` name conflict, ...
+  * This issue was intended to be fixed in version 0.16.2, but the fix was not complete
+  * Thanks to [@rolandmas](https://github.com./rolandmas) for reporting the issue and for the help in investigating the problem and testing the fix
+* Fixed [Issue #85](https://github.com./DataLab-Platform/DataLab/issues/85) - Test data paths may be added multiple times to `cdl.utils.tests.TST_PATH`
+  * This issue is related to [Issue #84](https://github.com./DataLab-Platform/DataLab/issues/84)
+  * Adding the test data paths multiple times to `cdl.utils.tests.TST_PATH` was causing the test data to be loaded multiple times, which lead to some tests failing (a simple workaround was added to V0.16.2: this issue is now fixed)
+  * Thanks again to [@rolandmas](https://github.com./rolandmas) for reporting the issue in the context of the Debian packaging
+
 ## DataLab Version 0.16.2 ##
 
 This release requires PlotPy v2.4.0 or later, which brings the following bug fixes and new features:

cdl/__init__.py

@@ -13,7 +13,7 @@
 
 import os
 
-__version__ = "0.16.2"
+__version__ = "0.16.3"
 __docurl__ = __homeurl__ = "https://datalab-platform.com/"
 __supporturl__ = "https://github.com./DataLab-Platform/DataLab/issues/new/choose"
 

cdl/tests/__init__.py

@@ -28,12 +28,6 @@
 from cdl.utils import qthelpers as qth
 from cdl.utils import tests
 
-# Add test data files and folders pointed by `CDL_DATA` environment variable:
-tests.add_test_path_from_env("CDL_DATA")
-
-
-# TODO: [P2] Documentation: add more screenshots from tests
-
 
 @contextmanager
 def cdltest_app_context(

cdl/utils/tests.py

@@ -26,12 +26,33 @@
 TST_PATH = []
 
 
+def add_test_path(path: str) -> None:
+    """Appends test data path, after normalizing it and making it absolute.
+    Do nothing if the path is already in the list.
+
+    Args:
+        Path to add to the list of test data paths
+
+    Raises:
+        FileNotFoundError: if the path does not exist
+    """
+    path = osp.abspath(osp.normpath(path))
+    if path not in TST_PATH:
+        if not osp.exists(path):
+            raise FileNotFoundError(f"Test data path does not exist: {path}")
+        TST_PATH.append(path)
+
+
 def add_test_path_from_env(envvar: str) -> None:
     """Appends test data path from environment variable (fails silently)"""
     # Note: this function is used in third-party plugins
     path = os.environ.get(envvar)
     if path:
-        TST_PATH.append(path)
+        add_test_path(path)
+
+
+# Add test data files and folders pointed by `CDL_DATA` environment variable:
+add_test_path_from_env("CDL_DATA")
 
 
 def add_test_module_path(modname: str, relpath: str) -> None:
@@ -43,9 +64,10 @@ def add_test_module_path(modname: str, relpath: str) -> None:
     modname must be the name of an already imported module as found in
     sys.modules
     """
-    TST_PATH.append(get_module_data_path(modname, relpath=relpath))
+    add_test_path(get_module_data_path(modname, relpath=relpath))
 
 
+# Add test data files and folders for the DataLab module:
 add_test_module_path(MOD_NAME, osp.join("data", "tests"))