snowflake-cli-labs 2.8.0rc1__py3-none-any.whl → 2.8.2__py3-none-any.whl

snowflake/cli/plugins/nativeapp/teardown_processor.py

@@ -1,301 +0,0 @@
-# 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
-
-from pathlib import Path
-from textwrap import dedent
-from typing import Dict, Optional
-
-import typer
-from snowflake.cli.api.console import cli_console as cc
-from snowflake.cli.api.errno import APPLICATION_NO_LONGER_AVAILABLE
-from snowflake.cli.api.exceptions import SnowflakeSQLExecutionError
-from snowflake.cli.plugins.nativeapp.constants import (
-    ALLOWED_SPECIAL_COMMENTS,
-    COMMENT_COL,
-    EXTERNAL_DISTRIBUTION,
-    INTERNAL_DISTRIBUTION,
-    OWNER_COL,
-)
-from snowflake.cli.plugins.nativeapp.exceptions import (
-    CouldNotDropApplicationPackageWithVersions,
-)
-from snowflake.cli.plugins.nativeapp.manager import (
-    NativeAppCommandProcessor,
-    NativeAppManager,
-    ensure_correct_owner,
-)
-from snowflake.cli.plugins.nativeapp.utils import (
-    needs_confirmation,
-)
-from snowflake.connector import ProgrammingError
-from snowflake.connector.cursor import DictCursor
-
-
-class NativeAppTeardownProcessor(NativeAppManager, NativeAppCommandProcessor):
-    def __init__(self, project_definition: Dict, project_root: Path):
-        super().__init__(project_definition, project_root)
-
-    def drop_generic_object(
-        self, object_type: str, object_name: str, role: str, cascade: bool = False
-    ):
-        """
-        Drop object using the given role.
-        """
-        with self.use_role(role):
-            cc.step(f"Dropping {object_type} {object_name} now.")
-            drop_query = f"drop {object_type} {object_name}"
-            if cascade:
-                drop_query += " cascade"
-            try:
-                self._execute_query(drop_query)
-            except:
-                raise SnowflakeSQLExecutionError(drop_query)
-
-            cc.message(f"Dropped {object_type} {object_name} successfully.")
-
-    def drop_application(
-        self, auto_yes: bool, interactive: bool = False, cascade: Optional[bool] = None
-    ):
-        """
-        Attempts to drop the application object if all validations and user prompts allow so.
-        """
-
-        needs_confirm = True
-
-        # 1. If existing application is not found, exit gracefully
-        show_obj_row = self.get_existing_app_info()
-        if show_obj_row is None:
-            cc.warning(
-                f"Role {self.app_role} does not own any application object with the name {self.app_name}, or the application object does not exist."
-            )
-            return
-
-        # 2. Check for the right owner
-        ensure_correct_owner(
-            row=show_obj_row, role=self.app_role, obj_name=self.app_name
-        )
-
-        # 3. Check if created by the Snowflake CLI
-        row_comment = show_obj_row[COMMENT_COL]
-        if row_comment not in ALLOWED_SPECIAL_COMMENTS and needs_confirmation(
-            needs_confirm, auto_yes
-        ):
-            should_drop_object = typer.confirm(
-                dedent(
-                    f"""\
-                        Application object {self.app_name} was not created by Snowflake CLI.
-                        Application object details:
-                        Name: {self.app_name}
-                        Created on: {show_obj_row["created_on"]}
-                        Source: {show_obj_row["source"]}
-                        Owner: {show_obj_row[OWNER_COL]}
-                        Comment: {show_obj_row[COMMENT_COL]}
-                        Version: {show_obj_row["version"]}
-                        Patch: {show_obj_row["patch"]}
-                        Are you sure you want to drop it?
-                    """
-                )
-            )
-            if not should_drop_object:
-                cc.message(f"Did not drop application object {self.app_name}.")
-                # The user desires to keep the app, therefore we can't proceed since it would
-                # leave behind an orphan app when we get to dropping the package
-                raise typer.Abort()
-
-        # 4. Check for application objects owned by the application
-        # This query will fail if the application package has already been dropped, so handle this case gracefully
-        has_objects_to_drop = False
-        message_prefix = ""
-        cascade_true_message = ""
-        cascade_false_message = ""
-        interactive_prompt = ""
-        non_interactive_abort = ""
-        try:
-            if application_objects := self.get_objects_owned_by_application():
-                has_objects_to_drop = True
-                message_prefix = (
-                    f"The following objects are owned by application {self.app_name}"
-                )
-                cascade_true_message = f"{message_prefix} and will be dropped:"
-                cascade_false_message = f"{message_prefix} and will NOT be dropped:"
-                interactive_prompt = "Would you like to drop these objects in addition to the application? [y/n/ABORT]"
-                non_interactive_abort = "Re-run teardown again with --cascade or --no-cascade to specify whether these objects should be dropped along with the application"
-        except ProgrammingError as e:
-            if e.errno != APPLICATION_NO_LONGER_AVAILABLE:
-                raise
-            application_objects = []
-            message_prefix = f"Could not determine which objects are owned by application {self.app_name}"
-            has_objects_to_drop = True  # potentially, but we don't know what they are
-            cascade_true_message = (
-                f"{message_prefix}, an unknown number of objects will be dropped."
-            )
-            cascade_false_message = f"{message_prefix}, they will NOT be dropped."
-            interactive_prompt = f"Would you like to drop an unknown set of objects in addition to the application? [y/n/ABORT]"
-            non_interactive_abort = f"Re-run teardown again with --cascade or --no-cascade to specify whether any objects should be dropped along with the application."
-
-        if has_objects_to_drop:
-            if cascade is True:
-                # If the user explicitly passed the --cascade flag
-                cc.message(cascade_true_message)
-                with cc.indented():
-                    for obj in application_objects:
-                        cc.message(self._application_object_to_str(obj))
-            elif cascade is False:
-                # If the user explicitly passed the --no-cascade flag
-                cc.message(cascade_false_message)
-                with cc.indented():
-                    for obj in application_objects:
-                        cc.message(self._application_object_to_str(obj))
-            elif interactive:
-                # If the user didn't pass any cascade flag and the session is interactive
-                cc.message(message_prefix)
-                with cc.indented():
-                    for obj in application_objects:
-                        cc.message(self._application_object_to_str(obj))
-                user_response = typer.prompt(
-                    interactive_prompt,
-                    show_default=False,
-                    default="ABORT",
-                ).lower()
-                if user_response in ["y", "yes"]:
-                    cascade = True
-                elif user_response in ["n", "no"]:
-                    cascade = False
-                else:
-                    raise typer.Abort()
-            else:
-                # Else abort since we don't know what to do and can't ask the user
-                cc.message(message_prefix)
-                with cc.indented():
-                    for obj in application_objects:
-                        cc.message(self._application_object_to_str(obj))
-                cc.message(non_interactive_abort)
-                raise typer.Abort()
-        elif cascade is None:
-            # If there's nothing to drop, set cascade to an explicit False value
-            cascade = False
-
-        # 5. All validations have passed, drop object
-        self.drop_generic_object(
-            object_type="application",
-            object_name=self.app_name,
-            role=self.app_role,
-            cascade=cascade,
-        )
-        return  # The application object was successfully dropped, therefore exit gracefully
-
-    def drop_package(self, auto_yes: bool):
-        """
-        Attempts to drop application package unless user specifies otherwise.
-        """
-        needs_confirm = True
-
-        # 1. If existing application package is not found, exit gracefully
-        show_obj_row = self.get_existing_app_pkg_info()
-        if show_obj_row is None:
-            cc.warning(
-                f"Role {self.package_role} does not own any application package with the name {self.package_name}, or the application package does not exist."
-            )
-            return
-
-        # 2. Check for the right owner
-        ensure_correct_owner(
-            row=show_obj_row, role=self.package_role, obj_name=self.package_name
-        )
-
-        with self.use_role(self.package_role):
-            # 3. Check for versions in the application package
-            show_versions_query = (
-                f"show versions in application package {self.package_name}"
-            )
-            show_versions_cursor = self._execute_query(
-                show_versions_query, cursor_class=DictCursor
-            )
-            if show_versions_cursor.rowcount is None:
-                raise SnowflakeSQLExecutionError(show_versions_query)
-
-            if show_versions_cursor.rowcount > 0:
-                # allow dropping a package with versions when --force is set
-                if not auto_yes:
-                    raise CouldNotDropApplicationPackageWithVersions(
-                        "Drop versions first, or use --force to override."
-                    )
-
-        # 4. Check distribution of the existing application package
-        actual_distribution = self.get_app_pkg_distribution_in_snowflake
-        if not self.verify_project_distribution(actual_distribution):
-            cc.warning(
-                f"Continuing to execute `snow app teardown` on application package {self.package_name} with distribution '{actual_distribution}'."
-            )
-
-        # 5. If distribution is internal, check if created by the Snowflake CLI
-        row_comment = show_obj_row[COMMENT_COL]
-        if actual_distribution == INTERNAL_DISTRIBUTION:
-            if row_comment in ALLOWED_SPECIAL_COMMENTS:
-                needs_confirm = False
-            else:
-                if needs_confirmation(needs_confirm, auto_yes):
-                    cc.warning(
-                        f"Application package {self.package_name} was not created by Snowflake CLI."
-                    )
-        else:
-            if needs_confirmation(needs_confirm, auto_yes):
-                cc.warning(
-                    f"Application package {self.package_name} in your Snowflake account has distribution property '{EXTERNAL_DISTRIBUTION}' and could be associated with one or more of your listings on Snowflake Marketplace."
-                )
-
-        if needs_confirmation(needs_confirm, auto_yes):
-            should_drop_object = typer.confirm(
-                dedent(
-                    f"""\
-                        Application package details:
-                        Name: {self.app_name}
-                        Created on: {show_obj_row["created_on"]}
-                        Distribution: {actual_distribution}
-                        Owner: {show_obj_row[OWNER_COL]}
-                        Comment: {show_obj_row[COMMENT_COL]}
-                        Are you sure you want to drop it?
-                    """
-                )
-            )
-            if not should_drop_object:
-                cc.message(f"Did not drop application package {self.package_name}.")
-                return  # The user desires to keep the application package, therefore exit gracefully
-
-        # All validations have passed, drop object
-        self.drop_generic_object(
-            object_type="application package",
-            object_name=self.package_name,
-            role=self.package_role,
-        )
-        return  # The application package was successfully dropped, therefore exit gracefully
-
-    def process(
-        self,
-        interactive: bool,
-        force_drop: bool = False,
-        cascade: Optional[bool] = None,
-        *args,
-        **kwargs,
-    ):
-
-        # Drop the application object
-        self.drop_application(
-            auto_yes=force_drop, interactive=interactive, cascade=cascade
-        )
-
-        # Drop the application package
-        self.drop_package(auto_yes=force_drop)

