fix: resolve SQLite database file locking on Windows for unittests

- Add teardown_sqlalchemy() to properly dispose engine and release file locks
- Fix clear_db() to dispose its engine in a finally block
- Update all test teardowns to use teardown_sqlalchemy()
- Add ignore_errors=True to shutil.rmtree calls as safety net
- Add windows-latest to CI test matrix
- Use poetry run instead of source $VENV for cross-platform CI

Closes #291

Author: MDUYN

.github/workflows/test.yml

@@ -39,7 +39,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        os: [ "ubuntu-latest", "macos-latest" ]
+        os: [ "ubuntu-latest", "macos-latest", "windows-latest" ]
         python-version: [ "3.10", "3.11" ]
     defaults:
       run:
@@ -101,14 +101,12 @@ jobs:
       #----------------------------------------------
       - name: Run tests
         run: |
-          source $VENV
-          coverage run -m unittest discover -s tests
+          poetry run coverage run -m unittest discover -s tests
       - name: Generate coverage report
         if: always()
         continue-on-error: true
         run: |
-          source $VENV
-          coverage xml
+          poetry run coverage xml
       #----------------------------------------------
       #             upload coverage stats
       #----------------------------------------------

investing_algorithm_framework/infrastructure/database/__init__.py

@@ -1,11 +1,12 @@
 from .sql_alchemy import Session, setup_sqlalchemy, SQLBaseModel, \
-    create_all_tables, clear_db, SqliteDecimal
+    create_all_tables, clear_db, teardown_sqlalchemy, SqliteDecimal
 
 __all__ = [
     "Session",
     "setup_sqlalchemy",
     "SQLBaseModel",
     "create_all_tables",
     "clear_db",
+    "teardown_sqlalchemy",
     "SqliteDecimal"
 ]

investing_algorithm_framework/infrastructure/database/sql_alchemy.py

@@ -3,7 +3,7 @@
 
 from sqlalchemy import create_engine, StaticPool, String
 from sqlalchemy import inspect
-from sqlalchemy.orm import DeclarativeBase, sessionmaker
+from sqlalchemy.orm import DeclarativeBase, sessionmaker, close_all_sessions
 from sqlalchemy import TypeDecorator
 
 from investing_algorithm_framework.domain import SQLALCHEMY_DATABASE_URI, \
@@ -83,6 +83,21 @@ def create_all_tables():
     SQLBaseModel.metadata.create_all(bind=Session().bind)
 
 
+def teardown_sqlalchemy():
+    """
+    Dispose the engine and close all sessions to release file locks.
+    This is essential on Windows where file locks are mandatory and
+    prevent deletion of SQLite database files while connections are open.
+    """
+    close_all_sessions()
+    bind = Session.kw.get("bind")
+
+    if bind is not None:
+        bind.dispose()
+
+    Session.configure(bind=None)
+
+
 from sqlalchemy import event
 from sqlalchemy.orm import mapper
 from datetime import timezone
