keboola-cli 0.100.2__tar.gz → 0.100.4__tar.gz

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/CLAUDE.md

@@ -490,7 +490,7 @@ kbagent auth register-projects [--stack URL|alias] [--all] [--project-id ID ...]
 #   starts the server and blocks every destructive route (none of them under `/auth/*`).
 #   See docs/web-server.md.
 
-kbagent project create --url URL [--project ALIAS] [--name NAME] [--backend snowflake|bigquery] [--sync-backend-init]
+kbagent project create --url URL [--project|--alias ALIAS] [--name NAME] [--backend snowflake|bigquery] [--sync-backend-init]
 # project create (since 0.95.0, DMD-1940): the ONLY kbagent command that works from nothing --
 #   no account, no token, no `auth login`. POSTs the unauthenticated provisioning endpoint
 #   (`/manage/programmatic-projects`, gated by the `agent-provisioning` stack feature
@@ -515,13 +515,13 @@ kbagent project create --url URL [--project ALIAS] [--name NAME] [--backend snow
 #   delivered and may have succeeded (retryable:false, message says not to repeat -- check
 #   `auth status`, whose stored session + claim link is the evidence). `--sync-backend-init`
 #   raises that call's read timeout to 300s, which can outlast an agent's foreground shell.
-kbagent project add --project NAME --url URL [--token-stdin | --token-file PATH [--keep-token-file] | --token-env NAME | --token TOKEN]
+kbagent project add --project|--alias NAME --url URL [--token-stdin | --token-file PATH [--keep-token-file] | --token-env NAME | --token TOKEN]
 kbagent project list
 kbagent project remove --project NAME
 kbagent project edit --project NAME [--url URL] [--token-stdin | --token-file PATH [--keep-token-file] | --token-env NAME | --token TOKEN] [--new-alias NEW]
 kbagent project status [--project NAME | --all-projects]
 kbagent project refresh --project ALIAS [--dry-run] [--force] [--yes] [--token-description DESC] [--token-expires-in N]
-kbagent project refresh --all [--dry-run] [--force] [--yes] [--token-description DESC] [--token-expires-in N]
+kbagent project refresh --all|--all-projects [--dry-run] [--force] [--yes] [--token-description DESC] [--token-expires-in N]
 kbagent project description-get --project NAME
 kbagent project description-set --project NAME [--text STR | --file PATH | --stdin]
 kbagent project use ALIAS

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: keboola-cli
-Version: 0.100.2
+Version: 0.100.4
 Summary: AI-friendly CLI for managing Keboola projects
 Author-email: Keboola <dev@keboola.com>
 License-Expression: Apache-2.0

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "keboola-cli"
-version = "0.100.2"
+version = "0.100.4"
 description = "AI-friendly CLI for managing Keboola projects"
 readme = "README.md"
 requires-python = ">=3.12"

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/src/keboola_agent_cli/changelog.py

@@ -26,6 +26,24 @@ from .constants import CHANGELOG_HEADLINE_MAX_CHARS
 
 # Ordered newest-first.  Each value is a list of brief one-line descriptions.
 CHANGELOG: dict[str, list[str]] = {
+    "0.100.4": [
+        "Fix (#919, backport of #917): `sync push` now sends an edit to `transform.sql` or another code file "
+        "of a config that a push created. Before, it found no change in such a file "
+        "(`transform.sql`, `transform.py`, `code.py`, `pyproject.toml`, `_description.md`): "
+        "`sync diff` said in sync, `sync push` said there was nothing to push, and the job "
+        "kept running the old code. With the same gap, `sync pull --force` could "
+        "replace such an edit with the remote code; it now stops with `SYNC_CONFLICT`. An edit "
+        "to `_config.yml` was always detected. A tree written by an older version is fixed by "
+        "one `sync pull`; copy edited code files aside before it.",
+    ],
+    "0.100.3": [
+        "New (#911): `project add` and `project create` also take the alias of the new project "
+        "as `--alias`, and `project refresh` also takes `--all-projects`. These are the names of "
+        "kbagent 1.0.0, which removes `--project` from these two commands and `--all` from "
+        "`project refresh`. A script with the new names works on 0.100.3 and on 1.x. On 0.x, "
+        "`--project` and `--all` keep working.",
+        "Note (#912): housekeeping with no user-facing change. It updates the filelock package.",
+    ],
     "0.100.2": [
         "Fix (#898): `kbagent update --beta` now allows a pre-release of kbagent itself, not of "
         "the Python packages that kbagent uses. Before, it allowed pre-releases of every package, "

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/src/keboola_agent_cli/commands/context.py

@@ -268,7 +268,7 @@ Use `kbagent <command> --help` for full flag details and examples.
 
 ### Project Management
 
-  kbagent project create --url URL [--project ALIAS] [--name NAME]
+  kbagent project create --url URL [--project|--alias ALIAS] [--name NAME]
                          [--backend snowflake|bigquery] [--sync-backend-init]
     Create a BRAND-NEW Keboola project from a machine with no Keboola
     identity -- no account, no token, no `auth login` first. The only command
@@ -300,7 +300,7 @@ Use `kbagent <command> --help` for full flag details and examples.
     the stack finish it in the background (the async default warns that the
     first Storage command may fail until it lands).
 
-  kbagent project add --project NAME --url URL [--token-stdin | --token-file PATH | --token-env NAME | --token TOKEN]
+  kbagent project add --project|--alias NAME --url URL [--token-stdin | --token-file PATH | --token-env NAME | --token TOKEN]
     Add a new project connection. Token verified against API.
     See "Getting a Storage token in" below before you pick a flag.
 
@@ -374,8 +374,8 @@ Use `kbagent <command> --help` for full flag details and examples.
     `project list`, including on an ERROR row.
 
   kbagent project refresh --project ALIAS [--dry-run] [--force] [--yes] [--token-description ...] [--token-expires-in N]
-  kbagent project refresh --all [--dry-run] [--force] [--yes] [--token-description ...] [--token-expires-in N]
-    Refresh project tokens via Manage API. --all refreshes all projects. --force replaces non-expiring tokens.
+  kbagent project refresh --all|--all-projects [--dry-run] [--force] [--yes] [--token-description ...] [--token-expires-in N]
+    Refresh project tokens via Manage API. --all (or --all-projects) refreshes all projects. --force replaces non-expiring tokens.
     Browser-login (session) projects are reported under "skipped" with the
     reason that there is no static token to replace -- their access token
     rotates on its own from auth.json. --force does NOT convert them either;

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/src/keboola_agent_cli/commands/project.py

@@ -172,7 +172,9 @@ def _format_status_table(console: Console, statuses: list[dict[str, Any]]) -> No
 @project_app.command("add")
 def project_add(
     ctx: typer.Context,
-    alias: str = typer.Option(..., "--project", help="Human-friendly name for this project"),
+    alias: str = typer.Option(
+        ..., "--project", "--alias", help="Human-friendly name for this project"
+    ),
     url: str = typer.Option(
         DEFAULT_STACK_URL,
         help="Keboola stack URL",
@@ -244,7 +246,10 @@ def project_create(
         help="Keboola stack URL to create the project on (required -- never guessed)",
     ),
     alias: str | None = typer.Option(
-        None, "--project", help="Local alias for the new project (default: from its name)"
+        None,
+        "--project",
+        "--alias",
+        help="Local alias for the new project (default: from its name)",
     ),
     name: str | None = typer.Option(None, "--name", help="Name for the new Keboola project"),
     backend: ProjectBackend | None = typer.Option(
@@ -574,7 +579,7 @@ def project_refresh(
         None, "--project", "-p", help="Refresh token for a specific project"
     ),
     all_projects: bool = typer.Option(
-        False, "--all", help="Refresh all projects with invalid tokens"
+        False, "--all", "--all-projects", help="Refresh all projects with invalid tokens"
     ),
     dry_run: bool = typer.Option(
         False, "--dry-run", help="Preview what would be refreshed without making changes"

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/src/keboola_agent_cli/services/_sync_writeback.py

@@ -61,6 +61,7 @@ def stamp_created_config(
         new_id=new_id,
         file_hash=hashes.file_hash,
         cfg_hash=stamp.cfg_hash,
+        extra_hashes=hashes.extra_hashes,
     )
     apply_stamp(writeback.entry.metadata, stamp)
     return writeback
@@ -112,6 +113,7 @@ def stamp_updated_config(
         new_id=config_id,
         file_hash=hashes.file_hash,
         cfg_hash=stamp.cfg_hash,
+        extra_hashes=hashes.extra_hashes,
     ).entry
     apply_stamp(entry.metadata, stamp)
 
@@ -125,6 +127,7 @@ def writeback_create_config_in_manifest(
     new_id: str,
     file_hash: str,
     cfg_hash: str,
+    extra_hashes: dict[str, str],
 ) -> WritebackResult:
     """Record a freshly-created config in the manifest.
 
@@ -154,13 +157,18 @@ def writeback_create_config_in_manifest(
             entry.id = new_id
             entry.metadata["pull_hash"] = file_hash
             entry.metadata["pull_config_hash"] = cfg_hash
+            entry.metadata["pull_extra_hashes"] = extra_hashes
             return WritebackResult(entry=entry, previous_id=previous_id)
     new_entry = ManifestConfiguration(
         branchId=target_branch,
         componentId=component_id,
         id=new_id,
         path=config_path_str,
-        metadata={"pull_hash": file_hash, "pull_config_hash": cfg_hash},
+        metadata={
+            "pull_hash": file_hash,
+            "pull_config_hash": cfg_hash,
+            "pull_extra_hashes": extra_hashes,
+        },
     )
     manifest.configurations.append(new_entry)
     return WritebackResult(entry=new_entry, previous_id="")

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/tests/test_cli.py

@@ -10,6 +10,7 @@ from typing import Any
 from unittest.mock import MagicMock, patch
 
 import pytest
+import typer.main
 from typer.testing import CliRunner
 
 from helpers import make_mock_client
@@ -75,6 +76,48 @@ class TestProjectAdd:
         # Token should be masked
         assert "55555" not in output["data"]["token"]
 
+    def test_project_add_alias_option(self, tmp_path: Path) -> None:
+        """--alias is the 1.x name of --project here, so one command works on 0.x and 1.x."""
+        mock_client = make_mock_client(project_name="Prod Project", project_id=5678)
+        config_dir = tmp_path / "config"
+        config_dir.mkdir()
+
+        with (
+            patch("keboola_agent_cli.cli.ConfigStore") as MockStore,
+            patch("keboola_agent_cli.cli.ProjectService") as MockService,
+            patch.dict(os.environ, {"KBC_TOKEN": TEST_TOKEN}),
+        ):
+            store_instance = ConfigStore(config_dir=config_dir)
+            MockStore.return_value = store_instance
+            MockService.return_value = ProjectService(
+                config_store=store_instance,
+                client_factory=lambda url, token: mock_client,
+            )
+
+            result = runner.invoke(
+                app,
+                [
+                    "--json",
+                    "project",
+                    "add",
+                    "--alias",
+                    "prod",
+                    "--url",
+                    "https://connection.keboola.com",
+                ],
+            )
+
+        assert result.exit_code == 0, f"Exit code {result.exit_code}: {result.output}"
+        assert json.loads(result.output)["data"]["alias"] == "prod"
+        assert "prod" in store_instance.load().projects
+
+    def test_project_create_takes_alias_option(self) -> None:
+        """project create accepts --alias, the 1.x name of its --project."""
+        root: Any = typer.main.get_command(app)
+        create = root.commands["project"].commands["create"]
+        alias = next(p for p in create.params if p.name == "alias")
+        assert alias.opts == ["--project", "--alias"]
+
     def test_project_add_success_human(self, tmp_path: Path) -> None:
         """project add in human mode outputs success message."""
         mock_client = make_mock_client()
@@ -8520,6 +8563,27 @@ class TestProjectRefresh:
         assert output["status"] == "error"
         assert "not both" in output["error"]["message"]
 
+    def test_project_refresh_all_projects_is_the_all_option(self, tmp_path: Path) -> None:
+        """--all-projects is the 1.x name of --all: with --project it is the same usage error."""
+        config_dir = tmp_path / "config"
+        config_dir.mkdir()
+        store = ConfigStore(config_dir=config_dir)
+
+        with (
+            patch("keboola_agent_cli.cli.ConfigStore") as MockStore,
+            patch("keboola_agent_cli.cli.OrgService"),
+        ):
+            MockStore.return_value = store
+
+            result = runner.invoke(
+                app,
+                ["--json", "project", "refresh", "--project", "prod", "--all-projects", "--yes"],
+            )
+
+        assert result.exit_code == 2, f"Exit code {result.exit_code}: {result.output}"
+        output = json.loads(result.output)
+        assert "not both" in output["error"]["message"]
+
     def test_project_refresh_dry_run(self, tmp_path: Path) -> None:
         """project refresh --all --dry-run --json shows preview without changes."""
         config_dir = tmp_path / "config"

keboola_cli-0.100.4/tests/test_sync_push_companion_hashes.py

@@ -0,0 +1,137 @@
+"""A config CREATED by `sync push` must track its companion code files.
+
+`sync pull` records a hash for every companion file (`transform.sql`,
+`code.py`, ...) under `pull_extra_hashes`; diff reads an edit to one of them
+only through that record. The create path recorded `_config.yml` alone, so
+after a push that created a config, a later edit to its SQL diffed as
+"unchanged" and the next push sent nothing -- exit 0, the job kept running the
+old code. Reported by a customer on a dev-branch loop (author in `main/`,
+`sync push --branch <dev>`, edit `transform.sql`, push again).
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+import pytest
+
+import test_sync_formal_counterexamples as formal
+from test_sync_formal_counterexamples import DEV, PROD, World
+
+TRANSFORMATION = "keboola.snowflake-transformation"
+
+
+@pytest.fixture
+def world(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> World:
+    """A sync world whose fake remote lists configs under a SQL transformation."""
+    monkeypatch.setattr(formal, "COMP", TRANSFORMATION)
+    w = World(tmp_path)
+    return w
+
+
+def _author_transformation(root: Path) -> Path:
+    """Write a new, untracked transformation under main/ (no config id yet)."""
+    config_dir = root / "main" / "transformation" / TRANSFORMATION / "orders-model"
+    config_dir.mkdir(parents=True)
+    (config_dir / "_config.yml").write_text(
+        "version: 2\nname: orders-model\ndescription: ''\nparameters: {}\n"
+        f"_keboola:\n  component_id: {TRANSFORMATION}\n"
+    )
+    (config_dir / "transform.sql").write_text("SELECT 1 FROM VALUES (1);\n")
+    return config_dir
+
+
+def _edit_sql(config_dir: Path) -> None:
+    sql = config_dir / "transform.sql"
+    sql.write_text(sql.read_text().replace("VALUES", "VALUEZ"))
+
+
+def _remote_sql(world: World, branch: int, config_id: str) -> str:
+    blocks = world.api.remote[branch][config_id]["configuration"]["parameters"]["blocks"]
+    return "".join(s for b in blocks for c in b["codes"] for s in c["script"])
+
+
+def test_sql_edit_after_create_on_default_branch_is_pushed(world: World) -> None:
+    world.init()
+    world.pull()
+    config_dir = _author_transformation(world.root)
+    assert world.push().get("created", 0) == 1
+    (config_id,) = world.api.ids(PROD)
+
+    _edit_sql(config_dir)
+
+    assert world.diff()["summary"]["modified"] == 1
+    assert world.push().get("updated", 0) == 1
+    assert "VALUEZ" in _remote_sql(world, PROD, config_id)
+
+
+def test_sql_edit_after_promote_create_to_dev_branch_is_pushed(world: World) -> None:
+    """The customer's loop: author in main/, push to a dev branch, edit, push."""
+    world.init()
+    world.pull()
+    config_dir = _author_transformation(world.root)
+    assert world.push(branch=DEV).get("created", 0) == 1
+    (config_id,) = world.api.ids(DEV)
+
+    _edit_sql(config_dir)
+
+    assert world.diff(branch=DEV)["summary"]["modified"] == 1
+    second = world.push(branch=DEV)
+    assert second.get("updated", 0) == 1
+    assert second.get("created", 0) == 0
+    assert "VALUEZ" in _remote_sql(world, DEV, config_id)
+    assert world.api.ids(PROD) == []
+
+
+def test_sql_edit_after_promoting_a_pulled_config_is_pushed(world: World) -> None:
+    """A production config promoted to a dev branch gets a NEW dev entry."""
+    world.api.put(
+        PROD,
+        "cfg-1",
+        "Orders",
+        "a",
+        extra={"blocks": [{"name": "B", "codes": [{"name": "C", "script": ["SELECT 1;"]}]}]},
+    )
+    world.init()
+    world.pull()
+    world.push(branch=DEV)
+    (dev_id,) = world.api.ids(DEV)
+    sql = world.config_dir("orders") / "transform.sql"
+    sql.write_text(sql.read_text().replace("SELECT 1", "SELECT 2"))
+
+    assert world.diff(branch=DEV)["summary"]["modified"] == 1
+    assert world.push(branch=DEV).get("updated", 0) == 1
+    assert "SELECT 2" in _remote_sql(world, DEV, dev_id)
+    assert "SELECT 1" in _remote_sql(world, PROD, "cfg-1")
+
+
+def test_unedited_config_stays_clean_after_create(world: World) -> None:
+    """Recording the companion hashes must not turn a clean tree dirty."""
+    world.init()
+    world.pull()
+    _author_transformation(world.root)
+    world.push(branch=DEV)
+
+    summary = world.diff(branch=DEV)["summary"]
+    assert summary["modified"] == 0
+    assert summary["added"] == 0
+    assert world.push(branch=DEV).get("updated", 0) == 0
+
+
+def test_force_pull_does_not_overwrite_sql_edit_after_create(world: World) -> None:
+    """Without the companion hashes, pull read an edited `transform.sql` as
+    untouched and `--force` replaced it with the remote code once the config
+    changed remotely (here: renamed in the UI). It is now a conflict."""
+    from keboola_agent_cli.errors import SyncConflictError
+
+    world.init()
+    world.pull()
+    config_dir = _author_transformation(world.root)
+    world.push()
+    (config_id,) = world.api.ids(PROD)
+    _edit_sql(config_dir)
+    world.api.remote[PROD][config_id]["name"] = "renamed in the UI"
+
+    with pytest.raises(SyncConflictError):
+        world.pull(force=True)
+    assert "VALUEZ" in (config_dir / "transform.sql").read_text()

{keboola_cli-0.100.2 → keboola_cli-0.100.4}/tests/test_sync_service.py

@@ -3194,6 +3194,7 @@ class TestFreshCreateWriteback:
             new_id="123456789",
             file_hash="abc123",
             cfg_hash="def456",
+            extra_hashes={"transform.sql": "sql789"},
         )
 
         entry = writeback.entry
@@ -3205,6 +3206,7 @@ class TestFreshCreateWriteback:
         assert entry.branch_id == 12345
         assert entry.metadata["pull_hash"] == "abc123"
         assert entry.metadata["pull_config_hash"] == "def456"
+        assert entry.metadata["pull_extra_hashes"] == {"transform.sql": "sql789"}
         assert entry.metadata["KBC.configuration.folderName"] == "FI Pipeline", (
             "user-declared KBC.* metadata must survive the writeback"
         )
@@ -3238,6 +3240,7 @@ class TestFreshCreateWriteback:
             new_id="dev-id-002",
             file_hash="h1",
             cfg_hash="h2",
+            extra_hashes={},
         )
 
         entry = writeback.entry
@@ -3269,6 +3272,7 @@ class TestFreshCreateWriteback:
             new_id="999",
             file_hash="h1",
             cfg_hash="h2",
+            extra_hashes={},
         )
 
         entry = writeback.entry
@@ -3276,7 +3280,11 @@ class TestFreshCreateWriteback:
         assert len(manifest.configurations) == 1
         assert manifest.configurations[0] is entry
         assert entry.id == "999"
-        assert entry.metadata == {"pull_hash": "h1", "pull_config_hash": "h2"}
+        assert entry.metadata == {
+            "pull_hash": "h1",
+            "pull_config_hash": "h2",
+            "pull_extra_hashes": {},
+        }
 
     def test_propagate_kbc_metadata_calls_set_config_metadata(self, tmp_config_dir: Path) -> None:
         """KBC.* keys are POSTed via client.set_config_metadata; bookkeeping