Add --default to add command to mark connection as default (#1186)

RELEASE-NOTES.md

@@ -26,7 +26,8 @@
   * `snow notebook execute` enabling head-less execution of a notebook.
   * `snow notebook create` proving an option to create a Snowflake Notebook from a file on stage.
 * Added templating support for project definition file.
-  * Template variables can now be used anywhere in the the project definition file.
+  * Template variables can now be used anywhere in the project definition file.
+* Added `--default` flag to `snow connection add` commands allowing users to mark the new connection as default.
 
 ## Fixes and improvements
 * Fixed error handling for malformatted `config.toml`

src/snowflake/cli/plugins/connection/commands.py

@@ -218,6 +218,12 @@ def add(
         prompt="Path to private key file",
         help="Path to file containing private key",
     ),
+    set_as_default: bool = typer.Option(
+        False,
+        "--default",
+        is_flag=True,
+        help="If provided the connection will be configured as default connection.",
+    ),
     **options,
 ) -> CommandResult:
     """Adds a connection to configuration file."""
@@ -241,6 +247,11 @@ def add(
             private_key_path=private_key_path,
         ),
     )
+    if set_as_default:
+        set_config_value(
+            section=None, key="default_connection_name", value=connection_name
+        )
+
     return MessageResult(
         f"Wrote new connection {connection_name} to {CONFIG_MANAGER.file_path}"
     )

tests/__snapshots__/test_connection.ambr

@@ -26,6 +26,16 @@
 
   '''
 # ---
+# name: test_new_connection_can_be_added_as_default
+  '''
+  default_connection_name = "default-conn"
+  [connections.default-conn]
+  account = "account1"
+  user = "user1"
+  password = "password1"
+
+  '''
+# ---
 # name: test_new_connection_with_jwt_auth
   '''
   [connections.conn2]

tests/__snapshots__/test_help_messages.ambr

@@ -901,6 +901,8 @@
   │                                        [default: optional]                   │
   │ --private-key            -k      TEXT  Path to file containing private key   │
   │                                        [default: optional]                   │
+  │ --default                              If provided the connection will be    │
+  │                                        configured as default connection.     │
   │ --help                                 Show this message and exit.           │
   ╰──────────────────────────────────────────────────────────────────────────────╯
   ╭─ Global configuration ───────────────────────────────────────────────────────╮

tests/test_connection.py

@@ -48,6 +48,29 @@ def test_new_connection_can_be_added(runner, snapshot):
     assert content == snapshot
 
 
+def test_new_connection_can_be_added_as_default(runner, snapshot):
+    with NamedTemporaryFile("w+", suffix=".toml") as tmp_file:
+        result = runner.invoke_with_config_file(
+            tmp_file.name,
+            [
+                "connection",
+                "add",
+                "--connection-name",
+                "default-conn",
+                "--username",
+                "user1",
+                "--password",
+                "password1",
+                "--account",
+                "account1",
+                "--default",
+            ],
+        )
+        content = tmp_file.read()
+    assert result.exit_code == 0, result.output
+    assert content == snapshot
+
+
 def test_new_connection_with_jwt_auth(runner, snapshot):
     with NamedTemporaryFile("w+", suffix=".toml") as tmp_file:
         result = runner.invoke_with_config_file(