tinybird 0.0.1.dev258__tar.gz → 0.0.1.dev260__tar.gz

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: tinybird
-Version: 0.0.1.dev258
+Version: 0.0.1.dev260
 Summary: Tinybird Command Line Tool
 Home-page: https://www.tinybird.co/docs/forward/commands
 Author: Tinybird

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/prompts.py

@@ -376,6 +376,7 @@ You are a Tinybird expert. You will be given a pipe containing different nodes w
     - If there are no parameters, you can omit parameters and generate a single test.
     - The format of the parameters is the following: ?param1=value1&param2=value2&param3=value3
     - If some parameters are provided by the user and you need to use them, preserve in the same format as they were provided, like case sensitive.
+    - If user provides the current test content, use it to generate the new test content.
 </instructions>
 
 This is an example of a test with parameters:

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/tb/__cli__.py

@@ -4,5 +4,5 @@ __description__ = 'Tinybird Command Line Tool'
 __url__ = 'https://www.tinybird.co/docs/forward/commands'
 __author__ = 'Tinybird'
 __author_email__ = 'support@tinybird.co'
-__version__ = '0.0.1.dev258'
-__revision__ = 'ca57848'
+__version__ = '0.0.1.dev260'
+__revision__ = 'bd0c45e'

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/tb/modules/agent/agent.py

@@ -17,11 +17,11 @@ from tinybird.tb.modules.agent.animations import ThinkingAnimation
 from tinybird.tb.modules.agent.banner import display_banner
 from tinybird.tb.modules.agent.memory import clear_history, clear_messages, load_messages, save_messages
 from tinybird.tb.modules.agent.models import create_model, model_costs
-from tinybird.tb.modules.agent.prompts import agent_system_prompt, resources_prompt
+from tinybird.tb.modules.agent.prompts import agent_system_prompt, load_custom_project_rules, resources_prompt
 from tinybird.tb.modules.agent.tools.analyze import analyze_file, analyze_url
 from tinybird.tb.modules.agent.tools.append import append_file, append_url
 from tinybird.tb.modules.agent.tools.build import build
-from tinybird.tb.modules.agent.tools.create_datafile import create_datafile
+from tinybird.tb.modules.agent.tools.create_datafile import create_datafile, rename_datafile_or_fixture
 from tinybird.tb.modules.agent.tools.deploy import deploy
 from tinybird.tb.modules.agent.tools.deploy_check import deploy_check
 from tinybird.tb.modules.agent.tools.diff_resource import diff_resource
@@ -32,6 +32,8 @@ from tinybird.tb.modules.agent.tools.mock import mock
 from tinybird.tb.modules.agent.tools.plan import plan
 from tinybird.tb.modules.agent.tools.preview_datafile import preview_datafile
 from tinybird.tb.modules.agent.tools.request_endpoint import request_endpoint
+from tinybird.tb.modules.agent.tools.test import create_tests as create_tests_tool
+from tinybird.tb.modules.agent.tools.test import run_tests as run_tests_tool
 from tinybird.tb.modules.agent.utils import AgentRunCancelled, TinybirdAgentContext, show_input
 from tinybird.tb.modules.build_common import process as build_process
 from tinybird.tb.modules.common import _analyze, _get_tb_client, echo_safe_humanfriendly_tables_format_pretty_table
@@ -43,6 +45,7 @@ from tinybird.tb.modules.local_common import get_tinybird_local_client
 from tinybird.tb.modules.login_common import login
 from tinybird.tb.modules.mock_common import append_mock_data, create_mock_data
 from tinybird.tb.modules.project import Project
+from tinybird.tb.modules.test_common import run_tests as run_tests_common
 
 
 class TinybirdAgent:
