snowflake-cli 3.3.0__py3-none-any.whl → 3.5.0__py3-none-any.whl

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

@@ -4,6 +4,7 @@ import json
 import os
 import re
 from datetime import datetime
+from functools import cached_property
 from pathlib import Path
 from textwrap import dedent
 from typing import Any, List, Literal, Optional, Set, Union
@@ -13,7 +14,6 @@ from click import BadOptionUsage, ClickException, UsageError
 from pydantic import Field, field_validator
 from snowflake.cli._plugins.connection.util import UIParameter
 from snowflake.cli._plugins.nativeapp.artifacts import (
-    BundleMap,
     VersionInfo,
     build_bundle,
     find_setup_script_file,
@@ -61,29 +61,35 @@ from snowflake.cli._plugins.snowpark.snowpark_entity_model import (
     FunctionEntityModel,
     ProcedureEntityModel,
 )
-from snowflake.cli._plugins.stage.diff import DiffResult
-from snowflake.cli._plugins.stage.manager import StageManager
+from snowflake.cli._plugins.stage.diff import DiffResult, compute_stage_diff
+from snowflake.cli._plugins.stage.manager import (
+    DefaultStagePathParts,
+    StageManager,
+    StagePathParts,
+)
+from snowflake.cli._plugins.stage.utils import print_diff_to_console
 from snowflake.cli._plugins.streamlit.streamlit_entity_model import (
     StreamlitEntityModel,
 )
 from snowflake.cli._plugins.workspace.context import ActionContext
+from snowflake.cli.api.artifacts.bundle_map import BundleMap
 from snowflake.cli.api.cli_global_context import span
 from snowflake.cli.api.entities.common import (
     EntityBase,
     attach_spans_to_entity_actions,
-    get_sql_executor,
 )
 from snowflake.cli.api.entities.utils import (
     drop_generic_object,
     execute_post_deploy_hooks,
     generic_sql_error_handler,
+    get_sql_executor,
     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.exceptions import SnowflakeSQLExecutionError
 from snowflake.cli.api.project.schemas.entities.common import (
-    EntityModelBase,
+    EntityModelBaseWithArtifacts,
     Identifier,
     PostDeployHook,
 )
@@ -93,12 +99,10 @@ from snowflake.cli.api.project.schemas.updatable_model import (
     UpdatableModel,
 )
 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 (
     SCHEMA_AND_NAME,
     VALID_IDENTIFIER_REGEX,
     append_test_resource_suffix,
-    extract_schema,
     identifier_to_show_like_pattern,
     same_identifiers,
     sql_match,
@@ -147,19 +151,12 @@ class ApplicationPackageChildField(UpdatableModel):
     )
 
 
-class ApplicationPackageEntityModel(EntityModelBase):
+class ApplicationPackageEntityModel(EntityModelBaseWithArtifacts):
     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/",
-    )
     children_artifacts_dir: Optional[str] = Field(
         title="Folder under deploy_root where the child artifacts will be stored",
         default="_children/",
@@ -184,6 +181,11 @@ class ApplicationPackageEntityModel(EntityModelBase):
         title="Path to manifest.yml. Unused and deprecated starting with Snowflake CLI 3.2",
         default="",
     )
+
+    stage_subdirectory: Optional[str] = Field(
+        title="Subfolder in stage to upload the artifacts to, instead of the root of the application package's stage",
+        default="",
+    )
     children: Optional[List[ApplicationPackageChildField]] = Field(
         title="Entities that will be bundled and deployed as part of this application package",
         default=[],
@@ -211,23 +213,6 @@ class ApplicationPackageEntityModel(EntityModelBase):
             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
-
     @field_validator("stage")
     @classmethod
     def validate_source_stage(cls, input_value: str):
@@ -250,7 +235,11 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
 
     @property
     def deploy_root(self) -> Path:
-        return self.project_root / self._entity_model.deploy_root
+        return (
+            self.project_root
+            / self._entity_model.deploy_root
+            / self._entity_model.stage_subdirectory
+        )
 
     @property
     def children_artifacts_deploy_root(self) -> Path:
@@ -281,12 +270,16 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         ) or to_identifier(self._workspace_ctx.default_warehouse)
 
     @property
-    def stage_fqn(self) -> str:
-        return f"{self.name}.{self._entity_model.stage}"
+    def scratch_stage_path(self) -> DefaultStagePathParts:
+        return DefaultStagePathParts.from_fqn(
+            f"{self.name}.{self._entity_model.scratch_stage}"
+        )
 
-    @property
-    def scratch_stage_fqn(self) -> str:
-        return f"{self.name}.{self._entity_model.scratch_stage}"
+    @cached_property
+    def stage_path(self) -> DefaultStagePathParts:
+        stage_fqn = f"{self.name}.{self._entity_model.stage}"
+        subdir = self._entity_model.stage_subdirectory
+        return DefaultStagePathParts.from_fqn(stage_fqn, subdir)
 
     @property
     def post_deploy_hooks(self) -> list[PostDeployHook] | None:
@@ -296,6 +289,23 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
     def action_bundle(self, action_ctx: ActionContext, *args, **kwargs):
         return self._bundle(action_ctx)
 
+    def action_diff(
+        self, action_ctx: ActionContext, print_to_console: bool, *args, **kwargs
+    ):
+        """
+        Compute the diff between the local artifacts and the remote ones on the stage.
+        """
+        bundle_map = self._bundle()
+        diff = compute_stage_diff(
+            local_root=self.deploy_root,
+            stage_path=self.stage_path,
+        )
+
+        if print_to_console:
+            print_diff_to_console(diff, bundle_map)
+
+        return diff
+
     def action_deploy(
         self,
         action_ctx: ActionContext,
@@ -305,7 +315,6 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         validate: bool,
         interactive: bool,
         force: bool,
-        stage_fqn: Optional[str] = None,
         *args,
         **kwargs,
     ):
@@ -317,7 +326,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             paths=paths,
             print_diff=True,
             validate=validate,
-            stage_fqn=stage_fqn or self.stage_fqn,
+            stage_path=self.stage_path,
             interactive=interactive,
             force=force,
         )
