fix(cli): keep migrate local and delegate duplicated commands

Author: rmorehig

src/tinybird_sdk/cli/commands/__init__.py

@@ -1,34 +1,8 @@
-from .branch import run_branch_list, run_branch_status, run_branch_delete, run_branch_list_cached
-from .build import run_build
-from .clear import run_clear
-from .deploy import run_deploy
-from .dev import run_dev
 from .generate import run_generate, runGenerate
-from .info import run_info
-from .init import run_init
-from .login import run_login
 from .migrate import run_migrate
-from .open_dashboard import run_open_dashboard
-from .preview import run_preview, generate_preview_branch_name
-from .pull import run_pull
 
 __all__ = [
-    "run_branch_list",
-    "run_branch_status",
-    "run_branch_delete",
-    "run_branch_list_cached",
-    "run_build",
-    "run_clear",
-    "run_deploy",
-    "run_dev",
     "run_generate",
     "runGenerate",
-    "run_info",
-    "run_init",
-    "run_login",
     "run_migrate",
-    "run_open_dashboard",
-    "run_preview",
-    "generate_preview_branch_name",
-    "run_pull",
 ]

src/tinybird_sdk/cli/index.py

@@ -6,6 +6,7 @@
 import sys
 
 from .commands.generate import run_generate
+from .commands.migrate import run_migrate
 from .output import output
 
 
@@ -47,45 +48,91 @@ def create_cli() -> argparse.ArgumentParser:
     generate_cmd.add_argument("--json", action="store_true")
     generate_cmd.add_argument("-o", "--output-dir")
 
+    migrate_cmd = sub.add_parser("migrate", help="Migrate Tinybird .datasource/.pipe files to Python resources")
+    migrate_cmd.add_argument("patterns", nargs="+", help="Files, directories, or glob patterns to migrate")
+    migrate_cmd.add_argument("--cwd", help="Working directory to resolve patterns from")
+    migrate_cmd.add_argument("-o", "--out", help="Output file path for the generated migration module")
+    migrate_cmd.add_argument("--dry-run", action="store_true", help="Generate output without writing files")
+    migrate_cmd.add_argument("--force", action="store_true", help="Overwrite existing output file when needed")
+    migrate_cmd.add_argument(
+        "--strict",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="Fail on migration issues (disable with --no-strict)",
+    )
+    migrate_cmd.add_argument("--json", action="store_true", help="Print migration result as JSON")
+
     return parser
 
 
 def main(argv: list[str] | None = None) -> int:
     normalized_argv = list(argv) if argv is not None else list(sys.argv[1:])
 
-    # `generate` is owned by the SDK; all other commands are delegated to Tinybird CLI.
-    if not normalized_argv or normalized_argv[0] != "generate":
+    # SDK-owned commands stay local; all other commands are delegated to Tinybird CLI.
+    if not normalized_argv or normalized_argv[0] not in {"generate", "migrate"}:
         return _run_installed_tinybird_cli(normalized_argv)
 
     parser = create_cli()
     args = parser.parse_args(normalized_argv)
 
-    result = run_generate({"output_dir": args.output_dir})
-    if not result.success:
-        output.error(result.error or "Generate failed")
-        return 1
+    if args.command == "generate":
+        result = run_generate({"output_dir": args.output_dir})
+        if not result.success:
+            output.error(result.error or "Generate failed")
+            return 1
+
+        if args.json:
+            _print_json(asdict(result))
+            return 0
+
+        stats = result.stats or {
+            "datasource_count": 0,
+            "pipe_count": 0,
+            "connection_count": 0,
+            "total_count": 0,
+        }
+        print(
+            "Generated "
+            f"{stats['total_count']} resources "
+            f"({stats['datasource_count']} datasources, "
+            f"{stats['pipe_count']} pipes, "
+            f"{stats['connection_count']} connections)"
+        )
+        if result.output_dir:
+            print(f"Written to: {result.output_dir}")
+        print(f"Completed in {output.format_duration(result.duration_ms)}")
+        return 0
+
+    result = run_migrate(
+        {
+            "cwd": args.cwd,
+            "patterns": args.patterns,
+            "out": args.out,
+            "strict": args.strict,
+            "dry_run": args.dry_run,
+            "force": args.force,
+        }
+    )
 
     if args.json:
-        _print_json(asdict(result))
+        _print_json(result)
+        return 0 if result["success"] else 1
+
+    if result["success"]:
+        migrated_count = len(result.get("migrated") or [])
+        print(f"Migrated {migrated_count} resources")
+        if result.get("output_path"):
+            print(f"Written to: {result['output_path']}")
         return 0
 