@@ -72,6 +75,12 @@ class TinybirdAgent:
             tools=[
                 Tool(preview_datafile, docstring_format="google", require_parameter_descriptions=True, takes_ctx=False),
                 Tool(create_datafile, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
+                Tool(
+                    rename_datafile_or_fixture,
+                    docstring_format="google",
+                    require_parameter_descriptions=True,
+                    takes_ctx=True,
+                ),
                 Tool(plan, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
                 Tool(build, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
                 Tool(deploy, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
@@ -93,6 +102,8 @@ class TinybirdAgent:
                 Tool(execute_query, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
                 Tool(request_endpoint, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
                 Tool(diff_resource, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
+                Tool(create_tests_tool, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
+                Tool(run_tests_tool, docstring_format="google", require_parameter_descriptions=True, takes_ctx=True),
             ],
             # history_processors=[self._keep_recent_messages],
         )
@@ -152,6 +163,7 @@ class TinybirdAgent:
             get_connection_datafile_cloud=partial(get_connection_datafile_cloud, config=config),
             get_connection_datafile_local=partial(get_connection_datafile_local, config=config),
             get_project_files=project.get_project_files,
+            run_tests=partial(run_tests, project=project, config=config),
             folder=folder,
             thinking_animation=self.thinking_animation,
             workspace_name=self.project.workspace_name,
@@ -164,7 +176,7 @@ class TinybirdAgent:
         )
 
     def run(self, user_prompt: str, config: dict[str, Any]) -> None:
-        user_prompt = f"{user_prompt}\n\n{resources_prompt(self.project)}"
+        user_prompt = f"{user_prompt}\n\n{load_custom_project_rules(self.project.folder)}"
         self.thinking_animation.start()
         result = self.agent.run_sync(
             user_prompt,
@@ -179,7 +191,7 @@ class TinybirdAgent:
         self._echo_usage(config, result)
 
     async def run_iter(self, user_prompt: str, config: dict[str, Any]) -> None:
-        user_prompt = f"{user_prompt}\n\n"
+        user_prompt = f"{user_prompt}\n\n{load_custom_project_rules(self.project.folder)}"
         self.thinking_animation.start()
         deps = self._build_agent_deps(config)
 
@@ -495,3 +507,11 @@ def get_connection_datafile_local(config: dict[str, Any], connection_name: str)
         return local_client.connection_file(connection_name)
     except Exception:
         return "Connection not found"
+
+
+def run_tests(config: dict[str, Any], project: Project, pipe_name: Optional[str] = None) -> None:
+    local_client = get_tinybird_local_client(config, test=True, silent=True)
+    try:
+        run_tests_common(name=(pipe_name,) if pipe_name else (), project=project, client=local_client)
+    except SystemExit as e:
+        raise Exception(e.args[0])

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/tb/modules/agent/prompts.py

@@ -16,6 +16,7 @@ from tinybird.prompts import (
     pipe_instructions,
     s3_connection_example,
     sink_pipe_instructions,
+    test_instructions,
 )
 from tinybird.tb.modules.project import Project
 
@@ -114,6 +115,7 @@ datafile_instructions = """
 def resources_prompt(project: Project) -> str:
     files = project.get_project_files()
     fixture_files = project.get_fixture_files()
+    test_files = project.get_test_files()
 
     resources_content = "# Existing resources in the project:\n"
     if files:
@@ -146,7 +148,22 @@ def resources_prompt(project: Project) -> str:
     else:
         fixture_content += "No fixture files found"
 
-    return resources_content + "\n" + fixture_content
+    test_content = "# Test files in the project:\n"
+    if test_files:
+        tests: list[dict[str, Any]] = []
+        for filename in test_files:
+            file_path = Path(filename)
+            test = {
+                "path": str(file_path.relative_to(project.folder)),
+                "name": file_path.stem,
+                "content": file_path.read_text(),
+            }
+            tests.append(test)
+        test_content = format_as_xml(tests, root_tag="tests", item_tag="test")
+    else:
+        test_content += "No test files found"
+
+    return resources_content + "\n" + fixture_content + "\n" + test_content
 
 
 def get_resource_type(path: Path) -> str:
@@ -550,9 +567,11 @@ You have access to the following tools:
 13. `execute_query` - Execute a query against Tinybird Cloud or Local.
 13. `request_endpoint` - Request an endpoint against Tinybird Cloud or Local.
 14. `diff_resource` - Diff the content of a resource in Tinybird Cloud vs Tinybird Local vs Project local file.
+15. `create_tests` - Create tests for an endpoint.
+16. `rename_datafile_or_fixture` - Rename a datafile or fixture.
 
 # When creating or updating datafiles:
-1. Use `plan` tool to plan the creation or update of resources.
+1. Use `plan` tool to plan the creation, update or rename of resources.
 2. If the user confirms the plan, go from 3 to 7 steps until all the resources are created, updated or skipped.
 3. Use `preview_datafile` tool to preview the content of a datafile.
 4. Without asking, use the `create_datafile` tool to create the datafile, because it will ask for confirmation before creating the file.
@@ -612,22 +631,26 @@ Kafka: {kafka_connection_example}
 S3: {s3_connection_example}
 GCS: {gcs_connection_example}
 
-# When executing a query or requesting/testing an endpoint:
+# When executing a query or calling an endpoint:
 - You need to be sure that the selected resource is updated to the last version in the environment you are working on.
 - Use `diff_resource` tool to compare the content of the resource to compare the differences between environments.
 - Project local file is the source of truth.
 - If the resource is not present or updated to the last version in Tinybird Local, it means you need to build the project. 
 - If the resource is not present or updated to the last version in Tinybird Cloud, it means you need to deploy the project.
+- If exploring an endpoint, the response is empty. You can query the tables to understand what data is available.
+
 
 # How to use apppend tools:
 - Use append as part of the creation of a new landing datasource if the user provided a file or an external url
 - Use append if user explicitly asks for it
-- Do not append data if user requests to test an endpoint
+- Do not append data if user requests to test an endpoint or call an endpoint.
+- Do not append data as consequence of an empty response from the endpoint or a query.
 
 # How to use `mock` tool:
 - Use `mock` tool as part of the creation of a new landing datasource if the user did not provided a file or an external url
 - Use `mock` tool if user explicitly asks for it
 - Do not use `mock` tool if user requests to test an endpoint.
+- Do not use `mock` tool as consequence of an empty response from the endpoint or a query.
 
 # When sharing endpoints paths or urls:
 - Use `get_openapi_definition` tool to get the url of the endpoint and parameters available.
@@ -639,6 +662,25 @@ GCS: {gcs_connection_example}
 - `DateTime` parameters accept values in format `YYYY-MM-DD HH:MM:SS`
 - `Date` parameters accept values in format `YYYYMMDD`
 
+# Working with tests:
+{test_instructions}
+<dev_notes>
+- Create tests only when the user explicitly asks for it with prompts like "Create tests for this endpoint" or "Create tests for this pipe".
+- If the user asks for "testing an endpoint" or "call an endpoint", just request to the endpoint.
+- The data that the tests are using is the data provided in the fixtures folder.
+- Querying data or requesting endpoints won't return the data that the tests are using.
+- MANDATORY: Before creating the test, analyze the fixture files that the tables of the endpoint are using so you can create relevant tests.
+</dev_notes>
+
 # Info
 Today is {datetime.now().strftime("%Y-%m-%d")}
 """
+
+
+def load_custom_project_rules(folder: str) -> str:
+    tinybird_rules = Path(folder).joinpath("TINYBIRD.md")
+
+    if not tinybird_rules.exists():
+        return ""
+
+    return f"# Custom Project Rulesd defined by the user\n\n{tinybird_rules.read_text()}"

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/tb/modules/agent/tools/create_datafile.py

@@ -122,3 +122,59 @@ def create_file(ctx: RunContext[TinybirdAgentContext], path: str, content: str):
         f.write(content)
 
     return "ok"
+
+
+def rename_datafile_or_fixture(ctx: RunContext[TinybirdAgentContext], path: str, new_path: str):
+    """Renames a datafile or fixture.
+
+    Args:
+        path (str): The path to the file to rename. Required.
+        new_path (str): The new path to the file. Required.
+    """
+    try:
+        ctx.deps.thinking_animation.stop()
+        confirmation = show_confirmation(
+            title=f"Rename '{path}' to '{new_path}'?",
+            skip_confirmation=ctx.deps.dangerously_skip_permissions,
+        )
+
+        if confirmation == "review":
+            feedback = show_input(ctx.deps.workspace_name)
+            ctx.deps.thinking_animation.start()
+            return f"User did not confirm the proposed changes and gave the following feedback: {feedback}"
+
+        click.echo(FeedbackManager.highlight(message=f"» Renaming file {path} to {new_path}..."))
+        new_path_full = Path(ctx.deps.folder) / new_path.removeprefix("/")
+
+        if new_path_full.exists():
+            click.echo(FeedbackManager.error(message=f"Error: File {new_path} already exists"))
+            ctx.deps.thinking_animation.start()
+            return f"Error: File {new_path} already exists"
+
+        parent_path = new_path_full.parent
+        parent_path.mkdir(parents=True, exist_ok=True)
+        os.rename(Path(ctx.deps.folder) / path.removeprefix("/"), new_path_full)
+        is_datafile = (".connection", ".datasource", ".pipe")
+
+        if new_path_full.suffix in is_datafile:
+            ctx.deps.build_project(test=False, silent=True)
+
+        click.echo(FeedbackManager.success(message=f"✓ {new_path} created"))
+        ctx.deps.thinking_animation.start()
+        return f"Renamed file from {path} to {new_path}"
+    except AgentRunCancelled as e:
+        raise e
+    except FileNotFoundError:
+        ctx.deps.thinking_animation.start()
+        click.echo(FeedbackManager.error(message=f"Error: File {path} not found"))
+        return f"Error: File {path} not found (double check the file path)"
+    except CLIBuildException as e:
+        ctx.deps.thinking_animation.stop()
+        click.echo(FeedbackManager.error(message=e))
+        ctx.deps.thinking_animation.start()
+        return f"Error building project: {e}"
+    except Exception as e:
+        ctx.deps.thinking_animation.stop()
+        click.echo(FeedbackManager.error(message=e))
+        ctx.deps.thinking_animation.start()
+        return f"Error renaming {path} to {new_path}: {e}"

tinybird-0.0.1.dev260/tinybird/tb/modules/agent/tools/test.py

@@ -0,0 +1,120 @@
+from pathlib import Path
+from typing import Optional
+
+import click
+from pydantic_ai import RunContext
+
+from tinybird.tb.modules.agent.utils import (
+    AgentRunCancelled,
+    TinybirdAgentContext,
+    create_terminal_box,
+    show_confirmation,
+    show_input,
+)
+from tinybird.tb.modules.feedback_manager import FeedbackManager
+
+
+def create_tests(ctx: RunContext[TinybirdAgentContext], pipe_name: str, test_content: str) -> str:
+    """Given a pipe name, create or update a test for it
+
+    Args:
+        pipe_name (str): The pipe name to create a test for. Required.
+        test_content (str): The content of the test. Required.
+
+    Returns:
+        str: If the test was created or updated and the result of running the tests.
+    """
+    running_tests = False
+    try:
+        ctx.deps.thinking_animation.stop()
+        path = Path(ctx.deps.folder) / "tests" / f"{pipe_name}.yaml"
+        current_test_content: Optional[str] = None
+        if path.exists():
+            current_test_content = path.read_text()
+
+        if current_test_content:
+            content = create_terminal_box(current_test_content, new_content=test_content, title=path.name)
+        else:
+            content = create_terminal_box(test_content, title=path.name)
+
+        click.echo(content)
+        action_text = "Create" if not current_test_content else "Update"
+        confirmation = show_confirmation(
+            title=f"{action_text} '{path.name}'?",
+            skip_confirmation=ctx.deps.dangerously_skip_permissions,
+        )
+
+        if confirmation == "review":
+            feedback = show_input(ctx.deps.workspace_name)
+            ctx.deps.thinking_animation.start()
+            return f"User did not confirm the proposed changes and gave the following feedback: {feedback}"
+
+        folder_path = path.parent
+        folder_path.mkdir(parents=True, exist_ok=True)
+        path.touch(exist_ok=True)
+        path.write_text(test_content)
+        action_text = "created" if not current_test_content else "updated"
+        click.echo(FeedbackManager.success(message=f"✓ {path.name} {action_text}"))
+        running_tests = True
+        test_output = ctx.deps.run_tests(pipe_name=pipe_name)
+        click.echo(test_output)
+        ctx.deps.thinking_animation.start()
+        return f"Test {action_text} for '{pipe_name}' endpoint in {path} and ran successfully\n{test_output}"
+    except AgentRunCancelled as e:
+        raise e
+    except Exception as e:
+        error_message = str(e).replace("test_error__error__", "")
+        ctx.deps.thinking_animation.stop()
+        if not running_tests:
+            click.echo(FeedbackManager.error(message=error_message))
+        ctx.deps.thinking_animation.start()
+        if running_tests:
+            return f"Test {action_text} for '{pipe_name}' endpoint in {path} but there were errors running the tests: {error_message}"
+        return f"Error creating test for '{pipe_name}' endpoint: {error_message}"
+
+
+def run_tests(ctx: RunContext[TinybirdAgentContext], pipe_name: Optional[str] = None) -> str:
+    """Run tests for a given pipe name or all tests in the project
+
+    Args:
+        pipe_name (Optional[str]): The pipe name to run tests for. If not provided, all tests in the project will be run.
+
+    Returns:
+        str: The result of running the tests.
+    """
+
+    try:
+        ctx.deps.thinking_animation.stop()
+        path = Path(ctx.deps.folder) / "tests" / f"{pipe_name}.yaml"
+
+        title = f"Run tests for '{pipe_name}'?" if pipe_name else "Run all tests in the project?"
+        confirmation = show_confirmation(
+            title=title,
+            skip_confirmation=ctx.deps.dangerously_skip_permissions,
+        )
+
+        if confirmation == "review":
+            feedback = show_input(ctx.deps.workspace_name)
+            ctx.deps.thinking_animation.start()
+            return f"User did not confirm the proposed changes and gave the following feedback: {feedback}"
+
+        test_output = ctx.deps.run_tests(pipe_name=pipe_name)
+        click.echo(test_output)
+        ctx.deps.thinking_animation.start()
+        if pipe_name:
+            return f"Tests for '{pipe_name}' endpoint in {path} and ran successfully\n{test_output}"
+        else:
+            return f"All tests in the project ran successfully\n{test_output}"
+    except AgentRunCancelled as e:
+        raise e
+    except Exception as e:
+        error_message = str(e)
+        test_exit_code = "test_error__error__"
+        test_error = test_exit_code in error_message
+        ctx.deps.thinking_animation.stop()
+        if not test_error:
+            click.echo(FeedbackManager.error(message=error_message))
+        else:
+            error_message = error_message.replace(test_exit_code, "")
+        ctx.deps.thinking_animation.start()
+        return f"Error running tests: {error_message}"

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/tb/modules/agent/utils.py

@@ -52,6 +52,7 @@ class TinybirdAgentContext(BaseModel):
     get_pipe_datafile_local: Callable[..., str]
     get_connection_datafile_cloud: Callable[..., str]
     get_connection_datafile_local: Callable[..., str]
+    run_tests: Callable[..., Optional[str]]
     dangerously_skip_permissions: bool
     token: str
     user_token: str

{tinybird-0.0.1.dev258 → tinybird-0.0.1.dev260}/tinybird/tb/modules/project.py

@@ -24,6 +24,10 @@ class Project:
     def vendor_path(self) -> str:
         return f"{self.path}/vendor"
 
+    @property
+    def tests_path(self) -> str:
+        return f"{self.path}/tests"
+
     def get_files(self, extension: str) -> List[str]:
         project_files: List[str] = []
         for level in range(self.max_depth):
@@ -52,13 +56,32 @@ class Project:
 
     def get_fixture_files(self) -> List[str]:
         fixture_files: List[str] = []
-        for extension in ["csv", "ndjson", "parquet"]:
+        for extension in [
+            "csv",
+            "csv.gz",
+            "ndjson",
+            "ndjson.gz",
+            "jsonl",
+            "jsonl.gz",
+            "json",
+            "json.gz",
+            "parquet",
+            "parquet.gz",
+        ]:
             for fixture_file in self.get_files(extension):
                 if self.vendor_path in fixture_file:
                     continue
                 fixture_files.append(fixture_file)
         return fixture_files
 
+    def get_test_files(self) -> List[str]:
+        test_files: List[str] = []
+        for test_file in self.get_files("yaml"):
+            if self.vendor_path in test_file or self.tests_path not in test_file:
+                continue
+            test_files.append(test_file)
+        return test_files
+
     def get_resource_path(self, resource_name: str, resource_type: str) -> str:
         full_path = next(
             (p for p in self.get_project_files() if p.endswith("/" + resource_name + f".{resource_type}")), ""

tinybird-0.0.1.dev260/tinybird/tb/modules/test.py

@@ -0,0 +1,61 @@
+# This is a command file for our CLI. Please keep it clean.
+#
+# - If it makes sense and only when strictly necessary, you can create utility functions in this file.
+# - But please, **do not** interleave utility functions and command definitions.
+
+from typing import Tuple
+
+import click
+
+from tinybird.tb.client import TinyB
+from tinybird.tb.modules.cli import cli
+from tinybird.tb.modules.project import Project
+from tinybird.tb.modules.test_common import create_test, run_tests, update_test
+
+
+@cli.group()
+@click.pass_context
+def test(ctx: click.Context) -> None:
+    """Test commands."""
+
+
+@test.command(
+    name="create",
+    help="Create a test for an existing pipe",
+)
+@click.argument("name_or_filename", type=str)
+@click.option(
+    "--prompt", type=str, default="Create a test for the selected pipe", help="Prompt to be used to create the test"
+)
+@click.pass_context
+def test_create(ctx: click.Context, name_or_filename: str, prompt: str) -> None:
+    """
+    Create a test for an existing pipe
+    """
+    project: Project = ctx.ensure_object(dict)["project"]
+    client: TinyB = ctx.ensure_object(dict)["client"]
+    create_test(name_or_filename, prompt, project, client)
+
+
+@test.command(
+    name="update",
+    help="Update the test expectations for a file or a test.",
+)
+@click.argument("pipe", type=str)
+@click.pass_context
+def test_update(ctx: click.Context, pipe: str) -> None:
+    client: TinyB = ctx.ensure_object(dict)["client"]
+    project: Project = ctx.ensure_object(dict)["project"]
+    update_test(pipe, project, client)
+
+
+@test.command(
+    name="run",
+    help="Run the test suite, a file, or a test",
+)
+@click.argument("name", nargs=-1)
+@click.pass_context
+def run_tests_command(ctx: click.Context, name: Tuple[str, ...]) -> None:
+    client: TinyB = ctx.ensure_object(dict)["client"]
+    project: Project = ctx.ensure_object(dict)["project"]
+    run_tests(name, project, client)