Merge pull request #25 from piercefreeman/feature/close-mountaineer-d…

…ependency

Close connection automatically if dependency injected

iceaxe/__tests__/mountaineer/dependencies/test_core.py

@@ -0,0 +1,73 @@
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import asyncpg
+import pytest
+from mountaineer import CoreDependencies
+
+from iceaxe.mountaineer.config import DatabaseConfig
+from iceaxe.mountaineer.dependencies.core import get_db_connection
+from iceaxe.session import DBConnection
+
+
+@pytest.fixture(autouse=True)
+def mock_db_connect():
+    conn = AsyncMock(spec=asyncpg.Connection)
+    conn.close = AsyncMock()
+
+    with patch("asyncpg.connect", new_callable=AsyncMock) as mock:
+        mock.return_value = conn
+        yield mock
+
+
+@pytest.fixture
+def mock_config():
+    return DatabaseConfig(
+        POSTGRES_HOST="test-host",
+        POSTGRES_PORT=5432,
+        POSTGRES_USER="test-user",
+        POSTGRES_PASSWORD="test-pass",
+        POSTGRES_DB="test-db",
+    )
+
+
+@pytest.fixture
+def mock_connection():
+    conn = AsyncMock(spec=asyncpg.Connection)
+    conn.close = AsyncMock()
+    return conn
+
+
+@pytest.mark.asyncio
+async def test_get_db_connection_closes_after_yield(
+    mock_config: DatabaseConfig,
+    mock_connection: AsyncMock,
+    mock_db_connect: AsyncMock,
+):
+    mock_get_config = MagicMock(return_value=mock_config)
+    CoreDependencies.get_config_with_type = mock_get_config
+
+    mock_db_connect.return_value = mock_connection
+
+    # Get the generator
+    db_gen = get_db_connection(mock_config)
+
+    # Get the connection
+    connection = await anext(db_gen)  # noqa: F821
+
+    assert isinstance(connection, DBConnection)
+    assert connection.conn == mock_connection
+    mock_db_connect.assert_called_once_with(
+        host=mock_config.POSTGRES_HOST,
+        port=mock_config.POSTGRES_PORT,
+        user=mock_config.POSTGRES_USER,
+        password=mock_config.POSTGRES_PASSWORD,
+        database=mock_config.POSTGRES_DB,
+    )
+
+    # Simulate the end of the generator's scope
+    try:
+        await db_gen.aclose()
+    except StopAsyncIteration:
+        pass
+
+    mock_connection.close.assert_called_once()

iceaxe/mountaineer/dependencies/core.py

@@ -3,6 +3,8 @@
 
 """
 
+from typing import AsyncGenerator
+
 import asyncpg
 from mountaineer import CoreDependencies, Depends
 
@@ -14,12 +16,15 @@ async def get_db_connection(
     config: DatabaseConfig = Depends(
         CoreDependencies.get_config_with_type(DatabaseConfig)
     ),
-) -> DBConnection:
+) -> AsyncGenerator[DBConnection, None]:
     conn = await asyncpg.connect(
         host=config.POSTGRES_HOST,
         port=config.POSTGRES_PORT,
         user=config.POSTGRES_USER,
         password=config.POSTGRES_PASSWORD,
         database=config.POSTGRES_DB,
     )
-    return DBConnection(conn)
+    try:
+        yield DBConnection(conn)
+    finally:
+        await conn.close()