@@ -477,7 +486,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 paths=[],
                 print_diff=True,
                 validate=True,
-                stage_fqn=self.stage_fqn,
+                stage_path=self.stage_path,
                 interactive=interactive,
                 force=force,
             )
@@ -767,6 +776,58 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             role=self.role,
         )
 
+    def action_release_directive_add_accounts(
+        self,
+        action_ctx: ActionContext,
+        release_directive: str,
+        release_channel: str,
+        target_accounts: list[str],
+        *args,
+        **kwargs,
+    ):
+        """
+        Adds target accounts to a release directive.
+        """
+
+        if not target_accounts:
+            raise ClickException("No target accounts provided.")
+
+        self._validate_target_accounts(target_accounts)
+
+        get_snowflake_facade().add_accounts_to_release_directive(
+            package_name=self.name,
+            release_directive=release_directive,
+            release_channel=self.get_sanitized_release_channel(release_channel),
+            target_accounts=target_accounts,
+            role=self.role,
+        )
+
+    def action_release_directive_remove_accounts(
+        self,
+        action_ctx: ActionContext,
+        release_directive: str,
+        release_channel: str,
+        target_accounts: list[str],
+        *args,
+        **kwargs,
+    ):
+        """
+        Removes target accounts from a release directive.
+        """
+
+        if not target_accounts:
+            raise ClickException("No target accounts provided.")
+
+        self._validate_target_accounts(target_accounts)
+
+        get_snowflake_facade().remove_accounts_from_release_directive(
+            package_name=self.name,
+            release_directive=release_directive,
+            release_channel=self.get_sanitized_release_channel(release_channel),
+            target_accounts=target_accounts,
+            role=self.role,
+        )
+
     def _print_channel_to_console(self, channel: ReleaseChannel) -> None:
         """
         Prints the release channel details to the console.
@@ -911,6 +972,31 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             role=self.role,
         )
 
+    def action_release_channel_set_accounts(
+        self,
+        action_ctx: ActionContext,
+        release_channel: str,
+        target_accounts: list[str],
+        *args,
+        **kwargs,
+    ):
+        """
+        Sets target accounts for a release channel.
+        """
+
+        if not target_accounts:
+            raise ClickException("No target accounts provided.")
+
+        self.validate_release_channel(release_channel)
+        self._validate_target_accounts(target_accounts)
+
+        get_snowflake_facade().set_accounts_for_release_channel(
+            package_name=self.name,
+            release_channel=release_channel,
+            target_accounts=target_accounts,
+            role=self.role,
+        )
+
     def action_release_channel_add_version(
         self,
         action_ctx: ActionContext,
@@ -1202,7 +1288,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         paths: list[Path],
         print_diff: bool,
         validate: bool,
-        stage_fqn: str,
+        stage_path: StagePathParts,
         interactive: bool,
         force: bool,
         run_post_deploy_hooks: bool = True,
@@ -1217,7 +1303,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
             policy = DenyAlwaysPolicy()
 
         console = workspace_ctx.console
-        stage_fqn = stage_fqn or self.stage_fqn
+        stage_path = stage_path or self.stage_path
 
         # 1. Create a bundle if one wasn't passed in
         bundle_map = bundle_map or self._bundle(action_ctx)
@@ -1232,17 +1318,15 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
 
         with get_sql_executor().use_role(self.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(
                 console=console,
                 deploy_root=self.deploy_root,
                 package_name=self.name,
-                stage_schema=stage_schema,
                 bundle_map=bundle_map,
                 role=self.role,
                 prune=prune,
                 recursive=recursive,
-                stage_fqn=stage_fqn,
+                stage_path=stage_path,
                 local_paths_to_sync=paths,
                 print_diff=print_diff,
             )
@@ -1321,7 +1405,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         get_snowflake_facade().create_version_in_package(
             role=self.role,
             package_name=self.name,
-            stage_fqn=self.stage_fqn,
+            path_to_version_directory=self.stage_path.full_path,
             version=version,
             label=label,
         )
@@ -1346,7 +1430,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         new_patch = get_snowflake_facade().add_patch_to_package_version(
             role=self.role,
             package_name=self.name,
-            stage_fqn=self.stage_fqn,
+            path_to_version_directory=self.stage_path.full_path,
             version=version,
             patch=patch,
             label=label,
@@ -1440,7 +1524,7 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
     ) -> bool:
         """
         Returns true if the 'distribution' attribute of an existing application package in snowflake
