Pytest utilities

Author: Joaopeuko

mqpy/utilities.py

@@ -57,7 +57,7 @@ def check_trade_availability(self, symbol: str, count_until: int) -> bool:
             self.__counter_flag = True
 
         if self.__minutes_counter == count_until:
-            logger.info("Trading is allowed.\n")
+            logger.info("Trading is allowed.")
             self.__reset_counters()
 
         return self.__allowed_to_trade
@@ -68,3 +68,59 @@ def __reset_counters(self) -> None:
         self.__counter_flag = True
         self.__allow_to_count = False
         self.__allowed_to_trade = True
+
+    # Test-only methods
+    def _test_get_minutes_counter(self) -> int:
+        """Get the minutes counter (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        return self.__minutes_counter
+
+    def _test_get_counter_flag(self) -> bool:
+        """Get the counter flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        return self.__counter_flag
+
+    def _test_get_allowed_to_trade(self) -> bool:
+        """Get the allowed to trade flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        return self.__allowed_to_trade
+
+    def _test_get_allow_to_count(self) -> bool:
+        """Get the allow to count flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        return self.__allow_to_count
+
+    def _test_get_recent_trade(self) -> bool:
+        """Get the recent trade flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        return self.__recent_trade
+
+    def _test_set_minutes_counter(self, value: int) -> None:
+        """Set the minutes counter (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        self.__minutes_counter = value
+
+    def _test_set_counter_flag(self, value: bool) -> None:
+        """Set the counter flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        self.__counter_flag = value
+
+    def _test_set_allowed_to_trade(self, value: bool) -> None:
+        """Set the allowed to trade flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        self.__allowed_to_trade = value
+
+    def _test_set_allow_to_count(self, value: bool) -> None:
+        """Set the allow to count flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        self.__allow_to_count = value
+
+    def _test_set_recent_trade(self, value: bool) -> None:
+        """Set the recent trade flag (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        self.__recent_trade = value
+
+    def _test_reset_counters(self) -> None:
+        """Reset counters (for testing only)."""
+        logger.warning("This method is for testing purposes only and should not be used in production code.")
+        self.__reset_counters()

pyproject.toml

@@ -134,7 +134,8 @@ max-complexity = 10
 
 [tool.ruff.lint.per-file-ignores]
 "conftest.py" = ["S101", "D100", "D103", "D417", "FBT001", "INP001"]
-"test_*.py" = ["S101", "D100", "D103", "D417", "FBT001", "INP001"]
+"test_*.py" = ["S101", "D100", "D103", "D417", "FBT001", "INP001", "SLF001", "FBT003"]
+"mqpy/utilities.py" = ["FBT001"]
 
 [tool.ruff.lint.pydocstyle]
 convention = "google"

tests/test_utilities.py

@@ -0,0 +1,96 @@
+"""Tests for the Utilities class that provides helper functions for trading operations."""
+
+from __future__ import annotations
+
+import time
+from typing import Generator
+
+import MetaTrader5 as Mt5
+import pytest
+
+from mqpy.utilities import Utilities
+
+
+@pytest.fixture(scope="module", autouse=True)
+def setup_teardown() -> Generator[None, None, None]:
+    """Set up and tear down MetaTrader5 connection for the test module."""
+    if not Mt5.initialize():
+        pytest.skip("MetaTrader5 could not be initialized")
+
+    time.sleep(5)
+
+    yield
+
+    Mt5.shutdown()
+
+
+@pytest.fixture
+def symbol() -> str:
+    """Provides a valid trading symbol for testing."""
+    time.sleep(1)
+
+    symbols = Mt5.symbols_get()
+    if not symbols:
+        pytest.skip("No symbols available for testing")
+
+    for symbol in symbols:
+        if symbol.name == "EURUSD":
+            return "EURUSD"
+
+    return symbols[0].name
+
+
+@pytest.fixture
+def utilities() -> Utilities:
+    """Provides a Utilities instance for testing."""
+    return Utilities()
+
+
+def test_utilities_initialization() -> None:
+    """Test initialization of Utilities class."""
+    utilities = Utilities()
+    assert isinstance(utilities, Utilities)
+    symbol = "EURUSD"
+    assert utilities.check_trade_availability(symbol, 5) is True
+
+
+def test_multiple_utilities_instances() -> None:
+    """Test that multiple Utilities instances work independently."""
+    utilities1 = Utilities()
+    utilities2 = Utilities()
+    assert utilities1.check_trade_availability("EURUSD", 5) is True
+    assert utilities2.check_trade_availability("EURUSD", 5) is True
+    assert utilities1 is not utilities2
+
+
+def test_utilities_attributes(utilities: Utilities) -> None:
+    """Test that the Utilities class has the expected attributes."""
+    assert hasattr(utilities, "_test_get_minutes_counter")
+    assert hasattr(utilities, "_test_get_counter_flag")
+    assert hasattr(utilities, "_test_get_allowed_to_trade")
+    assert hasattr(utilities, "_test_get_allow_to_count")
+    assert hasattr(utilities, "_test_get_recent_trade")
+
+    assert utilities._test_get_minutes_counter() == 0
+    assert utilities._test_get_counter_flag() is True
+    assert utilities._test_get_allowed_to_trade() is True
+    assert utilities._test_get_allow_to_count() is False
+    assert utilities._test_get_recent_trade() is False
+
+    assert hasattr(utilities, "check_trade_availability")
+    assert callable(utilities.check_trade_availability)
+
+
+def test_reset_counters_functionality(utilities: Utilities) -> None:
+    """Test the reset_counters functionality directly."""
+    utilities._test_set_minutes_counter(5)
+    utilities._test_set_counter_flag(False)
+    utilities._test_set_allowed_to_trade(False)
+    utilities._test_set_allow_to_count(True)
+
+    utilities._test_reset_counters()
+
+    assert utilities._test_get_minutes_counter() == 0
+    assert utilities._test_get_counter_flag() is True
+    assert utilities._test_get_allowed_to_trade() is True
+    assert utilities._test_get_allow_to_count() is False