Register remote dev plugin

Author: sfc-gh-zzhu

src/snowflake/cli/_app/commands_registration/builtin_plugins.py

@@ -25,6 +25,7 @@
 from snowflake.cli._plugins.notebook import plugin_spec as notebook_plugin_spec
 from snowflake.cli._plugins.object import plugin_spec as object_plugin_spec
 from snowflake.cli._plugins.plugin import plugin_spec as plugin_plugin_spec
+from snowflake.cli._plugins.remote import plugin_spec as remote_plugin_spec
 from snowflake.cli._plugins.snowpark import plugin_spec as snowpark_plugin_spec
 from snowflake.cli._plugins.spcs import plugin_spec as spcs_plugin_spec
 from snowflake.cli._plugins.sql import plugin_spec as sql_plugin_spec
@@ -53,6 +54,7 @@ def get_builtin_plugin_name_to_plugin_spec():
         "init": init_plugin_spec,
         "workspace": workspace_plugin_spec,
         "plugin": plugin_plugin_spec,
+        "remote": remote_plugin_spec,
         "dbt": dbt_plugin_spec,
         "logs": logs_plugin_spec,
     }

src/snowflake/cli/_plugins/remote/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

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

@@ -0,0 +1,38 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+import logging
+
+from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+
+log = logging.getLogger(__name__)
+app = SnowTyperFactory(
+    name="remote",
+    help="Manages remote development environments.",
+)
+
+
+@app.command("list", requires_connection=True)
+def list_services(**options) -> None:
+    """
+    List remote development environments.
+
+    This is a placeholder command for the remote plugin.
+    Full functionality will be implemented in subsequent PRs.
+    """
+    log.info("Remote plugin registered successfully")
+    log.info("Remote development environments plugin is registered.")
+    log.info("Full functionality will be available in upcoming releases.")

src/snowflake/cli/_plugins/remote/plugin_spec.py

@@ -0,0 +1,30 @@
+# Copyright (c) 2024 Snowflake Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from snowflake.cli._plugins.remote import commands
+from snowflake.cli.api.plugins.command import (
+    SNOWCLI_ROOT_COMMAND_PATH,
+    CommandSpec,
+    CommandType,
+    plugin_hook_impl,
+)
+
+
+@plugin_hook_impl
+def command_spec():
+    return CommandSpec(
+        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
+        command_type=CommandType.COMMAND_GROUP,
+        typer_instance=commands.app.create_instance(),
+    )

tests_e2e/__snapshots__/test_installation.ambr

@@ -39,6 +39,7 @@
   | logs                 Retrieves logs for a given object.                      |
   | notebook             Manages notebooks in Snowflake.                         |
   | object               Manages Snowflake objects like warehouses and stages    |
+  | remote               Manages remote development environments.                |
   | snowpark             Manages procedures and functions.                       |
   | spcs                 Manages Snowpark Container Services compute pools,      |
   |                      services, image registries, and image repositories.     |
@@ -102,6 +103,7 @@
   | logs         Retrieves logs for a given object.                              |
   | notebook     Manages notebooks in Snowflake.                                 |
   | object       Manages Snowflake objects like warehouses and stages            |
+  | remote       Manages remote development environments.                        |
   | snowpark     Manages procedures and functions.                               |
   | spcs         Manages Snowpark Container Services compute pools, services,    |
   |              image registries, and image repositories.                       |
@@ -146,6 +148,7 @@
   | logs                 Retrieves logs for a given object.                      |
   | notebook             Manages notebooks in Snowflake.                         |
   | object               Manages Snowflake objects like warehouses and stages    |
+  | remote               Manages remote development environments.                |
   | snowpark             Manages procedures and functions.                       |
   | spcs                 Manages Snowpark Container Services compute pools,      |
   |                      services, image registries, and image repositories.     |
@@ -229,6 +232,7 @@
   | logs         Retrieves logs for a given object.                              |
   | notebook     Manages notebooks in Snowflake.                                 |
   | object       Manages Snowflake objects like warehouses and stages            |
+  | remote       Manages remote development environments.                        |
   | snowpark     Manages procedures and functions.                               |
   | spcs         Manages Snowpark Container Services compute pools, services,    |
   |              image registries, and image repositories.                       |