-        is the same as the the attribute specified in project definition file.
+        is the same as the attribute specified in project definition file.
         """
         model = self._entity_model
         workspace_ctx = self._workspace_ctx
@@ -1583,9 +1667,9 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         force: bool,
     ):
         """Call system$validate_native_app_setup() to validate deployed Native App setup script."""
-        stage_fqn = self.stage_fqn
+        stage_path = self.stage_path
         if use_scratch_stage:
-            stage_fqn = self.scratch_stage_fqn
+            stage_path = self.scratch_stage_path
             self._deploy(
                 action_ctx=action_ctx,
                 bundle_map=None,
@@ -1594,12 +1678,15 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
                 paths=[],
                 print_diff=False,
                 validate=False,
-                stage_fqn=self.scratch_stage_fqn,
+                stage_path=stage_path,
                 interactive=interactive,
                 force=force,
                 run_post_deploy_hooks=False,
             )
-        prefixed_stage_fqn = StageManager.get_standard_stage_prefix(stage_fqn)
+        prefixed_stage_fqn = StageManager.get_standard_stage_prefix(
+            stage_path.full_path
+        )
+
         sql_executor = get_sql_executor()
         try:
             cursor = sql_executor.execute_query(
@@ -1616,11 +1703,11 @@ class ApplicationPackageEntity(EntityBase[ApplicationPackageEntityModel]):
         finally:
             if use_scratch_stage:
                 self._workspace_ctx.console.step(
-                    f"Dropping stage {self.scratch_stage_fqn}."
+                    f"Dropping stage {self.scratch_stage_path.stage}."
                 )
                 with sql_executor.use_role(self.role):
                     sql_executor.execute_query(
-                        f"drop stage if exists {self.scratch_stage_fqn}"
+                        f"drop stage if exists {self.scratch_stage_path.stage}"
                     )
 
     def resolve_version_info(

snowflake/cli/_plugins/nativeapp/release_channel/commands.py

@@ -25,7 +25,7 @@ from snowflake.cli._plugins.workspace.manager import WorkspaceManager
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.decorators import with_project_definition
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.entities.common import EntityActions
+from snowflake.cli.api.entities.utils import EntityActions
 from snowflake.cli.api.output.formats import OutputFormat
 from snowflake.cli.api.output.types import (
     CollectionResult,
@@ -82,7 +82,7 @@ def release_channel_add_accounts(
     ),
     target_accounts: str = typer.Option(
         show_default=False,
-        help="The accounts to add to the release channel. Format has to be `org1.account1,org2.account2`.",
+        help="The accounts to add to the release channel. Format must be `org1.account1,org2.account2`.",
     ),
     **options,
 ) -> CommandResult:
@@ -116,7 +116,7 @@ def release_channel_remove_accounts(
     ),
     target_accounts: str = typer.Option(
         show_default=False,
-        help="The accounts to remove from the release channel. Format has to be `org1.account1,org2.account2`.",
+        help="The accounts to remove from the release channel. Format must be `org1.account1,org2.account2`.",
     ),
     **options,
 ) -> CommandResult:
@@ -140,6 +140,40 @@ def release_channel_remove_accounts(
     return MessageResult("Successfully removed accounts from the release channel.")
 
 
+@with_project_definition()
+@app.command("set-accounts", requires_connection=True)
+@force_project_definition_v2()
+def release_channel_set_accounts(
+    channel: str = typer.Argument(
+        show_default=False,
+        help="The release channel to set accounts for.",
+    ),
+    target_accounts: str = typer.Option(
+        show_default=False,
+        help="The accounts to set for the release channel. Format must be `org1.account1,org2.account2`.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Sets accounts for a release channel.
+    """
+
+    cli_context = get_cli_context()
+    ws = WorkspaceManager(
+        project_definition=cli_context.project_definition,
+        project_root=cli_context.project_root,
+    )
+    package_id = options["package_entity_id"]
+    ws.perform_action(
+        package_id,
+        EntityActions.RELEASE_CHANNEL_SET_ACCOUNTS,
+        release_channel=channel,
+        target_accounts=target_accounts.split(","),
+    )
+
+    return MessageResult("Successfully set accounts for the release channel.")
+
+
 @app.command("add-version", requires_connection=True)
 @with_project_definition()
 @force_project_definition_v2()

