snowflake-cli-labs 3.0.0rc0__py3-none-any.whl → 3.0.0rc2__py3-none-any.whl

snowflake/cli/api/commands/flags.py

@@ -21,18 +21,18 @@ from typing import Any, Callable, Optional
 import click
 import typer
 from click import ClickException
-from snowflake.cli.api.cli_global_context import get_cli_context_manager
+from snowflake.cli.api.cli_global_context import (
+    _CliGlobalContextManager,
+    get_cli_context_manager,
+)
 from snowflake.cli.api.commands.common import OnErrorType
 from snowflake.cli.api.commands.overrideable_parameter import OverrideableOption
-from snowflake.cli.api.commands.typer_pre_execute import register_pre_execute_command
 from snowflake.cli.api.commands.utils import parse_key_value_variables
 from snowflake.cli.api.config import get_all_connections
+from snowflake.cli.api.connections import ConnectionContext
 from snowflake.cli.api.console import cli_console
-from snowflake.cli.api.exceptions import MissingConfiguration
 from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.output.formats import OutputFormat
-from snowflake.cli.api.project.definition_manager import DefinitionManager
-from snowflake.cli.api.rendering.jinja import CONTEXT_KEY
 
 DEFAULT_CONTEXT_SETTINGS = {"help_option_names": ["--help", "-h"]}
 
@@ -40,10 +40,39 @@ _CONNECTION_SECTION = "Connection configuration"
 _CLI_BEHAVIOUR = "Global configuration"
 
 
-def _callback(provide_setter: Callable[[], Callable[[Any], Any]]):
+def _connection_callback(prop: str):
+    """Generates a setter for a field on the current context manager's connection context."""
+    if prop not in ConnectionContext.__dataclass_fields__:
+        raise KeyError(
+            f"Cannot generate setter for non-existent connection attr {prop}"
+        )
+
     def callback(value):
-        set_value = provide_setter()
-        set_value(value)
+        try:
+            if click.get_current_context().resilient_parsing:
+                return
+        except RuntimeError:
+            pass
+
+        setattr(get_cli_context_manager().connection_context, prop, value)
+        return value
+
+    return callback
+
+
+def _context_callback(prop: str):
+    """Generates a setter for a field on the current context manager."""
+    if prop not in _CliGlobalContextManager.__dataclass_fields__:
+        raise KeyError(f"Cannot generate setter for non-existent context attr {prop}")
+
+    def callback(value):
+        try:
+            if click.get_current_context().resilient_parsing:
+                return
+        except RuntimeError:
+            pass
+
+        setattr(get_cli_context_manager(), prop, value)
         return value
 
     return callback
