-
-
Notifications
You must be signed in to change notification settings - Fork 51
/
Copy pathtest_cli.py
393 lines (355 loc) · 15.8 KB
/
test_cli.py
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
385
386
387
388
389
390
391
392
393
import subprocess
import sys
from pathlib import Path
from unittest.mock import patch
import uvicorn
from fastapi_cli.cli import app
from typer.testing import CliRunner
from tests.utils import changing_dir
runner = CliRunner()
assets_path = Path(__file__).parent / "assets"
def test_dev() -> None:
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["dev", "single_file_app.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "single_file_app:app",
"host": "127.0.0.1",
"port": 8000,
"reload": True,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string single_file_app:app" in result.output
assert (
"╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
)
assert "│ Serving at: http://127.0.0.1:8000" in result.output
assert "│ API docs: http://127.0.0.1:8000/docs" in result.output
assert "│ Running in development mode, for production use:" in result.output
assert "│ fastapi run" in result.output
def test_dev_args() -> None:
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(
app,
[
"dev",
"single_file_app.py",
"--host",
"192.168.0.2",
"--port",
"8080",
"--no-reload",
"--root-path",
"/api",
"--app",
"api",
"--no-proxy-headers",
],
)
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "single_file_app:api",
"host": "192.168.0.2",
"port": 8080,
"reload": False,
"workers": None,
"root_path": "/api",
"proxy_headers": False,
}
assert "Using import string single_file_app:api" in result.output
assert (
"╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
)
assert "│ Serving at: http://192.168.0.2:8080" in result.output
assert "│ API docs: http://192.168.0.2:8080/docs" in result.output
assert "│ Running in development mode, for production use:" in result.output
assert "│ fastapi run" in result.output
def test_run() -> None:
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["run", "single_file_app.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "single_file_app:app",
"host": "0.0.0.0",
"port": 8000,
"reload": False,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string single_file_app:app" in result.output
assert (
"╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
)
assert "│ Serving at: http://0.0.0.0:8000" in result.output
assert "│ API docs: http://0.0.0.0:8000/docs" in result.output
assert "│ Running in production mode, for development use:" in result.output
assert "│ fastapi dev" in result.output
def test_run_args() -> None:
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(
app,
[
"run",
"single_file_app.py",
"--host",
"192.168.0.2",
"--port",
"8080",
"--no-reload",
"--workers",
"2",
"--root-path",
"/api",
"--app",
"api",
"--no-proxy-headers",
],
)
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "single_file_app:api",
"host": "192.168.0.2",
"port": 8080,
"reload": False,
"workers": 2,
"root_path": "/api",
"proxy_headers": False,
}
assert "Using import string single_file_app:api" in result.output
assert (
"╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
)
assert "│ Serving at: http://192.168.0.2:8080" in result.output
assert "│ API docs: http://192.168.0.2:8080/docs" in result.output
assert "│ Running in production mode, for development use:" in result.output
assert "│ fastapi dev" in result.output
def test_run_error() -> None:
with changing_dir(assets_path):
result = runner.invoke(app, ["run", "non_existing_file.py"])
assert result.exit_code == 1, result.output
assert "Path does not exist non_existing_file.py" in result.output
def test_dev_help() -> None:
result = runner.invoke(app, ["dev", "--help"])
assert result.exit_code == 0, result.output
assert "Run a FastAPI app in development mode." in result.output
assert (
"This is equivalent to fastapi run but with reload enabled and listening on the 127.0.0.1 address."
in result.output
)
assert (
"Otherwise, it uses the first FastAPI app found in the imported module or package."
in result.output
)
assert "A path to a Python file or package directory" in result.output
assert "The host to serve on." in result.output
assert "The port to serve on." in result.output
assert "Enable auto-reload of the server when (code) files change." in result.output
assert "The root path is used to tell your app" in result.output
assert "The name of the variable that contains the FastAPI app" in result.output
assert "Use multiple worker processes." not in result.output
def test_run_help() -> None:
result = runner.invoke(app, ["run", "--help"])
assert result.exit_code == 0, result.output
assert "Run a FastAPI app in production mode." in result.output
assert (
"This is equivalent to fastapi dev but with reload disabled and listening on the 0.0.0.0 address."
in result.output
)
assert (
"Otherwise, it uses the first FastAPI app found in the imported module or package."
in result.output
)
assert "A path to a Python file or package directory" in result.output
assert "The host to serve on." in result.output
assert "The port to serve on." in result.output
assert "Enable auto-reload of the server when (code) files change." in result.output
assert "The root path is used to tell your app" in result.output
assert "The name of the variable that contains the FastAPI app" in result.output
assert "Use multiple worker processes." in result.output
def test_callback_help() -> None:
result = runner.invoke(app, ["--help"])
assert result.exit_code == 0, result.output
assert "FastAPI CLI - The fastapi command line app." in result.output
assert "Show the version and exit." in result.output
def test_version() -> None:
result = runner.invoke(app, ["--version"])
assert result.exit_code == 0, result.output
assert "FastAPI CLI version:" in result.output
def test_script() -> None:
result = subprocess.run(
[sys.executable, "-m", "coverage", "run", "-m", "fastapi_cli", "--help"],
capture_output=True,
encoding="utf-8",
)
assert "Usage" in result.stdout
def test_dev_and_fastapi_app_with_docs_url_set_should_show_correctly_url_in_stdout() -> (
None
):
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["dev", "with_docs_url_set.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "with_docs_url_set:app",
"host": "127.0.0.1",
"port": 8000,
"reload": True,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string with_docs_url_set:app" in result.output
assert (
"╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
)
assert "│ Serving at: http://127.0.0.1:8000" in result.output
assert "│ API docs: http://127.0.0.1:8000/any-other-path" in result.output
assert "│ Running in development mode, for production use:" in result.output
assert "│ fastapi run" in result.output
def test_dev_and_fastapi_app_without_docs_url_set_should_show_default_url_in_stdout() -> (
None
):
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["dev", "without_docs_url_set.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "without_docs_url_set:app",
"host": "127.0.0.1",
"port": 8000,
"reload": True,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string without_docs_url_set:app" in result.output
assert (
"╭────────── FastAPI CLI - Development mode ───────────╮" in result.output
)
assert "│ Serving at: http://127.0.0.1:8000" in result.output
assert "│ API docs: http://127.0.0.1:8000/docs" in result.output
assert "│ Running in development mode, for production use:" in result.output
assert "│ fastapi run" in result.output
def test_run_and_fastapi_app_with_docs_url_set_should_show_correctly_url_in_stdout() -> (
None
):
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["run", "with_docs_url_set.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "with_docs_url_set:app",
"host": "0.0.0.0",
"port": 8000,
"reload": False,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string with_docs_url_set:app" in result.output
assert (
"╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
)
assert "│ Serving at: http://0.0.0.0:8000" in result.output
assert "│ API docs: http://0.0.0.0:8000/any-other-path" in result.output
assert "│ Running in production mode, for development use:" in result.output
assert "│ fastapi dev" in result.output
def test_run_and_fastapi_app_without_docs_url_set_should_show_default_url_in_stdout() -> (
None
):
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["run", "without_docs_url_set.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "without_docs_url_set:app",
"host": "0.0.0.0",
"port": 8000,
"reload": False,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string without_docs_url_set:app" in result.output
assert (
"╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
)
assert "│ Serving at: http://0.0.0.0:8000" in result.output
assert "│ API docs: http://0.0.0.0:8000/docs" in result.output
assert "│ Running in production mode, for development use:" in result.output
assert "│ fastapi dev" in result.output
def test_run_and_fastapi_app_docs_url_set_to_none_should_not_show_api_docs_section() -> (
None
):
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["run", "without_docs_url_none.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "without_docs_url_none:app",
"host": "0.0.0.0",
"port": 8000,
"reload": False,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string without_docs_url_none:app" in result.output
assert (
"╭─────────── FastAPI CLI - Production mode ───────────╮" in result.output
)
assert "│ Serving at: http://0.0.0.0:8000" in result.output
assert "│ Running in production mode, for development use:" in result.output
assert "│ fastapi dev" in result.output
assert "│ API docs" not in result.output
def test_dev_and_fastapi_app_docs_url_set_to_none_should_not_show_api_docs_section() -> (
None
):
with changing_dir(assets_path):
with patch.object(uvicorn, "run") as mock_run:
result = runner.invoke(app, ["dev", "without_docs_url_none.py"])
assert result.exit_code == 0, result.output
assert mock_run.called
assert mock_run.call_args
assert mock_run.call_args.kwargs == {
"app": "without_docs_url_none:app",
"host": "127.0.0.1",
"port": 8000,
"reload": True,
"workers": None,
"root_path": "",
"proxy_headers": True,
}
assert "Using import string without_docs_url_none:app" in result.output
assert (
"╭────────── FastAPI CLI - Development mode ───────────"
) in result.output
assert "│ Serving at: http://127.0.0.1:8000" in result.output
assert "│ Running in development mode, for production use:" in result.output
assert "│ fastapi run" in result.output
assert "│ API docs" not in result.output