snowflake/cli/_plugins/nativeapp/release_directive/commands.py

@@ -27,7 +27,7 @@ from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.decorators import with_project_definition
 from snowflake.cli.api.commands.flags import like_option
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
-from snowflake.cli.api.entities.common import EntityActions
+from snowflake.cli.api.entities.utils import EntityActions
 from snowflake.cli.api.output.types import (
     CollectionResult,
     CommandResult,
@@ -95,7 +95,7 @@ def release_directive_set(
     target_accounts: Optional[str] = typer.Option(
         None,
         show_default=False,
-        help="List of the accounts to apply the release directive to. Format has to be `org1.account1,org2.account2`",
+        help="List of the accounts to apply the release directive to. Format must be `org1.account1,org2.account2`",
     ),
     version: str = typer.Option(
         show_default=False,
@@ -163,3 +163,81 @@ def release_directive_unset(
         release_channel=channel,
     )
     return MessageResult(f"Successfully unset release directive {directive}.")
+
+
+@app.command("add-accounts", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_directive_add_accounts(
+    directive: str = typer.Argument(
+        show_default=False,
+        help="Name of the release directive",
+    ),
+    channel: str = typer.Option(
+        DEFAULT_CHANNEL,
+        help="Name of the release channel to use",
+    ),
+    target_accounts: str = typer.Option(
+        show_default=False,
+        help="List of the accounts to add to the release directive. Format must be `org1.account1,org2.account2`",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Adds accounts to a release directive.
+    """
+
+    cli_context = get_cli_context()
+    ws = WorkspaceManager(
+        project_definition=cli_context.project_definition,
+        project_root=cli_context.project_root,
+    )
+    package_id = options["package_entity_id"]
+    ws.perform_action(
+        package_id,
+        EntityActions.RELEASE_DIRECTIVE_ADD_ACCOUNTS,
+        release_directive=directive,
+        target_accounts=target_accounts.split(","),
+        release_channel=channel,
+    )
+
+    return MessageResult("Successfully added accounts to the release directive.")
+
+
+@app.command("remove-accounts", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_directive_remove_accounts(
+    directive: str = typer.Argument(
+        show_default=False,
+        help="Name of the release directive",
+    ),
+    channel: str = typer.Option(
+        DEFAULT_CHANNEL,
+        help="Name of the release channel to use",
+    ),
+    target_accounts: str = typer.Option(
+        show_default=False,
+        help="List of the accounts to remove from the release directive. Format must be `org1.account1,org2.account2`",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Removes accounts from a release directive.
+    """
+
+    cli_context = get_cli_context()
+    ws = WorkspaceManager(
+        project_definition=cli_context.project_definition,
+        project_root=cli_context.project_root,
+    )
+    package_id = options["package_entity_id"]
+    ws.perform_action(
+        package_id,
+        EntityActions.RELEASE_DIRECTIVE_REMOVE_ACCOUNTS,
+        release_directive=directive,
+        target_accounts=target_accounts.split(","),
+        release_channel=channel,
+    )
+
+    return MessageResult("Successfully removed accounts from the release directive.")