flowbase-cli 0.1.2__tar.gz → 0.1.3__tar.gz

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.
@@ -0,0 +1,37 @@
1
+ Metadata-Version: 2.4
2
+ Name: flowbase-cli
3
+ Version: 0.1.3
4
+ Summary: Command line client for the FlowBase OpenAPI
5
+ Author: DeepFlowAI
6
+ License: Apache-2.0
7
+ Requires-Python: >=3.11
8
+ Description-Content-Type: text/markdown
9
+
10
+ # FlowBase CLI
11
+
12
+ Install from this checkout:
13
+
14
+ ```bash
15
+ python -m pip install ./packages/flowbase-cli
16
+ ```
17
+
18
+ Configure an environment Base URL and an API key:
19
+
20
+ ```bash
21
+ export FLOWBASE_HOST=https://flowbase-test-a.deepflowagent.com
22
+ export FLOWBASE_API_KEY=fbk_xxx
23
+
24
+ flowbase objects list
25
+ flowbase pages list --object-id obj_xxx
26
+ flowbase pages create --json-file page.json
27
+ flowbase records create obj_xxx --json '{"values":{"name":"Example"}}'
28
+ flowbase versions list --resource customer --change-type business-change
29
+ flowbase versions show abc1234
30
+ flowbase versions releases
31
+ flowbase changes commit --message "Add customer field" --yes
32
+ flowbase changes release --message "Release customer field" --yes
33
+ flowbase environments restart --confirm "A 测试环境" --yes
34
+ flowbase docs list
35
+ ```
36
+
37
+ `--host` selects the environment through its Host. Version history commands are read-only and limited to the history visible from that Host; production release records are available only on the production Host. A test release can succeed only when its current version meets FlowBase's fast-forward checks. `environments restart` first shows a destructive preflight and then clears the current test configuration and records before starting from the latest production version. The CLI never accepts a separate environment override and never stores API keys on disk. See `flowbase --help` and `flowbase docs list` for the complete command set.
@@ -0,0 +1,28 @@
1
+ # FlowBase CLI
2
+
3
+ Install from this checkout:
4
+
5
+ ```bash
6
+ python -m pip install ./packages/flowbase-cli
7
+ ```
8
+
9
+ Configure an environment Base URL and an API key:
10
+
11
+ ```bash
12
+ export FLOWBASE_HOST=https://flowbase-test-a.deepflowagent.com
13
+ export FLOWBASE_API_KEY=fbk_xxx
14
+
15
+ flowbase objects list
16
+ flowbase pages list --object-id obj_xxx
17
+ flowbase pages create --json-file page.json
18
+ flowbase records create obj_xxx --json '{"values":{"name":"Example"}}'
19
+ flowbase versions list --resource customer --change-type business-change
20
+ flowbase versions show abc1234
21
+ flowbase versions releases
22
+ flowbase changes commit --message "Add customer field" --yes
23
+ flowbase changes release --message "Release customer field" --yes
24
+ flowbase environments restart --confirm "A 测试环境" --yes
25
+ flowbase docs list
26
+ ```
27
+
28
+ `--host` selects the environment through its Host. Version history commands are read-only and limited to the history visible from that Host; production release records are available only on the production Host. A test release can succeed only when its current version meets FlowBase's fast-forward checks. `environments restart` first shows a destructive preflight and then clears the current test configuration and records before starting from the latest production version. The CLI never accepts a separate environment override and never stores API keys on disk. See `flowbase --help` and `flowbase docs list` for the complete command set.
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "flowbase-cli"
7
- version = "0.1.2"
7
+ version = "0.1.3"
8
8
  description = "Command line client for the FlowBase OpenAPI"
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.11"
@@ -1,3 +1,3 @@
1
1
  """FlowBase OpenAPI CLI."""
2
2
 
