snowflake-cli 3.0.2__py3-none-any.whl → 3.1.0__py3-none-any.whl

snowflake/cli/_plugins/nativeapp/entities/application_package.py

@@ -31,6 +31,7 @@ from snowflake.cli._plugins.nativeapp.exceptions import (
     ApplicationPackageAlreadyExistsError,
     ApplicationPackageDoesNotExistError,
     CouldNotDropApplicationPackageWithVersions,
+    ObjectPropertyNotFoundError,
     SetupScriptFailedValidation,
 )
 from snowflake.cli._plugins.nativeapp.policy import (
@@ -42,7 +43,7 @@ from snowflake.cli._plugins.nativeapp.policy import (
 from snowflake.cli._plugins.nativeapp.utils import needs_confirmation
 from snowflake.cli._plugins.stage.diff import DiffResult
 from snowflake.cli._plugins.stage.manager import StageManager
-from snowflake.cli._plugins.workspace.action_context import ActionContext
+from snowflake.cli._plugins.workspace.context import ActionContext
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.console.abc import AbstractConsole
 from snowflake.cli.api.entities.common import EntityBase, get_sql_executor
@@ -50,7 +51,6 @@ from snowflake.cli.api.entities.utils import (
     drop_generic_object,
     execute_post_deploy_hooks,
     generic_sql_error_handler,
-    render_script_templates,
     sync_deploy_root_with_stage,
     validation_item_to_str,
 )
@@ -75,7 +75,6 @@ from snowflake.cli.api.project.util import (
     to_identifier,
     unquote_identifier,
 )
-from snowflake.cli.api.rendering.jinja import get_basic_jinja_env
 from snowflake.cli.api.utils.cursor import find_all_rows
 from snowflake.connector import DictCursor, ProgrammingError
 from snowflake.connector.cursor import SnowflakeCursor
@@ -150,20 +149,23 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
     A Native App application package.
     """
 
-    def action_bundle(self, ctx: ActionContext, *args, **kwargs):
+    def action_bundle(self, action_ctx: ActionContext, *args, **kwargs):
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         return self.bundle(
-            project_root=ctx.project_root,
-            deploy_root=Path(model.deploy_root),
-            bundle_root=Path(model.bundle_root),
-            generated_root=Path(model.generated_root),
+            project_root=workspace_ctx.project_root,
+            deploy_root=workspace_ctx.project_root / model.deploy_root,
+            bundle_root=workspace_ctx.project_root / model.bundle_root,
+            generated_root=(
+                workspace_ctx.project_root / model.deploy_root / model.generated_root
+            ),
             package_name=model.identifier,
             artifacts=model.artifacts,
         )
 
     def action_deploy(
         self,
-        ctx: ActionContext,
+        action_ctx: ActionContext,
         prune: bool,
         recursive: bool,
         paths: List[Path],
@@ -175,6 +177,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         **kwargs,
     ):
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         package_name = model.fqn.identifier
 
         if force:
@@ -185,15 +188,17 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             policy = DenyAlwaysPolicy()
 
         return self.deploy(
-            console=ctx.console,
-            project_root=ctx.project_root,
-            deploy_root=Path(model.deploy_root),
-            bundle_root=Path(model.bundle_root),
-            generated_root=Path(model.generated_root),
+            console=workspace_ctx.console,
+            project_root=workspace_ctx.project_root,
+            deploy_root=workspace_ctx.project_root / model.deploy_root,
+            bundle_root=workspace_ctx.project_root / model.bundle_root,
+            generated_root=(
+                workspace_ctx.project_root / model.deploy_root / model.generated_root
+            ),
             artifacts=model.artifacts,
             bundle_map=None,
             package_name=package_name,
-            package_role=(model.meta and model.meta.role) or ctx.default_role,
+            package_role=(model.meta and model.meta.role) or workspace_ctx.default_role,
             package_distribution=model.distribution,
             prune=prune,
             recursive=recursive,
@@ -202,32 +207,39 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             validate=validate,
             stage_fqn=stage_fqn or f"{package_name}.{model.stage}",
             package_warehouse=(
-                (model.meta and model.meta.warehouse) or ctx.default_warehouse
+                (model.meta and model.meta.warehouse) or workspace_ctx.default_warehouse
             ),
             post_deploy_hooks=model.meta and model.meta.post_deploy,
-            package_scripts=[],  # Package scripts are not supported in PDFv2
             policy=policy,
         )
 
-    def action_drop(self, ctx: ActionContext, force_drop: bool, *args, **kwargs):
+    def action_drop(self, action_ctx: ActionContext, force_drop: bool, *args, **kwargs):
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         package_name = model.fqn.identifier
         if model.meta and model.meta.role:
             package_role = model.meta.role
         else:
-            package_role = ctx.default_role
+            package_role = workspace_ctx.default_role
 
         self.drop(
-            console=ctx.console,
+            console=workspace_ctx.console,
             package_name=package_name,
             package_role=package_role,
             force_drop=force_drop,
         )
 
     def action_validate(
-        self, ctx: ActionContext, interactive: bool, force: bool, *args, **kwargs
+        self,
+        action_ctx: ActionContext,
+        interactive: bool,
+        force: bool,
+        use_scratch_stage: bool = True,
+        *args,
+        **kwargs,
     ):
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         package_name = model.fqn.identifier
         if force:
             policy = AllowAlwaysPolicy()
@@ -237,42 +249,43 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             policy = DenyAlwaysPolicy()
 
         self.validate_setup_script(
-            console=ctx.console,
-            project_root=ctx.project_root,
-            deploy_root=Path(model.deploy_root),
-            bundle_root=Path(model.bundle_root),
-            generated_root=Path(model.generated_root),
+            console=workspace_ctx.console,
+            project_root=workspace_ctx.project_root,
+            deploy_root=workspace_ctx.project_root / model.deploy_root,
+            bundle_root=workspace_ctx.project_root / model.bundle_root,
+            generated_root=(
+                workspace_ctx.project_root / model.deploy_root / model.generated_root
+            ),
             artifacts=model.artifacts,
             package_name=package_name,
-            package_role=(model.meta and model.meta.role) or ctx.default_role,
+            package_role=(model.meta and model.meta.role) or workspace_ctx.default_role,
             package_distribution=model.distribution,
             prune=True,
             recursive=True,
             paths=[],
             stage_fqn=f"{package_name}.{model.stage}",
             package_warehouse=(
-                (model.meta and model.meta.warehouse) or ctx.default_warehouse
+                (model.meta and model.meta.warehouse) or workspace_ctx.default_warehouse
             ),
-            post_deploy_hooks=model.meta and model.meta.post_deploy,
-            package_scripts=[],  # Package scripts are not supported in PDFv2
             policy=policy,
-            use_scratch_stage=True,
+            use_scratch_stage=use_scratch_stage,
             scratch_stage_fqn=f"{package_name}.{model.scratch_stage}",
         )
-        ctx.console.message("Setup script is valid")
+        workspace_ctx.console.message("Setup script is valid")
 
     def action_version_list(
-        self, ctx: ActionContext, *args, **kwargs
+        self, action_ctx: ActionContext, *args, **kwargs
     ) -> SnowflakeCursor:
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         return self.version_list(
             package_name=model.fqn.identifier,
-            package_role=(model.meta and model.meta.role) or ctx.default_role,
+            package_role=(model.meta and model.meta.role) or workspace_ctx.default_role,
         )
 
     def action_version_create(
         self,
-        ctx: ActionContext,
+        action_ctx: ActionContext,
         version: Optional[str],
         patch: Optional[int],
         skip_git_check: bool,
@@ -282,16 +295,19 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         **kwargs,
     ):
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         package_name = model.fqn.identifier
         return self.version_create(
-            console=ctx.console,
-            project_root=ctx.project_root,
-            deploy_root=Path(model.deploy_root),
-            bundle_root=Path(model.bundle_root),
-            generated_root=Path(model.generated_root),
+            console=workspace_ctx.console,
+            project_root=workspace_ctx.project_root,
+            deploy_root=workspace_ctx.project_root / model.deploy_root,
+            bundle_root=workspace_ctx.project_root / model.bundle_root,
+            generated_root=(
+                workspace_ctx.project_root / model.deploy_root / model.generated_root
+            ),
             artifacts=model.artifacts,
             package_name=package_name,
-            package_role=(model.meta and model.meta.role) or ctx.default_role,
+            package_role=(model.meta and model.meta.role) or workspace_ctx.default_role,
             package_distribution=model.distribution,
             prune=True,
             recursive=True,
@@ -300,10 +316,9 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             validate=True,
             stage_fqn=f"{package_name}.{model.stage}",
             package_warehouse=(
-                (model.meta and model.meta.warehouse) or ctx.default_warehouse
+                (model.meta and model.meta.warehouse) or workspace_ctx.default_warehouse
             ),
             post_deploy_hooks=model.meta and model.meta.post_deploy,
-            package_scripts=[],  # Package scripts are not supported in PDFv2
             version=version,
             patch=patch,
             skip_git_check=skip_git_check,
@@ -313,7 +328,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
 
     def action_version_drop(
         self,
-        ctx: ActionContext,
+        action_ctx: ActionContext,
         version: Optional[str],
         interactive: bool,
         force: bool,
@@ -321,16 +336,19 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         **kwargs,
     ):
         model = self._entity_model
+        workspace_ctx = self._workspace_ctx
         package_name = model.fqn.identifier
         return self.version_drop(
-            console=ctx.console,
-            project_root=ctx.project_root,
-            deploy_root=Path(model.deploy_root),
-            bundle_root=Path(model.bundle_root),
-            generated_root=Path(model.generated_root),
+            console=workspace_ctx.console,
+            project_root=workspace_ctx.project_root,
+            deploy_root=workspace_ctx.project_root / model.deploy_root,
+            bundle_root=workspace_ctx.project_root / model.bundle_root,
+            generated_root=(
+                workspace_ctx.project_root / model.deploy_root / model.generated_root
+            ),
             artifacts=model.artifacts,
             package_name=package_name,
-            package_role=(model.meta and model.meta.role) or ctx.default_role,
+            package_role=(model.meta and model.meta.role) or workspace_ctx.default_role,
             package_distribution=model.distribution,
             version=version,
             force=force,
@@ -380,7 +398,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         validate: bool,
         stage_fqn: str,
         post_deploy_hooks: list[PostDeployHook] | None,
-        package_scripts: List[str],
         policy: PolicyBase,
     ) -> DiffResult:
         # 1. Create a bundle if one wasn't passed in
@@ -405,16 +422,8 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             console.warning(e.message)
             if not policy.should_proceed("Proceed with using this package?"):
                 raise typer.Abort() from e
-        with get_sql_executor().use_role(package_role):
-            cls.apply_package_scripts(
-                console=console,
-                package_scripts=package_scripts,
-                package_warehouse=package_warehouse,
-                project_root=project_root,
-                package_role=package_role,
-                package_name=package_name,
-            )
 
+        with get_sql_executor().use_role(package_role):
             # 3. Upload files from deploy root local folder to the above stage
             stage_schema = extract_schema(stage_fqn)
             diff = sync_deploy_root_with_stage(
@@ -431,13 +440,13 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 print_diff=print_diff,
             )
 
-        cls.execute_post_deploy_hooks(
-            console=console,
-            project_root=project_root,
-            post_deploy_hooks=post_deploy_hooks,
-            package_name=package_name,
-            package_warehouse=package_warehouse,
-        )
+            cls.execute_post_deploy_hooks(
+                console=console,
+                project_root=project_root,
+                post_deploy_hooks=post_deploy_hooks,
+                package_name=package_name,
+                package_warehouse=package_warehouse,
+            )
 
         if validate:
             cls.validate_setup_script(
@@ -455,8 +464,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 paths=paths,
                 stage_fqn=stage_fqn,
                 package_warehouse=package_warehouse,
-                post_deploy_hooks=post_deploy_hooks,
-                package_scripts=package_scripts,
                 policy=policy,
                 use_scratch_stage=False,
                 scratch_stage_fqn="",
@@ -500,7 +507,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         validate: bool,
         stage_fqn: str,
         post_deploy_hooks: list[PostDeployHook] | None,
-        package_scripts: List[str],
         version: Optional[str],
         patch: Optional[int],
         force: bool,
@@ -593,7 +599,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             stage_fqn=stage_fqn,
             package_warehouse=package_warehouse,
             post_deploy_hooks=post_deploy_hooks,
-            package_scripts=package_scripts,
             policy=policy,
         )
 
@@ -685,7 +690,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 if err.msg.__contains__("does not exist or not authorized"):
                     raise ApplicationPackageDoesNotExistError(package_name)
                 else:
-                    generic_sql_error_handler(err=err, role=package_role)
+                    generic_sql_error_handler(err=err)
                     return None
 
     @classmethod
@@ -976,13 +981,10 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 for row in desc_cursor:
                     if row[0].lower() == "distribution":
                         return row[1].lower()
-        raise ProgrammingError(
-            msg=dedent(
-                f"""\
-                Could not find the 'distribution' attribute for application package {package_name} in the output of SQL query:
-                'describe application package {package_name}'
-                """
-            )
+        raise ObjectPropertyNotFoundError(
+            property_name="distribution",
+            object_type="application package",
+            object_name=package_name,
         )
 
     @classmethod
@@ -1037,53 +1039,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 )
             )
 
-    @classmethod
-    def apply_package_scripts(
-        cls,
-        console: AbstractConsole,
-        package_scripts: List[str],
-        package_warehouse: Optional[str],
-        project_root: Path,
-        package_role: str,
-        package_name: str,
-    ) -> None:
-        """
-        Assuming the application package exists and we are using the correct role,
-        applies all package scripts in-order to the application package.
-        """
-
-        metrics = get_cli_context().metrics
-        metrics.set_counter_default(CLICounterField.PACKAGE_SCRIPTS, 0)
-
-        if not package_scripts:
-            return
-
-        metrics.set_counter(CLICounterField.PACKAGE_SCRIPTS, 1)
-
-        console.warning(
-            "WARNING: native_app.package.scripts is deprecated. Please migrate to using native_app.package.post_deploy."
-        )
-
-        queued_queries = render_script_templates(
-            project_root,
-            dict(package_name=package_name),
-            package_scripts,
-            get_basic_jinja_env(),
-        )
-
-        # once we're sure all the templates expanded correctly, execute all of them
-        with cls.use_package_warehouse(
-            package_warehouse=package_warehouse,
-        ):
-            try:
-                for i, queries in enumerate(queued_queries):
-                    console.step(f"Applying package script: {package_scripts[i]}")
-                    get_sql_executor().execute_queries(queries)
-            except ProgrammingError as err:
-                generic_sql_error_handler(
-                    err, role=package_role, warehouse=package_warehouse
-                )
-
     @classmethod
     def create_app_package(
         cls,
@@ -1182,15 +1137,13 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         recursive: bool,
         paths: List[Path] | None,
         stage_fqn: str,
-        post_deploy_hooks: list[PostDeployHook] | None,
-        package_scripts: List[str],
         policy: PolicyBase,
         use_scratch_stage: bool,
         scratch_stage_fqn: str,
     ):
         """Validates Native App setup script SQL."""
         with console.phase(f"Validating Snowflake Native App setup script."):
-            validation_result = cls.get_validation_result(
+            validation_result = cls.get_validation_result_static(
                 console=console,
                 project_root=project_root,
                 deploy_root=deploy_root,
@@ -1205,8 +1158,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 paths=paths,
                 stage_fqn=stage_fqn,
                 package_warehouse=package_warehouse,
-                post_deploy_hooks=post_deploy_hooks,
-                package_scripts=package_scripts,
                 policy=policy,
                 use_scratch_stage=use_scratch_stage,
                 scratch_stage_fqn=scratch_stage_fqn,
@@ -1226,8 +1177,36 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             if validation_result["status"] == "FAIL":
                 raise SetupScriptFailedValidation()
 
+    def get_validation_result(self, use_scratch_stage: bool = True):
+        model = self._entity_model
+        workspace_ctx = self._workspace_ctx
+        package_name = model.fqn.identifier
+        return self.get_validation_result_static(
+            console=workspace_ctx.console,
+            project_root=workspace_ctx.project_root,
+            deploy_root=workspace_ctx.project_root / model.deploy_root,
+            bundle_root=workspace_ctx.project_root / model.bundle_root,
+            generated_root=(
+                workspace_ctx.project_root / model.deploy_root / model.generated_root
+            ),
+            artifacts=model.artifacts,
+            package_name=package_name,
+            package_role=(model.meta and model.meta.role) or workspace_ctx.default_role,
+            package_distribution=model.distribution,
+            prune=True,
+            recursive=True,
+            paths=[],
+            stage_fqn=f"{package_name}.{model.stage}",
+            package_warehouse=(
+                (model.meta and model.meta.warehouse) or workspace_ctx.default_warehouse
+            ),
+            policy=AllowAlwaysPolicy(),
+            use_scratch_stage=use_scratch_stage,
+            scratch_stage_fqn=f"{package_name}.{model.scratch_stage}",
+        )
+
     @classmethod
-    def get_validation_result(
+    def get_validation_result_static(
         cls,
         console: AbstractConsole,
         project_root: Path,
@@ -1243,8 +1222,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         recursive: bool,
         paths: List[Path] | None,
         stage_fqn: str,
-        post_deploy_hooks: list[PostDeployHook] | None,
-        package_scripts: List[str],
         policy: PolicyBase,
         use_scratch_stage: bool,
         scratch_stage_fqn: str,
@@ -1270,8 +1247,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 validate=False,
                 stage_fqn=stage_fqn,
                 package_warehouse=package_warehouse,
-                post_deploy_hooks=post_deploy_hooks,
-                package_scripts=package_scripts,
+                post_deploy_hooks=[],
                 policy=policy,
             )
         prefixed_stage_fqn = StageManager.get_standard_stage_prefix(stage_fqn)

snowflake/cli/_plugins/nativeapp/exceptions.py

@@ -111,3 +111,15 @@ class NoEventTableForAccount(ClickException):
 
     def __init__(self):
         super().__init__(f"{self.__doc__}\n\n{self.INSTRUCTIONS}")
+
+
+class ObjectPropertyNotFoundError(RuntimeError):
+    def __init__(self, property_name: str, object_type: str, object_name: str):
+        super().__init__(
+            dedent(
+                f"""\
+                        Could not find the '{property_name}' attribute for {object_type} {object_name} in the output of SQL query:
+                        'describe {object_type} {object_name}'
+                        """
+            )
+        )

snowflake/cli/_plugins/nativeapp/manager.py

@@ -217,7 +217,7 @@ class NativeAppManager:
         )
 
     def get_existing_app_info(self) -> Optional[dict]:
-        return ApplicationEntity.get_existing_app_info(
+        return ApplicationEntity.get_existing_app_info_static(
             app_name=self.app_name,
             app_role=self.app_role,
         )
@@ -244,7 +244,7 @@ class NativeAppManager:
 
     def get_snowsight_url(self) -> str:
         """Returns the URL that can be used to visit this app via Snowsight."""
-        return ApplicationEntity.get_snowsight_url(
+        return ApplicationEntity.get_snowsight_url_static(
             self.app_name, self.application_warehouse
         )
 
@@ -256,25 +256,6 @@ class NativeAppManager:
             package_distribution=self.package_distribution,
         )
 
-    def _apply_package_scripts(self) -> None:
-        return ApplicationPackageEntity.apply_package_scripts(
-            console=cc,
-            package_scripts=self.package_scripts,
-            package_warehouse=self.package_warehouse,
-            project_root=self.project_root,
-            package_role=self.package_role,
-            package_name=self.package_name,
-        )
-
-    def execute_package_post_deploy_hooks(self) -> None:
-        execute_post_deploy_hooks(
-            console=cc,
-            project_root=self.project_root,
-            post_deploy_hooks=self.package_post_deploy_hooks,
-            deployed_object_type="application package",
-            database_name=self.package_name,
-        )
-
     def execute_app_post_deploy_hooks(self) -> None:
         execute_post_deploy_hooks(
             console=cc,
@@ -334,15 +315,13 @@ class NativeAppManager:
             paths=[],
             stage_fqn=self.stage_fqn,
             package_warehouse=self.package_warehouse,
-            post_deploy_hooks=self.package_post_deploy_hooks,
-            package_scripts=self.package_scripts,
             policy=AllowAlwaysPolicy(),
             use_scratch_stage=use_scratch_stage,
             scratch_stage_fqn=self.scratch_stage_fqn,
         )
 
     def get_validation_result(self, use_scratch_stage: bool = False):
-        return ApplicationPackageEntity.get_validation_result(
+        return ApplicationPackageEntity.get_validation_result_static(
             console=cc,
             project_root=self.project_root,
             deploy_root=self.deploy_root,
@@ -357,8 +336,6 @@ class NativeAppManager:
             paths=[],
             stage_fqn=self.stage_fqn,
             package_warehouse=self.package_warehouse,
-            post_deploy_hooks=self.package_post_deploy_hooks,
-            package_scripts=self.package_scripts,
             policy=AllowAlwaysPolicy(),
             use_scratch_stage=use_scratch_stage,
             scratch_stage_fqn=self.scratch_stage_fqn,