snowflake/cli/plugins/nativeapp/utils.py

@@ -1,98 +0,0 @@
-# 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 os
-from pathlib import Path
-from sys import stdin, stdout
-from typing import Iterable, Optional, Union
-
-from click import ClickException
-
-
-def needs_confirmation(needs_confirm: bool, auto_yes: bool) -> bool:
-    return needs_confirm and not auto_yes
-
-
-def is_tty_interactive():
-    return stdin.isatty() and stdout.isatty()
-
-
-def get_first_paragraph_from_markdown_file(file_path: Path) -> Optional[str]:
-    """
-    Reads a Markdown file at the given file path and finds the first paragraph
-
-    Parameters:
-        file_path (Path): Path to Markdown file
-
-    Returns:
-        Optional[str]: the first paragraph as a string, or None
-        if no paragraph could be found
-
-    Raises:
-        FileNotFoundError: if file_path to Markdown file does not exist
-    """
-    if not file_path.exists():
-        raise FileNotFoundError(file_path)
-
-    with open(file_path, "r") as markdown_file:
-        paragraph_text = None
-
-        for line in markdown_file:
-            stripped_line = line.strip()
-            if not stripped_line.startswith("#") and stripped_line:
-                paragraph_text = stripped_line
-                break
-
-        return paragraph_text
-
-
-def shallow_git_clone(url: Union[str, os.PathLike], to_path: Union[str, os.PathLike]):
-    """
-    Performs a shallow clone of the repository at the provided url to the path specified
-
-    Parameters:
-        url (str | PathLike): Valid git url.
-        to_path (str | PathLike): Path to which the repository should be cloned to.
-
-    Returns:
-        Repo: the repository that was cloned
-    """
-    from git import Repo
-
-    # Clone the repository in the directory with options.
-    repo = Repo.clone_from(
-        url=url,
-        to_path=to_path,
-        filter=["tree:0"],
-        depth=1,
-    )
-    # Close repo to avoid issues with permissions on Windows
-    repo.close()
-
-    return repo
-
-
-def verify_no_directories(paths_to_sync: Iterable[Path]):
-    for path in paths_to_sync:
-        if path.is_dir():
-            raise ClickException(
-                f"{path} is a directory. Add the -r flag to deploy directories."  #
-            )
-
-
-def verify_exists(path: Path):
-    if not path.exists():
-        raise ClickException(f"The following path does not exist: {path}")

