-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathtest_cli.py
More file actions
543 lines (464 loc) · 14.9 KB
/
Copy pathtest_cli.py
File metadata and controls
543 lines (464 loc) · 14.9 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
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
import os
from pathlib import Path
import pytest
from create_awesome_python_app import __version__
from create_awesome_python_app.cli import app
from typer.testing import CliRunner
runner = CliRunner()
def test_version() -> None:
result = runner.invoke(app, ["--version"])
assert result.exit_code == 0
combined = result.stdout + result.stderr
assert __version__ in combined
def test_help() -> None:
result = runner.invoke(app, ["--help"])
assert result.exit_code == 0
assert "Scaffold" in result.stdout or "create" in result.stdout.lower()
def test_refresh_flag_is_forwarded(tmp_path: Path, monkeypatch) -> None:
tpl = tmp_path / "tpl"
tpl.mkdir()
captured: dict[str, object] = {}
async def fake_check_for_latest_version(_package_name):
return None
async def fake_create_python_app(project_directory, options, *_args, **_kwargs):
captured["project_directory"] = project_directory
captured["options"] = options
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.cli.create_python_app",
fake_create_python_app,
)
result = runner.invoke(
app,
[
"--template",
f"file://{tpl}",
"--refresh",
"always",
"--no-install",
"--no-interactive",
"api",
],
)
assert result.exit_code == 0, result.stdout + result.stderr
options = captured["options"]
assert isinstance(options, dict)
assert options["refresh"] == "always"
def test_invalid_refresh_mode_fails(tmp_path: Path) -> None:
tpl = tmp_path / "tpl"
tpl.mkdir()
result = runner.invoke(
app,
[
"--template",
f"file://{tpl}",
"--refresh",
"bogus",
"--no-install",
"--no-interactive",
"api",
],
)
assert result.exit_code == 2
assert "Invalid --refresh mode" in result.stdout + result.stderr
def test_no_cache_sets_explicit_refresh(tmp_path: Path, monkeypatch) -> None:
tpl = tmp_path / "tpl"
tpl.mkdir()
captured: dict[str, object] = {}
async def fake_check_for_latest_version(_package_name):
return None
async def fake_create_python_app(project_directory, options, *_args, **_kwargs):
captured["project_directory"] = project_directory
captured["options"] = options
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.cli.create_python_app",
fake_create_python_app,
)
result = runner.invoke(
app,
[
"--template",
f"file://{tpl}",
"--no-cache",
"--no-install",
"--no-interactive",
"api",
],
)
assert result.exit_code == 0, result.stdout + result.stderr
options = captured["options"]
assert isinstance(options, dict)
assert options["refresh"] == "always"
def test_pin_appends_ref_to_template_url(tmp_path: Path, monkeypatch) -> None:
tpl = tmp_path / "tpl"
tpl.mkdir()
captured: dict[str, object] = {}
async def fake_check_for_latest_version(_package_name):
return None
async def fake_create_python_app(project_directory, options, *_args, **_kwargs):
captured["project_directory"] = project_directory
captured["options"] = options
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.cli.create_python_app",
fake_create_python_app,
)
result = runner.invoke(
app,
[
"--template",
f"file://{tpl}",
"--pin",
"abc123",
"--no-install",
"--no-interactive",
"api",
],
)
assert result.exit_code == 0, result.stdout + result.stderr
options = captured["options"]
assert isinstance(options, dict)
assert options["template"] == f"file://{tpl}?ref=abc123"
def test_incompatible_addons_fail_fast(tmp_path: Path, monkeypatch) -> None:
tpl = tmp_path / "tpl"
tpl.mkdir()
catalog = {
"templates": [
{"slug": "fastapi-starter", "url": f"file://{tpl}"},
],
"extensions": [
{
"slug": "saga",
"url": "file:///ext/saga",
"incompatibleWith": ["thunk"],
},
{
"slug": "thunk",
"url": "file:///ext/thunk",
"incompatibleWith": ["saga"],
},
],
}
async def fake_check_for_latest_version(_package_name):
return None
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.catalog.get_catalog_data",
lambda: catalog,
)
result = runner.invoke(
app,
[
"--template",
"fastapi-starter",
"--addons",
"saga",
"--addons",
"thunk",
"--no-install",
"--no-interactive",
"api",
],
)
text = (result.stdout or "") + (result.stderr or "")
assert result.exit_code == 2
assert "Incompatible extension combination" in text
assert "saga" in text
def test_help_mentions_fixture() -> None:
result = runner.invoke(app, ["--help"])
assert result.exit_code == 0
text = (result.stdout or "") + (result.stderr or "")
assert "fixture" in text.lower()
def test_options_after_project_directory(tmp_path: Path, monkeypatch) -> None:
"""Regression: README-style `cpa my-api --template …` must work.
Registering a Typer subcommand group made Click treat ``--template`` as a
COMMAND after the positional project directory.
"""
tpl = tmp_path / "tpl"
tpl.mkdir()
captured: dict[str, object] = {}
async def fake_check_for_latest_version(_package_name):
return None
async def fake_create_python_app(project_directory, options, *_args, **_kwargs):
captured["project_directory"] = project_directory
captured["options"] = options
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.cli.create_python_app",
fake_create_python_app,
)
result = runner.invoke(
app,
[
"my-api",
"--template",
f"file://{tpl}",
"--addons",
"github-setup",
"--no-install",
"--no-interactive",
],
)
text = (result.stdout or "") + (result.stderr or "")
assert result.exit_code == 0, text
assert "No such command" not in text
assert captured["project_directory"] == "my-api"
options = captured["options"]
assert isinstance(options, dict)
assert options["template"] == f"file://{tpl}"
def test_expand_variadic_addons_and_extend() -> None:
from create_awesome_python_app.cli import (
_expand_variadic_option,
_preprocess_cli_argv,
)
assert _expand_variadic_option(
["cpa", "my-api", "--addons", "fastapi-docker", "github-setup", "--no-install"],
"--addons",
) == [
"cpa",
"my-api",
"--addons",
"fastapi-docker",
"--addons",
"github-setup",
"--no-install",
]
assert _preprocess_cli_argv(
[
"cpa",
"my-api",
"--template",
"fastapi-starter",
"--addons",
"fastapi-docker",
"github-setup",
"--extend",
"a",
"b",
"--no-interactive",
]
) == [
"cpa",
"my-api",
"--template",
"fastapi-starter",
"--addons",
"fastapi-docker",
"--addons",
"github-setup",
"--extend",
"a",
"--extend",
"b",
"--no-interactive",
]
def test_expand_preserves_trailing_project_directory() -> None:
"""Repeated ``--addons`` with directory last must not swallow the path."""
from create_awesome_python_app.cli import _preprocess_cli_argv
assert _preprocess_cli_argv(
[
"cpa",
"--addons",
"github-setup",
"--addons",
"fastapi-docker",
"/tmp/app",
]
) == [
"cpa",
"--addons",
"github-setup",
"--addons",
"fastapi-docker",
"/tmp/app",
]
# CI-shaped argv: flags between last addon and directory.
assert (
_preprocess_cli_argv(
[
"cpa",
"--template",
"fastapi-starter",
"--addons",
"fastapi-docker",
"--addons",
"github-setup",
"--no-interactive",
"--no-install",
"--force",
"/tmp/app",
]
)[-1]
== "/tmp/app"
)
# Space-separated addons with directory last (no prior positional).
assert _preprocess_cli_argv(
["cpa", "--addons", "fastapi-docker", "github-setup", "/tmp/app"]
) == [
"cpa",
"--addons",
"fastapi-docker",
"--addons",
"github-setup",
"/tmp/app",
]
def test_space_separated_addons_after_project_directory(
tmp_path: Path, monkeypatch
) -> None:
"""CNA parity: ``--addons fastapi-docker github-setup`` (one flag, many values)."""
from create_awesome_python_app.cli import _preprocess_cli_argv
tpl = tmp_path / "tpl"
tpl.mkdir()
captured: dict[str, object] = {}
async def fake_check_for_latest_version(_package_name):
return None
async def fake_create_python_app(project_directory, options, *_args, **_kwargs):
captured["project_directory"] = project_directory
captured["options"] = options
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.cli.create_python_app",
fake_create_python_app,
)
argv = _preprocess_cli_argv(
[
"cpa",
"my-api",
"--template",
f"file://{tpl}",
"--addons",
"fastapi-docker",
"github-setup",
"--no-install",
"--no-interactive",
]
)
result = runner.invoke(app, argv[1:])
text = (result.stdout or "") + (result.stderr or "")
assert result.exit_code == 0, text
assert "unexpected extra argument" not in text.lower()
options = captured["options"]
assert isinstance(options, dict)
addons = options["addons"]
assert isinstance(addons, list)
assert len(addons) == 2
assert any("fastapi-docker" in a for a in addons)
assert any("github-setup" in a for a in addons)
def test_repeated_addons_with_directory_last(tmp_path: Path, monkeypatch) -> None:
"""``--addons a --addons b <dir>`` must keep ``<dir>`` as project_directory."""
from create_awesome_python_app.cli import _preprocess_cli_argv
tpl = tmp_path / "tpl"
tpl.mkdir()
target = tmp_path / "app"
captured: dict[str, object] = {}
async def fake_check_for_latest_version(_package_name):
return None
async def fake_create_python_app(project_directory, options, *_args, **_kwargs):
captured["project_directory"] = project_directory
captured["options"] = options
monkeypatch.setattr(
"create_awesome_python_app.cli.check_for_latest_version",
fake_check_for_latest_version,
)
monkeypatch.setattr(
"create_awesome_python_app.cli.create_python_app",
fake_create_python_app,
)
argv = _preprocess_cli_argv(
[
"cpa",
"--template",
f"file://{tpl}",
"--addons",
"fastapi-docker",
"--addons",
"github-setup",
"--no-install",
"--no-interactive",
str(target),
]
)
result = runner.invoke(app, argv[1:])
text = (result.stdout or "") + (result.stderr or "")
assert result.exit_code == 0, text
assert captured["project_directory"] == str(target)
options = captured["options"]
assert isinstance(options, dict)
addons = options["addons"]
assert isinstance(addons, list)
assert len(addons) == 2
assert not any(str(target) in a for a in addons)
def test_preprocess_fixture_argv_bare_and_with_dir() -> None:
from create_awesome_python_app.cli import _FIXTURE_AUTO, _preprocess_fixture_argv
assert _preprocess_fixture_argv(["cpa", "--fixture", "--list-templates"]) == [
"cpa",
f"--fixture={_FIXTURE_AUTO}",
"--list-templates",
]
assert _preprocess_fixture_argv(
["cpa", "--fixture", "./my-fixtures", "--list-templates"]
) == ["cpa", "--fixture", "./my-fixtures", "--list-templates"]
def test_fixture_flag_enables_catalog_fixture(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
from create_awesome_python_app.cli import _FIXTURE_AUTO, apply_fixture_mode
apply_fixture_mode(_FIXTURE_AUTO)
assert os.environ.get("CPA_CATALOG_FIXTURE") == "1"
assert "CPA_FIXTURE_DIR" not in os.environ
monkeypatch.delenv("CPA_CATALOG_FIXTURE", raising=False)
monkeypatch.delenv("CPA_FIXTURE_DIR", raising=False)
apply_fixture_mode(str(tmp_path))
assert os.environ.get("CPA_CATALOG_FIXTURE") == "1"
assert os.environ.get("CPA_FIXTURE_DIR") == str(tmp_path)
def test_list_templates_with_fixture_dir(
tmp_path: Path, monkeypatch: pytest.MonkeyPatch
) -> None:
import json
import os
catalog_dir = tmp_path / "fixtures" / "catalog"
catalog_dir.mkdir(parents=True)
(catalog_dir / "templates.json").write_text(
json.dumps(
{
"templates": [
{
"slug": "fixture-only",
"category": "tooling",
"type": "cli",
}
],
"extensions": [],
"categories": [],
}
),
encoding="utf-8",
)
monkeypatch.delenv("CPA_CATALOG_FIXTURE", raising=False)
monkeypatch.delenv("CPA_FIXTURE_DIR", raising=False)
result = runner.invoke(
app,
["--fixture", str(tmp_path), "--list-templates"],
)
text = (result.stdout or "") + (result.stderr or "")
assert result.exit_code == 0, text
assert "fixture-only" in text
assert os.environ.get("CPA_CATALOG_FIXTURE") == "1"