SNOW-2021431 error codes handle cursor errors (#2183)

Author: sfc-gh-mraba

src/snowflake/cli/_plugins/helpers/snowsl_vars_reader.py

@@ -89,6 +89,11 @@
         "Suggested": "PRIVATE_KEY_PASSPHRASE",
         "Additional info": "https://docs.snowflake.com/en/developer-guide/snowflake-cli/connecting/configure-connections",
     },
+    "EXIT_ON_ERROR": {
+        "Found": "EXIT_ON_ERROR",
+        "Suggested": "SNOWFLAKE_ENHANCED_EXIT_CODES",
+        "Additional info": "https://docs.snowflake.com/en/developer-guide/snowflake-cli/sql/execute-sql",
+    },
 }
 
 

src/snowflake/cli/api/commands/flags.py

@@ -379,6 +379,7 @@ def _diag_log_allowlist_path_callback(path: str):
     is_flag=True,
     rich_help_panel=_CLI_BEHAVIOUR,
     is_eager=True,
+    envvar="SNOWFLAKE_ENHANCED_EXIT_CODES",
 )
 
 

src/snowflake/cli/api/commands/snow_typer.py

@@ -31,7 +31,13 @@
     ExecutionStatus,
 )
 from snowflake.cli.api.commands.flags import DEFAULT_CONTEXT_SETTINGS
-from snowflake.cli.api.exceptions import CommandReturnTypeError
+from snowflake.cli.api.exceptions import (
+    BaseCliError,
+    CliArgumentError,
+    CliError,
+    CliSqlError,
+    CommandReturnTypeError,
+)
 from snowflake.cli.api.output.types import CommandResult
 from snowflake.cli.api.sanitizers import sanitize_for_terminal
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
@@ -168,8 +174,20 @@ def exception_handler(exception: Exception, execution: ExecutionMetadata):
 
         log.debug("Executing command exception callback")
         log_command_execution_error(exception, execution)
+        exception = SnowTyper._cli_base_exception_migration_dispatcher(exception)
+        return exception
+
+    @staticmethod
+    def _cli_base_exception_migration_dispatcher(exception):
+        """Handler used for dispatching exception until migration completed."""
+        if isinstance(
+            exception, (BaseCliError, CliError, CliArgumentError, CliSqlError)
+        ):
+            return exception
+
         if isinstance(exception, DatabaseError):
-            return ClickException(exception.msg)
+            return CliSqlError(exception.msg)
+
         return exception
 
     @staticmethod

tests/__snapshots__/test_help_messages.ambr

@@ -88,6 +88,8 @@
   |                                              to console.                     |
   | --enhanced-exit-codes                        Differentiate exit error codes  |
   |                                              based on failure type.          |
+  |                                              [env var:                       |
+  |                                              SNOWFLAKE_ENHANCED_EXIT_CODES]  |
   +------------------------------------------------------------------------------+
 
 
@@ -117,6 +119,8 @@
   |                                              to console.                     |
   | --enhanced-exit-codes                        Differentiate exit error codes  |
   |                                              based on failure type.          |
+  |                                              [env var:                       |
+  |                                              SNOWFLAKE_ENHANCED_EXIT_CODES]  |
   +------------------------------------------------------------------------------+
 
 
@@ -168,6 +172,8 @@
   |                                              to console.                     |
   | --enhanced-exit-codes                        Differentiate exit error codes  |
   |                                              based on failure type.          |
+  |                                              [env var:                       |
+  |                                              SNOWFLAKE_ENHANCED_EXIT_CODES]  |
   +------------------------------------------------------------------------------+
 
 

tests/api/commands/__snapshots__/test_snow_typer.ambr

@@ -93,6 +93,8 @@
   |                                              to console.                     |
   | --enhanced-exit-codes                        Differentiate exit error codes  |
   |                                              based on failure type.          |
+  |                                              [env var:                       |
+  |                                              SNOWFLAKE_ENHANCED_EXIT_CODES]  |
   +------------------------------------------------------------------------------+
 
 

tests/api/artifacts/test_enhanced_error_codes.py renamed to tests/api/test_enhanced_exit_codes.py

@@ -106,6 +106,8 @@
   |                                              to console.                     |
   | --enhanced-exit-codes                        Differentiate exit error codes  |
   |                                              based on failure type.          |
+  |                                              [env var:                       |
+  |                                              SNOWFLAKE_ENHANCED_EXIT_CODES]  |
   +------------------------------------------------------------------------------+
 
 

tests/output/__snapshots__/test_silent_output.ambr

@@ -26,7 +26,7 @@
         pytest.param(
             ("sql", "-q", "select '&foo'", "--enhanced-exit-codes"),
             5,
-            id="missing variable fails with 1",
+            id="missing variable fails with 5",
         ),
     ),
 )

tests/sql/__snapshots__/test_sql.ambr

@@ -217,3 +217,16 @@ def test_sql_with_variables_from_project(runner, project_directory, template):
         )
         assert result.exit_code == 0, result.output
         assert result.json == [{"VAR": "Knights of Nii"}]
+
+
+@pytest.mark.integration
+def test_sql_ec(runner):
+    result = runner.invoke_with_connection(
+        [
+            "sql",
+            "--enhanced-exit-codes",
+            "-q",
+            "select a",
+        ],
+    )
+    assert result.exit_code == 5, result