1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
from __future__ import annotations
from typing import TYPE_CHECKING, Any, Union, cast
from unittest.mock import MagicMock
import pytest
from pytest import FixtureRequest
from pytest_mock import MockerFixture
from sanic import HTTPResponse, Request, Sanic
from sanic_testing.testing import SanicTestClient # type: ignore[import-untyped]
from sqlalchemy import Engine
from sqlalchemy.ext.asyncio import AsyncEngine
from typing_extensions import assert_type
from advanced_alchemy.extensions.sanic import AdvancedAlchemy, SQLAlchemyAsyncConfig, SQLAlchemySyncConfig
AnyConfig = Union[SQLAlchemyAsyncConfig, SQLAlchemySyncConfig]
@pytest.fixture()
def app() -> Sanic[Any, Any]:
return Sanic("TestSanic")
@pytest.fixture()
def client(app: Sanic[Any, Any]) -> SanicTestClient:
return SanicTestClient(app=app)
@pytest.fixture()
def sync_config() -> SQLAlchemySyncConfig:
return SQLAlchemySyncConfig(connection_string="sqlite+pysqlite://")
@pytest.fixture()
def async_config() -> SQLAlchemyAsyncConfig:
return SQLAlchemyAsyncConfig(connection_string="sqlite+aiosqlite://")
@pytest.fixture(params=["sync_config", "async_config"])
def config(request: FixtureRequest) -> AnyConfig:
return cast(AnyConfig, request.getfixturevalue(request.param))
@pytest.fixture()
def alchemy(config: AnyConfig, app: Sanic[Any, Any]) -> AdvancedAlchemy:
alchemy = AdvancedAlchemy(sqlalchemy_config=config)
alchemy.register(app)
return alchemy
@pytest.fixture()
def mock_close(mocker: MockerFixture, config: AnyConfig) -> MagicMock:
if isinstance(config, SQLAlchemySyncConfig):
return mocker.patch("sqlalchemy.orm.Session.close")
return mocker.patch("sqlalchemy.ext.asyncio.AsyncSession.close")
@pytest.fixture()
def mock_commit(mocker: MockerFixture, config: AnyConfig) -> MagicMock:
if isinstance(config, SQLAlchemySyncConfig):
return mocker.patch("sqlalchemy.orm.Session.commit")
return mocker.patch("sqlalchemy.ext.asyncio.AsyncSession.commit")
@pytest.fixture()
def mock_rollback(mocker: MockerFixture, config: AnyConfig) -> MagicMock:
if isinstance(config, SQLAlchemySyncConfig):
return mocker.patch("sqlalchemy.orm.Session.rollback")
return mocker.patch("sqlalchemy.ext.asyncio.AsyncSession.rollback")
def test_infer_types_from_config(async_config: SQLAlchemyAsyncConfig, sync_config: SQLAlchemySyncConfig) -> None:
if TYPE_CHECKING:
sync_alchemy = AdvancedAlchemy(sqlalchemy_config=sync_config)
async_alchemy = AdvancedAlchemy(sqlalchemy_config=async_config)
assert_type(sync_alchemy.get_sync_engine(), Engine)
assert_type(async_alchemy.get_async_engine(), AsyncEngine)
def test_inject_engine(app: Sanic[Any, Any], alchemy: AdvancedAlchemy) -> None:
@app.get("/")
async def handler(request: Request) -> HTTPResponse:
assert isinstance(getattr(request.app.ctx, alchemy.get_config().engine_key), (Engine, AsyncEngine))
return HTTPResponse(status=200)
client = SanicTestClient(app=app)
assert client.get("/")[1].status == 200 # pyright: ignore[reportOptionalMemberAccess,reportUnknownMemberType]
"""
def test_inject_session(app: Sanic, alchemy: AdvancedAlchemy, client: SanicTestClient) -> None:
if isinstance(alchemy.sqlalchemy_config, SQLAlchemyAsyncConfig):
app.ext.add_dependency(AsyncSession, alchemy.get_session_from_request)
@app.get("/")
async def handler(request: Request) -> HTTPResponse:
assert isinstance(getattr(request.ctx, alchemy.session_key), AsyncSession)
return HTTPResponse(status=200)
assert client.get("/")[1].status == 200
else:
app.ext.add_dependency(Session, alchemy.get_session_from_request)
@app.get("/")
async def handler(request: Request) -> HTTPResponse:
assert isinstance(getattr(request.ctx, alchemy.session_key), Session)
return HTTPResponse(status=200)
assert client.get("/")[1].status == 200
"""
"""
def test_session_no_autocommit(
app: Sanic,
alchemy: AdvancedAlchemy,
client: SanicTestClient,
mock_commit: MagicMock,
mock_close: MagicMock,
) -> None:
alchemy.autocommit_strategy = None
app.ext.add_dependency(Session, alchemy.get_session)
@app.get("/")
def handler(session: Session) -> None:
pass
assert client.get("/")[1].status == 200
mock_commit.assert_not_called()
mock_close.assert_called_once()
"""
"""
def test_session_autocommit_always(
app: Sanic,
alchemy: AdvancedAlchemy,
client: SanicTestClient,
mock_commit: MagicMock,
mock_close: MagicMock,
) -> None:
alchemy.autocommit_strategy = "always"
app.ext.add_dependency(Session, alchemy.get_session)
@app.get("/")
def handler(session: Session) -> None:
pass
assert client.get("/")[1].status == 200
mock_commit.assert_called_once()
mock_close.assert_called_once()
"""
"""
@pytest.mark.parametrize("status", [200, 201, 202, 204, 206])
def test_session_autocommit_match_status(
app: Sanic,
alchemy: AdvancedAlchemy,
client: SanicTestClient,
mock_commit: MagicMock,
mock_close: MagicMock,
mock_rollback: MagicMock,
status: int,
) -> None:
alchemy.autocommit_strategy = "match_status"
app.ext.add_dependency(Session, alchemy.get_session)
@app.get("/")
def handler(session: Session) -> HTTPResponse:
return HTTPResponse(status=status)
client.get("/")
mock_commit.assert_called_once()
mock_close.assert_called_once()
mock_rollback.assert_not_called()
"""
"""
@pytest.mark.parametrize("status", [300, 301, 305, 307, 308, 400, 401, 404, 450, 500, 900])
def test_session_autocommit_rollback_for_status(
app: Sanic,
alchemy: AdvancedAlchemy,
client: SanicTestClient,
mock_commit: MagicMock,
mock_close: MagicMock,
mock_rollback: MagicMock,
status: int,
) -> None:
alchemy.autocommit_strategy = "match_status"
app.ext.add_dependency(Session, alchemy.get_session)
@app.get("/")
def handler(session: Session) -> HTTPResponse:
return HTTPResponse(status=status)
client.get("/")
mock_commit.assert_not_called()
mock_close.assert_called_once()
mock_rollback.assert_called_once()
"""
"""
@pytest.mark.parametrize("autocommit_strategy", ["always", "match_status"])
def test_session_autocommit_close_on_exception(
app: Sanic,
alchemy: AdvancedAlchemy,
client: SanicTestClient,
mock_commit: MagicMock,
mock_close: MagicMock,
autocommit_strategy: CommitStrategy,
) -> None:
alchemy.autocommit_strategy = autocommit_strategy
mock_commit.side_effect = ValueError
app.ext.add_dependency(Session, alchemy.get_session)
@app.get("/")
def handler(session: Session) -> None:
pass
client.get("/")
mock_commit.assert_called_once()
mock_close.assert_called_once()
"""
"""
def test_multiple_instances(app: Sanic) -> None:
mock = MagicMock()
config_1 = SQLAlchemySyncConfig(connection_string="sqlite+aiosqlite://")
config_2 = SQLAlchemySyncConfig(connection_string="sqlite+aiosqlite:///test.db")
alchemy_1 = AdvancedAlchemy(sqlalchemy_config=config_1)
alchemy_2 = AdvancedAlchemy(
sqlalchemy_config=config_2,
engine_key="other_engine",
session_key="other_session",
session_maker_key="other_sessionmaker",
)
Extend.register(alchemy_1)
Extend.register(alchemy_2)
app.ext.add_dependency(Session, alchemy_1.get_session)
app.ext.add_dependency(Session, alchemy_2.get_session)
app.ext.add_dependency(Engine, alchemy_1.get_engine)
app.ext.add_dependency(Engine, alchemy_2.get_engine)
@app.get("/")
async def handler(
session_1: Session,
session_2: Session,
engine_1: Engine,
engine_2: Engine,
) -> None:
assert session_1 != session_2
assert engine_1 != engine_2
mock(session=session_1, engine=engine_1)
mock(session=session_2, engine=engine_2)
client = SanicTestClient(app=app)
_response = client.get("/")
assert alchemy_1.engine_key != alchemy_2.engine_key
assert alchemy_1.session_maker_key != alchemy_2.session_maker_key
assert alchemy_1.session_key != alchemy_2.session_key
assert alchemy_1.get_engine() is not alchemy_2.get_engine()
assert alchemy_1.get_sessionmaker() is not alchemy_2.get_sessionmaker()
"""
|
