-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathtest_module_ref.py
More file actions
384 lines (309 loc) · 12.3 KB
/
Copy pathtest_module_ref.py
File metadata and controls
384 lines (309 loc) · 12.3 KB
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
import pytest
from ellar.app import AppFactory
from ellar.common import (
Module,
exception_handler,
middleware,
template_filter,
template_global,
)
from ellar.common.constants import (
EXCEPTION_HANDLERS_KEY,
MIDDLEWARE_HANDLERS_KEY,
MODULE_METADATA,
TEMPLATE_FILTER_KEY,
TEMPLATE_GLOBAL_KEY,
)
from ellar.core import Config, ModuleBase, ModuleSetup
from ellar.core.modules.ref import (
InvalidModuleTypeException,
ModulePlainRef,
ModuleTemplateRef,
create_module_ref_factor,
)
from ellar.di import (
EllarInjector,
ModuleTreeManager,
TransientScope,
injectable,
)
from ellar.di.providers import ModuleProvider
from ellar.reflect import reflect
from ellar.testing import Test
from ellar.utils import get_name
from injector import UnsatisfiedRequirement
from starlette.routing import Route
from .sample import AnotherUserService, ModuleBaseExample, SampleController, UserService
@injectable(scope=TransientScope)
@Module(name="ModuleProviderTest")
class ModuleProviderTest(ModuleBase):
def __init__(self, a: ModuleBaseExample, c: str = "C", d: float = 12.3):
self.a = a
self.c = c
self.d = d
class InitKwargsModule(ModuleBase):
def __init__(self, a: str, b: int, c: str = "C", d: float = 12.3):
self.c = c
self.d = d
self.a = a
self.b = b
class NonTemplateModuleExample(ModuleBase):
def __init__(self, a, b):
self.a = a
self.b = b
def test_create_module_ref_factor_creates_right_module_ref():
config = Config()
container = EllarInjector(auto_bind=False).container
module_ref = create_module_ref_factor(
NonTemplateModuleExample, config=config, container=container, a="a", b="b"
)
assert isinstance(module_ref, ModulePlainRef)
assert module_ref._init_kwargs == {"a": "a", "b": "b"}
module_ref = create_module_ref_factor(
ModuleBaseExample, config=config, container=container
)
assert isinstance(module_ref, ModuleTemplateRef)
assert module_ref._init_kwargs == {}
def test_module_init_kwargs_build_correctly():
config = Config()
container = EllarInjector(auto_bind=False).container
module_ref = create_module_ref_factor(
InitKwargsModule, config=config, container=container
)
assert module_ref
assert module_ref._init_kwargs == {"d": 12.3, "c": "C"}
def test_module_ref_registers_module_type():
tm = Test.create_test_module(modules=[ModuleBaseExample, ModuleProviderTest])
app = tm.create_application()
instance = tm.get(ModuleBaseExample)
instance2 = tm.get(ModuleProviderTest)
container1 = next(
app.injector.tree_manager.find_module(
lambda data: data.name == "ModuleBaseExample"
)
)
container2 = next(
app.injector.tree_manager.find_module(
lambda data: data.name == "ModuleProviderTest"
)
)
module_provider_module_base_example = container1.value.container.get_binding(
ModuleBaseExample
)
module_provider_module_provider_test = container2.value.container.get_binding(
ModuleProviderTest
)
assert isinstance(module_provider_module_base_example[0].provider, ModuleProvider)
assert isinstance(module_provider_module_provider_test[0].provider, ModuleProvider)
assert isinstance(instance, ModuleBaseExample)
assert instance2.a is instance
assert isinstance(instance2, ModuleProviderTest)
assert instance2 is not app.injector.get(ModuleProviderTest)
def test_module_template_ref_template_filters():
@Module()
class ModuleTemplateExample(ModuleBase):
@template_global()
def some_template_global(cls, n):
pass
@template_filter()
def some_template_filter(cls, n):
pass
config = Config(**{TEMPLATE_GLOBAL_KEY: {}})
container = EllarInjector(auto_bind=False).container
module_setup = ModuleSetup(ModuleTemplateExample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleTemplateExample, module_setup),
)
template_filter_functions = config[TEMPLATE_FILTER_KEY]
template_global_filter_functions = config[TEMPLATE_GLOBAL_KEY]
assert "some_template_global" not in template_global_filter_functions
assert "some_template_filter" not in template_filter_functions
module_setup.get_module_ref(config=config, container=container)
template_filter_functions = config[TEMPLATE_FILTER_KEY]
template_global_filter_functions = config[TEMPLATE_GLOBAL_KEY]
assert isinstance(template_filter_functions, dict) and isinstance(
template_global_filter_functions, dict
)
assert "some_template_global" in template_global_filter_functions
assert "some_template_filter" in template_filter_functions
def test_module_template_ref_scan_exceptions_handlers():
@Module()
class ModuleExceptionHandlerSample(ModuleBase):
@exception_handler(404, app=True)
async def exception_404(cls, ctx, exc):
pass
config = Config(**{EXCEPTION_HANDLERS_KEY: []})
container = EllarInjector(auto_bind=False).container
assert 404 not in config[EXCEPTION_HANDLERS_KEY]
module_setup = ModuleSetup(ModuleExceptionHandlerSample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleExceptionHandlerSample, module_setup),
)
module_setup.get_module_ref(config=config, container=container)
exception_handlers = config[EXCEPTION_HANDLERS_KEY]
assert isinstance(exception_handlers, list)
handler = exception_handlers[0]
k, v = iter(handler)
assert 404 == k
def test_module_template_ref_scan_middle_ware():
@Module()
class ModuleMiddlewareExample(ModuleBase):
@middleware(app=True)
async def middleware_func(cls, context, call_next):
await call_next()
config = Config(**{MIDDLEWARE_HANDLERS_KEY: ()})
container = EllarInjector(auto_bind=False).container
assert len(config[MIDDLEWARE_HANDLERS_KEY]) == 0
module_setup = ModuleSetup(ModuleMiddlewareExample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleMiddlewareExample, module_setup),
)
module_setup.get_module_ref(config=config, container=container)
config_middleware = config[MIDDLEWARE_HANDLERS_KEY]
assert isinstance(config_middleware, list)
assert "middleware_func" == get_name(config_middleware[0].kwargs["dispatch"])
def test_module_template_ref_get_all_routers():
some_invalid_router = type("SomeInvalidRouter", (), {})
config = Config()
container = EllarInjector(auto_bind=False).container
module_setup = ModuleSetup(ModuleBaseExample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleBaseExample, module_setup),
)
with reflect.context():
reflect.define_metadata(
MODULE_METADATA.ROUTERS,
[
some_invalid_router(),
Route("/", endpoint=lambda request: "Test"),
Route("/test", endpoint=lambda request: "Test"),
],
ModuleBaseExample,
)
with pytest.raises(RuntimeError):
module_ref = module_setup.get_module_ref(config=config, container=container)
module_ref.build_dependencies()
with reflect.context():
reflect.define_metadata(
MODULE_METADATA.ROUTERS,
[
Route("/", endpoint=lambda request: "Test"),
Route("/test", endpoint=lambda request: "Test"),
],
ModuleBaseExample,
)
module_ref = module_setup.get_module_ref(config=config, container=container)
module_ref.build_dependencies()
assert len(module_ref.get_routes()) == 4
# def test_module_template_ref_get_all_routers_fails_for_invalid_controller(caplog):
# some_invalid_controller = type("SomeInvalidController", (), {})
# with reflect.context():
# reflect.define_metadata(
# MODULE_METADATA.CONTROLLERS, [some_invalid_controller], ModuleBaseExample
# )
# config = Config()
# container = EllarInjector(auto_bind=False).container
#
# module_setup = ModuleSetup(ModuleBaseExample)
# container.register(
# ModuleTreeManager,
# ModuleTreeManager().add_module(ModuleBaseExample, module_setup),
# )
#
# with caplog.at_level(logging.WARNING):
# module_ref = module_setup.get_module_ref(config=config, container=container)
# module_ref.build_dependencies()
#
# assert (
# "Router Factory Builder was not found.\nUse `ControllerRouterBuilderFactory` "
# "as an example create a FactoryBuilder for this type: <class 'type'>"
# in str(caplog.text)
# )
def test_invalid_module_template_ref():
config = Config()
container = EllarInjector(auto_bind=False).container
invalid_module = type("InvalidModule", (), {})
with pytest.raises(
InvalidModuleTypeException,
match="must be a subclass of `ellar.core.ModuleBase`",
):
create_module_ref_factor(invalid_module, config=config, container=container)
def test_module_plain_ref_routes_return_empty_list():
config = Config()
container = EllarInjector(auto_bind=False).container
module_ref = create_module_ref_factor(
NonTemplateModuleExample, config=config, container=container
)
assert module_ref.routes == []
assert isinstance(module_ref.config, Config)
def test_module_template_ref_routes_returns_valid_routes():
config = Config()
container = EllarInjector(auto_bind=False).container
with reflect.context():
module_setup = ModuleSetup(ModuleBaseExample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleBaseExample, module_setup),
)
reflect.define_metadata(
MODULE_METADATA.ROUTERS,
[Route("/", endpoint=lambda request: "Test")],
ModuleBaseExample,
)
module_ref = module_setup.get_module_ref(config=config, container=container)
app = AppFactory.create_from_app_module(
module=ModuleBaseExample, config_module={"STATIC_MOUNT_PATH": None}
)
assert len(module_ref.get_routes()) == 3
assert len(module_ref.routes) == 3
assert len(app.routes) == 3
def test_module_template_ref_routes():
config = Config()
container = EllarInjector(auto_bind=False).container
module_setup = ModuleSetup(ModuleBaseExample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleBaseExample, module_setup),
)
module_ref = module_setup.get_module_ref(config=config, container=container)
assert len(module_ref.get_routes()) == 2
counts = sum(len(item.routes) for item in module_ref.get_routes())
assert counts == 4
def test_module_template_registers_providers_and_controllers():
config = Config()
container = EllarInjector(auto_bind=False).container
with pytest.raises(UnsatisfiedRequirement):
container.injector.get(UserService)
with pytest.raises(UnsatisfiedRequirement):
container.injector.get(AnotherUserService)
with pytest.raises(UnsatisfiedRequirement):
container.injector.get(SampleController)
module_setup = ModuleSetup(ModuleBaseExample)
container.register(
ModuleTreeManager,
ModuleTreeManager().add_module(ModuleBaseExample, module_setup),
)
module_ref = module_setup.get_module_ref(config=config, container=container)
module_ref.build_dependencies()
module_ref.run_module_register_services()
assert isinstance(module_ref.get(UserService), UserService)
assert isinstance(module_ref.get(AnotherUserService), AnotherUserService)
assert isinstance(module_ref.get(SampleController), SampleController)
# def test_run_application_ready_works():
# @Module()
# class TestModuleCycleExample(ModuleBase):
# _before_init_called = False
#
# @classmethod
# def before_init(cls, config: Config) -> None:
# cls._before_init_called = True
#
# assert TestModuleCycleExample._before_init_called is False
#
# Test.create_test_module(modules=[TestModuleCycleExample]).create_application()
#
# assert TestModuleCycleExample._before_init_called