dinemic-cli 0.0.19__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. dinemic_cli/__init__.py +1 -0
  2. dinemic_cli/__main__.py +16 -0
  3. dinemic_cli/client.py +75 -0
  4. dinemic_cli/commands/__init__.py +0 -0
  5. dinemic_cli/commands/auth.py +31 -0
  6. dinemic_cli/commands/caa.py +11 -0
  7. dinemic_cli/commands/cert.py +29 -0
  8. dinemic_cli/commands/cert_peer.py +37 -0
  9. dinemic_cli/commands/dns_entry.py +57 -0
  10. dinemic_cli/commands/dns_value.py +43 -0
  11. dinemic_cli/commands/dns_zone.py +98 -0
  12. dinemic_cli/commands/endpoint.py +39 -0
  13. dinemic_cli/commands/healthcheck.py +40 -0
  14. dinemic_cli/commands/loadbalancer.py +39 -0
  15. dinemic_cli/commands/loadbalancer_backend.py +44 -0
  16. dinemic_cli/commands/loadbalancer_host.py +37 -0
  17. dinemic_cli/commands/loadbalancer_route.py +42 -0
  18. dinemic_cli/commands/network.py +34 -0
  19. dinemic_cli/commands/node.py +29 -0
  20. dinemic_cli/commands/peer.py +33 -0
  21. dinemic_cli/commands/peer_config.py +33 -0
  22. dinemic_cli/commands/project.py +58 -0
  23. dinemic_cli/commands/quota.py +22 -0
  24. dinemic_cli/main.py +68 -0
  25. dinemic_cli/output.py +25 -0
  26. dinemic_cli-0.0.19.dist-info/METADATA +13 -0
  27. dinemic_cli-0.0.19.dist-info/RECORD +63 -0
  28. dinemic_cli-0.0.19.dist-info/WHEEL +5 -0
  29. dinemic_cli-0.0.19.dist-info/entry_points.txt +2 -0
  30. dinemic_cli-0.0.19.dist-info/licenses/LICENSE +696 -0
  31. dinemic_cli-0.0.19.dist-info/top_level.txt +2 -0
  32. tests/01-cli-fixes.patch +418 -0
  33. tests/02-tests-after-fixes.patch +208 -0
  34. tests/api_samples.py +214 -0
  35. tests/cert_peer.py +37 -0
  36. tests/cli_runner.py +113 -0
  37. tests/command_matrix.py +612 -0
  38. tests/conftest.py +235 -0
  39. tests/dns_entry.py +41 -0
  40. tests/dns_value.py +43 -0
  41. tests/dns_zone.py +38 -0
  42. tests/endpoint.py +39 -0
  43. tests/healthcheck.py +40 -0
  44. tests/loadbalancer.py +36 -0
  45. tests/loadbalancer_backend.py +44 -0
  46. tests/loadbalancer_host.py +37 -0
  47. tests/loadbalancer_route.py +42 -0
  48. tests/network.py +34 -0
  49. tests/network_node.py +74 -0
  50. tests/node.py +23 -0
  51. tests/peer.py +33 -0
  52. tests/project.py +58 -0
  53. tests/support.py +246 -0
  54. tests/test_auth.py +114 -0
  55. tests/test_columns.py +58 -0
  56. tests/test_commands.py +98 -0
  57. tests/test_confirmations.py +71 -0
  58. tests/test_envvars.py +119 -0
  59. tests/test_error_handling.py +83 -0
  60. tests/test_lifecycle.py +188 -0
  61. tests/test_network_node.py +116 -0
  62. tests/test_option_contract.py +335 -0
  63. tests/test_smoke.py +83 -0