snowflake/cli/plugins/nativeapp/v2_conversions/v2_to_v1_decorator.py

@@ -1,135 +0,0 @@
-# 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
-
-from functools import wraps
-from pathlib import Path
-from typing import Any, Dict, Optional, Union
-
-from click import ClickException
-from snowflake.cli.api.cli_global_context import cli_context, cli_context_manager
-from snowflake.cli.api.project.schemas.entities.application_entity import (
-    ApplicationEntity,
-)
-from snowflake.cli.api.project.schemas.entities.application_package_entity import (
-    ApplicationPackageEntity,
-)
-from snowflake.cli.api.project.schemas.native_app.path_mapping import PathMapping
-from snowflake.cli.api.project.schemas.project_definition import (
-    DefinitionV11,
-    DefinitionV20,
-)
-from snowflake.cli.api.utils.definition_rendering import render_definition_template
-
-
-def _convert_v2_artifact_to_v1_dict(
-    v2_artifact: Union[PathMapping, Path]
-) -> Union[Dict, str]:
-    if isinstance(v2_artifact, PathMapping):
-        return {
-            "src": v2_artifact.src,
-            "dest": v2_artifact.dest,
-            "processors": v2_artifact.processors,
-        }
-    return str(v2_artifact)
-
-
-def _pdf_v2_to_v1(v2_definition: DefinitionV20) -> DefinitionV11:
-    pdfv1: Dict[str, Any] = {"definition_version": "1.1", "native_app": {}}
-
-    app_package_definition: ApplicationPackageEntity = None
-    app_definition: Optional[ApplicationEntity] = None
-
-    for key, entity in v2_definition.entities.items():
-        if entity.get_type() == ApplicationPackageEntity.get_type():
-            if app_package_definition:
-                raise ClickException(
-                    "More than one application package entity exists in the project definition file."
-                )
-            app_package_definition = entity
-        elif entity.get_type() == ApplicationEntity.get_type():
-            if app_definition:
-                raise ClickException(
-                    "More than one application entity exists in the project definition file."
-                )
-            app_definition = entity
-    if not app_package_definition:
-        raise ClickException(
-            "Could not find an application package entity in the project definition file."
-        )
-
-    # NativeApp
-    if app_definition and app_definition.name:
-        pdfv1["native_app"]["name"] = app_definition.name
-    else:
-        pdfv1["native_app"]["name"] = app_package_definition.name.split("_pkg_")[0]
-    pdfv1["native_app"]["artifacts"] = [
-        _convert_v2_artifact_to_v1_dict(a) for a in app_package_definition.artifacts
-    ]
-    pdfv1["native_app"]["source_stage"] = app_package_definition.stage
-    pdfv1["native_app"]["bundle_root"] = str(app_package_definition.bundle_root)
-    pdfv1["native_app"]["generated_root"] = str(app_package_definition.generated_root)
-    pdfv1["native_app"]["deploy_root"] = str(app_package_definition.deploy_root)
-
-    # Package
-    pdfv1["native_app"]["package"] = {}
-    pdfv1["native_app"]["package"]["name"] = app_package_definition.name
-    if app_package_definition.distribution:
-        pdfv1["native_app"]["package"][
-            "distribution"
-        ] = app_package_definition.distribution
-    if app_package_definition.meta and app_package_definition.meta.post_deploy:
-        pdfv1["native_app"]["package"][
-            "post_deploy"
-        ] = app_package_definition.meta.post_deploy
-
-    # Application
-    if app_definition:
-        pdfv1["native_app"]["application"] = {}
-        pdfv1["native_app"]["application"]["name"] = app_definition.name
-        if app_definition.meta and app_definition.meta.role:
-            pdfv1["native_app"]["application"]["role"] = app_definition.meta.role
-        if app_definition.meta and app_definition.meta.post_deploy:
-            pdfv1["native_app"]["application"][
-                "post_deploy"
-            ] = app_definition.meta.post_deploy
-
-    result = render_definition_template(pdfv1, {})
-    # Override the definition object in global context
-    return result.project_definition
-
-
-def nativeapp_definition_v2_to_v1(func):
-    """
-    A command decorator that attempts to automatically convert a native app project from
-    definition v2 to v1.1. Assumes with_project_definition() has already been called.
-    The definition object in CliGlobalContext will be replaced with the converted object.
-    Exactly one application package entity type is expected, and up to one application
-    entity type is expected.
-    """
-
-    @wraps(func)
-    def wrapper(*args, **kwargs):
-        original_pdf: DefinitionV20 = cli_context.project_definition
-        if not original_pdf:
-            raise ValueError(
-                "Project definition could not be found. The nativeapp_definition_v2_to_v1 command decorator assumes with_project_definition() was called before it."
-            )
-        if original_pdf.definition_version == "2":
-            pdfv1 = _pdf_v2_to_v1(original_pdf)
-            cli_context_manager.set_project_definition(pdfv1)
-        return func(*args, **kwargs)
-
-    return wrapper

snowflake/cli/plugins/nativeapp/version/__init__.py

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