refactor: [SNOW-1890085] reimplement dbt execute as pass-through command group

Author: sfc-gh-jwilkowski

src/snowflake/cli/_plugins/dbt/commands.py

@@ -15,9 +15,12 @@
 from __future__ import annotations
 
 import logging
+from typing import Annotated
 
 import typer
+from snowflake.cli._plugins.dbt.constants import DBT_COMMANDS
 from snowflake.cli._plugins.dbt.manager import DBTManager
+from snowflake.cli.api.commands.decorators import global_options_with_connection
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.output.types import CommandResult, QueryResult
 
@@ -37,31 +40,47 @@ def list_dbts(
     **options,
 ) -> CommandResult:
     """
-    List all dbt projects on Snowflake.
+    List all dbt on Snowflake projects.
     """
     return QueryResult(DBTManager().list())
 
 
-@app.command(
-    "execute",
-    requires_connection=True,
-    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+# `execute` is a pass through command group, meaning that all params after command should be passed over as they are,
+# suppressing usual CLI behaviour for displaying help or formatting options.
+dbt_execute_app = SnowTyperFactory(
+    name="execute",
+    help="Execute a dbt command",
 )
-def execute(
-    ctx: typer.Context,
-    dbt_command: str = typer.Argument(
-        help="dbt command to execute, i. e. run, compile, seed...",
-    ),
-    name: str = typer.Option(
-        default=...,
-        help="Name of the dbt object to execute command on.",
-    ),
+app.add_typer(dbt_execute_app)
+
+
+@dbt_execute_app.callback()
+@global_options_with_connection
+def before_callback(
+    name: Annotated[
+        str, typer.Argument(help="Name of the dbt object to execute command on.")
+    ],
     **options,
-) -> CommandResult:
-    """
-    Execute command on dbt in Snowflake project.
-    """
-    # ctx.args are parameters that were not captured as known cli params (those are in **options).
-    # as a consequence, we don't support passing params known to snowflake cli further to dbt
-    dbt_cli_args = ctx.args
-    return QueryResult(DBTManager().execute(dbt_command, name, *dbt_cli_args))
+):
+    """Handles global options passed before the command and takes pipeline name to be accessed through child context later"""
+    pass
+
+
+for cmd in DBT_COMMANDS:
+
+    @dbt_execute_app.command(
+        name=cmd,
+        requires_connection=False,
+        requires_global_options=False,
+        context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+        help=f"Execute {cmd} command on dbt on Snowflake project.",
+        add_help_option=False,
+    )
+    def _dbt_execute(
+        ctx: typer.Context,
+    ) -> CommandResult:
+        # TODO: figure out how to present logs to users
+        dbt_cli_args = ctx.args
+        dbt_command = ctx.command.name
+        name = ctx.parent.params["name"]
+        return QueryResult(DBTManager().execute(dbt_command, name, *dbt_cli_args))

src/snowflake/cli/_plugins/dbt/constants.py

@@ -0,0 +1,20 @@
+DBT_COMMANDS = [
+    "build",
+    "clean",
+    "clone",
+    "compile",
+    "debug",
+    "deps",
+    "docs",
+    "init",
+    "list",
+    "parse",
+    "retry",
+    "run",
+    "run",
+    "seed",
+    "show",
+    "snapshot",
+    "source",
+    "test",
+]

tests/dbt/test_dbt_commands.py

@@ -37,35 +37,59 @@ def test_dbt_list(mock_connect, runner):
 @pytest.mark.parametrize(
     "args,expected_query",
     [
-        (
-            ["dbt", "execute", "compile", "--name=pipeline_name"],
-            "EXECUTE DBT pipeline_name compile",
+        pytest.param(
+            [
+                "dbt",
+                "execute",
+                "pipeline_name",
+                "test",
+            ],
+            "EXECUTE DBT pipeline_name test",
+            id="simple-command",
         ),
-        (
+        pytest.param(
             [
                 "dbt",
                 "execute",
-                "compile",
-                "--name=pipeline_name",
+                "pipeline_name",
+                "run",
                 "-f",
                 "--select @source:snowplow,tag:nightly models/export",
             ],
-            "EXECUTE DBT pipeline_name compile -f --select @source:snowplow,tag:nightly models/export",
+            "EXECUTE DBT pipeline_name run -f --select @source:snowplow,tag:nightly models/export",
+            id="with-dbt-options",
         ),
-        (
-            ["dbt", "execute", "compile", "--name=pipeline_name", "--vars '{foo:bar}'"],
+        pytest.param(
+            ["dbt", "execute", "pipeline_name", "compile", "--vars '{foo:bar}'"],
             "EXECUTE DBT pipeline_name compile --vars '{foo:bar}'",
+            id="with-dbt-vars",
         ),
-        (
+        pytest.param(
             [
                 "dbt",
                 "execute",
+                "pipeline_name",
                 "compile",
-                "--name=pipeline_name",
-                "--format=JSON",
+                "--format=TXT",  # collision with CLI's option; unsupported option
+                "-v",  # collision with CLI's option
+                "-h",
                 "--debug",
+                "--info",
+                "--config-file=/",
+            ],
+            "EXECUTE DBT pipeline_name compile --format=TXT -v -h --debug --info --config-file=/",
+            id="with-dbt-conflicting-options",
+        ),
+        pytest.param(
+            [
+                "dbt",
+                "execute",
+                "--format=JSON",
+                "pipeline_name",
+                "compile",
             ],
             "EXECUTE DBT pipeline_name compile",
+            id="with-cli-flag",
         ),
     ],
 )