3
- __version__ = "0.1.2"
3
+ __version__ = "0.1.3"
@@ -30,6 +30,17 @@ ENDPOINTS = (
30
30
  Endpoint("fields.update", "flowbase_fields_update", "PUT", "/objects/{object_id}/fields/{field_id}", "metadata:write", "Update a field draft.", "flowbase fields update obj_xxx fld_xxx --label Name --description 'Customer name'"),
31
31
  Endpoint("fields.delete", "flowbase_fields_delete", "DELETE", "/objects/{object_id}/fields/{field_id}", "metadata:write", "Logically delete a field.", "flowbase fields delete obj_xxx fld_xxx --yes", True),
32
32
  Endpoint("fields.restore", "flowbase_fields_restore", "POST", "/objects/{object_id}/fields/{field_id}/restore", "metadata:write", "Restore a field.", "flowbase fields restore obj_xxx fld_xxx --yes", True),
33
+ Endpoint("pages.list", "flowbase_pages_list", "GET", "/pages", "metadata:read", "List custom Page metadata.", "flowbase pages list --object-id obj_xxx"),
34
+ Endpoint("pages.options", "flowbase_pages_options", "GET", "/pages/options", "metadata:read", "Get custom Page design options.", "flowbase pages options"),
35
+ Endpoint("pages.get", "flowbase_pages_get", "GET", "/pages/{page_id}", "metadata:read", "Get a custom Page.", "flowbase pages get pag_xxx"),
36
+ Endpoint("pages.create", "flowbase_pages_create", "POST", "/pages", "metadata:write", "Create a custom Page draft.", "flowbase pages create --json-file page.json"),
37
+ Endpoint("pages.update", "flowbase_pages_update", "PUT", "/pages/{page_id}", "metadata:write", "Update a custom Page draft.", "flowbase pages update pag_xxx --json-file page.json"),
38
+ Endpoint("pages.set-default", "flowbase_pages_set_default", "POST", "/pages/{page_id}/set-default", "metadata:write", "Set a default custom Page.", "flowbase pages set-default pag_xxx --base-revision 4 --yes", True),
39
+ Endpoint("pages.delete", "flowbase_pages_delete", "POST", "/pages/{page_id}/delete", "metadata:write", "Logically delete a custom Page.", "flowbase pages delete pag_xxx --base-revision 4 --yes", True),
40
+ Endpoint("pages.restore", "flowbase_pages_restore", "POST", "/pages/{page_id}/restore", "metadata:write", "Restore a custom Page.", "flowbase pages restore pag_xxx --base-revision 4 --yes", True),
41
+ Endpoint("versions.list", "flowbase_versions_list", "GET", "/versions", "metadata:read", "List visible configuration versions.", "flowbase versions list"),
42
+ Endpoint("versions.get", "flowbase_versions_get", "GET", "/versions/{version_id}", "metadata:read", "Get a version with semantic and file diffs.", "flowbase versions show abc1234"),
43
+ Endpoint("releases.list", "flowbase_releases_list", "GET", "/releases", "metadata:read", "List production release records.", "flowbase versions releases", environments=("production",)),
33
44
  Endpoint("changes.commit", "flowbase_changes_commit", "POST", "/changes/commit", "metadata:write", "Commit current test-environment drafts.", "flowbase changes commit --message 'Add customer field' --yes", True, environments=("test-a", "test-b"), audit_event="version.commit"),
34
45
  Endpoint("changes.release", "flowbase_changes_release", "POST", "/changes/release", "metadata:write", "Release the current test-environment version.", "flowbase changes release --message 'Release customer field' --yes", True, environments=("test-a", "test-b"), audit_event="version.release"),
35
46
  Endpoint(
@@ -55,6 +66,29 @@ ENDPOINTS = (
55
66
  preflight_operation_id="flowbase_changes_direct_release_preflight",
56
67
  audit_event="version.forward-fix",
57
68
  ),
69
+ Endpoint(
70
+ "environments.restart-preflight",
71
+ "flowbase_environments_restart_preflight",
72
+ "GET",
73
+ "/environments/restart/preflight",
74
+ "metadata:write",
75
+ "Preflight restarting the current test environment from production.",
76
+ "flowbase environments restart --confirm 'A 测试环境' --yes",
77
+ environments=("test-a", "test-b"),
78
+ ),
79
+ Endpoint(
80
+ "environments.restart",
81
+ "flowbase_environments_restart",
82
+ "POST",
83
+ "/environments/restart",
84
+ "metadata:write",
85
+ "Clear and restart the current test environment from production.",
86
+ "flowbase environments restart --confirm 'A 测试环境' --yes",
87
+ requires_confirmation=True,
88
+ environments=("test-a", "test-b"),
89
+ preflight_operation_id="flowbase_environments_restart_preflight",
90
+ audit_event="version.base-update",
91
+ ),
58
92
  Endpoint("records.list", "flowbase_records_list", "GET", "/objects/{object_id}/records", "records:read", "List records.", "flowbase records list obj_xxx --page 1"),
59
93
  Endpoint("records.get", "flowbase_records_get", "GET", "/objects/{object_id}/records/{record_id}", "records:read", "Get a record.", "flowbase records get obj_xxx rec_xxx"),
60
94
  Endpoint("records.create", "flowbase_records_create", "POST", "/objects/{object_id}/records", "records:write", "Create a record.", "flowbase records create obj_xxx --json-file record.json"),
@@ -66,7 +100,6 @@ ENDPOINT_BY_KEY = {endpoint.key: endpoint for endpoint in ENDPOINTS}
66
100
 
67
101
  PENDING_MANAGEMENT_OPERATIONS = (
68
102
  {"key": "environments.enable", "status": "pending", "reason": "Requires an independent capability and confirmation contract."},
69
- {"key": "environments.restart", "status": "pending", "reason": "Requires destructive data-reset confirmation."},
70
103
  {"key": "changes.clear-drafts", "status": "pending", "reason": "Requires an independent capability and confirmation contract."},
71
104
  {"key": "api-keys.manage", "status": "pending", "reason": "API keys cannot delegate or expand their own authority."},
72
105
  {"key": "git-credentials.manage", "status": "pending", "reason": "Requires a dedicated credential-management capability."},
@@ -102,7 +102,11 @@ class OpenApiClient:
102
102
  if not self.api_key:
103
103
  raise CliError(f"Missing API key. Set {ENV_API_KEY} or pass --api-key.")
104
104
  url = self.build_url(endpoint, path_params, query)
105
- headers = {"Accept": "application/json", "Authorization": f"Bearer {self.api_key}"}
105
+ headers = {
106
+ "Accept": "application/json",
107
+ "Authorization": f"Bearer {self.api_key}",
108
+ "X-FlowBase-Channel": "cli",
109
+ }
106
110
  data = None
107
111
  if body is not None:
108
112
  data = exact_json_dumps(body).encode("utf-8")
@@ -309,6 +313,43 @@ def handle_fields(args: argparse.Namespace) -> int:
309
313
  return run_request(args, f"fields.{action}", path_params=path)
310
314
 
311
315
 
316
+ def handle_pages(args: argparse.Namespace) -> int:
317
+ action = args.pages_action
318
+ if action == "list":
319
+ return run_request(
320
+ args,
321
+ "pages.list",
322
+ query={
323
+ "status": args.status,
324
+ "objectId": args.object_id,
325
+ "type": args.type,
326
+ "keyword": args.keyword,
327
+ "page": args.page,
328
+ },
329
+ )
330
+ if action == "options":
331
+ return run_request(args, "pages.options")
332
+ if action == "get":
333
+ return run_request(args, "pages.get", path_params={"page_id": args.page_id})
334
+ if action in ("create", "update"):
335
+ body = load_json_payload(args.json, args.json_file)
336
+ require_fields(body, "baseRevision", "page")
337
+ if not isinstance(body["page"], dict):
338
+ raise CliError("Request field 'page' must be an object.")
339
+ return run_request(
340
+ args,
341
+ f"pages.{action}",
342
+ path_params={"page_id": args.page_id} if action == "update" else None,
343
+ body=body,
344
+ )
345
+ return run_request(
346
+ args,
347
+ f"pages.{action}",
348
+ path_params={"page_id": args.page_id},
349
+ body={"baseRevision": args.base_revision},
350
+ )
351
+
352
+
312
353
  def handle_changes(args: argparse.Namespace) -> int:
313
354
  if args.changes_action == "direct-release":
314
355
  client = client_from_args(args)
@@ -336,6 +377,28 @@ def handle_changes(args: argparse.Namespace) -> int:
336
377
  return run_request(args, f"changes.{args.changes_action}", body={"message": args.message})
337
378
 
338
379
 
380
+ def handle_versions(args: argparse.Namespace) -> int:
381
+ if args.versions_action == "show":
382
+ return run_request(
383
+ args,
384
+ "versions.get",
385
+ path_params={"version_id": args.version_id},
386
+ )
387
+ if args.versions_action == "releases":
388
+ return run_request(args, "releases.list")
389
+ return run_request(
390
+ args,
391
+ "versions.list",
392
+ query={
393
+ "q": args.query,
394
+ "resource": args.resource,
395
+ "changeType": args.change_type,
396
+ "releaseStatus": args.release_status,
397
+ "channel": args.channel,
398
+ },
399
+ )
400
+
401
+
339
402
  def _print_direct_release_preflight(preflight: dict[str, Any]) -> None:
340
403
  print("Production direct-release preflight:", file=sys.stderr)
341
404
  print(f" Current main: {preflight.get('mainCommit', 'unknown')}", file=sys.stderr)
@@ -352,6 +415,68 @@ def _print_direct_release_preflight(preflight: dict[str, Any]) -> None:
352
415
  print(f" RISK: {preflight.get('risk', 'This bypasses test environments.')}", file=sys.stderr)
353
416
 
354
417
 
418
+ def _environment_confirmation(args: argparse.Namespace, label: str) -> str:
419
+ value = (args.confirm or "").strip()
420
+ if not value:
421
+ if not sys.stdin.isatty():
422
+ raise CliError(
423
+ "Refusing to restart without --confirm '<environment name>' in non-interactive mode."
424
+ )
425
+ value = input(f"Type {label} to confirm: ").strip()
426
+ if value != label:
427
+ raise CliError("Environment confirmation does not match the preflight result.")
428
+ return value
429
+
430
+
431
+ def _print_environment_restart_preflight(preflight: dict[str, Any]) -> None:
432
+ current = str(preflight.get("currentCommit", "unknown"))
433
+ main = str(preflight.get("mainCommit", "unknown"))
434
+ print("Test-environment restart preflight:", file=sys.stderr)
435
+ print(f" Environment: {preflight.get('environmentLabel', 'unknown')}", file=sys.stderr)
436
+ print(f" Current test version: {current[:7]}", file=sys.stderr)
437
+ print(f" Latest production version: {main[:7]}", file=sys.stderr)
438
+ print(f" Drafts: {preflight.get('draftCount', 0)}", file=sys.stderr)
439
+ print(f" Test records: {preflight.get('recordCount', 0)}", file=sys.stderr)
440
+ for check in preflight.get("checks", []):
441
+ if isinstance(check, dict):
442
+ mark = "OK" if check.get("ok") else "FAIL"
443
+ print(f" [{mark}] {check.get('label', '')}", file=sys.stderr)
444
+ print(
445
+ f" RISK: {preflight.get('risk', 'All test configuration and records will be cleared.')}",
446
+ file=sys.stderr,
447
+ )
448
+
449
+
450
+ def handle_environments(args: argparse.Namespace) -> int:
451
+ client = client_from_args(args)
452
+ preflight_data = client.request("environments.restart-preflight")
453
+ try:
454
+ preflight = json.loads(preflight_data)
455
+ except json.JSONDecodeError as exc:
456
+ raise CliError("Environment restart preflight returned invalid JSON.") from exc
457
+ _print_environment_restart_preflight(preflight)
458
+ if not preflight.get("canRestart"):
459
+ raise CliError("Environment restart preflight failed. Resolve failed checks first.")
460
+ label = preflight.get("environmentLabel")
461
+ if not isinstance(label, str) or not label:
462
+ raise CliError("Environment restart preflight did not return an environment label.")
463
+ confirm = _environment_confirmation(args, label)
464
+ endpoint = get_endpoint("environments.restart")
465
+ confirm_change(endpoint, args.yes)
466
+ body = {
467
+ "confirm": confirm,
468
+ "expectedCurrentCommit": preflight.get("currentCommit"),
469
+ "expectedMainCommit": preflight.get("mainCommit"),
470
+ "expectedDraftRevision": preflight.get("draftRevision"),
471
+ "expectedRecordCount": preflight.get("recordCount"),
472
+ }
473
+ if any(value is None for value in body.values()):
474
+ raise CliError("Environment restart preflight returned incomplete binding state.")
475
+ data = client.request("environments.restart", body=body)
476
+ print_output(data, pretty=args.pretty, raw=args.raw)
477
+ return 0
478
+
479
+
355
480
  def handle_records(args: argparse.Namespace) -> int:
356
481
  action = args.records_action
357
482
  path = {"object_id": args.object_id}
@@ -435,6 +560,29 @@ def build_parser() -> argparse.ArgumentParser:
435
560
  add_yes(item)
436
561
  fields.set_defaults(handler=handle_fields)
437
562
 
563
+ pages = groups.add_parser("pages", help="Manage custom Page metadata.")
564
+ page_actions = pages.add_subparsers(dest="pages_action", required=True)
565
+ page_list = page_actions.add_parser("list")
566
+ page_list.add_argument("--status", choices=("active", "deleted"), default="active")
567
+ page_list.add_argument("--object-id")
568
+ page_list.add_argument("--type", choices=("create", "detail"))
569
+ page_list.add_argument("--keyword")
570
+ page_list.add_argument("--page", type=int, default=1)
571
+ page_actions.add_parser("options")
572
+ page_get = page_actions.add_parser("get")
573
+ page_get.add_argument("page_id")
574
+ page_create = page_actions.add_parser("create")
575
+ add_json_args(page_create)
576
+ page_update = page_actions.add_parser("update")
577
+ page_update.add_argument("page_id")
578
+ add_json_args(page_update)
579
+ for action in ("set-default", "delete", "restore"):
580
+ item = page_actions.add_parser(action)
581
+ item.add_argument("page_id")
582
+ item.add_argument("--base-revision", required=True, type=int)
583
+ add_yes(item)
584
+ pages.set_defaults(handler=handle_pages)
585
+
438
586
  changes = groups.add_parser("changes", help="Commit or release metadata versions.")
439
587
  change_actions = changes.add_subparsers(dest="changes_action", required=True)
440
588
  for action in ("commit", "release", "direct-release"):
@@ -443,6 +591,38 @@ def build_parser() -> argparse.ArgumentParser:
443
591
  add_yes(item)
444
592
  changes.set_defaults(handler=handle_changes)
445
593
 
594
+ versions = groups.add_parser("versions", help="Inspect read-only configuration history.")
595
+ version_actions = versions.add_subparsers(dest="versions_action", required=True)
596
+ version_list = version_actions.add_parser("list")
597
+ version_list.add_argument("--query")
598
+ version_list.add_argument("--resource")
599
+ version_list.add_argument(
600
+ "--change-type",
601
+ choices=("business-change", "format-migration"),
602
+ )
603
+ version_list.add_argument(
604
+ "--release-status",
605
+ choices=("released", "unreleased"),
606
+ )
607
+ version_list.add_argument(
608
+ "--channel",
609
+ choices=("web", "openapi", "cli", "ai", "system-migration"),
610
+ )
611
+ version_show = version_actions.add_parser("show")
612
+ version_show.add_argument("version_id")
613
+ version_actions.add_parser("releases")
614
+ versions.set_defaults(handler=handle_versions)
615
+
616
+ environments = groups.add_parser("environments", help="Manage the current test environment.")
617
+ environment_actions = environments.add_subparsers(dest="environments_action", required=True)
618
+ environment_restart = environment_actions.add_parser("restart")
619
+ environment_restart.add_argument(
620
+ "--confirm",
621
+ help="Exact environment name returned by preflight. Required in non-interactive mode.",
622
+ )
623
+ add_yes(environment_restart)
624
+ environments.set_defaults(handler=handle_environments)
625
+
446
626
  records = groups.add_parser("records", help="Manage business records.")
447
627
  record_actions = records.add_subparsers(dest="records_action", required=True)
448
628
  record_list = record_actions.add_parser("list")
@@ -0,0 +1,37 @@
1
+ Metadata-Version: 2.4
2
+ Name: flowbase-cli
3
+ Version: 0.1.3
4
+ Summary: Command line client for the FlowBase OpenAPI
5
+ Author: DeepFlowAI
6
+ License: Apache-2.0
7
+ Requires-Python: >=3.11
8
+ Description-Content-Type: text/markdown
9
+
10
+ # FlowBase CLI
11
+
12
+ Install from this checkout:
13
+
14
+ ```bash
15
+ python -m pip install ./packages/flowbase-cli
16
+ ```
17
+
18
+ Configure an environment Base URL and an API key:
19
+
20
+ ```bash
21
+ export FLOWBASE_HOST=https://flowbase-test-a.deepflowagent.com
22
+ export FLOWBASE_API_KEY=fbk_xxx
23
+
24
+ flowbase objects list
25
+ flowbase pages list --object-id obj_xxx
26
+ flowbase pages create --json-file page.json
27
+ flowbase records create obj_xxx --json '{"values":{"name":"Example"}}'
28
+ flowbase versions list --resource customer --change-type business-change
29
+ flowbase versions show abc1234
30
+ flowbase versions releases
31
+ flowbase changes commit --message "Add customer field" --yes
32
+ flowbase changes release --message "Release customer field" --yes
33
+ flowbase environments restart --confirm "A 测试环境" --yes
34
+ flowbase docs list
35
+ ```
36
+
37
+ `--host` selects the environment through its Host. Version history commands are read-only and limited to the history visible from that Host; production release records are available only on the production Host. A test release can succeed only when its current version meets FlowBase's fast-forward checks. `environments restart` first shows a destructive preflight and then clears the current test configuration and records before starting from the latest production version. The CLI never accepts a separate environment override and never stores API keys on disk. See `flowbase --help` and `flowbase docs list` for the complete command set.
@@ -6,7 +6,7 @@ import unittest
6
6
  from decimal import Decimal
7
7
  from pathlib import Path
8
8
  from tempfile import TemporaryDirectory
9
- from unittest.mock import patch
9
+ from unittest.mock import MagicMock, patch
10
10
 
11
11
  from flowbase_cli.endpoints import ENDPOINTS
12
12
  from flowbase_cli.main import (
@@ -66,6 +66,18 @@ class FlowBaseCliTest(unittest.TestCase):
66
66
  url = client.build_url(endpoint, {"object_id": "obj/a", "record_id": "rec b"}, {"page": 2})
67
67
  self.assertEqual(url, "https://example.com/api/openapi/v1/objects/obj%2Fa/records/rec%20b?page=2")
68
68
 
69
+ def test_requests_identify_cli_channel_without_exposing_key_in_url(self):
70
+ client = OpenApiClient("https://example.com", "fbk_secret")
71
+ response = MagicMock()
72
+ response.read.return_value = b"[]"
73
+ context = MagicMock()
74
+ context.__enter__.return_value = response
75
+ with patch("flowbase_cli.main.urlopen", return_value=context) as mocked:
76
+ client.request("versions.list")
77
+ request = mocked.call_args.args[0]
78
+ self.assertEqual(request.get_header("X-flowbase-channel"), "cli")
79
+ self.assertNotIn("fbk_secret", request.full_url)
80
+
69
81
  def test_docs_list_needs_no_api_key(self):
70
82
  stdout = io.StringIO()
71
83
  with patch("sys.stdout", stdout):
@@ -74,6 +86,58 @@ class FlowBaseCliTest(unittest.TestCase):
74
86
  payload = json.loads(stdout.getvalue())
75
87
  self.assertTrue(any(item["key"] == "records.create" for item in payload))
76
88
  self.assertTrue(any(item["key"] == "changes.release" for item in payload))
89
+ self.assertTrue(any(item["key"] == "versions.get" for item in payload))
90
+ self.assertTrue(any(item["key"] == "pages.create" for item in payload))
91
+
92
+ def test_page_set_default_sends_revision_and_requires_yes(self):
93
+ stderr = io.StringIO()
94
+ with patch("sys.stderr", stderr), patch("sys.stdin.isatty", return_value=False):
95
+ code = main(["--api-key", "fbk_test", "pages", "set-default", "pag_1", "--base-revision", "4"])
96
+ self.assertEqual(code, 1)
97
+ self.assertIn("without --yes", stderr.getvalue())
98
+
99
+ stdout = io.StringIO()
100
+ with (
101
+ patch("flowbase_cli.main.OpenApiClient.request", return_value=b'{"draftRevision":5}') as request,
102
+ patch("sys.stdout", stdout),
103
+ ):
104
+ code = main([
105
+ "--api-key", "fbk_test", "pages", "set-default", "pag_1",
106
+ "--base-revision", "4", "--yes",
107
+ ])
108
+ self.assertEqual(code, 0)
109
+ self.assertEqual(request.call_args.args[0], "pages.set-default")
110
+ self.assertEqual(request.call_args.kwargs["body"], {"baseRevision": 4})
111
+
112
+ def test_page_create_requires_full_request_body(self):
113
+ stderr = io.StringIO()
114
+ with patch("sys.stderr", stderr):
115
+ code = main(["pages", "create", "--json", '{"baseRevision":0}'])
116
+ self.assertEqual(code, 1)
117
+ self.assertIn("page", stderr.getvalue())
118
+
119
+ def test_version_show_uses_read_only_version_endpoint(self):
120
+ stdout = io.StringIO()
121
+ with (
122
+ patch(
123
+ "flowbase_cli.main.OpenApiClient.request",
124
+ return_value=b'{"commit":"abcdef0"}',
125
+ ) as request,
126
+ patch("sys.stdout", stdout),
127
+ ):
128
+ code = main([
129
+ "--api-key",
130
+ "fbk_test",
131
+ "versions",
132
+ "show",
133
+ "abcdef0",
134
+ ])
135
+ self.assertEqual(code, 0)
136
+ self.assertEqual(request.call_args.args[0], "versions.get")
137
+ self.assertEqual(
138
+ request.call_args.kwargs["path_params"],
139
+ {"version_id": "abcdef0"},
140
+ )
77
141
 
78
142
  def test_management_operation_catalog_identifies_pending_gaps(self):
79
143
  stdout = io.StringIO()
@@ -151,6 +215,95 @@ class FlowBaseCliTest(unittest.TestCase):
151
215
  self.assertNotIn("fbc_secret", stderr.getvalue())
152
216
  self.assertIn("Bypasses test environments", stderr.getvalue())
153
217
 
218
+ def test_environment_restart_preflights_and_binds_execution(self):
219
+ preflight = {
220
+ "environmentId": "test-a",
221
+ "environmentLabel": "A 测试环境",
222
+ "currentCommit": "a" * 40,
223
+ "mainCommit": "b" * 40,
224
+ "draftRevision": 7,
225
+ "draftCount": 0,
226
+ "recordCount": 3,
227
+ "checks": [
228
+ {"label": "当前环境为已启用测试环境", "ok": True},
229
+ {"label": "当前环境无待提交草稿", "ok": True},
230
+ ],
231
+ "canRestart": True,
232
+ "risk": "All test records will be deleted.",
233
+ }
234
+ stdout = io.StringIO()
235
+ stderr = io.StringIO()
236
+ with (
237
+ patch(
238
+ "flowbase_cli.main.OpenApiClient.request",
239
+ side_effect=[
240
+ json.dumps(preflight).encode(),
241
+ b'{"currentCommit":"bbbbbbb","clearedRecordCount":3}',
242
+ ],
243
+ ) as request,
244
+ patch("sys.stdout", stdout),
245
+ patch("sys.stderr", stderr),
246
+ ):
247
+ code = main([
248
+ "--api-key",
249
+ "fbk_test",
250
+ "environments",
251
+ "restart",
252
+ "--confirm",
253
+ "A 测试环境",
254
+ "--yes",
255
+ ])
256
+
257
+ self.assertEqual(code, 0)
258
+ self.assertEqual(request.call_count, 2)
259
+ self.assertEqual(request.call_args_list[0].args[0], "environments.restart-preflight")
260
+ self.assertEqual(request.call_args_list[1].args[0], "environments.restart")
261
+ self.assertEqual(
262
+ request.call_args_list[1].kwargs["body"],
263
+ {
264
+ "confirm": "A 测试环境",
265
+ "expectedCurrentCommit": "a" * 40,
266
+ "expectedMainCommit": "b" * 40,
267
+ "expectedDraftRevision": 7,
268
+ "expectedRecordCount": 3,
269
+ },
270
+ )
271
+ self.assertIn("All test records will be deleted", stderr.getvalue())
272
+
273
+ def test_environment_restart_noninteractive_requires_name_confirmation(self):
274
+ preflight = {
275
+ "environmentId": "test-a",
276
+ "environmentLabel": "A 测试环境",
277
+ "currentCommit": "a" * 40,
278
+ "mainCommit": "b" * 40,
279
+ "draftRevision": 0,
280
+ "draftCount": 0,
281
+ "recordCount": 0,
282
+ "checks": [],
283
+ "canRestart": True,
284
+ "risk": "Destructive.",
285
+ }
286
+ stderr = io.StringIO()
287
+ with (
288
+ patch(
289
+ "flowbase_cli.main.OpenApiClient.request",
290
+ return_value=json.dumps(preflight).encode(),
291
+ ) as request,
292
+ patch("sys.stderr", stderr),
293
+ patch("sys.stdin.isatty", return_value=False),
294
+ ):
295
+ code = main([
296
+ "--api-key",
297
+ "fbk_test",
298
+ "environments",
299
+ "restart",
300
+ "--yes",
301
+ ])
302
+
303
+ self.assertEqual(code, 1)
304
+ self.assertEqual(request.call_count, 1)
305
+ self.assertIn("--confirm", stderr.getvalue())
306
+
154
307
 
155
308
  if __name__ == "__main__":
156
309
  unittest.main()
@@ -1,31 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: flowbase-cli
3
- Version: 0.1.2
4
- Summary: Command line client for the FlowBase OpenAPI
5
- Author: DeepFlowAI
6
- License: Apache-2.0
7
- Requires-Python: >=3.11
8
- Description-Content-Type: text/markdown
9
-
10
- # FlowBase CLI
11
-
12
- Install from this checkout:
13
-
14
- ```bash
15
- python -m pip install ./packages/flowbase-cli
16
- ```
17
-
18
- Configure an environment Base URL and an API key:
19
-
20
- ```bash
21
- export FLOWBASE_HOST=https://flowbase-test-a.deepflowagent.com
22
- export FLOWBASE_API_KEY=fbk_xxx
23
-
24
- flowbase objects list
25
- flowbase records create obj_xxx --json '{"values":{"name":"Example"}}'
26
- flowbase changes commit --message "Add customer field" --yes
27
- flowbase changes release --message "Release customer field" --yes
28
- flowbase docs list
29
- ```
30
-
31
- `--host` selects the environment through its Host. Version commands are limited to the current enabled test environment; release can succeed only when its current version meets FlowBase's fast-forward checks. The CLI never accepts a separate environment override and never stores API keys on disk. See `flowbase --help` and `flowbase docs list` for the complete command set.
@@ -1,22 +0,0 @@
1
- # FlowBase CLI
2
-
3
- Install from this checkout:
4
-
5
- ```bash
6
- python -m pip install ./packages/flowbase-cli
7
- ```
8
-
9
- Configure an environment Base URL and an API key:
10
-
11
- ```bash
12
- export FLOWBASE_HOST=https://flowbase-test-a.deepflowagent.com
13
- export FLOWBASE_API_KEY=fbk_xxx
14
-
15
- flowbase objects list
16
- flowbase records create obj_xxx --json '{"values":{"name":"Example"}}'
17
- flowbase changes commit --message "Add customer field" --yes
18
- flowbase changes release --message "Release customer field" --yes
19
- flowbase docs list
20
- ```
21
-
22
- `--host` selects the environment through its Host. Version commands are limited to the current enabled test environment; release can succeed only when its current version meets FlowBase's fast-forward checks. The CLI never accepts a separate environment override and never stores API keys on disk. See `flowbase --help` and `flowbase docs list` for the complete command set.
@@ -1,31 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: flowbase-cli
3
- Version: 0.1.2
4
- Summary: Command line client for the FlowBase OpenAPI
5
- Author: DeepFlowAI
6
- License: Apache-2.0
7
- Requires-Python: >=3.11
8
- Description-Content-Type: text/markdown
9
-
10
- # FlowBase CLI
11
-
12
- Install from this checkout:
13
-
14
- ```bash
15
- python -m pip install ./packages/flowbase-cli
16
- ```
17
-
18
- Configure an environment Base URL and an API key:
19
-
20
- ```bash
21
- export FLOWBASE_HOST=https://flowbase-test-a.deepflowagent.com
22
- export FLOWBASE_API_KEY=fbk_xxx
23
-
24
- flowbase objects list
25
- flowbase records create obj_xxx --json '{"values":{"name":"Example"}}'
26
- flowbase changes commit --message "Add customer field" --yes
27
- flowbase changes release --message "Release customer field" --yes
28
- flowbase docs list
29
- ```
30
-
31
- `--host` selects the environment through its Host. Version commands are limited to the current enabled test environment; release can succeed only when its current version meets FlowBase's fast-forward checks. The CLI never accepts a separate environment override and never stores API keys on disk. See `flowbase --help` and `flowbase docs list` for the complete command set.
File without changes