@@ -55,9 +84,7 @@ ConnectionOption = typer.Option(
     "-c",
     "--environment",
     help=f"Name of the connection, as defined in your `config.toml`. Default: `default`.",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_connection_name
-    ),
+    callback=_connection_callback("connection_name"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     shell_complete=lambda _, __, ___: list(get_all_connections()),
@@ -68,9 +95,7 @@ TemporaryConnectionOption = typer.Option(
     "--temporary-connection",
     "-x",
     help="Uses connection defined with command line parameters, instead of one defined in config",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_temporary_connection
-    ),
+    callback=_connection_callback("temporary_connection"),
     is_flag=True,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -80,9 +105,7 @@ AccountOption = typer.Option(
     "--account",
     "--accountname",
     help="Name assigned to your Snowflake account. Overrides the value specified for the connection.",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_account
-    ),
+    callback=_connection_callback("account"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -92,7 +115,7 @@ UserOption = typer.Option(
     "--user",
     "--username",
     help="Username to connect to Snowflake. Overrides the value specified for the connection.",
-    callback=_callback(lambda: get_cli_context_manager().connection_context.set_user),
+    callback=_connection_callback("user"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -105,9 +128,7 @@ def _password_callback(value: str):
     if value:
         cli_console.message(PLAIN_PASSWORD_MSG)
 
-    return _callback(lambda: get_cli_context_manager().connection_context.set_password)(
-        value
-    )
+    return _connection_callback("password")(value)
 
 
 PasswordOption = typer.Option(
@@ -125,21 +146,18 @@ AuthenticatorOption = typer.Option(
     "--authenticator",
     help="Snowflake authenticator. Overrides the value specified for the connection.",
     hide_input=True,
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_authenticator
-    ),
+    callback=_connection_callback("authenticator"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
 
 PrivateKeyPathOption = typer.Option(
     None,
+    "--private-key-file",
     "--private-key-path",
-    help="Snowflake private key path. Overrides the value specified for the connection.",
+    help="Snowflake private key file path. Overrides the value specified for the connection.",
     hide_input=True,
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_private_key_path
-    ),
+    callback=_connection_callback("private_key_file"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -152,9 +170,7 @@ SessionTokenOption = typer.Option(
     "--session-token",
     help="Snowflake session token. Can be used only in conjunction with --master-token. Overrides the value specified for the connection.",
     hide_input=True,
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_session_token
-    ),
+    callback=_connection_callback("session_token"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -168,9 +184,7 @@ MasterTokenOption = typer.Option(
     "--master-token",
     help="Snowflake master token. Can be used only in conjunction with --session-token. Overrides the value specified for the connection.",
     hide_input=True,
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_master_token
-    ),
+    callback=_connection_callback("master_token"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -183,9 +197,7 @@ TokenFilePathOption = typer.Option(
     None,
     "--token-file-path",
     help="Path to file with an OAuth token that should be used when connecting to Snowflake",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_token_file_path
-    ),
+    callback=_connection_callback("token_file_path"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -198,9 +210,7 @@ DatabaseOption = typer.Option(
     "--database",
     "--dbname",
     help="Database to use. Overrides the value specified for the connection.",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_database
-    ),
+    callback=_connection_callback("database"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -210,7 +220,7 @@ SchemaOption = typer.Option(
     "--schema",
     "--schemaname",
     help="Database schema to use. Overrides the value specified for the connection.",
-    callback=_callback(lambda: get_cli_context_manager().connection_context.set_schema),
+    callback=_connection_callback("schema"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -220,7 +230,7 @@ RoleOption = typer.Option(
     "--role",
     "--rolename",
     help="Role to use. Overrides the value specified for the connection.",
-    callback=_callback(lambda: get_cli_context_manager().connection_context.set_role),
+    callback=_connection_callback("role"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -229,9 +239,7 @@ WarehouseOption = typer.Option(
     None,
     "--warehouse",
     help="Warehouse to use. Overrides the value specified for the connection.",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_warehouse
-    ),
+    callback=_connection_callback("warehouse"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
 )
@@ -240,9 +248,7 @@ MfaPasscodeOption = typer.Option(
     None,
     "--mfa-passcode",
     help="Token to use for multi-factor authentication (MFA)",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_mfa_passcode
-    ),
+    callback=_connection_callback("mfa_passcode"),
     prompt="MFA passcode",
     prompt_required=False,
     show_default=False,
@@ -253,9 +259,7 @@ EnableDiagOption = typer.Option(
     False,
     "--enable-diag",
     help="Run python connector diagnostic test",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_enable_diag
-    ),
+    callback=_connection_callback("enable_diag"),
     show_default=False,
     is_flag=True,
     rich_help_panel=_CONNECTION_SECTION,
@@ -267,18 +271,17 @@ _DIAG_LOG_DEFAULT_VALUE = "<temporary_directory>"
 
 
 def _diag_log_path_callback(path: str):
-    if path != _DIAG_LOG_DEFAULT_VALUE:
-        return path
-    return tempfile.gettempdir()
+    if path == _DIAG_LOG_DEFAULT_VALUE:
+        path = tempfile.gettempdir()
+    get_cli_context_manager().connection_context.diag_log_path = Path(path)
+    return path
 
 
 DiagLogPathOption: Path = typer.Option(
     _DIAG_LOG_DEFAULT_VALUE,
     "--diag-log-path",
     help="Diagnostic report path",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_diag_log_path
-    ),
+    callback=_diag_log_path_callback,
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -289,9 +292,7 @@ DiagAllowlistPathOption: Path = typer.Option(
     None,
     "--diag-allowlist-path",
     help="Diagnostic report path to optional allowlist",
-    callback=_callback(
-        lambda: get_cli_context_manager().connection_context.set_diag_allowlist_path
-    ),
+    callback=_connection_callback("diag_allowlist_path"),
     show_default=False,
     rich_help_panel=_CONNECTION_SECTION,
     exists=True,
@@ -303,7 +304,7 @@ OutputFormatOption = typer.Option(
     "--format",
     help="Specifies the output format.",
     case_sensitive=False,
-    callback=_callback(lambda: get_cli_context_manager().set_output_format),
+    callback=_context_callback("output_format"),
     rich_help_panel=_CLI_BEHAVIOUR,
 )
 
@@ -311,7 +312,7 @@ SilentOption = typer.Option(
     False,
     "--silent",
     help="Turns off intermediate output to console.",
-    callback=_callback(lambda: get_cli_context_manager().set_silent),
+    callback=_context_callback("silent"),
     is_flag=True,
     rich_help_panel=_CLI_BEHAVIOUR,
     is_eager=True,
@@ -322,7 +323,7 @@ VerboseOption = typer.Option(
     "--verbose",
     "-v",
     help="Displays log entries for log levels `info` and higher.",
-    callback=_callback(lambda: get_cli_context_manager().set_verbose),
+    callback=_context_callback("verbose"),
     is_flag=True,
     rich_help_panel=_CLI_BEHAVIOUR,
 )
@@ -331,7 +332,7 @@ DebugOption = typer.Option(
     False,
     "--debug",
     help="Displays log entries for log levels `debug` and higher; debug logs contains additional information.",
-    callback=_callback(lambda: get_cli_context_manager().set_enable_tracebacks),
+    callback=_context_callback("enable_tracebacks"),
     is_flag=True,
     rich_help_panel=_CLI_BEHAVIOUR,
 )
@@ -434,24 +435,49 @@ def experimental_option(
         "--experimental",
         help=help_text,
         hidden=True,
-        callback=_callback(lambda: get_cli_context_manager().set_experimental),
+        callback=_context_callback("experimental"),
         is_flag=True,
         rich_help_panel=_CLI_BEHAVIOUR,
     )
 
 
+class IdentifierType(click.ParamType):
+    name = "TEXT"
+
+    def convert(self, value, param, ctx):
+        return FQN.from_string(value)
+
+
+class IdentifierStageType(click.ParamType):
+    name = "TEXT"
+
+    def convert(self, value, param, ctx):
+        return FQN.from_stage(value)
+
+
 def identifier_argument(
-    sf_object: str, example: str, callback: Callable | None = None
+    sf_object: str,
+    example: str,
+    click_type: click.ParamType = IdentifierType(),
+    callback: Callable | None = None,
 ) -> typer.Argument:
     return typer.Argument(
         ...,
         help=f"Identifier of the {sf_object}. For example: {example}",
         show_default=False,
-        click_type=IdentifierType(),
+        click_type=click_type,
         callback=callback,
     )
 
 
+def identifier_stage_argument(
+    sf_object: str, example: str, callback: Callable | None = None
+) -> typer.Argument:
+    return identifier_argument(
+        sf_object, example, click_type=IdentifierStageType(), callback=callback
+    )
+
+
 def execution_identifier_argument(sf_object: str, example: str) -> typer.Argument:
     return typer.Argument(
         ...,
@@ -460,30 +486,12 @@ def execution_identifier_argument(sf_object: str, example: str) -> typer.Argumen
     )
 
 
-def register_project_definition(is_optional: bool) -> None:
-    cli_context_manager = get_cli_context_manager()
-    project_path = cli_context_manager.project_path_arg
-    env_overrides_args = cli_context_manager.project_env_overrides_args
-
-    dm = DefinitionManager(project_path, {CONTEXT_KEY: {"env": env_overrides_args}})
-    project_definition = dm.project_definition
-    project_root = dm.project_root
-    template_context = dm.template_context
-
-    if not dm.has_definition_file and not is_optional:
-        raise MissingConfiguration(
-            "Cannot find project definition (snowflake.yml). Please provide a path to the project or run this command in a valid project directory."
-        )
-
-    cli_context_manager.set_project_definition(project_definition)
-    cli_context_manager.set_project_root(project_root)
-    cli_context_manager.set_template_context(template_context)
-
-
 def project_definition_option(is_optional: bool):
-    def project_definition_callback(project_path: str) -> None:
-        get_cli_context_manager().set_project_path_arg(project_path)
-        register_pre_execute_command(lambda: register_project_definition(is_optional))
+    def project_path_callback(project_path: str) -> str:
+        ctx_mgr = get_cli_context_manager()
+        ctx_mgr.project_path_arg = project_path
+        ctx_mgr.project_is_optional = is_optional
+        return project_path
 
     return typer.Option(
         None,
@@ -491,23 +499,26 @@ def project_definition_option(is_optional: bool):
         "--project",
         help=f"Path where Snowflake project resides. "
         f"Defaults to current working directory.",
-        callback=_callback(lambda: project_definition_callback),
+        callback=project_path_callback,
         show_default=False,
     )
 
 
 def project_env_overrides_option():
-    def project_env_overrides_callback(env_overrides_args_list: list[str]) -> None:
+    def project_env_overrides_callback(
+        env_overrides_args_list: list[str],
+    ) -> dict[str, str]:
         env_overrides_args_map = {
             v.key: v.value for v in parse_key_value_variables(env_overrides_args_list)
         }
-        get_cli_context_manager().set_project_env_overrides_args(env_overrides_args_map)
+        get_cli_context_manager().project_env_overrides_args = env_overrides_args_map
+        return env_overrides_args_map
 
     return typer.Option(
         [],
         "--env",
-        help="String in format of key=value. Overrides variables from env section used for templating.",
-        callback=_callback(lambda: project_env_overrides_callback),
+        help="String in format of key=value. Overrides variables from env section used for templates.",
+        callback=project_env_overrides_callback,
         show_default=False,
     )
 
@@ -530,10 +541,3 @@ def deprecated_flag_callback_enum(msg: str):
         return value.value
 
     return _warning_callback
-
-
-class IdentifierType(click.ParamType):
-    name = "TEXT"
-
-    def convert(self, value, param, ctx):
-        return FQN.from_string(value)

snowflake/cli/api/commands/snow_typer.py

@@ -20,6 +20,7 @@ from functools import wraps
 from typing import Any, Callable, Dict, List, Optional, Tuple
 
 import typer
+from click import ClickException
 from snowflake.cli.api.commands.decorators import (
     global_options,
     global_options_with_connection,
@@ -29,10 +30,11 @@ from snowflake.cli.api.commands.execution_metadata import (
     ExecutionStatus,
 )
 from snowflake.cli.api.commands.flags import DEFAULT_CONTEXT_SETTINGS
-from snowflake.cli.api.commands.typer_pre_execute import run_pre_execute_commands
 from snowflake.cli.api.exceptions import 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
+from snowflake.connector import DatabaseError
 
 log = logging.getLogger(__name__)
 
@@ -71,6 +73,7 @@ class SnowTyper(typer.Typer):
         requires_global_options: bool = True,
         requires_connection: bool = False,
         is_enabled: Callable[[], bool] | None = None,
+        require_warehouse: bool = False,
         **kwargs,
     ):
         """
@@ -97,15 +100,15 @@ class SnowTyper(typer.Typer):
             def command_callable_decorator(*args, **kw):
                 """Wrapper around command callable. This is what happens at "runtime"."""
                 execution = ExecutionMetadata()
-                self.pre_execute(execution)
+                self.pre_execute(execution, require_warehouse=require_warehouse)
                 try:
                     result = command_callable(*args, **kw)
                     self.process_result(result)
                     execution.complete(ExecutionStatus.SUCCESS)
                 except Exception as err:
                     execution.complete(ExecutionStatus.FAILURE)
-                    self.exception_handler(err, execution)
-                    raise
+                    exception = self.exception_handler(err, execution)
+                    raise exception
                 finally:
                     self.post_execute(execution)
 
@@ -116,7 +119,7 @@ class SnowTyper(typer.Typer):
         return custom_command
 
     @staticmethod
-    def pre_execute(execution: ExecutionMetadata):
+    def pre_execute(execution: ExecutionMetadata, require_warehouse: bool = False):
         """
         Callback executed before running any command callable (after context execution).
         Pay attention to make this method safe to use if performed operations are not necessary
@@ -125,8 +128,11 @@ class SnowTyper(typer.Typer):
         from snowflake.cli._app.telemetry import log_command_usage
 
         log.debug("Executing command pre execution callback")
-        run_pre_execute_commands()
         log_command_usage(execution)
+        if require_warehouse and not SqlExecutionMixin().session_has_warehouse():
+            raise ClickException(
+                "The command requires warehouse. No warehouse found in current connection."
+            )
 
     @staticmethod
     def process_result(result):
@@ -150,6 +156,9 @@ class SnowTyper(typer.Typer):
 
         log.debug("Executing command exception callback")
         log_command_execution_error(exception, execution)
+        if isinstance(exception, DatabaseError):
+            return ClickException(exception.msg)
+        return exception
 
     @staticmethod
     def post_execute(execution: ExecutionMetadata):

snowflake/cli/api/config.py

@@ -30,7 +30,10 @@ from snowflake.cli.api.exceptions import (
     UnsupportedConfigSectionTypeError,
 )
 from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.api.secure_utils import file_permissions_are_strict
+from snowflake.cli.api.secure_utils import (
+    file_permissions_are_strict,
+    windows_get_not_whitelisted_users_with_access,
+)
 from snowflake.cli.api.utils.types import try_cast_to_bool
 from snowflake.connector.compat import IS_WINDOWS
 from snowflake.connector.config_manager import CONFIG_MANAGER
@@ -77,7 +80,7 @@ class ConnectionConfig:
     warehouse: Optional[str] = None
     role: Optional[str] = None
     authenticator: Optional[str] = None
-    private_key_path: Optional[str] = None
+    private_key_file: Optional[str] = None
     token_file_path: Optional[str] = None
 
     _other_settings: dict = field(default_factory=lambda: {})
@@ -160,6 +163,18 @@ def _read_config_file():
                 message="Bad owner or permissions.*",
                 module="snowflake.connector.config_manager",
             )
+
+            if not file_permissions_are_strict(CONFIG_MANAGER.file_path):
+                users = ", ".join(
+                    windows_get_not_whitelisted_users_with_access(
+                        CONFIG_MANAGER.file_path
+                    )
+                )
+                warnings.warn(
+                    f"Unauthorized users ({users}) have access to configuration file {CONFIG_MANAGER.file_path}.\n"
+                    f'Run `icacls "{CONFIG_MANAGER.file_path}" /deny <USER_ID>:F` on those users to restrict permissions.'
+                )
+
         try:
             CONFIG_MANAGER.read_config()
         except ConfigSourceError as exception:
@@ -281,7 +296,7 @@ def _initialise_config(config_file: Path) -> None:
 
 
 def get_env_variable_name(*path, key: str) -> str:
-    return "SNOWFLAKE_" + "_".join(p.upper() for p in path) + f"_{key.upper()}"
+    return ("_".join(["snowflake", *path, key])).upper()
 
 
 def get_env_value(*path, key: str) -> str | None:
@@ -322,8 +337,6 @@ def _dump_config(conf_file_cache: Dict):
 
 
 def _check_default_config_files_permissions() -> None:
-    if IS_WINDOWS:
-        return
     if CONNECTIONS_FILE.exists() and not file_permissions_are_strict(CONNECTIONS_FILE):
         raise ConfigFileTooWidePermissionsError(CONNECTIONS_FILE)
     if CONFIG_FILE.exists() and not file_permissions_are_strict(CONFIG_FILE):