@@ -98,6 +113,7 @@ def clear_db(db_uri):
     Returns:
         None
     """
+    engine = None
     # Drop all tables before deleting file
     try:
         engine = create_engine(db_uri)
@@ -107,12 +123,9 @@ def clear_db(db_uri):
             SQLBaseModel.metadata.drop_all(bind=engine)
     except Exception as e:
         logger.error(f"Error dropping tables: {e}")
-
-    # # Clear mappers (if using classical mappings)
-    # try:
-    #     clear_mappers()
-    # except Exception:
-    #     pass  # ignore if not needed
+    finally:
+        if engine is not None:
+            engine.dispose()
 
 
 @event.listens_for(mapper, "load")

tests/app/algorithm/test_run_strategy.py

@@ -8,6 +8,8 @@
 from investing_algorithm_framework import create_app, TradingStrategy, \
     TimeUnit, PortfolioConfiguration, RESOURCE_DIRECTORY, Algorithm, \
     MarketCredential
+from investing_algorithm_framework.infrastructure.database import \
+    teardown_sqlalchemy
 from tests.resources import random_string, OrderExecutorTest, \
     PortfolioProviderTest
 
@@ -73,6 +75,7 @@ def setUp(self) -> None:
 
     def tearDown(self) -> None:
         super().tearDown()
+        teardown_sqlalchemy()
         database_dir = os.path.join(self.resource_dir, "databases")
         if os.path.exists(database_dir):
             shutil.rmtree(database_dir, ignore_errors=True)

tests/app/algorithm/test_trade_price_update.py

@@ -8,6 +8,8 @@
     TimeUnit, PortfolioConfiguration, RESOURCE_DIRECTORY, \
     MarketCredential, DataSource, INDEX_DATETIME, DataType, \
     CSVOHLCVDataProvider, BacktestDateRange
+from investing_algorithm_framework.infrastructure.database import \
+    teardown_sqlalchemy
 from tests.resources import random_string, \
     PortfolioProviderTest, OrderExecutorTest
 
@@ -55,6 +57,7 @@ def setUp(self) -> None:
 
     def tearDown(self) -> None:
         super().tearDown()
+        teardown_sqlalchemy()
         database_dir = os.path.join(self.resource_dir, "databases")
         if os.path.exists(database_dir):
             shutil.rmtree(database_dir, ignore_errors=True)

tests/app/backtesting/test_run_backtest.py

@@ -8,6 +8,8 @@
 from investing_algorithm_framework import create_app, RESOURCE_DIRECTORY, \
     TradingStrategy, PortfolioConfiguration, TimeUnit, Algorithm, \
     BacktestDateRange
+from investing_algorithm_framework.infrastructure.database import \
+    teardown_sqlalchemy
 
 
 class TestStrategy(TradingStrategy):
@@ -47,12 +49,13 @@ def setUp(self) -> None:
 
     def tearDown(self) -> None:
         super().tearDown()
+        teardown_sqlalchemy()
 
         if os.path.exists(self.backtest_databases_directory):
-            shutil.rmtree(self.backtest_databases_directory)
+            shutil.rmtree(self.backtest_databases_directory, ignore_errors=True)
 
         if os.path.exists(self.backtest_report_directory):
-            shutil.rmtree(self.backtest_report_directory)
+            shutil.rmtree(self.backtest_report_directory, ignore_errors=True)
 
     def test_report_creation(self):
         app = create_app(

tests/app/test_backtesting.py

@@ -18,6 +18,8 @@
 from investing_algorithm_framework import TradingStrategy, Algorithm, \
     create_app, RESOURCE_DIRECTORY, PortfolioConfiguration, \
     BacktestDateRange, TimeUnit
+from investing_algorithm_framework.infrastructure.database import \
+    teardown_sqlalchemy
 from investing_algorithm_framework.domain import SQLALCHEMY_DATABASE_URI
 
 
@@ -70,13 +72,14 @@ def setUp(self) -> None:
 
     def tearDown(self) -> None:
         super().tearDown()
+        teardown_sqlalchemy()
         for path in (
             os.path.join(self.resource_dir, "databases"),
             self.backtest_databases_dir,
             self.backtest_reports_dir,
         ):
             if os.path.exists(path):
-                shutil.rmtree(path)
+                shutil.rmtree(path, ignore_errors=True)
 
 
 # ---------------------------------------------------------------------------
@@ -253,4 +256,3 @@ def test_run_backtests(self):
             risk_free_rate=0.027
         )
         self.assertEqual(3, len(reports))
-

tests/app/test_eventloop.py

@@ -240,7 +240,7 @@ def tearDown(self) -> None:
         )
 
         if os.path.exists(databases_directory):
-            shutil.rmtree(databases_directory)
+            shutil.rmtree(databases_directory, ignore_errors=True)
 
         if os.path.exists(backtest_databases_directory):
-            shutil.rmtree(backtest_databases_directory)
+            shutil.rmtree(backtest_databases_directory, ignore_errors=True)

tests/app/test_start.py

@@ -7,6 +7,8 @@
 from investing_algorithm_framework import create_app, TradingStrategy, \
     TimeUnit, RESOURCE_DIRECTORY, PortfolioConfiguration, Algorithm, \
     MarketCredential
+from investing_algorithm_framework.infrastructure.database import \
+    teardown_sqlalchemy
 from tests.resources import OrderExecutorTest, PortfolioProviderTest
 
 
@@ -106,6 +108,7 @@ def setUp(self) -> None:
         )
 
     def tearDown(self):
+        teardown_sqlalchemy()
         for subdir in ("databases", "backtest_databases"):
             path = os.path.join(self.resource_dir, subdir)
             if os.path.exists(path):

tests/resources/backtest_reports_for_testing/test_algorithm_backtest/algorithm_id.json

@@ -1,3 +1,3 @@
 {
-    "algorithm_id": "TestStrategy"
+    "algorithm_id": "BacktestTestStrategy"
 }