snowflake-cli-labs 2.8.1__py3-none-any.whl → 2.8.2__py3-none-any.whl

snowflake/cli/plugins/nativeapp/commands.py

@@ -1,439 +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 logging
-from pathlib import Path
-from textwrap import dedent
-from typing import List, Optional
-
-import typer
-from click import ClickException
-from snowflake.cli.api.cli_global_context import 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.output.formats import OutputFormat
-from snowflake.cli.api.output.types import (
-    CollectionResult,
-    CommandResult,
-    MessageResult,
-    ObjectResult,
-    StreamResult,
-)
-from snowflake.cli.api.project.project_verification import assert_project_type
-from snowflake.cli.api.secure_path import SecurePath
-from snowflake.cli.plugins.nativeapp.common_flags import (
-    ForceOption,
-    InteractiveOption,
-    ValidateOption,
-)
-from snowflake.cli.plugins.nativeapp.init import (
-    OFFICIAL_TEMPLATES_GITHUB_URL,
-    nativeapp_init,
-)
-from snowflake.cli.plugins.nativeapp.manager import NativeAppManager
-from snowflake.cli.plugins.nativeapp.policy import (
-    AllowAlwaysPolicy,
-    AskAlwaysPolicy,
-    DenyAlwaysPolicy,
-)
-from snowflake.cli.plugins.nativeapp.run_processor import NativeAppRunProcessor
-from snowflake.cli.plugins.nativeapp.teardown_processor import (
-    NativeAppTeardownProcessor,
-)
-from snowflake.cli.plugins.nativeapp.utils import (
-    get_first_paragraph_from_markdown_file,
-    shallow_git_clone,
-)
-from snowflake.cli.plugins.nativeapp.v2_conversions.v2_to_v1_decorator import (
-    nativeapp_definition_v2_to_v1,
-)
-from snowflake.cli.plugins.nativeapp.version.commands import app as versions_app
-from snowflake.cli.plugins.stage.diff import (
-    DiffResult,
-    compute_stage_diff,
-    print_diff_to_console,
-)
-
-app = SnowTyperFactory(
-    name="app",
-    help="Manages a Snowflake Native App",
-)
-app.add_typer(versions_app)
-
-log = logging.getLogger(__name__)
-
-
-@app.command("init")
-def app_init(
-    path: str = typer.Argument(
-        ...,
-        help=f"""Directory to be initialized with the Snowflake Native App project. This directory must not already exist.""",
-    ),
-    name: str = typer.Option(
-        None,
-        help=f"""The name of the Snowflake Native App project to include in snowflake.yml. When not specified, it is
-        generated from the name of the directory. Names are assumed to be unquoted identifiers whenever possible, but
-        can be forced to be quoted by including the surrounding quote characters in the provided value.""",
-    ),
-    template_repo: str = typer.Option(
-        None,
-        help=f"""Specifies the git URL to a template repository, which can be a template itself or contain many templates inside it,
-        such as https://github.com/snowflakedb/native-apps-templates.git for all official Snowflake Native App with Snowflake CLI templates.
-        If using a private Github repo, you might be prompted to enter your Github username and password.
-        Please use your personal access token in the password prompt, and refer to
-        https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls for information on currently recommended modes of authentication.""",
-    ),
-    template: str = typer.Option(
-        None,
-        help="A specific template name within the template repo to use as template for the Snowflake Native App project. Example: Default is basic if `--template-repo` is https://github.com/snowflakedb/native-apps-templates.git, and None if any other --template-repo is specified.",
-    ),
-    **options,
-) -> CommandResult:
-    """
-    Initializes a Snowflake Native App project.
-    """
-    project = nativeapp_init(
-        path=path, name=name, git_url=template_repo, template=template
-    )
-    return MessageResult(
-        f"Snowflake Native App project {project.name} has been created at: {path}"
-    )
-
-
-@app.command("list-templates", hidden=True)
-def app_list_templates(**options) -> CommandResult:
-    """
-    Prints information regarding the official templates that can be used with snow app init.
-    """
-    with SecurePath.temporary_directory() as temp_path:
-        from git import rmtree as git_rmtree
-
-        repo = shallow_git_clone(OFFICIAL_TEMPLATES_GITHUB_URL, temp_path.path)
-
-        # Mark a directory as a template if a project definition jinja template is inside
-        template_directories = [
-            entry.name
-            for entry in repo.head.commit.tree
-            if (temp_path / entry.name / "snowflake.yml.jinja").exists()
-        ]
-
-        # get the template descriptions from the README.md in its directory
-        template_descriptions = [
-            get_first_paragraph_from_markdown_file(
-                (temp_path / directory / "README.md").path
-            )
-            for directory in template_directories
-        ]
-
-        result = (
-            {"template": directory, "description": description}
-            for directory, description in zip(
-                template_directories, template_descriptions
-            )
-        )
-
-        # proactively clean up here to avoid permission issues on Windows
-        repo.close()
-        git_rmtree(temp_path.path)
-
-        return CollectionResult(result)
-
-
-@app.command("bundle")
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_bundle(
-    **options,
-) -> CommandResult:
-    """
-    Prepares a local folder with configured app artifacts.
-    """
-
-    assert_project_type("native_app")
-
-    manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    manager.build_bundle()
-    return MessageResult(f"Bundle generated at {manager.deploy_root}")
-
-
-@app.command("diff", requires_connection=True, hidden=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_diff(
-    **options,
-) -> CommandResult:
-    """
-    Performs a diff between the app's source stage and the local deploy root.
-    """
-    assert_project_type("native_app")
-
-    manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    bundle_map = manager.build_bundle()
-    diff: DiffResult = compute_stage_diff(
-        local_root=Path(manager.deploy_root), stage_fqn=manager.stage_fqn
-    )
-    if cli_context.output_format == OutputFormat.JSON:
-        return ObjectResult(diff.to_dict())
-    else:
-        print_diff_to_console(diff, bundle_map)
-        return None  # don't print any output
-
-
-@app.command("run", requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_run(
-    version: Optional[str] = typer.Option(
-        None,
-        help=f"""The version defined in an existing application package from which you want to create an application object.
-        The application object and application package names are determined from the project definition file.""",
-    ),
-    patch: Optional[int] = typer.Option(
-        None,
-        "--patch",
-        help=f"""The patch number under the given `--version` defined in an existing application package that should be used to create an application object.
-        The application object and application package names are determined from the project definition file.""",
-    ),
-    from_release_directive: Optional[bool] = typer.Option(
-        False,
-        "--from-release-directive",
-        help=f"""Creates or upgrades an application object to the version and patch specified by the release directive applicable to your Snowflake account.
-        The command fails if no release directive exists for your Snowflake account for a given application package, which is determined from the project definition file. Default: unset.""",
-        is_flag=True,
-    ),
-    interactive: bool = InteractiveOption,
-    force: Optional[bool] = ForceOption,
-    validate: bool = ValidateOption,
-    **options,
-) -> CommandResult:
-    """
-    Creates an application package in your Snowflake account, uploads code files to its stage,
-    then creates or upgrades an application object from the application package.
-    """
-
-    assert_project_type("native_app")
-
-    is_interactive = False
-    if force:
-        policy = AllowAlwaysPolicy()
-    elif interactive:
-        is_interactive = True
-        policy = AskAlwaysPolicy()
-    else:
-        policy = DenyAlwaysPolicy()
-
-    processor = NativeAppRunProcessor(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    bundle_map = processor.build_bundle()
-    processor.process(
-        bundle_map=bundle_map,
-        policy=policy,
-        version=version,
-        patch=patch,
-        from_release_directive=from_release_directive,
-        is_interactive=is_interactive,
-        validate=validate,
-    )
-    return MessageResult(
-        f"Your application object ({processor.app_name}) is now available:\n"
-        + processor.get_snowsight_url()
-    )
-
-
-@app.command("open", requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_open(
-    **options,
-) -> CommandResult:
-    """
-    Opens the Snowflake Native App inside of your browser,
-    once it has been installed in your account.
-    """
-
-    assert_project_type("native_app")
-
-    manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    if manager.get_existing_app_info():
-        typer.launch(manager.get_snowsight_url())
-        return MessageResult(f"Snowflake Native App opened in browser.")
-    else:
-        return MessageResult(
-            'Snowflake Native App not yet deployed! Please run "snow app run" first.'
-        )
-
-
-@app.command("teardown", requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_teardown(
-    force: Optional[bool] = ForceOption,
-    cascade: Optional[bool] = typer.Option(
-        None,
-        help=f"""Whether to drop all application objects owned by the application within the account. Default: false.""",
-        show_default=False,
-    ),
-    interactive: bool = InteractiveOption,
-    **options,
-) -> CommandResult:
-    """
-    Attempts to drop both the application object and application package as defined in the project definition file.
-    """
-
-    assert_project_type("native_app")
-
-    processor = NativeAppTeardownProcessor(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    processor.process(interactive, force, cascade)
-    return MessageResult(f"Teardown is now complete.")
-
-
-@app.command("deploy", requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_deploy(
-    prune: Optional[bool] = typer.Option(
-        default=None,
-        help=f"""Whether to delete specified files from the stage if they don't exist locally. If set, the command deletes files that exist in the stage, but not in the local filesystem. This option cannot be used when paths are specified.""",
-    ),
-    recursive: Optional[bool] = typer.Option(
-        None,
-        "--recursive/--no-recursive",
-        "-r",
-        help=f"""Whether to traverse and deploy files from subdirectories. If set, the command deploys all files and subdirectories; otherwise, only files in the current directory are deployed.""",
-    ),
-    paths: Optional[List[Path]] = typer.Argument(
-        default=None,
-        show_default=False,
-        help=dedent(
-            f"""
-            Paths, relative to the the project root, of files or directories you want to upload to a stage. If a file is
-            specified, it must match one of the artifacts src pattern entries in snowflake.yml. If a directory is
-            specified, it will be searched for subfolders or files to deploy based on artifacts src pattern entries. If
-            unspecified, the command syncs all local changes to the stage."""
-        ).strip(),
-    ),
-    validate: bool = ValidateOption,
-    **options,
-) -> CommandResult:
-    """
-    Creates an application package in your Snowflake account and syncs the local changes to the stage without creating or updating the application.
-    Running this command with no arguments at all, as in `snow app deploy`, is a shorthand for `snow app deploy --prune --recursive`.
-    """
-
-    assert_project_type("native_app")
-
-    has_paths = paths is not None and len(paths) > 0
-    if prune is None and recursive is None and not has_paths:
-        prune = True
-        recursive = True
-    else:
-        if prune is None:
-            prune = False
-        if recursive is None:
-            recursive = False
-
-    if has_paths and prune:
-        raise ClickException("--prune cannot be used when paths are also specified")
-
-    manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-
-    bundle_map = manager.build_bundle()
-    manager.deploy(
-        bundle_map=bundle_map,
-        prune=prune,
-        recursive=recursive,
-        local_paths_to_sync=paths,
-        validate=validate,
-    )
-
-    return MessageResult(
-        f"Deployed successfully. Application package and stage are up-to-date."
-    )
-
-
-@app.command("validate", requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_validate(**options):
-    """
-    Validates a deployed Snowflake Native App's setup script.
-    """
-
-    assert_project_type("native_app")
-
-    manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    if cli_context.output_format == OutputFormat.JSON:
-        return ObjectResult(manager.get_validation_result(use_scratch_stage=True))
-
-    manager.validate(use_scratch_stage=True)
-    return MessageResult("Snowflake Native App validation succeeded.")
-
-
-@app.command("events", hidden=True, requires_connection=True)
-@with_project_definition()
-@nativeapp_definition_v2_to_v1
-def app_events(**options):
-    """Fetches events for this app from the event table configured in Snowflake."""
-    assert_project_type("native_app")
-
-    manager = NativeAppManager(
-        project_definition=cli_context.project_definition.native_app,
-        project_root=cli_context.project_root,
-    )
-    events = manager.get_events()
-    if not events:
-        return MessageResult("No events found.")
-
-    def g():
-        for event in events:
-            yield EventResult(event)
-
-    return StreamResult(g())
-
-
-class EventResult(ObjectResult, MessageResult):
-    """ObjectResult that renders as a custom string when not printed as JSON."""
-
-    @property
-    def message(self):
-        e = self._element
-        return f"{e['TIMESTAMP']} {e['VALUE']}"
-
-    @property
-    def result(self):
-        return self._element

snowflake/cli/plugins/nativeapp/common_flags.py

@@ -1,44 +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.
-
-import typer
-from snowflake.cli.plugins.nativeapp.utils import is_tty_interactive
-
-
-def interactive_callback(val):
-    if val is None:
-        return is_tty_interactive()
-    return val
-
-
-InteractiveOption = typer.Option(
-    None,
-    help=f"""When enabled, this option displays prompts even if the standard input and output are not terminal devices. Defaults to True in an interactive shell environment, and False otherwise.""",
-    callback=interactive_callback,
-    show_default=False,
-)
-
-ForceOption = typer.Option(
-    False,
-    "--force",
-    help=f"""When enabled, this option causes the command to implicitly approve any prompts that arise.
-    You should enable this option if interactive mode is not specified and if you want perform potentially destructive actions. Defaults to unset.""",
-    is_flag=True,
-)
-ValidateOption = typer.Option(
-    True,
-    "--validate/--no-validate",
-    help="""When enabled, this option triggers validation of a deployed Snowflake Native App's setup script SQL""",
-    is_flag=True,
-)

snowflake/cli/plugins/nativeapp/constants.py

@@ -1,27 +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.
-
-SPECIAL_COMMENT_OLD = "GENERATED_BY_SNOWCLI"
-SPECIAL_COMMENT = "GENERATED_BY_SNOWFLAKECLI"
-ALLOWED_SPECIAL_COMMENTS = {SPECIAL_COMMENT, SPECIAL_COMMENT_OLD}
-LOOSE_FILES_MAGIC_VERSION = "UNVERSIONED"
-
-NAME_COL = "name"
-COMMENT_COL = "comment"
-OWNER_COL = "owner"
-VERSION_COL = "version"
-PATCH_COL = "patch"
-
-INTERNAL_DISTRIBUTION = "internal"
-EXTERNAL_DISTRIBUTION = "external"

snowflake/cli/plugins/nativeapp/exceptions.py

@@ -1,122 +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 textwrap import dedent
-from typing import Optional
-
-import jinja2
-from click.exceptions import ClickException
-
-
-class ApplicationPackageAlreadyExistsError(ClickException):
-    """An application package not created by Snowflake CLI exists with the same name."""
-
-    def __init__(self, name: str):
-        super().__init__(
-            f"An Application Package {name} already exists in account that may have been created without Snowflake CLI."
-        )
-
-
-class ApplicationPackageDoesNotExistError(ClickException):
-    """An application package of the specified name does not exist in the Snowflake account or the current role isn't authorized."""
-
-    def __init__(self, name: str):
-        super().__init__(
-            f"Application Package {name} does not exist in the Snowflake account or not authorized."
-        )
-
-
-class ApplicationCreatedExternallyError(ClickException):
-    """An application object not created by Snowflake CLI exists with the same name."""
-
-    def __init__(self, name: str):
-        super().__init__(
-            f'An application object "{name}" not created by Snowflake CLI already exists in the account.'
-        )
-
-
-class UnexpectedOwnerError(ClickException):
-    """An operation is blocked because an object is owned by an unexpected role."""
-
-    def __init__(self, item: str, expected_owner: str, actual_owner: str):
-        super().__init__(
-            f"Cannot operate on {item}: owned by {actual_owner} (expected {expected_owner})"
-        )
-
-
-class MissingScriptError(ClickException):
-    """A referenced script was not found."""
-
-    def __init__(self, relpath: str):
-        super().__init__(f'Script "{relpath}" does not exist')
-
-
-class InvalidScriptError(ClickException):
-    """A referenced script had syntax error(s)."""
-
-    def __init__(
-        self, relpath: str, err: jinja2.TemplateError, lineno: Optional[int] = None
-    ):
-        lineno_str = f":{lineno}" if lineno is not None else ""
-        super().__init__(
-            f'Script "{relpath}{lineno_str}" does not contain a valid template: {err.message}'
-        )
-        self.err = err
-
-
-class MissingSchemaError(ClickException):
-    """An identifier is missing a schema qualifier."""
-
-    def __init__(self, identifier: str):
-        super().__init__(f'Identifier missing a schema qualifier: "{identifier}"')
-
-
-class CouldNotDropApplicationPackageWithVersions(ClickException):
-    """Application package could not be dropped as it has versions associated with it."""
-
-    def __init__(self, additional_msg: str = ""):
-        super().__init__(
-            dedent(
-                f"""
-            {self.__doc__}
-            {additional_msg}
-            """
-            ).strip()
-        )
-
-
-class SetupScriptFailedValidation(ClickException):
-    """Snowflake Native App setup script failed validation."""
-
-    def __init__(self):
-        super().__init__(self.__doc__)
-
-
-class NoEventTableForAccount(ClickException):
-    """No event table was found for this Snowflake account."""
-
-    INSTRUCTIONS = dedent(
-        """\
-        Ask your Snowflake administrator to set up an event table for your account by following the docs at
-        https://docs.snowflake.com/en/developer-guide/logging-tracing/event-table-setting-up.
-
-        If your account is configured to send events to an organization event account, create a new
-        connection to this account using `snow connection add` and re-run this command using the new connection.
-        More information on event accounts is available at https://docs.snowflake.com/en/developer-guide/native-apps/setting-up-logging-and-events#configure-an-account-to-store-shared-events."""
-    )
-
-    def __init__(self):
-        super().__init__(f"{self.__doc__}\n\n{self.INSTRUCTIONS}")

snowflake/cli/plugins/nativeapp/feature_flags.py

@@ -1,24 +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 enum import unique
-
-from snowflake.cli.api.feature_flags import BooleanFlag, FeatureFlagMixin
-
-
-@unique
-class FeatureFlag(FeatureFlagMixin):
-    ENABLE_NATIVE_APP_PYTHON_SETUP = BooleanFlag(
-        "ENABLE_NATIVE_APP_PYTHON_SETUP", False
-    )