snowflake-cli-labs 2.4.0rc1__py3-none-any.whl → 2.5.0__py3-none-any.whl

snowflake/cli/plugins/nativeapp/codegen/snowpark/python_processor.py

@@ -1,3 +1,17 @@
+# 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 json
@@ -43,7 +57,10 @@ from snowflake.cli.plugins.stage.diff import to_stage_path
 DEFAULT_TIMEOUT = 30
 TEMPLATE_PATH = Path(__file__).parent / "callback_source.py.jinja"
 SNOWPARK_LIB_NAME = "snowflake-snowpark-python"
-SNOWPARK_LIB_REGEX = rf"'{SNOWPARK_LIB_NAME}\s*((<|<=|!=|==|>=|>|~=|===)\s*[a-zA-Z0-9_.*+!-]+)?'"  # support PEP 508, even though not all of it is supported in Snowflake yet
+SNOWPARK_LIB_REGEX = re.compile(
+    # support PEP 508, even though not all of it is supported in Snowflake yet
+    rf"'{SNOWPARK_LIB_NAME}\s*((<|<=|!=|==|>=|>|~=|===)\s*[a-zA-Z0-9_.*+!-]+)?'"
+)
 STAGE_PREFIX = "@"
 
 
@@ -194,6 +211,7 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
                 py_file=py_file,
             )
             collected_sql_files.append(sql_file)
+            insert_newline = False
             for extension_fn in extension_fns:
                 create_stmt = generate_create_sql_ddl_statement(extension_fn)
                 if create_stmt is None:
@@ -206,6 +224,9 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
                     collected_output.append(grant_statements)
 
                 with open(sql_file, "a") as file:
+                    if insert_newline:
+                        file.write("\n")
+                    insert_newline = True
                     file.write(
                         f"-- Generated by the Snowflake CLI from {relative_py_file}\n"
                     )
@@ -266,14 +287,12 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
         # If user defined their udf as @udf(lambda: x, ...) then extension_fn.handler is <lambda>.
         extension_fn.handler = f"{py_file.stem}.{extension_fn.handler}"
 
-        snowpark_lib_found = False
-        snowpark_lib_regex = re.compile(SNOWPARK_LIB_REGEX)
-        for pkg in extension_fn.packages:
-            if snowpark_lib_regex.fullmatch(ensure_string_literal(pkg.strip())):
-                snowpark_lib_found = True
-                break
-        if not snowpark_lib_found:
-            extension_fn.packages.append(SNOWPARK_LIB_NAME)
+        extension_fn.packages = [
+            self._normalize_package_name(pkg) for pkg in extension_fn.packages
+        ]
+        snowpark_lib_name = ensure_string_literal(SNOWPARK_LIB_NAME)
+        if snowpark_lib_name not in extension_fn.packages:
+            extension_fn.packages.append(snowpark_lib_name)
 
         if extension_fn.imports is None:
             extension_fn.imports = []
@@ -283,6 +302,23 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
             deploy_root=deploy_root,
         )
 
+    def _normalize_package_name(self, pkg: str) -> str:
+        """
+        Returns a normalized version of the provided package name, as a Snowflake SQL string literal. Since the
+        Snowpark library can sometimes add a spurious version to its own package name, we strip this here too so
+        that the native application does not accidentally rely on stale packages once the snowpark library is updated
+        in the cloud.
+
+        Args:
+            pkg (str): The package name to normalize.
+        Returns:
+            A normalized version of the package name, as a Snowflake SQL string literal.
+        """
+        normalized_package_name = ensure_string_literal(pkg.strip())
+        if SNOWPARK_LIB_REGEX.fullmatch(normalized_package_name):
+            return ensure_string_literal(SNOWPARK_LIB_NAME)
+        return normalized_package_name
+
     def collect_extension_functions(
         self, bundle_map: BundleMap, processor_mapping: Optional[ProcessorMapping]
     ) -> Dict[Path, List[NativeAppExtensionFunction]]:
@@ -311,8 +347,6 @@ class SnowparkAnnotationProcessor(ArtifactProcessor):
             )
 
             if collected_extension_function_json is None:
-                cc.warning(f"Error processing extension functions in {src_file}")
-                cc.warning("Skipping generating code of all objects from this file.")
                 continue
 
             collected_extension_functions = []
