-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathtest_module.py
More file actions
281 lines (230 loc) · 8.53 KB
/
Copy pathtest_module.py
File metadata and controls
281 lines (230 loc) · 8.53 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
import os
import typing
import pytest
from ellar.app import AppFactory
from ellar.common import GuardCanActivate
from ellar.common.constants import GUARDS_KEY, MODULE_METADATA
from ellar.core import ExecutionContext
from ellar.core.modules.ref import ModuleTemplateRef
from ellar.di import injectable
from ellar.openapi import (
OpenAPIDocumentBuilder,
OpenAPIDocumentModule,
ReDocUI,
StopLightUI,
SwaggerUI,
)
from ellar.openapi.module import AllowAnyGuard
from ellar.reflect import reflect
from ellar.testing import TestClient
EMPTY_OPENAPI_DOC = {
"openapi": "3.1.0",
"info": {"title": "Ellar API Docs", "version": "1.0.0"},
"paths": {},
"components": {
"schemas": {
"HTTPValidationError": {
"properties": {
"detail": {
"items": {"$ref": "#/components/schemas/ValidationError"},
"type": "array",
"title": "Details",
}
},
"type": "object",
"required": ["detail"],
"title": "HTTPValidationError",
},
"ValidationError": {
"properties": {
"loc": {
"items": {"type": "string"},
"type": "array",
"title": "Location",
},
"msg": {"type": "string", "title": "Message"},
"type": {"type": "string", "title": "Error Type"},
},
"type": "object",
"required": ["loc", "msg", "type"],
"title": "ValidationError",
},
}
},
"tags": [],
}
@injectable
class CustomDocsGuard(GuardCanActivate):
detail: str = "Not Allowed"
async def can_activate(self, context: ExecutionContext) -> bool:
return False
def test_openapi_module_template_path_exist():
app = AppFactory.create_app()
document = OpenAPIDocumentBuilder().build_document(app)
module = OpenAPIDocumentModule.setup(
app=app,
document=document,
docs_ui=SwaggerUI(),
)
module_ref = typing.cast(ModuleTemplateRef, app.injector.get_module(module))
path = module_ref.jinja_loader.searchpath[0]
assert os.path.exists(path)
list_of_html_contained_in_path = ["swagger.html", "redocs.html"]
for item in os.listdir(path):
if os.path.isfile(os.path.join(path, item)):
list_of_html_contained_in_path.remove(item)
assert len(list_of_html_contained_in_path) == 0
def test_openapi_module_with_openapi_url_doesnot_create_new_openapi_url():
app = AppFactory.create_app()
client = TestClient(app)
document = OpenAPIDocumentBuilder().build_document(app)
OpenAPIDocumentModule.setup(
app=app,
openapi_url="/openapi_url.json",
document=document,
docs_ui=SwaggerUI(),
)
res = client.get("/docs")
assert res.status_code == 200
assert "/openapi_url.json" in res.text
def test_openapi_module_creates_openapi_url():
app = AppFactory.create_app()
document = OpenAPIDocumentBuilder().build_document(app)
OpenAPIDocumentModule.setup(app=app, document=document, docs_ui=SwaggerUI())
client = TestClient(app)
res = client.get("/docs")
assert res.status_code == 200
assert "/openapi.json" in res.text
res = client.get("/openapi.json")
assert res.status_code == 200
document_json = res.json()
assert document_json == EMPTY_OPENAPI_DOC
def test_openapi_module_creates_swagger_endpoint():
app = AppFactory.create_app()
document = OpenAPIDocumentBuilder().build_document(app)
OpenAPIDocumentModule.setup(
app=app,
openapi_url="/openapi_url.json",
document=document,
docs_ui=SwaggerUI(title="Swagger Doc Test", path="docs-swagger-test"),
)
client = TestClient(app)
response = client.get("docs-swagger-test")
assert response.status_code == 200
assert "Swagger Doc Test" in response.text
assert "openapi_url.json" in response.text
assert '<div id="swagger-ui"></div>' in response.text
assert "const ui = SwaggerUIBundle({" in response.text
def test_openapi_module_creates_redocs_endpoint():
app = AppFactory.create_app()
document = OpenAPIDocumentBuilder().build_document(app)
OpenAPIDocumentModule.setup(
app=app,
openapi_url="/openapi_url.json",
document=document,
docs_ui=ReDocUI(title="Redocs Doc Test", path="docs-redocs-test"),
)
client = TestClient(app)
response = client.get("docs-redocs-test")
assert response.status_code == 200
assert "Redocs Doc Test" in response.text
assert "openapi_url.json" in response.text
assert '<redoc spec-url="/openapi_url.json"></redoc>' in response.text
def test_openapi_module_creates_stoplight_endpoint():
app = AppFactory.create_app()
document = OpenAPIDocumentBuilder().build_document(app)
OpenAPIDocumentModule.setup(
app=app,
document=document,
docs_ui=StopLightUI(
title="StopLight", path="elements-path", config={"layout": "nav"}
),
)
client = TestClient(app)
response = client.get("elements-path")
assert response.status_code == 200
assert "StopLight" in response.text
assert 'apiDescriptionUrl="/openapi.json"' in response.text
assert '"layout": "nav"' in response.text
assert '"router": "hash"' in response.text
assert "StopLight" in response.text
def test_openapi_module_with_route_guards():
app = AppFactory.create_app(providers=[CustomDocsGuard])
document = OpenAPIDocumentBuilder().build_document(app)
module = OpenAPIDocumentModule.setup(
app=app,
document=document,
guards=[CustomDocsGuard],
docs_ui=(SwaggerUI(), ReDocUI(), StopLightUI()),
)
client = TestClient(app)
routers = reflect.get_metadata(MODULE_METADATA.ROUTERS, module)
guards = reflect.get_metadata(GUARDS_KEY, routers[0])
assert len(guards) == 2
assert AllowAnyGuard in guards
response = client.get("openapi.json")
assert response.status_code == 403
assert response.json() == {"detail": "Not Allowed", "status_code": 403}
response = client.get("docs")
assert response.status_code == 403
assert response.json() == {"detail": "Not Allowed", "status_code": 403}
response = client.get("redoc")
assert response.status_code == 403
assert response.json() == {"detail": "Not Allowed", "status_code": 403}
def test_invalid_open_api_doc_setup():
app = AppFactory.create_app(providers=[CustomDocsGuard])
document = OpenAPIDocumentBuilder().build_document(app)
with pytest.raises(Exception) as ex:
OpenAPIDocumentModule.setup(
app=app,
document=document,
guards=[CustomDocsGuard],
docs_ui=(CustomDocsGuard(),),
)
assert str(ex.value) == "CustomDocsGuard must be of type `IDocumentationUIContext`"
with pytest.raises(Exception) as ex:
OpenAPIDocumentModule.setup(
app=app,
document=document,
guards=[CustomDocsGuard],
docs_ui=(CustomDocsGuard,),
)
assert str(ex.value) == "CustomDocsGuard must be of type `IDocumentationUIContext`"
def test_app_global_guard_blocks_openapi_doc_page():
app = AppFactory.create_app(global_guards=[CustomDocsGuard])
document = OpenAPIDocumentBuilder().build_document(app)
client = TestClient(app)
OpenAPIDocumentModule.setup(
app=app,
document=document,
docs_ui=SwaggerUI(),
allow_any=False,
)
response = client.get("/docs")
assert response.status_code == 403
assert response.json() == {"detail": "Not Allowed", "status_code": 403}
module = OpenAPIDocumentModule.setup(
app=app,
document=document,
docs_ui=SwaggerUI(),
allow_any=False,
guards=[CustomDocsGuard],
)
routers = reflect.get_metadata(MODULE_METADATA.ROUTERS, module)
guards = reflect.get_metadata(GUARDS_KEY, routers[0])
assert len(guards) == 1
assert AllowAnyGuard not in guards
def test_lazy_openapi_document_build():
app = AppFactory.create_app()
document = OpenAPIDocumentBuilder()
OpenAPIDocumentModule.setup(
app=app,
document=document,
router_prefix="/api",
docs_ui=SwaggerUI(),
allow_any=False,
)
client = TestClient(app)
response = client.get("/api/openapi.json")
assert response.status_code == 200
assert response.json() == EMPTY_OPENAPI_DOC