@@ -0,0 +1,612 @@
1
+ """A declarative map of the whole CLI: command -> API call.
2
+
3
+ One source of truth for the tests. The same table drives:
4
+
5
+ * ``test_commands.py`` — does the command hit the right method/path/payload,
6
+ * ``test_columns.py`` — do the rendered columns exist in the API response,
7
+ * ``test_confirmations.py`` — does ``delete`` ask for confirmation,
8
+ * ``test_smoke.py`` / ``test_lifecycle.py`` — do those paths and fields exist at all.
9
+
10
+ Add a command to the CLI -> add one row here.
11
+ """
12
+
13
+ from __future__ import annotations
14
+
15
+ from dataclasses import dataclass, field
16
+ from typing import Any
17
+
18
+ import api_samples as s
19
+
20
+ CERT_COLUMNS = [
21
+ "id",
22
+ "project",
23
+ "common_name",
24
+ "status",
25
+ "domains",
26
+ "not_before",
27
+ "not_after",
28
+ "expires_in_days",
29
+ "issued_at",
30
+ "needs_renewal",
31
+ "delivered_to",
32
+ "attempts",
33
+ "error",
34
+ ]
35
+
36
+ NODE_COLUMNS = [
37
+ "id",
38
+ "project",
39
+ "public_key",
40
+ "description",
41
+ "created",
42
+ "sync_time",
43
+ "state",
44
+ "ipv4_address",
45
+ "ipv6_address",
46
+ "continent_code",
47
+ "country_code",
48
+ "city_name",
49
+ ]
50
+
51
+
52
+ @dataclass(frozen=True)
53
+ class Case:
54
+ """One CLI command and the API call it is expected to make."""
55
+
56
+ id: str
57
+ module: str
58
+ args: tuple[str, ...]
59
+ method: str
60
+ path: str
61
+ kind: str # list | create | delete | other
62
+ payload: dict[str, Any] | None = None
63
+ params: dict[str, Any] = field(default_factory=dict)
64
+ columns: list[str] | None = None
65
+ #: when set, the test becomes xfail(strict=True); remove once the bug is fixed
66
+ xfail: str | None = None
67
+
68
+
69
+ CASES: list[Case] = [
70
+ # ------------------------------------------------------------------ project
71
+ Case(
72
+ id="project-list",
73
+ module="project",
74
+ args=("list",),
75
+ method="GET",
76
+ path="/project/",
77
+ kind="list",
78
+ columns=["id", "name", "public_key", "auto_accept_nodes"],
79
+ ),
80
+ Case(
81
+ id="project-create",
82
+ module="project",
83
+ args=("create", "-n", "projekt1"),
84
+ method="POST",
85
+ path="/project/",
86
+ kind="create",
87
+ payload={"name": "projekt1"},
88
+ ),
89
+ Case(
90
+ id="project-delete",
91
+ module="project",
92
+ args=("delete", "-p", s.PROJECT_ID, "-y"),
93
+ method="DELETE",
94
+ path=f"/project/{s.PROJECT_ID}/",
95
+ kind="delete",
96
+ ),
97
+ Case(
98
+ id="project-configure",
99
+ module="project",
100
+ args=("configure", "-p", s.PROJECT_ID),
101
+ method="GET",
102
+ path=f"/project/{s.PROJECT_ID}/",
103
+ kind="other",
104
+ ),
105
+ # ------------------------------------------------------------------ network
106
+ Case(
107
+ id="network-list",
108
+ module="network",
109
+ args=("list",),
110
+ method="GET",
111
+ path="/network/",
112
+ kind="list",
113
+ params={"project": None},
114
+ columns=["id", "name", "project", "ip_address", "ip_netmask"],
115
+ ),
116
+ Case(
117
+ id="network-list-filtered",
118
+ module="network",
119
+ args=("list", "-p", s.PROJECT_ID),
120
+ method="GET",
121
+ path="/network/",
122
+ kind="list",
123
+ params={"project": s.PROJECT_ID},
124
+ columns=["id", "name", "project", "ip_address", "ip_netmask"],
125
+ ),
126
+ Case(
127
+ id="network-create",
128
+ module="network",
129
+ args=(
130
+ "create",
131
+ "-p",
132
+ s.PROJECT_ID,
133
+ "-n",
134
+ "mesh",
135
+ "-i",
136
+ "10.0.0.0",
137
+ "-m",
138
+ "255.255.255.0",
139
+ ),
140
+ method="POST",
141
+ path="/network/",
142
+ kind="create",
143
+ payload={
144
+ "project": s.PROJECT_ID,
145
+ "name": "mesh",
146
+ "ip_address": "10.0.0.0",
147
+ "ip_netmask": "255.255.255.0",
148
+ },
149
+ ),
150
+ Case(
151
+ id="network-delete",
152
+ module="network",
153
+ args=("delete", "-n", s.NETWORK_ID, "-y"),
154
+ method="DELETE",
155
+ path=f"/network/{s.NETWORK_ID}/",
156
+ kind="delete",
157
+ ),
158
+ # --------------------------------------------------------------------- node
159
+ Case(
160
+ id="node-list",
161
+ module="node",
162
+ args=("list",),
163
+ method="GET",
164
+ path="/node/",
165
+ kind="list",
166
+ params={"project": None},
167
+ columns=NODE_COLUMNS,
168
+ ),
169
+ Case(
170
+ id="node-delete",
171
+ module="node",
172
+ args=("delete", "-n", s.NODE_ID, "-y"),
173
+ method="DELETE",
174
+ path=f"/node/{s.NODE_ID}/",
175
+ kind="delete",
176
+ ),
177
+ # --------------------------------------------------------------------- peer
178
+ Case(
179
+ id="peer-list",
180
+ module="peer",
181
+ args=("list",),
182
+ method="GET",
183
+ path="/peer/",
184
+ kind="list",
185
+ params={"project": None},
186
+ columns=[
187
+ "id",
188
+ "node",
189
+ "network",
190
+ "network_node",
191
+ "ipv4_address",
192
+ "service_port",
193
+ "role",
194
+ ],
195
+ ),
196
+ Case(
197
+ id="peer-create",
198
+ module="peer",
199
+ args=("create", "-N", s.NODE_ID, "-n", s.NETWORK_ID, "-c", s.LB_ID),
200
+ method="POST",
201
+ path="/peer/",
202
+ kind="create",
203
+ payload={"network": s.NETWORK_ID, "node": s.NODE_ID, "config": s.LB_ID},
204
+ ),
205
+ Case(
206
+ id="peer-delete",
207
+ module="peer",
208
+ args=("delete", "-p", s.PEER_ID, "-y"),
209
+ method="DELETE",
210
+ path=f"/peer/{s.PEER_ID}/",
211
+ kind="delete",
212
+ ),
213
+ # ----------------------------------------------------------------- endpoint
214
+ Case(
215
+ id="endpoint-list",
216
+ module="endpoint",
217
+ args=("list",),
218
+ method="GET",
219
+ path="/endpoint/",
220
+ kind="list",
221
+ params={"project": None},
222
+ columns=["id", "project", "name", "scheme", "host", "port"],
223
+ ),
224
+ Case(
225
+ id="endpoint-create",
226
+ module="endpoint",
227
+ args=(
228
+ "create",
229
+ "-p",
230
+ s.PROJECT_ID,
231
+ "-n",
232
+ "api-backend",
233
+ "-s",
234
+ "HTTP",
235
+ "-H",
236
+ "127.0.0.1",
237
+ "-P",
238
+ "8080",
239
+ ),
240
+ method="POST",
241
+ path="/endpoint/",
242
+ kind="create",
243
+ payload={
244
+ "project": s.PROJECT_ID,
245
+ "name": "api-backend",
246
+ "scheme": "HTTP",
247
+ "host": "127.0.0.1",
248
+ "port": 8080,
249
+ "tags": [],
250
+ },
251
+ ),
252
+ Case(
253
+ id="endpoint-delete",
254
+ module="endpoint",
255
+ args=("delete", "-e", s.ENDPOINT_ID, "-y"),
256
+ method="DELETE",
257
+ path=f"/endpoint/{s.ENDPOINT_ID}/",
258
+ kind="delete",
259
+ ),
260
+ # -------------------------------------------------------------- healthcheck
261
+ Case(
262
+ id="healthcheck-list",
263
+ module="healthcheck",
264
+ args=("list",),
265
+ method="GET",
266
+ path="/healthcheck/",
267
+ kind="list",
268
+ params={"project": None},
269
+ columns=["id", "name", "project", "path", "period", "max_fail", "initial_delay"],
270
+ ),
271
+ Case(
272
+ id="healthcheck-create",
273
+ module="healthcheck",
274
+ args=(
275
+ "create",
276
+ "-p",
277
+ s.PROJECT_ID,
278
+ "-n",
279
+ "http-ok",
280
+ "-P",
281
+ "/healthz",
282
+ "-d",
283
+ "10",
284
+ "-m",
285
+ "3",
286
+ "-i",
287
+ "30",
288
+ ),
289
+ method="POST",
290
+ path="/healthcheck/",
291
+ kind="create",
292
+ payload={
293
+ "project": s.PROJECT_ID,
294
+ "name": "http-ok",
295
+ "path": "/healthz",
296
+ "period": 10,
297
+ "max_fail": 3,
298
+ "initial_delay": 30,
299
+ },
300
+ ),
301
+ Case(
302
+ id="healthcheck-delete",
303
+ module="healthcheck",
304
+ args=("delete", "-H", s.HEALTHCHECK_ID, "-y"),
305
+ method="DELETE",
306
+ path=f"/healthcheck/{s.HEALTHCHECK_ID}/",
307
+ kind="delete",
308
+ ),
309
+ # ------------------------------------------------------------- loadbalancer
310
+ Case(
311
+ id="lb-list",
312
+ module="loadbalancer",
313
+ args=("list",),
314
+ method="GET",
315
+ path="/loadbalancer/",
316
+ kind="list",
317
+ params={"project": None},
318
+ columns=["id", "name", "project"],
319
+ ),
320
+ Case(
321
+ id="lb-create",
322
+ module="loadbalancer",
323
+ args=("create", "-p", s.PROJECT_ID, "-n", "lb-eu"),
324
+ method="POST",
325
+ path="/loadbalancer/",
326
+ kind="create",
327
+ payload={"project": s.PROJECT_ID, "name": "lb-eu"},
328
+ ),
329
+ Case(
330
+ id="lb-delete",
331
+ module="loadbalancer",
332
+ args=("delete", "-l", s.LB_ID, "-y"),
333
+ method="DELETE",
334
+ path=f"/loadbalancer/{s.LB_ID}/",
335
+ kind="delete",
336
+ ),
337
+ Case(
338
+ id="lb-host-list",
339
+ module="loadbalancer_host",
340
+ args=("list", "-l", s.LB_ID),
341
+ method="GET",
342
+ path=f"/loadbalancer/{s.LB_ID}/host/",
343
+ kind="list",
344
+ columns=["id", "domain"],
345
+ ),
346
+ Case(
347
+ id="lb-host-create",
348
+ module="loadbalancer_host",
349
+ args=("create", "-l", s.LB_ID, "-d", s.ZONE_ID),
350
+ method="POST",
351
+ path=f"/loadbalancer/{s.LB_ID}/host/",
352
+ kind="create",
353
+ payload={"domain": s.ZONE_ID},
354
+ ),
355
+ Case(
356
+ id="lb-host-delete",
357
+ module="loadbalancer_host",
358
+ args=("delete", "-l", s.LB_ID, "-H", s.HOST_ID, "-y"),
359
+ method="DELETE",
360
+ path=f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/",
361
+ kind="delete",
362
+ ),
363
+ Case(
364
+ id="lb-route-list",
365
+ module="loadbalancer_route",
366
+ args=("list", "-l", s.LB_ID, "-H", s.HOST_ID),
367
+ method="GET",
368
+ path=f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/route/",
369
+ kind="list",
370
+ columns=["id", "path", "host", "healthcheck", "priority"],
371
+ ),
372
+ Case(
373
+ id="lb-route-create",
374
+ module="loadbalancer_route",
375
+ args=(
376
+ "create",
377
+ "-l",
378
+ s.LB_ID,
379
+ "-H",
380
+ s.HOST_ID,
381
+ "-p",
382
+ "/",
383
+ "-P",
384
+ "10",
385
+ "-k",
386
+ s.HEALTHCHECK_ID,
387
+ ),
388
+ method="POST",
389
+ path=f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/route/",
390
+ kind="create",
391
+ payload={"path": "/", "priority": 10, "healthcheck": s.HEALTHCHECK_ID},
392
+ ),
393
+ Case(
394
+ id="lb-route-delete",
395
+ module="loadbalancer_route",
396
+ args=("delete", "-l", s.LB_ID, "-H", s.HOST_ID, "-r", s.ROUTE_ID, "-y"),
397
+ method="DELETE",
398
+ path=f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/route/{s.ROUTE_ID}/",
399
+ kind="delete",
400
+ ),
401
+ Case(
402
+ id="lb-backend-list",
403
+ module="loadbalancer_backend",
404
+ args=("list", "-l", s.LB_ID, "-H", s.HOST_ID, "-r", s.ROUTE_ID),
405
+ method="GET",
406
+ path=f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/route/{s.ROUTE_ID}/backend/",
407
+ kind="list",
408
+ columns=["id", "endpoint", "weight", "route"],
409
+ ),
410
+ Case(
411
+ id="lb-backend-create",
412
+ module="loadbalancer_backend",
413
+ args=(
414
+ "create",
415
+ "-l",
416
+ s.LB_ID,
417
+ "-H",
418
+ s.HOST_ID,
419
+ "-r",
420
+ s.ROUTE_ID,
421
+ "-e",
422
+ s.ENDPOINT_ID,
423
+ "-w",
424
+ "1",
425
+ ),
426
+ method="POST",
427
+ path=f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/route/{s.ROUTE_ID}/backend/",
428
+ kind="create",
429
+ payload={"endpoint": s.ENDPOINT_ID, "weight": 1},
430
+ ),
431
+ Case(
432
+ id="lb-backend-delete",
433
+ module="loadbalancer_backend",
434
+ args=(
435
+ "delete",
436
+ "-l",
437
+ s.LB_ID,
438
+ "-H",
439
+ s.HOST_ID,
440
+ "-r",
441
+ s.ROUTE_ID,
442
+ "-b",
443
+ s.BACKEND_ID,
444
+ "-y",
445
+ ),
446
+ method="DELETE",
447
+ path=(
448
+ f"/loadbalancer/{s.LB_ID}/host/{s.HOST_ID}/route/{s.ROUTE_ID}"
449
+ f"/backend/{s.BACKEND_ID}/"
450
+ ),
451
+ kind="delete",
452
+ ),
453
+ # ---------------------------------------------------------------------- dns
454
+ Case(
455
+ id="zone-list",
456
+ module="dns_zone",
457
+ args=("list",),
458
+ method="GET",
459
+ path="/zone/",
460
+ kind="list",
461
+ params={"project": None},
462
+ columns=["id", "domain", "project"],
463
+ ),
464
+ Case(
465
+ id="zone-create",
466
+ module="dns_zone",
467
+ args=(
468
+ "create",
469
+ "-d",
470
+ "example.com",
471
+ "-p",
472
+ s.PROJECT_ID,
473
+ "-c",
474
+ s.CAA_ID,
475
+ "-n",
476
+ "example.com",
477
+ ),
478
+ method="POST",
479
+ path="/zone/",
480
+ kind="create",
481
+ payload={
482
+ "domain": "example.com",
483
+ "project": s.PROJECT_ID,
484
+ "valid_caa": [s.CAA_ID],
485
+ "name": "example.com",
486
+ },
487
+ ),
488
+ Case(
489
+ id="zone-delete",
490
+ module="dns_zone",
491
+ args=("delete", "-z", s.ZONE_ID, "-y"),
492
+ method="DELETE",
493
+ path=f"/zone/{s.ZONE_ID}/",
494
+ kind="delete",
495
+ ),
496
+ Case(
497
+ id="entry-list",
498
+ module="dns_entry",
499
+ args=("list", "-z", s.ZONE_ID),
500
+ method="GET",
501
+ path=f"/zone/{s.ZONE_ID}/entry/",
502
+ kind="list",
503
+ columns=["id", "record", "type", "ttl"],
504
+ ),
505
+ Case(
506
+ id="entry-create",
507
+ module="dns_entry",
508
+ args=("create", "-z", s.ZONE_ID, "-r", "www", "-t", "A"),
509
+ method="POST",
510
+ path=f"/zone/{s.ZONE_ID}/entry/",
511
+ kind="create",
512
+ payload={"record": "www", "type": "A", "ttl": 300},
513
+ ),
514
+ Case(
515
+ id="entry-delete",
516
+ module="dns_entry",
517
+ args=("delete", "-z", s.ZONE_ID, "-r", s.ENTRY_ID, "-y"),
518
+ method="DELETE",
519
+ path=f"/zone/{s.ZONE_ID}/entry/{s.ENTRY_ID}/",
520
+ kind="delete",
521
+ ),
522
+ Case(
523
+ id="value-list",
524
+ module="dns_value",
525
+ args=("list", "-z", s.ZONE_ID, "-r", s.ENTRY_ID),
526
+ method="GET",
527
+ path=f"/zone/{s.ZONE_ID}/entry/{s.ENTRY_ID}/value/",
528
+ kind="list",
529
+ columns=["id", "value", "weight"],
530
+ ),
531
+ Case(
532
+ id="value-create",
533
+ module="dns_value",
534
+ args=("create", "-z", s.ZONE_ID, "-r", s.ENTRY_ID, "-v", "203.0.113.10"),
535
+ method="POST",
536
+ path=f"/zone/{s.ZONE_ID}/entry/{s.ENTRY_ID}/value/",
537
+ kind="create",
538
+ payload={"value": "203.0.113.10", "weight": 1},
539
+ ),
540
+ Case(
541
+ id="value-delete",
542
+ module="dns_value",
543
+ args=("delete", "-z", s.ZONE_ID, "-r", s.ENTRY_ID, "-v", s.VALUE_ID, "-y"),
544
+ method="DELETE",
545
+ path=f"/zone/{s.ZONE_ID}/entry/{s.ENTRY_ID}/value/{s.VALUE_ID}/",
546
+ kind="delete",
547
+ ),
548
+ # --------------------------------------------------------------------- cert
549
+ Case(
550
+ id="caa-list",
551
+ module="caa",
552
+ args=("list",),
553
+ method="GET",
554
+ path="/caa/",
555
+ kind="list",
556
+ columns=["id", "name"],
557
+ ),
558
+ Case(
559
+ id="cert-list",
560
+ module="cert",
561
+ args=("list",),
562
+ method="GET",
563
+ path="/certificate/",
564
+ kind="list",
565
+ columns=CERT_COLUMNS,
566
+ ),
567
+ Case(
568
+ id="cert-peer-list",
569
+ module="cert_peer",
570
+ args=("list",),
571
+ method="GET",
572
+ path="/certificate-peer/",
573
+ kind="list",
574
+ columns=[
575
+ "id",
576
+ "name",
577
+ "project",
578
+ "directory_url",
579
+ "email",
580
+ "max_parallel",
581
+ "dns_servers",
582
+ "lb_recipients",
583
+ ],
584
+ ),
585
+ Case(
586
+ id="cert-peer-create",
587
+ module="cert_peer",
588
+ args=("create", "-p", s.PROJECT_ID, "-n", "acme-1", "-m", "2"),
589
+ method="POST",
590
+ path="/certificate-peer/",
591
+ kind="create",
592
+ payload={
593
+ "project": s.PROJECT_ID,
594
+ "name": "acme-1",
595
+ "directory_url": "https://acme-v02.api.letsencrypt.org/directory",
596
+ "max_parallel": 2,
597
+ },
598
+ ),
599
+ Case(
600
+ id="cert-peer-delete",
601
+ module="cert_peer",
602
+ args=("delete", "-c", s.CERT_PEER_ID, "-y"),
603
+ method="DELETE",
604
+ path=f"/certificate-peer/{s.CERT_PEER_ID}/",
605
+ kind="delete",
606
+ ),
607
+ ]
608
+
609
+ BY_ID = {case.id: case for case in CASES}
610
+ LIST_CASES = [c for c in CASES if c.kind == "list"]
611
+ CREATE_CASES = [c for c in CASES if c.kind == "create"]
612
+ DELETE_CASES = [c for c in CASES if c.kind == "delete"]