@@ -429,15 +463,20 @@ def generate_grant_sql_ddl_statements(
 
     if not extension_fn.application_roles:
         cc.warning(
-            "Skipping generation of 'GRANT USAGE ON ...' SQL statement for this object due to lack of application roles."
+            f"Skipping generation of 'GRANT USAGE ON ...' SQL statement for {extension_fn.function_type.upper()} {extension_fn.handler} due to lack of application roles."
         )
         return None
 
     grant_sql_statements = []
+    object_type = (
+        "PROCEDURE"
+        if extension_fn.function_type == ExtensionFunctionTypeEnum.PROCEDURE
+        else "FUNCTION"
+    )
     for app_role in extension_fn.application_roles:
         grant_sql_statement = dedent(
             f"""\
-            GRANT USAGE ON {get_sql_object_type(extension_fn)} {get_qualified_object_name(extension_fn)}({get_function_type_signature_for_grant(extension_fn)})
+            GRANT USAGE ON {object_type} {get_qualified_object_name(extension_fn)}({get_function_type_signature_for_grant(extension_fn)})
             TO APPLICATION ROLE {app_role};
             """
         ).strip()

snowflake/cli/plugins/nativeapp/commands.py

@@ -1,3 +1,17 @@
+# 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
@@ -9,14 +23,20 @@ from snowflake.cli.api.cli_global_context import cli_context
 from snowflake.cli.api.commands.decorators import (
     with_project_definition,
 )
-from snowflake.cli.api.commands.snow_typer import SnowTyper
+from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.output.formats import OutputFormat
 from snowflake.cli.api.output.types import (
     CollectionResult,
     CommandResult,
     MessageResult,
+    ObjectResult,
 )
 from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.plugins.nativeapp.common_flags import ForceOption, InteractiveOption
+from snowflake.cli.plugins.nativeapp.common_flags import (
+    ForceOption,
+    InteractiveOption,
+    ValidateOption,
+)
 from snowflake.cli.plugins.nativeapp.init import (
     OFFICIAL_TEMPLATES_GITHUB_URL,
     nativeapp_init,
@@ -37,7 +57,7 @@ from snowflake.cli.plugins.nativeapp.utils import (
 )
 from snowflake.cli.plugins.nativeapp.version.commands import app as versions_app
 
-app = SnowTyper(
+app = SnowTyperFactory(
     name="app",
     help="Manages a Snowflake Native App",
 )
@@ -68,7 +88,7 @@ def app_init(
     ),
     template: str = typer.Option(
         None,
-        help="A specific template name within the template repo to use as template for the Native Apps project. Example: Default is basic if `--template-repo` is https://github.com/snowflakedb/native-apps-templates.git, and None if any other --template-repo is specified.",
+        help="A specific template name within the template repo to use as template for the Snowflake Native App project. Example: Default is basic if `--template-repo` is https://github.com/snowflakedb/native-apps-templates.git, and None if any other --template-repo is specified.",
     ),
     **options,
 ) -> CommandResult:
@@ -89,6 +109,8 @@ def app_list_templates(**options) -> CommandResult:
     Prints information regarding the official templates that can be used with snow app init.
     """
     with SecurePath.temporary_directory() as temp_path:
+        from git import rmtree as git_rmtree
+
         repo = shallow_git_clone(OFFICIAL_TEMPLATES_GITHUB_URL, temp_path.path)
 
         # Mark a directory as a template if a project definition jinja template is inside
@@ -113,10 +135,14 @@ def app_list_templates(**options) -> CommandResult:
             )
         )
 
+        # proactively clean up here to avoid permission issues on Windows
+        repo.close()
+        git_rmtree(temp_path.path)
+
         return CollectionResult(result)
 
 
-@app.command("bundle", hidden=True)
+@app.command("bundle")
 @with_project_definition("native_app")
 def app_bundle(
     **options,
@@ -140,7 +166,7 @@ def app_run(
         help=f"""The version defined in an existing application package from which you want to create an application object.
         The application object and application package names are determined from the project definition file.""",
     ),
-    patch: Optional[str] = typer.Option(
+    patch: Optional[int] = typer.Option(
         None,
         "--patch",
         help=f"""The patch number under the given `--version` defined in an existing application package that should be used to create an application object.
@@ -155,6 +181,7 @@ def app_run(
     ),
     interactive: bool = InteractiveOption,
     force: Optional[bool] = ForceOption,
+    validate: bool = ValidateOption,
     **options,
 ) -> CommandResult:
     """
@@ -175,13 +202,15 @@ def app_run(
         project_definition=cli_context.project_definition,
         project_root=cli_context.project_root,
     )
-    processor.build_bundle()
+    bundle_map = processor.build_bundle()
     processor.process(
+        bundle_map=bundle_map,
         policy=policy,
         version=version,
         patch=patch,
         from_release_directive=from_release_directive,
         is_interactive=is_interactive,
+        validate=validate,
     )
     return MessageResult(
         f"Your application object ({processor.app_name}) is now available:\n"
@@ -243,7 +272,7 @@ def app_deploy(
     ),
     recursive: Optional[bool] = typer.Option(
         None,
-        "--recursive",
+        "--recursive/--no-recursive",
         "-r",
         help=f"""Whether to traverse and deploy files from subdirectories. If set, the command deploys all files and subdirectories; otherwise, only files in the current directory are deployed.""",
     ),
@@ -252,6 +281,7 @@ def app_deploy(
         show_default=False,
         help=f"""Paths, relative to the the project root, of files you want to upload to a stage. The paths must match one of the artifacts src pattern entries in snowflake.yml. If unspecified, the command syncs all local changes to the stage.""",
     ),
+    validate: bool = ValidateOption,
     **options,
 ) -> CommandResult:
     """
@@ -273,9 +303,32 @@ def app_deploy(
         project_root=cli_context.project_root,
     )
 
-    mapped_files = manager.build_bundle()
-    manager.deploy(prune, recursive, files, mapped_files)
+    bundle_map = manager.build_bundle()
+    manager.deploy(
+        bundle_map=bundle_map,
+        prune=prune,
+        recursive=recursive,
+        local_paths_to_sync=files,
+        validate=validate,
+    )
 
     return MessageResult(
         f"Deployed successfully. Application package and stage are up-to-date."
     )
+
+
+@app.command("validate", requires_connection=True)
+@with_project_definition("native_app")
+def app_validate(**options):
+    """
+    Validates a deployed Snowflake Native App's setup script.
+    """
+    manager = NativeAppManager(
+        project_definition=cli_context.project_definition,
+        project_root=cli_context.project_root,
+    )
+    if cli_context.output_format == OutputFormat.JSON:
+        return ObjectResult(manager.get_validation_result(use_scratch_stage=True))
+
+    manager.validate(use_scratch_stage=True)
+    return MessageResult("Snowflake Native App validation succeeded.")

snowflake/cli/plugins/nativeapp/common_flags.py

@@ -1,3 +1,17 @@
+# 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.
+
 import typer
 from snowflake.cli.plugins.nativeapp.utils import is_tty_interactive
 
@@ -22,3 +36,9 @@ ForceOption = typer.Option(
     You should enable this option if interactive mode is not specified and if you want perform potentially destructive actions. Defaults to unset.""",
     is_flag=True,
 )
+ValidateOption = typer.Option(
+    True,
+    "--validate/--no-validate",
+    help="""When enabled, this option triggers validation of a deployed Snowflake Native App's setup script SQL""",
+    is_flag=True,
+)

snowflake/cli/plugins/nativeapp/constants.py

@@ -1,3 +1,17 @@
+# 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.
+
 SPECIAL_COMMENT_OLD = "GENERATED_BY_SNOWCLI"
 SPECIAL_COMMENT = "GENERATED_BY_SNOWFLAKECLI"
 ALLOWED_SPECIAL_COMMENTS = {SPECIAL_COMMENT, SPECIAL_COMMENT_OLD}
@@ -12,5 +26,6 @@ PATCH_COL = "patch"
 INTERNAL_DISTRIBUTION = "internal"
 EXTERNAL_DISTRIBUTION = "external"
 
+ERROR_MESSAGE_2003 = "does not exist or not authorized"
 ERROR_MESSAGE_2043 = "Object does not exist, or operation cannot be performed."
 ERROR_MESSAGE_606 = "No active warehouse selected in the current session."

snowflake/cli/plugins/nativeapp/exceptions.py

@@ -1,3 +1,17 @@
+# 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 textwrap import dedent
 
 import jinja2
@@ -14,11 +28,11 @@ class ApplicationPackageAlreadyExistsError(ClickException):
 
 
 class ApplicationPackageDoesNotExistError(ClickException):
-    """An application package of the specified name does not exist in the Snowflake account."""
+    """An application package of the specified name does not exist in the Snowflake account or the current role isn't authorized."""
 
     def __init__(self, name: str):
         super().__init__(
-            f"Application Package {name} does not exist in the Snowflake account."
+            f"Application Package {name} does not exist in the Snowflake account or not authorized."
         )
 
 
@@ -74,3 +88,10 @@ class CouldNotDropApplicationPackageWithVersions(ClickException):
             """
             )
         )
+
+
+class SetupScriptFailedValidation(ClickException):
+    """Snowflake Native App setup script failed validation."""
+
+    def __init__(self):
+        super().__init__(self.__doc__)

snowflake/cli/plugins/nativeapp/init.py

@@ -1,3 +1,17 @@
+# 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