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
|
import pytest
from django.core.exceptions import ImproperlyConfigured
from django.urls import path, re_path
from channels.routing import ChannelNameRouter, ProtocolTypeRouter, URLRouter
class MockApplication:
call_args = None
def __init__(self, return_value):
self.return_value = return_value
super().__init__()
async def __call__(self, scope, receive, send):
self.call_args = ((scope, receive, send), None)
return self.return_value
@pytest.mark.asyncio
@pytest.mark.filterwarnings("ignore::DeprecationWarning")
async def test_protocol_type_router():
"""
Tests the ProtocolTypeRouter
"""
# Test basic operation
router = ProtocolTypeRouter(
{
"websocket": MockApplication(return_value="ws"),
"http": MockApplication(return_value="http"),
}
)
assert await router({"type": "websocket"}, None, None) == "ws"
assert await router({"type": "http"}, None, None) == "http"
# Test an unmatched type
with pytest.raises(ValueError):
await router({"type": "aprs"}, None, None)
# Test a scope with no type
with pytest.raises(KeyError):
await router({"tyyyype": "http"}, None, None)
@pytest.mark.asyncio
async def test_channel_name_router():
"""
Tests the ChannelNameRouter
"""
# Test basic operation
router = ChannelNameRouter(
{
"test": MockApplication(return_value=1),
"other_test": MockApplication(return_value=2),
}
)
assert await router({"channel": "test"}, None, None) == 1
assert await router({"channel": "other_test"}, None, None) == 2
# Test an unmatched channel
with pytest.raises(ValueError):
await router({"channel": "chat"}, None, None)
# Test a scope with no channel
with pytest.raises(ValueError):
await router({"type": "http"}, None, None)
@pytest.mark.asyncio
async def test_url_router():
"""
Tests the URLRouter
"""
posarg_app = MockApplication(return_value=4)
kwarg_app = MockApplication(return_value=5)
defaultkwarg_app = MockApplication(return_value=6)
router = URLRouter(
[
path("", MockApplication(return_value=1)),
path("foo/", MockApplication(return_value=2)),
re_path(r"bar", MockApplication(return_value=3)),
re_path(r"^posarg/(\d+)/$", posarg_app),
path("kwarg/<str:name>/", kwarg_app),
path("defaultkwargs/", defaultkwarg_app, kwargs={"default": 42}),
]
)
# Valid basic matches
assert await router({"type": "http", "path": "/"}, None, None) == 1
assert await router({"type": "http", "path": "/foo/"}, None, None) == 2
assert await router({"type": "http", "path": "/bar/"}, None, None) == 3
assert await router({"type": "http", "path": "/bar/baz/"}, None, None) == 3
# Valid positional matches
assert await router({"type": "http", "path": "/posarg/123/"}, None, None) == 4
assert posarg_app.call_args[0][0]["url_route"] == {"args": ("123",), "kwargs": {}}
assert await router({"type": "http", "path": "/posarg/456/"}, None, None) == 4
assert posarg_app.call_args[0][0]["url_route"] == {"args": ("456",), "kwargs": {}}
# Valid keyword argument matches
assert await router({"type": "http", "path": "/kwarg/hello/"}, None, None) == 5
assert kwarg_app.call_args[0][0]["url_route"] == {
"args": tuple(),
"kwargs": {"name": "hello"},
}
assert await router({"type": "http", "path": "/kwarg/hellothere/"}, None, None) == 5
assert kwarg_app.call_args[0][0]["url_route"] == {
"args": tuple(),
"kwargs": {"name": "hellothere"},
}
# Valid default keyword arguments
assert await router({"type": "http", "path": "/defaultkwargs/"}, None, None) == 6
assert defaultkwarg_app.call_args[0][0]["url_route"] == {
"args": tuple(),
"kwargs": {"default": 42},
}
# Valid root_path in scope
assert (
await router(
{"type": "http", "path": "/root/", "root_path": "/root"}, None, None
)
== 1
)
assert (
await router(
{"type": "http", "path": "/root/foo/", "root_path": "/root"}, None, None
)
== 2
)
# Unmatched root_path in scope
with pytest.raises(ValueError):
await router({"type": "http", "path": "/", "root_path": "/root"}, None, None)
# Invalid matches
with pytest.raises(ValueError):
await router({"type": "http", "path": "/nonexistent/"}, None, None)
@pytest.mark.asyncio
async def test_url_router_nesting():
"""
Tests that nested URLRouters add their keyword captures together.
"""
test_app = MockApplication(return_value=1)
inner_router = URLRouter(
[
re_path(r"^book/(?P<book>[\w\-]+)/page/(?P<page>\d+)/$", test_app),
re_path(r"^test/(\d+)/$", test_app),
]
)
outer_router = URLRouter(
[
re_path(
r"^universe/(?P<universe>\d+)/author/(?P<author>\w+)/", inner_router
),
re_path(r"^positional/(\w+)/", inner_router),
]
)
assert (
await outer_router(
{
"type": "http",
"path": "/universe/42/author/andrewgodwin/book/channels-guide/page/10/",
},
None,
None,
)
== 1
)
assert test_app.call_args[0][0]["url_route"] == {
"args": (),
"kwargs": {
"book": "channels-guide",
"author": "andrewgodwin",
"page": "10",
"universe": "42",
},
}
assert (
await outer_router(
{"type": "http", "path": "/positional/foo/test/3/"}, None, None
)
== 1
)
assert test_app.call_args[0][0]["url_route"] == {"args": ("foo", "3"), "kwargs": {}}
@pytest.mark.asyncio
async def test_url_router_nesting_path():
"""
Tests that nested URLRouters add their keyword captures together when used
with path().
"""
from django.urls import path
test_app = MockApplication(return_value=1)
inner_router = URLRouter([path("test/<int:page>/", test_app)])
def asgi_middleware(inner):
# Some middleware which hides the fact that we have an inner URLRouter
async def app(scope, receive, send):
return await inner(scope, receive, send)
app._path_routing = True
return app
outer_router = URLRouter(
[path("number/<int:number>/", asgi_middleware(inner_router))]
)
assert await inner_router({"type": "http", "path": "/test/3/"}, None, None) == 1
assert (
await outer_router({"type": "http", "path": "/number/42/test/3/"}, None, None)
== 1
)
assert test_app.call_args[0][0]["url_route"] == {
"args": (),
"kwargs": {"number": 42, "page": 3},
}
with pytest.raises(ValueError):
assert await outer_router(
{"type": "http", "path": "/number/42/test/3/bla/"}, None, None
)
with pytest.raises(ValueError):
assert await outer_router(
{"type": "http", "path": "/number/42/blub/"}, None, None
)
@pytest.mark.asyncio
async def test_url_router_path():
"""
Tests that URLRouter also works with path()
"""
from django.urls import path
kwarg_app = MockApplication(return_value=3)
router = URLRouter(
[
path("", MockApplication(return_value=1)),
path("foo/", MockApplication(return_value=2)),
path("author/<name>/", kwarg_app),
path("year/<int:year>/", kwarg_app),
]
)
# Valid basic matches
assert await router({"type": "http", "path": "/"}, None, None) == 1
assert await router({"type": "http", "path": "/foo/"}, None, None) == 2
# Named without typecasting
assert (
await router({"type": "http", "path": "/author/andrewgodwin/"}, None, None) == 3
)
assert kwarg_app.call_args[0][0]["url_route"] == {
"args": tuple(),
"kwargs": {"name": "andrewgodwin"},
}
# Named with typecasting
assert await router({"type": "http", "path": "/year/2012/"}, None, None) == 3
assert kwarg_app.call_args[0][0]["url_route"] == {
"args": tuple(),
"kwargs": {"year": 2012},
}
# Invalid matches
with pytest.raises(ValueError):
await router({"type": "http", "path": "/nonexistent/"}, None, None)
@pytest.mark.asyncio
async def test_path_remaining():
"""
Resolving continues in outer router if an inner router has no matching
routes
"""
inner_router = URLRouter([path("no-match/", MockApplication(return_value=1))])
test_app = MockApplication(return_value=2)
outer_router = URLRouter(
[path("prefix/", inner_router), path("prefix/stuff/", test_app)]
)
outermost_router = URLRouter([path("", outer_router)])
assert (
await outermost_router({"type": "http", "path": "/prefix/stuff/"}, None, None)
== 2
)
assert (
await outermost_router(
{"type": "http", "path": "/root/prefix/stuff/", "root_path": "/root"},
None,
None,
)
== 2
)
with pytest.raises(ValueError):
await outermost_router(
{"type": "http", "path": "/root/root/prefix/stuff/", "root_path": "/root"},
None,
None,
)
with pytest.raises(ValueError):
await outermost_router(
{"type": "http", "path": "/root/prefix/root/stuff/", "root_path": "/root"},
None,
None,
)
def test_invalid_routes():
"""
Test URLRouter route validation
"""
from django.urls import include
with pytest.raises(ImproperlyConfigured) as exc:
URLRouter([path("", include([]))])
assert "include() is not supported in URLRouter." in str(exc)
|
