refactor: [SNOW-1890085] use object plugin for listing dbt projects

Author: sfc-gh-jwilkowski

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

@@ -20,9 +20,12 @@
 import typer
 from snowflake.cli._plugins.dbt.constants import DBT_COMMANDS
 from snowflake.cli._plugins.dbt.manager import DBTManager
+from snowflake.cli._plugins.object.command_aliases import add_object_command_aliases
+from snowflake.cli._plugins.object.commands import scope_option
 from snowflake.cli.api.commands.decorators import global_options_with_connection
-from snowflake.cli.api.commands.flags import identifier_argument
+from snowflake.cli.api.commands.flags import identifier_argument, like_option
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.constants import ObjectType
 from snowflake.cli.api.feature_flags import FeatureFlag
 from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.types import CommandResult, MessageResult, QueryResult
@@ -39,17 +42,16 @@
 DBTNameArgument = identifier_argument(sf_object="DBT Project", example="my_pipeline")
 
 
-@app.command(
-    "list",
-    requires_connection=True,
+add_object_command_aliases(
+    app=app,
+    object_type=ObjectType.DBT_PROJECT,
+    name_argument=DBTNameArgument,
+    like_option=like_option(
+        help_example='`list --like "my%"` lists all dbt projects that begin with “my”'
+    ),
+    scope_option=scope_option(help_example="`list --in database my_db`"),
+    ommit_commands=["drop", "create", "describe"],
 )
-def list_dbts(
-    **options,
-) -> CommandResult:
-    """
-    List all dbt on Snowflake projects.
-    """
-    return QueryResult(DBTManager().list())
 
 
 @app.command(

src/snowflake/cli/api/constants.py

@@ -35,7 +35,7 @@ def __str__(self):
 
 class ObjectType(Enum):
     COMPUTE_POOL = ObjectNames("compute-pool", "compute pool", "compute pools")
-    DBT_PROJECT = ObjectNames("dbt-project", "DBT project", "DBT projects")
+    DBT_PROJECT = ObjectNames("dbt-project", "dbt project", "dbt projects")
     DATABASE = ObjectNames("database", "database", "databases")
     FUNCTION = ObjectNames("function", "function", "functions")
     INTEGRATION = ObjectNames("integration", "integration", "integrations")

tests/dbt/test_dbt_commands.py

@@ -32,12 +32,34 @@ def mock_connect(mock_ctx):
 
 
 class TestDBTList:
-    def test_dbt_list(self, mock_connect, runner):
-
-        result = runner.invoke(["dbt", "list"])
+    def test_list_command_alias(self, mock_connect, runner):
+        result = runner.invoke(
+            [
+                "object",
+                "list",
+                "dbt-project",
+                "--like",
+                "%PROJECT_NAME%",
+                "--in",
+                "database",
+                "my_db",
+            ]
+        )
 
         assert result.exit_code == 0, result.output
-        assert mock_connect.mocked_ctx.get_query() == "SHOW DBT PROJECTS"
+        result = runner.invoke(
+            ["dbt", "list", "--like", "%PROJECT_NAME%", "--in", "database", "my_db"],
+            catch_exceptions=False,
+        )
+        assert result.exit_code == 0, result.output
+
+        queries = mock_connect.mocked_ctx.get_queries()
+        assert len(queries) == 2
+        assert (
+            queries[0]
+            == queries[1]
+            == "show dbt projects like '%PROJECT_NAME%' in database my_db"
+        )
 
 
 class TestDBTDeploy: