snowflake-cli-labs 3.0.0rc3__py3-none-any.whl → 3.0.0rc4__py3-none-any.whl

snowflake/cli/_plugins/nativeapp/{application_package_entity.py → entities/application_package.py}

@@ -1,14 +1,14 @@
+from __future__ import annotations
+
 import json
 from contextlib import contextmanager
 from pathlib import Path
 from textwrap import dedent
-from typing import Callable, List, Optional
+from typing import List, Literal, Optional, Union
 
 import typer
 from click import BadOptionUsage, ClickException
-from snowflake.cli._plugins.nativeapp.application_package_entity_model import (
-    ApplicationPackageEntityModel,
-)
+from pydantic import Field, field_validator
 from snowflake.cli._plugins.nativeapp.artifacts import (
     BundleMap,
     build_bundle,
@@ -39,13 +39,11 @@ from snowflake.cli._plugins.nativeapp.policy import (
     DenyAlwaysPolicy,
     PolicyBase,
 )
-from snowflake.cli._plugins.nativeapp.utils import (
-    needs_confirmation,
-)
+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.api.console import cli_console as cc
+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
 from snowflake.cli.api.entities.utils import (
@@ -56,24 +54,95 @@ from snowflake.cli.api.entities.utils import (
     sync_deploy_root_with_stage,
     validation_item_to_str,
 )
-from snowflake.cli.api.errno import (
-    DOES_NOT_EXIST_OR_NOT_AUTHORIZED,
-)
+from snowflake.cli.api.errno import DOES_NOT_EXIST_OR_NOT_AUTHORIZED
 from snowflake.cli.api.exceptions import SnowflakeSQLExecutionError
-from snowflake.cli.api.project.schemas.entities.common import PostDeployHook
+from snowflake.cli.api.metrics import CLICounterField
+from snowflake.cli.api.project.schemas.entities.common import (
+    EntityModelBase,
+    Identifier,
+    PostDeployHook,
+)
+from snowflake.cli.api.project.schemas.updatable_model import (
+    DiscriminatorField,
+    IdentifierField,
+)
+from snowflake.cli.api.project.schemas.v1.native_app.package import DistributionOptions
 from snowflake.cli.api.project.schemas.v1.native_app.path_mapping import PathMapping
 from snowflake.cli.api.project.util import (
+    append_test_resource_suffix,
     extract_schema,
     identifier_to_show_like_pattern,
     to_identifier,
     unquote_identifier,
 )
-from snowflake.cli.api.rendering.jinja import (
-    get_basic_jinja_env,
-)
+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 ProgrammingError
-from snowflake.connector.cursor import DictCursor, SnowflakeCursor
+from snowflake.connector import DictCursor, ProgrammingError
+from snowflake.connector.cursor import SnowflakeCursor
+
+
+class ApplicationPackageEntityModel(EntityModelBase):
+    type: Literal["application package"] = DiscriminatorField()  # noqa: A003
+    artifacts: List[Union[PathMapping, str]] = Field(
+        title="List of paths or file source/destination pairs to add to the deploy root",
+    )
+    bundle_root: Optional[str] = Field(
+        title="Folder at the root of your project where artifacts necessary to perform the bundle step are stored.",
+        default="output/bundle/",
+    )
+    deploy_root: Optional[str] = Field(
+        title="Folder at the root of your project where the build step copies the artifacts",
+        default="output/deploy/",
+    )
+    generated_root: Optional[str] = Field(
+        title="Subdirectory of the deploy root where files generated by the Snowflake CLI will be written.",
+        default="__generated/",
+    )
+    stage: Optional[str] = IdentifierField(
+        title="Identifier of the stage that stores the application artifacts.",
+        default="app_src.stage",
+    )
+    scratch_stage: Optional[str] = IdentifierField(
+        title="Identifier of the stage that stores temporary scratch data used by the Snowflake CLI.",
+        default="app_src.stage_snowflake_cli_scratch",
+    )
+    distribution: Optional[DistributionOptions] = Field(
+        title="Distribution of the application package created by the Snowflake CLI",
+        default="internal",
+    )
+    manifest: str = Field(
+        title="Path to manifest.yml",
+    )
+
+    @field_validator("identifier")
+    @classmethod
+    def append_test_resource_suffix_to_identifier(
+        cls, input_value: Identifier | str
+    ) -> Identifier | str:
+        identifier = (
+            input_value.name if isinstance(input_value, Identifier) else input_value
+        )
+        with_suffix = append_test_resource_suffix(identifier)
+        if isinstance(input_value, Identifier):
+            return input_value.model_copy(update=dict(name=with_suffix))
+        return with_suffix
+
+    @field_validator("artifacts")
+    @classmethod
+    def transform_artifacts(
+        cls, orig_artifacts: List[Union[PathMapping, str]]
+    ) -> List[PathMapping]:
+        transformed_artifacts = []
+        if orig_artifacts is None:
+            return transformed_artifacts
+
+        for artifact in orig_artifacts:
+            if isinstance(artifact, PathMapping):
+                transformed_artifacts.append(artifact)
+            else:
+                transformed_artifacts.append(PathMapping(src=artifact))
+
+        return transformed_artifacts
 
 
 class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
@@ -160,32 +229,35 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
     ):
         model = self._entity_model
         package_name = model.fqn.identifier
-        stage_fqn = f"{package_name}.{model.stage}"
-        if model.meta and model.meta.role:
-            package_role = model.meta.role
+        if force:
+            policy = AllowAlwaysPolicy()
+        elif interactive:
+            policy = AskAlwaysPolicy()
         else:
-            package_role = ctx.default_role
-
-        def deploy_to_scratch_stage_fn():
-            self.action_deploy(
-                ctx=ctx,
-                prune=True,
-                recursive=True,
-                paths=[],
-                validate=False,
-                stage_fqn=f"{package_name}.{model.scratch_stage}",
-                interactive=interactive,
-                force=force,
-            )
+            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),
+            artifacts=model.artifacts,
             package_name=package_name,
-            package_role=package_role,
-            stage_fqn=stage_fqn,
+            package_role=(model.meta and model.meta.role) or 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
+            ),
+            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,
             scratch_stage_fqn=f"{package_name}.{model.scratch_stage}",
-            deploy_to_scratch_stage_fn=deploy_to_scratch_stage_fn,
         )
         ctx.console.message("Setup script is valid")
 
@@ -239,6 +311,32 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             interactive=interactive,
         )
 
+    def action_version_drop(
+        self,
+        ctx: ActionContext,
+        version: Optional[str],
+        interactive: bool,
+        force: bool,
+        *args,
+        **kwargs,
+    ):
+        model = self._entity_model
+        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),
+            artifacts=model.artifacts,
+            package_name=package_name,
+            package_role=(model.meta and model.meta.role) or ctx.default_role,
+            package_distribution=model.distribution,
+            version=version,
+            force=force,
+            interactive=interactive,
+        )
+
     @staticmethod
     def bundle(
         project_root: Path,
@@ -304,19 +402,18 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 package_distribution=package_distribution,
             )
         except ApplicationPackageAlreadyExistsError as e:
-            cc.warning(e.message)
+            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):
-            if package_scripts:
-                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,
-                )
+            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,
+            )
 
             # 3. Upload files from deploy root local folder to the above stage
             stage_schema = extract_schema(stage_fqn)
@@ -334,24 +431,35 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 print_diff=print_diff,
             )
 
-        if post_deploy_hooks:
-            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(
                 console=console,
+                project_root=project_root,
+                deploy_root=deploy_root,
+                bundle_root=bundle_root,
+                generated_root=generated_root,
+                artifacts=artifacts,
                 package_name=package_name,
                 package_role=package_role,
+                package_distribution=package_distribution,
+                prune=prune,
+                recursive=recursive,
+                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="",
-                deploy_to_scratch_stage_fn=lambda *args: None,
             )
 
         return diff
@@ -723,6 +831,113 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         except InvalidGitRepositoryError:
             pass  # not a git repository, which is acceptable
 
