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

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

@@ -0,0 +1,43 @@
+from abc import ABC, abstractmethod
+from pathlib import Path
+from typing import Optional
+
+
+class ApplicationPackageChildInterface(ABC):
+    @abstractmethod
+    def bundle(self, bundle_root=Path, *args, **kwargs) -> None:
+        """
+        Bundles the entity artifacts into the provided root directory. Must not have any side-effects, such as deploying the artifacts into a stage, etc.
+        @param bundle_root: The directory where the bundle contents should be put.
+        """
+        pass
+
+    @abstractmethod
+    def get_deploy_sql(
+        self,
+        artifacts_dir: Path,
+        schema: Optional[str],
+        *args,
+        **kwargs,
+    ) -> str:
+        """
+        Returns the SQL that would create the entity object. Must not execute the SQL or have any other side-effects.
+        @param artifacts_dir: Path to the child entity artifacts directory relative to the deploy root.
+        @param [Optional] schema: Schema to use when creating the object.
+        """
+        pass
+
+    @abstractmethod
+    def get_usage_grant_sql(
+        self,
+        app_role: str,
+        schema: Optional[str],
+        *args,
+        **kwargs,
+    ) -> str:
+        """
+        Returns the SQL that would grant the required USAGE privilege to the provided application role on the entity object. Must not execute the SQL or have any other side-effects.
+        @param app_role: The application role to grant the privileges to.
+        @param [Optional] schema: The schema where the object was created.
+        """
+        pass

snowflake/cli/_plugins/nativeapp/feature_flags.py

@@ -18,7 +18,11 @@ from snowflake.cli.api.feature_flags import BooleanFlag, FeatureFlagMixin
 
 
 @unique
-class FeatureFlag(FeatureFlagMixin):
+class FeatureFlag(
+    FeatureFlagMixin
+):  # TODO move this to snowflake.cli.api.feature_flags
     ENABLE_NATIVE_APP_PYTHON_SETUP = BooleanFlag(
         "ENABLE_NATIVE_APP_PYTHON_SETUP", False
     )
+    ENABLE_NATIVE_APP_CHILDREN = BooleanFlag("ENABLE_NATIVE_APP_CHILDREN", False)
+    ENABLE_RELEASE_CHANNELS = BooleanFlag("ENABLE_RELEASE_CHANNELS", None)

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

@@ -0,0 +1,13 @@
+# 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.

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