-    stats = result.stats or {
-        "datasource_count": 0,
-        "pipe_count": 0,
-        "connection_count": 0,
-        "total_count": 0,
-    }
-    print(
-        "Generated "
-        f"{stats['total_count']} resources "
-        f"({stats['datasource_count']} datasources, "
-        f"{stats['pipe_count']} pipes, "
-        f"{stats['connection_count']} connections)"
-    )
-    if result.output_dir:
-        print(f"Written to: {result.output_dir}")
-    print(f"Completed in {output.format_duration(result.duration_ms)}")
-    return 0
+    errors = result.get("errors") or []
+    if errors:
+        output.error(f"Migrate failed with {len(errors)} error(s)")
+        for error in errors:
+            output.error(str(error))
+    else:
+        output.error("Migrate failed")
+    return 1
 
 
 if __name__ == "__main__":

src/tinybird_sdk/migrate/runner.py

@@ -242,7 +242,7 @@ def run_migrate(options: MigrateOptions | dict[str, Any]) -> MigrationResult:
                     resource_kind=pipe.kind,
                     message=(
                         f'Materialized pipe references missing/unmigrated datasource '
-                        f'"{pipe.materialized_datasource or '(none)'}".'
+                        f'"{pipe.materialized_datasource or "(none)"}".'
                     ),
                 )
             )
@@ -258,7 +258,7 @@ def run_migrate(options: MigrateOptions | dict[str, Any]) -> MigrationResult:
                     resource_kind=pipe.kind,
                     message=(
                         f'Copy pipe references missing/unmigrated datasource '
-                        f'"{pipe.copy_target_datasource or '(none)'}".'
+                        f'"{pipe.copy_target_datasource or "(none)"}".'
                     ),
                 )
             )

tests/test_cli_entrypoint.py

@@ -56,13 +56,18 @@ def fake_import(name: str, *args, **kwargs):
     assert cli_index._run_installed_tinybird_cli(["build"]) == 1
 
 
-def test_cli_entrypoint_delegates_non_generate_commands(monkeypatch: pytest.MonkeyPatch) -> None:
+def test_cli_entrypoint_delegates_non_sdk_commands(monkeypatch: pytest.MonkeyPatch) -> None:
     monkeypatch.setattr(cli_index, "_run_installed_tinybird_cli", lambda argv: 7 if argv == ["build", "--dry-run"] else 1)
     monkeypatch.setattr(
         cli_index,
         "run_generate",
         lambda *_args, **_kwargs: (_ for _ in ()).throw(AssertionError("generate should not run")),
     )
+    monkeypatch.setattr(
+        cli_index,
+        "run_migrate",
+        lambda *_args, **_kwargs: (_ for _ in ()).throw(AssertionError("migrate should not run")),
+    )
     assert cli_index.main(["build", "--dry-run"]) == 7
 
 
@@ -101,6 +106,31 @@ def test_cli_entrypoint_runs_generate_locally(monkeypatch: pytest.MonkeyPatch, c
     assert "Generated 2 resources (1 datasources, 1 pipes, 0 connections)" in out
 
 
+def test_cli_entrypoint_runs_migrate_locally(monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]) -> None:
+    monkeypatch.setattr(
+        cli_index,
+        "_run_installed_tinybird_cli",
+        lambda *_args, **_kwargs: (_ for _ in ()).throw(AssertionError("should not delegate migrate")),
+    )
+    monkeypatch.setattr(
+        cli_index,
+        "run_migrate",
+        lambda *_args, **_kwargs: {
+            "success": True,
+            "output_path": "/tmp/tinybird.migration.py",
+            "migrated": ["a", "b"],
+            "errors": [],
+            "dry_run": False,
+            "output_content": None,
+        },
+    )
+
+    assert cli_index.main(["migrate", "legacy.datasource"]) == 0
+    out = capsys.readouterr().out
+    assert "Migrated 2 resources" in out
+    assert "Written to: /tmp/tinybird.migration.py" in out
+
+
 def test_cli_entrypoint_runs_generate_json_output(monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]) -> None:
     monkeypatch.setattr(
         cli_index,
@@ -141,3 +171,18 @@ def test_cli_entrypoint_generate_failure_returns_error(monkeypatch: pytest.Monke
         lambda *_args, **_kwargs: SimpleNamespace(success=False, error="boom", duration_ms=1),
     )
     assert cli_index.main(["generate"]) == 1
+
+
+def test_cli_entrypoint_migrate_failure_returns_error(monkeypatch: pytest.MonkeyPatch) -> None:
+    _mute_output(monkeypatch)
+    monkeypatch.setattr(
+        cli_index,
+        "_run_installed_tinybird_cli",
+        lambda *_args, **_kwargs: (_ for _ in ()).throw(AssertionError("should not delegate migrate")),
+    )
+    monkeypatch.setattr(
+        cli_index,
+        "run_migrate",
+        lambda *_args, **_kwargs: {"success": False, "errors": ["boom"]},
+    )
+    assert cli_index.main(["migrate", "legacy.datasource"]) == 1