+    @classmethod
+    def version_drop(
+        cls,
+        console: AbstractConsole,
+        project_root: Path,
+        deploy_root: Path,
+        bundle_root: Path,
+        generated_root: Path,
+        artifacts: list[PathMapping],
+        package_name: str,
+        package_role: str,
+        package_distribution: str,
+        version: Optional[str],
+        force: bool,
+        interactive: bool,
+    ):
+        """
+        Drops a version defined in an application package. If --force is provided, then no user prompts will be executed.
+        """
+        if force:
+            interactive = False
+            policy = AllowAlwaysPolicy()
+        else:
+            policy = AskAlwaysPolicy() if interactive else DenyAlwaysPolicy()
+
+        # 1. Check for existing an existing application package
+        show_obj_row = cls.get_existing_app_pkg_info(package_name, package_role)
+        if not show_obj_row:
+            raise ApplicationPackageDoesNotExistError(package_name)
+
+        # 2. Check distribution of the existing application package
+        actual_distribution = cls.get_app_pkg_distribution_in_snowflake(
+            package_name, package_role
+        )
+        if not cls.verify_project_distribution(
+            console=console,
+            package_name=package_name,
+            package_role=package_role,
+            package_distribution=package_distribution,
+            expected_distribution=actual_distribution,
+        ):
+            console.warning(
+                f"Continuing to execute version drop on application package "
+                f"{package_name} with distribution '{actual_distribution}'."
+            )
+
+        # 3. If the user did not pass in a version string, determine from manifest.yml
+        if not version:
+            console.message(
+                dedent(
+                    f"""\
+                        Version was not provided through the Snowflake CLI. Checking version in the manifest.yml instead.
+                        This step will bundle your app artifacts to determine the location of the manifest.yml file.
+                    """
+                )
+            )
+            cls.bundle(
+                project_root=project_root,
+                deploy_root=deploy_root,
+                bundle_root=bundle_root,
+                generated_root=generated_root,
+                artifacts=artifacts,
+                package_name=package_name,
+            )
+            version, _ = find_version_info_in_manifest_file(deploy_root)
+            if not version:
+                raise ClickException(
+                    "Manifest.yml file does not contain a value for the version field."
+                )
+
+        # Make the version a valid identifier, adding quotes if necessary
+        version = to_identifier(version)
+
+        console.step(
+            f"About to drop version {version} in application package {package_name}."
+        )
+
+        # If user did not provide --force, ask for confirmation
+        user_prompt = (
+            f"Are you sure you want to drop version {version} "
+            f"in application package {package_name}? "
+            f"Once dropped, this operation cannot be undone."
+        )
+        if not policy.should_proceed(user_prompt):
+            if interactive:
+                console.message("Not dropping version.")
+                raise typer.Exit(0)
+            else:
+                console.message(
+                    "Cannot drop version non-interactively without --force."
+                )
+                raise typer.Exit(1)
+
+        # Drop the version
+        sql_executor = get_sql_executor()
+        with sql_executor.use_role(package_role):
+            try:
+                sql_executor.execute_query(
+                    f"alter application package {package_name} drop version {version}"
+                )
+            except ProgrammingError as err:
+                raise err  # e.g. version is referenced in a release directive(s)
+
+        console.message(
+            f"Version {version} in application package {package_name} dropped successfully."
+        )
+
     @staticmethod
     def get_existing_app_pkg_info(
         package_name: str,
@@ -837,10 +1052,17 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         applies all package scripts in-order to the application package.
         """
 
-        if package_scripts:
-            console.warning(
-                "WARNING: native_app.package.scripts is deprecated. Please migrate to using native_app.package.post_deploy."
-            )
+        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,
@@ -929,36 +1151,65 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         package_name: str,
         package_warehouse: Optional[str],
     ):
-        with cls.use_package_warehouse(package_warehouse):
-            execute_post_deploy_hooks(
-                console=console,
-                project_root=project_root,
-                post_deploy_hooks=post_deploy_hooks,
-                deployed_object_type="application package",
-                database_name=package_name,
-            )
+        get_cli_context().metrics.set_counter_default(
+            CLICounterField.POST_DEPLOY_SCRIPTS, 0
+        )
+
+        if post_deploy_hooks:
+            with cls.use_package_warehouse(package_warehouse):
+                execute_post_deploy_hooks(
+                    console=console,
+                    project_root=project_root,
+                    post_deploy_hooks=post_deploy_hooks,
+                    deployed_object_type="application package",
+                    database_name=package_name,
+                )
 
     @classmethod
     def validate_setup_script(
         cls,
         console: AbstractConsole,
+        project_root: Path,
+        deploy_root: Path,
+        bundle_root: Path,
+        generated_root: Path,
+        artifacts: list[PathMapping],
         package_name: str,
         package_role: str,
+        package_distribution: str,
+        package_warehouse: str | None,
+        prune: bool,
+        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,
-        deploy_to_scratch_stage_fn: Callable,
     ):
         """Validates Native App setup script SQL."""
         with console.phase(f"Validating Snowflake Native App setup script."):
             validation_result = cls.get_validation_result(
                 console=console,
+                project_root=project_root,
+                deploy_root=deploy_root,
+                bundle_root=bundle_root,
+                generated_root=generated_root,
+                artifacts=artifacts,
                 package_name=package_name,
                 package_role=package_role,
+                package_distribution=package_distribution,
+                prune=prune,
+                recursive=recursive,
+                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,
-                deploy_to_scratch_stage_fn=deploy_to_scratch_stage_fn,
             )
 
             # First print warnings, regardless of the outcome of validation
@@ -975,20 +1226,54 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             if validation_result["status"] == "FAIL":
                 raise SetupScriptFailedValidation()
 
-    @staticmethod
+    @classmethod
     def get_validation_result(
+        cls,
         console: AbstractConsole,
+        project_root: Path,
+        deploy_root: Path,
+        bundle_root: Path,
+        generated_root: Path,
+        artifacts: list[PathMapping],
         package_name: str,
         package_role: str,
+        package_distribution: str,
+        package_warehouse: str | None,
+        prune: bool,
+        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,
-        deploy_to_scratch_stage_fn: Callable,
     ):
         """Call system$validate_native_app_setup() to validate deployed Native App setup script."""
         if use_scratch_stage:
             stage_fqn = scratch_stage_fqn
-            deploy_to_scratch_stage_fn()
+            cls.deploy(
+                console=console,
+                project_root=project_root,
+                deploy_root=deploy_root,
+                bundle_root=bundle_root,
+                generated_root=generated_root,
+                artifacts=artifacts,
+                bundle_map=None,
+                package_name=package_name,
+                package_role=package_role,
+                package_distribution=package_distribution,
+                prune=prune,
+                recursive=recursive,
+                paths=paths,
+                print_diff=False,
+                validate=False,
+                stage_fqn=stage_fqn,
+                package_warehouse=package_warehouse,
+                post_deploy_hooks=post_deploy_hooks,
+                package_scripts=package_scripts,
+                policy=policy,
+            )
         prefixed_stage_fqn = StageManager.get_standard_stage_prefix(stage_fqn)
         sql_executor = get_sql_executor()
         try: