Set tests to use corresponding operating system path

Author: jaime-cespedes-sisniega

frouros/tests/integration/test_real.py

@@ -23,12 +23,14 @@ def test_elec2_file_not_found_error(elec2_raw: Elec2) -> None:
         _ = elec2_raw.load()
 
 
-# FIXME: PermissionError not raised on Windows or MacOS.
+# FIXME: PermissionError not raised on Windows and MacOS.
 @pytest.mark.skipif(
-    sys.platform.startswith("win"), reason="PermissionError not raised on Windows.",
+    sys.platform.startswith("win"),
+    reason="PermissionError not raised on Windows.",
 )
 @pytest.mark.skipif(
-    sys.platform.startswith("darwin"), reason="PermissionError not raised on MacOS.",
+    sys.platform.startswith("darwin"),
+    reason="PermissionError not raised on MacOS.",
 )
 def test_elec2_permission_error() -> None:
     """Test Elec2 permission error."""

frouros/tests/unit/utils/test_persistence.py

@@ -10,10 +10,11 @@
 from frouros.detectors.concept_drift import DDM, DDMConfig
 from frouros.detectors.data_drift import MMD  # type: ignore
 from frouros.utils import load, save
+from frouros.utils.decorators import set_os_filename
 
 
 @pytest.fixture(
-    scope="module",
+    scope="session",
     params=[
         DDM(
             config=DDMConfig(),
@@ -35,7 +36,7 @@ def detector(
 
 
 @pytest.fixture(
-    scope="module",
+    scope="session",
     params=[
         HistoryConceptDrift(),
         PermutationTestDistanceBased(
@@ -56,65 +57,97 @@ def callback(
     return request.param
 
 
+@set_os_filename("detector.pkl")
 def test_save_load_with_valid_detector(
+    request: pytest.FixtureRequest,
     detector: BaseDetector,
 ) -> None:
     """Test save and load with valid detector.
 
+    :param request: Request
+    :type request: pytest.FixtureRequest
     :param detector: Detector
     :type detector: BaseDetector
     """
-    filename = "/tmp/detector.pkl"
-    save(detector, filename)
-    loaded_detector = load(filename)
+    filename = request.node.get_closest_marker("filename").args[0]
+    save(
+        obj=detector,
+        filename=filename,
+    )
+    loaded_detector = load(
+        filename=filename,
+    )
     assert isinstance(loaded_detector, detector.__class__)
 
 
+@set_os_filename("callback.pkl")
 def test_save_load_with_valid_callback(
+    request: pytest.FixtureRequest,
     callback: BaseCallback,
 ) -> None:
     """Test save and load with valid callback.
 
+    :param request: Request
+    :type request: pytest.FixtureRequest
     :param callback: Callback
     :type callback: BaseCallback
     """
-    filename = "/tmp/callback.pkl"
-    save(callback, filename)
-    loaded_callback = load(filename)
+    filename = request.node.get_closest_marker("filename").args[0]
+    save(
+        obj=callback,
+        filename=filename,
+    )
+    loaded_callback = load(
+        filename=filename,
+    )
     assert isinstance(loaded_callback, BaseCallback)
 
 
-def test_save_with_invalid_object() -> None:
+@set_os_filename("invalid.pkl")
+def test_save_with_invalid_object(
+    request: pytest.FixtureRequest,
+) -> None:
     """Test save with invalid object.
 
+    :param request: Request
+    :type request: pytest.FixtureRequest
     :raises TypeError: Type error exception
     """
     invalid_object = "invalid"
-    filename = "/tmp/invalid.pkl"
+    filename = request.node.get_closest_marker("filename").args[0]
     with pytest.raises(TypeError):
         save(invalid_object, filename)
 
 
+@set_os_filename("detector.pkl")
 def test_save_with_invalid_protocol(
+    request: pytest.FixtureRequest,
     detector: BaseDetector,
 ) -> None:
     """Test save with invalid protocol.
 
+    :param request: Request
+    :type request: pytest.FixtureRequest
     :param detector: Detector
     :type detector: BaseDetector
     :raises ValueError: Value error exception
     """
-    filename = "/tmp/detector.pkl"
     invalid_protocol = pickle.HIGHEST_PROTOCOL + 1
+    filename = request.node.get_closest_marker("filename").args[0]
     with pytest.raises(ValueError):
         save(detector, filename, invalid_protocol)
 
 
-def test_load_with_non_existent_file() -> None:
+@set_os_filename("non_existent.pkl")
+def test_load_with_non_existent_file(
+    request: pytest.FixtureRequest,
+) -> None:
     """Test load with non-existent file.
 
+    :param request: Request
+    :type request: pytest.FixtureRequest
     :raises FileNotFoundError: File not found error exception
     """
-    filename = "/tmp/non_existent.pkl"
+    filename = request.node.get_closest_marker("filename").args[0]
     with pytest.raises(FileNotFoundError):
         load(filename)

frouros/utils/decorators.py

@@ -0,0 +1,36 @@
+"""Decorators module."""
+
+import functools
+import os
+from typing import Any
+
+import pytest
+
+
+def set_os_filename(base_filename: str) -> Any:
+    """Set OS filename.
+
+    :param base_filename: Base filename
+    :type base_filename: str
+    :return: Decorator
+    :rtype: Any
+    """
+
+    def decorator(func: Any) -> Any:
+        if os.name == "nt":  # Windows
+            temp_dir = os.environ.get("TEMP") or os.environ.get("TMP")
+            filename = f"{temp_dir}\\{base_filename}"
+        elif os.name == "posix":  # Linux or macOS
+            temp_dir = "/tmp"
+            filename = f"{temp_dir}/{base_filename}"
+        else:
+            raise Exception("Unsupported operating system.")
+
+        @functools.wraps(func)
+        @pytest.mark.filename(filename)
+        def wrapper(*args: Any, **kwargs: Any) -> Any:
+            func(*args, **kwargs)
+
+        return wrapper
+
+    return decorator