@@ -0,0 +1,212 @@
+# 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
+from typing import Optional
+
+import typer
+from snowflake.cli._plugins.nativeapp.v2_conversions.compat import (
+    force_project_definition_v2,
+)
+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.output.formats import OutputFormat
+from snowflake.cli.api.output.types import (
+    CollectionResult,
+    CommandResult,
+    MessageResult,
+)
+
+app = SnowTyperFactory(
+    name="release-channel",
+    help="Manages release channels of an application package",
+)
+
+log = logging.getLogger(__name__)
+
+
+@app.command("list", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_channel_list(
+    channel: Optional[str] = typer.Argument(
+        default=None,
+        show_default=False,
+        help="The release channel to list. If not provided, all release channels are listed.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Lists the release channels available for an application package.
+    """
+
+    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"]
+    channels = ws.perform_action(
+        package_id,
+        EntityActions.RELEASE_CHANNEL_LIST,
+        release_channel=channel,
+    )
+
+    if cli_context.output_format == OutputFormat.JSON:
+        return CollectionResult(channels)
+
+
+@app.command("add-accounts", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_channel_add_accounts(
+    channel: str = typer.Argument(
+        show_default=False,
+        help="The release channel to add accounts to.",
+    ),
+    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`.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Adds accounts to 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_ADD_ACCOUNTS,
+        release_channel=channel,
+        target_accounts=target_accounts.split(","),
+    )
+
+    return MessageResult("Successfully added accounts to the release channel.")
+
+
+@app.command("remove-accounts", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_channel_remove_accounts(
+    channel: str = typer.Argument(
+        show_default=False,
+        help="The release channel to remove accounts from.",
+    ),
+    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`.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Removes accounts from 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_REMOVE_ACCOUNTS,
+        release_channel=channel,
+        target_accounts=target_accounts.split(","),
+    )
+
+    return MessageResult("Successfully removed accounts from the release channel.")
+
+
+@app.command("add-version", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_channel_add_version(
+    channel: str = typer.Argument(
+        show_default=False,
+        help="The release channel to add a version to.",
+    ),
+    version: str = typer.Option(
+        show_default=False,
+        help="The version to add to the release channel.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Adds a version to 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_ADD_VERSION,
+        release_channel=channel,
+        version=version,
+    )
+
+    return MessageResult(
+        f"Successfully added version {version} to the release channel."
+    )
+
+
+@app.command("remove-version", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_channel_remove_version(
+    channel: str = typer.Argument(
+        show_default=False,
+        help="The release channel to remove a version from.",
+    ),
+    version: str = typer.Option(
+        show_default=False,
+        help="The version to remove from the release channel.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Removes a version from 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_REMOVE_VERSION,
+        release_channel=channel,
+        version=version,
+    )
+
+    return MessageResult(
+        f"Successfully removed version {version} from the release channel."
+    )

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

@@ -0,0 +1,13 @@
+# 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.

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

@@ -0,0 +1,165 @@
+# 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
+from typing import Optional
+
+import typer
+from snowflake.cli._plugins.nativeapp.constants import DEFAULT_CHANNEL
+from snowflake.cli._plugins.nativeapp.v2_conversions.compat import (
+    force_project_definition_v2,
+)
+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.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.output.types import (
+    CollectionResult,
+    CommandResult,
+    MessageResult,
+)
+
+app = SnowTyperFactory(
+    name="release-directive",
+    help="Manages release directives of an application package",
+)
+
+log = logging.getLogger(__name__)
+
+
+@app.command("list", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_directive_list(
+    like: str = like_option(
+        help_example="`snow app release-directive list --like='my%'` lists all release directives starting with 'my'",
+    ),
+    channel: Optional[str] = typer.Option(
+        default=None,
+        show_default=False,
+        help="The release channel to use when listing release directives. If not provided, release directives from all release channels are listed.",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Lists release directives in an application package.
+    If no release channel is specified, release directives for all channels are listed.
+    If a release channel is specified, only release directives for that channel are listed.
+
+    If `--like` is provided, only release directives matching the SQL pattern are listed.
+    """
+
+    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"]
+    result = ws.perform_action(
+        package_id,
+        EntityActions.RELEASE_DIRECTIVE_LIST,
+        release_channel=channel,
+        like=like,
+    )
+
+    return CollectionResult(result)
+
+
+@app.command("set", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_directive_set(
+    directive: str = typer.Argument(
+        show_default=False,
+        help="Name of the release directive to set",
+    ),
+    channel: str = typer.Option(
+        DEFAULT_CHANNEL,
+        help="Name of the release channel to use",
+    ),
+    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`",
+    ),
+    version: str = typer.Option(
+        show_default=False,
+        help="Version of the application package to use",
+    ),
+    patch: int = typer.Option(
+        show_default=False,
+        help="Patch number to use for the selected version",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Sets a release directive.
+
+    target_accounts cannot be specified for default release directives.
+    target_accounts field is required when creating a new non-default 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_SET,
+        release_directive=directive,
+        version=version,
+        patch=patch,
+        target_accounts=None if target_accounts is None else target_accounts.split(","),
+        release_channel=channel,
+    )
+    return MessageResult("Successfully set release directive.")
+
+
+@app.command("unset", requires_connection=True)
+@with_project_definition()
+@force_project_definition_v2()
+def release_directive_unset(
+    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",
+    ),
+    **options,
+) -> CommandResult:
+    """
+    Unsets 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_UNSET,
+        release_directive=directive,
+        release_channel=channel,
+    )
+    return MessageResult(f"Successfully unset release directive {directive}.")

snowflake/cli/_plugins/nativeapp/same_account_install_method.py

@@ -1,3 +1,4 @@
+from dataclasses import dataclass
 from typing import Optional
 
 from snowflake.cli._plugins.nativeapp.constants import (
@@ -8,25 +9,15 @@ from snowflake.cli._plugins.nativeapp.exceptions import (
     ApplicationCreatedExternallyError,
 )
 from snowflake.cli._plugins.stage.manager import StageManager
+from snowflake.cli.api.project.util import to_identifier
 
 
+@dataclass
 class SameAccountInstallMethod:
     _requires_created_by_cli: bool
-    _from_release_directive: bool
-    version: Optional[str]
-    patch: Optional[int]
-
-    def __init__(
-        self,
-        requires_created_by_cli: bool,
-        version: Optional[str] = None,
-        patch: Optional[int] = None,
-        from_release_directive: bool = False,
-    ):
-        self._requires_created_by_cli = requires_created_by_cli
-        self.version = version
-        self.patch = patch
-        self._from_release_directive = from_release_directive
+    version: Optional[str] = None
+    patch: Optional[int] = None
+    _from_release_directive: bool = False
 
     @classmethod
     def unversioned_dev(cls):
@@ -39,7 +30,7 @@ class SameAccountInstallMethod:
 
     @classmethod
     def release_directive(cls):
-        return cls(False, from_release_directive=True)
+        return cls(False, _from_release_directive=True)
 
     @property
     def is_dev_mode(self) -> bool:
@@ -53,8 +44,9 @@ class SameAccountInstallMethod:
             return ""
 
         if self.version:
+            version_clause = f"version {to_identifier(self.version)}"
             patch_clause = f"patch {self.patch}" if self.patch else ""
-            return f"using version {self.version} {patch_clause}"
+            return f"using {version_clause} {patch_clause}"
 
         stage_name = StageManager.quote_stage_name(stage_fqn)
         return f"using {stage_name}"

snowflake/cli/_plugins/nativeapp/sf_facade_exceptions.py

@@ -11,12 +11,83 @@
 # 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
+
 from typing import NoReturn
 
 from click import ClickException
 from snowflake.cli._plugins.nativeapp.sf_facade_constants import UseObjectType
+from snowflake.cli.api.errno import (
+    APPLICATION_FILE_NOT_FOUND_ON_STAGE,
+    APPLICATION_INSTANCE_EMPTY_SETUP_SCRIPT,
+    APPLICATION_INSTANCE_FAILED_TO_RUN_SETUP_SCRIPT,
+    APPLICATION_INSTANCE_NO_ACTIVE_WAREHOUSE_FOR_CREATE_OR_UPGRADE,
+    APPLICATION_NO_LONGER_AVAILABLE,
+    APPLICATION_PACKAGE_CANNOT_SET_EXTERNAL_DISTRIBUTION_WITH_SPCS,
+    APPLICATION_PACKAGE_MANIFEST_CONTAINER_IMAGE_URL_BAD_VALUE,
+    APPLICATION_PACKAGE_MANIFEST_SPECIFIED_FILE_NOT_FOUND,
+    APPLICATION_PACKAGE_PATCH_DOES_NOT_EXIST,
+    CANNOT_GRANT_NON_MANIFEST_PRIVILEGE,
+    CANNOT_GRANT_OBJECT_NOT_IN_APP_PACKAGE,
+    CANNOT_GRANT_RESTRICTED_PRIVILEGE_TO_APP_PACKAGE_SHARE,
+    CANNOT_UPGRADE_FROM_LOOSE_FILES_TO_VERSION,
+    CANNOT_UPGRADE_FROM_VERSION_TO_LOOSE_FILES,
+    NATIVE_APPLICATION_MANIFEST_GENERIC_JSON_ERROR,
+    NATIVE_APPLICATION_MANIFEST_INVALID_SYNTAX,
+    NATIVE_APPLICATION_MANIFEST_UNEXPECTED_VALUE_FOR_PROPERTY,
+    NATIVE_APPLICATION_MANIFEST_UNRECOGNIZED_FIELD,
+    NO_REFERENCE_SET_FOR_DEFINITION,
+    NO_VERSIONS_AVAILABLE_FOR_ACCOUNT,
+    NOT_SUPPORTED_ON_DEV_MODE_APPLICATIONS,
+    ONLY_SUPPORTED_ON_DEV_MODE_APPLICATIONS,
+    ROLE_NOT_ASSIGNED,
+    SNOWSERVICES_IMAGE_MANIFEST_NOT_FOUND,
+    SNOWSERVICES_IMAGE_REPOSITORY_FAILS_TO_RETRIEVE_IMAGE_HASH_NEW,
+    SNOWSERVICES_IMAGE_REPOSITORY_IMAGE_IMPORT_TO_NATIVE_APP_FAIL,
+    VIEW_EXPANSION_FAILED,
+)
 from snowflake.connector import DatabaseError, Error, ProgrammingError
 
+# Reasons why an `alter application ... upgrade` might fail
+UPGRADE_RESTRICTION_CODES = {
+    CANNOT_UPGRADE_FROM_LOOSE_FILES_TO_VERSION,
+    CANNOT_UPGRADE_FROM_VERSION_TO_LOOSE_FILES,
+    ONLY_SUPPORTED_ON_DEV_MODE_APPLICATIONS,
+    NOT_SUPPORTED_ON_DEV_MODE_APPLICATIONS,
+    APPLICATION_NO_LONGER_AVAILABLE,
+}
+
+CREATE_OR_UPGRADE_APPLICATION_EXPECTED_USER_ERROR_CODES = {
+    APPLICATION_INSTANCE_FAILED_TO_RUN_SETUP_SCRIPT,
+    NATIVE_APPLICATION_MANIFEST_GENERIC_JSON_ERROR,
+    APPLICATION_INSTANCE_NO_ACTIVE_WAREHOUSE_FOR_CREATE_OR_UPGRADE,
+    # when setup script/manifest/readme isn't on the stage
+    APPLICATION_FILE_NOT_FOUND_ON_STAGE,
+    NATIVE_APPLICATION_MANIFEST_UNRECOGNIZED_FIELD,
+    SNOWSERVICES_IMAGE_MANIFEST_NOT_FOUND,
+    # user tried to clone tables and it failed
+    VIEW_EXPANSION_FAILED,
+    # user tried to do something with a role that wasn't assigned to them
+    ROLE_NOT_ASSIGNED,
+    APPLICATION_PACKAGE_MANIFEST_SPECIFIED_FILE_NOT_FOUND,
+    SNOWSERVICES_IMAGE_REPOSITORY_IMAGE_IMPORT_TO_NATIVE_APP_FAIL,
+    APPLICATION_PACKAGE_PATCH_DOES_NOT_EXIST,
+    APPLICATION_PACKAGE_MANIFEST_CONTAINER_IMAGE_URL_BAD_VALUE,
+    SNOWSERVICES_IMAGE_REPOSITORY_FAILS_TO_RETRIEVE_IMAGE_HASH_NEW,
+    NATIVE_APPLICATION_MANIFEST_UNEXPECTED_VALUE_FOR_PROPERTY,
+    CANNOT_GRANT_NON_MANIFEST_PRIVILEGE,
+    NO_REFERENCE_SET_FOR_DEFINITION,
+    NATIVE_APPLICATION_MANIFEST_INVALID_SYNTAX,
+    CANNOT_GRANT_OBJECT_NOT_IN_APP_PACKAGE,
+    APPLICATION_PACKAGE_MANIFEST_SPECIFIED_FILE_NOT_FOUND,
+    # user tried installing from release directive and there are none available
+    NO_VERSIONS_AVAILABLE_FOR_ACCOUNT,
+    APPLICATION_PACKAGE_MANIFEST_CONTAINER_IMAGE_URL_BAD_VALUE,
+    APPLICATION_INSTANCE_EMPTY_SETUP_SCRIPT,
+    APPLICATION_PACKAGE_CANNOT_SET_EXTERNAL_DISTRIBUTION_WITH_SPCS,
+    CANNOT_GRANT_RESTRICTED_PRIVILEGE_TO_APP_PACKAGE_SHARE,
+}
+
 
 def handle_unclassified_error(err: Error | Exception, context: str) -> NoReturn:
     """
@@ -115,3 +186,12 @@ class InsufficientPrivilegesError(ClickException):
         if role:
             message += f" using role: {role}"
         super().__init__(message)
+
+
+class UpgradeApplicationRestrictionError(UserInputError):
+    """
+    Raised when an alter application ... upgrade fails due to user error.
+    Must be caught and handled by the caller of an upgrade_application
+    """
+
+    pass