snowflake-cli-labs 2.6.1__py3-none-any.whl → 2.7.0__py3-none-any.whl

snowflake/cli/plugins/git/manager.py

@@ -12,13 +12,50 @@
 # 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 List
 
-from snowflake.cli.plugins.stage.manager import StageManager, StagePathParts
+from snowflake.cli.plugins.stage.manager import (
+    USER_STAGE_PREFIX,
+    StageManager,
+    StagePathParts,
+    UserStagePathParts,
+)
 from snowflake.connector.cursor import SnowflakeCursor
 
 
+class GitStagePathParts(StagePathParts):
+    def __init__(self, stage_path: str):
+        self.stage = GitManager.get_stage_from_path(stage_path)
+        stage_path_parts = Path(stage_path).parts
+        git_repo_name = stage_path_parts[0].split(".")[-1]
+        if git_repo_name.startswith("@"):
+            git_repo_name = git_repo_name[1:]
+        self.stage_name = "/".join([git_repo_name, *stage_path_parts[1:3], ""])
+        self.directory = "/".join(stage_path_parts[3:])
+        self.is_directory = True if stage_path.endswith("/") else False
+
+    @property
+    def path(self) -> str:
+        return (
+            f"{self.stage_name}{self.directory}"
+            if self.stage_name.endswith("/")
+            else f"{self.stage_name}/{self.directory}"
+        )
+
+    def add_stage_prefix(self, file_path: str) -> str:
+        stage = Path(self.stage).parts[0]
+        file_path_without_prefix = Path(file_path).parts[1:]
+        return f"{stage}/{'/'.join(file_path_without_prefix)}"
+
+    def get_directory_from_file_path(self, file_path: str) -> List[str]:
+        stage_path_length = len(Path(self.directory).parts)
+        return list(Path(file_path).parts[3 + stage_path_length : -1])
+
+
 class GitManager(StageManager):
     def show_branches(self, repo_name: str, like: str) -> SnowflakeCursor:
         return self._execute_query(f"show git branches like '{like}' in {repo_name}")
@@ -51,22 +88,9 @@ class GitManager(StageManager):
         """
         return f"{'/'.join(Path(path).parts[0:3])}/"
 
-    def _split_stage_path(self, stage_path: str) -> StagePathParts:
-        """
-        Splits Git repository path `@repo/branch/main/dir`
-            stage -> @repo/branch/main/
-            stage_name -> repo/branch/main/
-            directory -> dir
-        For Git repository with fully qualified name `@db.schema.repo/branch/main/dir`
-            stage -> @db.schema.repo/branch/main/
-            stage_name -> repo/branch/main/
-            directory -> dir
-        """
-        stage = self.get_stage_from_path(stage_path)
-        stage_path_parts = Path(stage_path).parts
-        git_repo_name = stage_path_parts[0].split(".")[-1]
-        if git_repo_name.startswith("@"):
-            git_repo_name = git_repo_name[1:]
-        stage_name = "/".join([git_repo_name, *stage_path_parts[1:3], ""])
-        directory = "/".join(stage_path_parts[3:])
-        return StagePathParts(stage, stage_name, directory)
+    @staticmethod
+    def _stage_path_part_factory(stage_path: str) -> StagePathParts:
+        stage_path = StageManager.get_standard_stage_prefix(stage_path)
+        if stage_path.startswith(USER_STAGE_PREFIX):
+            return UserStagePathParts(stage_path)
+        return GitStagePathParts(stage_path)

snowflake/cli/plugins/init/__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/init/commands.py

@@ -0,0 +1,242 @@
+# 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 Any, Dict, List, Optional
+
+import typer
+import yaml
+from click import ClickException
+from snowflake.cli.api.commands.flags import (
+    NoInteractiveOption,
+    parse_key_value_variables,
+    variables_option,
+)
+from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
+from snowflake.cli.api.constants import DEFAULT_SIZE_LIMIT_MB
+from snowflake.cli.api.exceptions import InvalidTemplate
+from snowflake.cli.api.output.types import (
+    CommandResult,
+    MessageResult,
+)
+from snowflake.cli.api.project.schemas.template import Template, TemplateVariable
+from snowflake.cli.api.rendering.project_templates import render_template_files
+from snowflake.cli.api.secure_path import SecurePath
+
+# simple Typer with defaults because it won't become a command group as it contains only one command
+app = SnowTyperFactory()
+
+
+DEFAULT_SOURCE = "https://github.com/snowflakedb/snowflake-cli-templates"
+
+log = logging.getLogger(__name__)
+
+
+def _path_argument_callback(path: str) -> str:
+    if SecurePath(path).exists():
+        raise ClickException(
+            f"The directory {path} already exists. Please specify a different path for the project."
+        )
+    return path
+
+
+PathArgument = typer.Argument(
+    ...,
+    help="Directory to be initialized with the project. This directory must not already exist",
+    show_default=False,
+    callback=_path_argument_callback,
+)
+TemplateOption = typer.Option(
+    None,
+    "--template",
+    help="which template (subdirectory of --template-source) should be used. If not provided,"
+    " whole source will be used as the template.",
+    show_default=False,
+)
+SourceOption = typer.Option(
+    default=DEFAULT_SOURCE,
+    help=f"local path to template directory or URL to git repository with templates.",
+)
+VariablesOption = variables_option(
+    "String in `key=value` format. Provided variables will not be prompted for."
+)
+
+TEMPLATE_METADATA_FILE_NAME = "template.yml"
+
+
+def _fetch_local_template(
+    template_source: SecurePath, path: Optional[str], destination: SecurePath
+) -> SecurePath:
+    """Copies local template to [dest] and returns path to the template root.
+    Ends with an error of the template does not exist."""
+
+    template_source.assert_exists()
+    template_origin = template_source / path if path else template_source
+    log.info("Copying local template from %s", template_origin.path)
+    if not template_origin.exists():
+        raise ClickException(
+            f"Template '{path}' cannot be found under {template_source}"
+        )
+
+    template_origin.copy(destination.path)
+    return destination / template_origin.name
+
+
+def _fetch_remote_template(
+    url: str, path: Optional[str], destination: SecurePath
+) -> SecurePath:
+    """Downloads remote repository template to [dest],
+    and returns path to the template root.
+    Ends with an error of the template does not exist."""
+    from git import GitCommandError
+    from git import rmtree as git_rmtree
+
+    # TODO: during nativeapp refactor get rid of this dependency
+    from snowflake.cli.plugins.nativeapp.utils import shallow_git_clone
+
+    log.info("Downloading remote template from %s", url)
+    try:
+        shallow_git_clone(url, to_path=destination.path)
+    except GitCommandError as err:
+        import re
+
+        if re.search("fatal: repository '.*' not found", err.stderr):
+            raise ClickException(f"Repository '{url}' does not exist")
+        raise
+
+    if path:
+        # template is a subdirectoruy of the repository
+        template_root = destination / path
+    else:
+        # template is a whole repository
+        # removing .git directory not to copy it to the template
+        template_root = destination
+        git_rmtree((template_root / ".git").path)
+    if not template_root.exists():
+        raise ClickException(f"Template '{path}' cannot be found under {url}")
+
+    return template_root
+
+
+def _read_template_metadata(template_root: SecurePath) -> Template:
+    """Parse template.yml file."""
+    template_metadata_path = template_root / TEMPLATE_METADATA_FILE_NAME
+    log.debug("Reading template metadata from %s", template_metadata_path.path)
+    if not template_metadata_path.exists():
+        raise InvalidTemplate(
+            f"Template does not have {TEMPLATE_METADATA_FILE_NAME} file."
+        )
+    with template_metadata_path.open(read_file_limit_mb=DEFAULT_SIZE_LIMIT_MB) as fd:
+        yaml_contents = yaml.safe_load(fd) or {}
+    return Template(template_root, **yaml_contents)
+
+
+def _remove_template_metadata_file(template_root: SecurePath) -> None:
+    (template_root / TEMPLATE_METADATA_FILE_NAME).unlink()
+
+
+def _determine_variable_values(
+    variables_metadata: List[TemplateVariable],
+    variables_from_flags: Dict[str, Any],
+    no_interactive: bool,
+) -> Dict[str, Any]:
+    """
+    Prompt user for values not provided in [variables_from_flags].
+    If [no_interactive] is True, fill not provided variables with their default values.
+    """
+    result = {}
+
+    log.debug(
+        "Resolving values of variables: %s",
+        ", ".join(v.name for v in variables_metadata),
+    )
+    for variable in variables_metadata:
+        if variable.name in variables_from_flags:
+            value = variable.python_type(variables_from_flags[variable.name])
+        else:
+            value = variable.prompt_user_for_value(no_interactive)
+
+        result[variable.name] = value
+
+    return result
+
+
+def _validate_cli_version(required_version: str) -> None:
+    from packaging.version import parse
+    from snowflake.cli.__about__ import VERSION
+
+    if parse(required_version) > parse(VERSION):
+        raise ClickException(
+            f"Snowflake CLI version ({VERSION}) is too low - minimum version required"
+            f" by template is {required_version}. Please upgrade before continuing."
+        )
+
+
+@app.command(no_args_is_help=True)
+def init(
+    path: str = PathArgument,
+    template: Optional[str] = TemplateOption,
+    template_source: Optional[str] = SourceOption,
+    variables: Optional[List[str]] = VariablesOption,
+    no_interactive: bool = NoInteractiveOption,
+    **options,
+) -> CommandResult:
+    """
+    Creates project directory from template.
+    """
+    variables_from_flags = {
+        v.key: v.value for v in parse_key_value_variables(variables)
+    }
+    is_remote = any(
+        template_source.startswith(prefix) for prefix in ["git@", "http://", "https://"]  # type: ignore
+    )
+
+    # copy/download template into tmpdir, so it is going to be removed in case command ends with an error
+    with SecurePath.temporary_directory() as tmpdir:
+        if is_remote:
+            template_root = _fetch_remote_template(
+                url=template_source, path=template, destination=tmpdir  # type: ignore
+            )
+        else:
+            template_root = _fetch_local_template(
+                template_source=SecurePath(template_source),
+                path=template,
+                destination=tmpdir,
+            )
+
+        template_metadata = _read_template_metadata(template_root)
+        if template_metadata.minimum_cli_version:
+            _validate_cli_version(template_metadata.minimum_cli_version)
+
+        variable_values = _determine_variable_values(
+            variables_metadata=template_metadata.variables,
+            variables_from_flags=variables_from_flags,
+            no_interactive=no_interactive,
+        )
+        variable_values["project_dir_name"] = SecurePath(path).name
+        log.debug(
+            "Rendering template files: %s", ", ".join(template_metadata.files_to_render)
+        )
+        render_template_files(
+            template_root=template_root,
+            files_to_render=template_metadata.files_to_render,
+            data=variable_values,
+        )
+        _remove_template_metadata_file(template_root)
+        SecurePath(path).parent.mkdir(exist_ok=True, parents=True)
+        template_root.copy(path)
+
+    return MessageResult(f"Initialized the new project in {path}")

snowflake/cli/plugins/init/plugin_spec.py

@@ -0,0 +1,30 @@
+# 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 snowflake.cli.api.plugins.command import (
+    SNOWCLI_ROOT_COMMAND_PATH,
+    CommandSpec,
+    CommandType,
+    plugin_hook_impl,
+)
+from snowflake.cli.plugins.init import commands
+
+
+@plugin_hook_impl
+def command_spec():
+    return CommandSpec(
+        parent_command_path=SNOWCLI_ROOT_COMMAND_PATH,
+        command_type=CommandType.SINGLE_COMMAND,
+        typer_instance=commands.app.create_instance(),
+    )

snowflake/cli/plugins/nativeapp/codegen/artifact_processor.py

@@ -15,6 +15,7 @@
 from __future__ import annotations
 
 from abc import ABC, abstractmethod
+from pathlib import Path
 from typing import Optional
 
 from click import ClickException
@@ -34,6 +35,42 @@ class UnsupportedArtifactProcessorError(ClickException):
         )
 
 
+def is_python_file_artifact(src: Path, _: Path):
+    """Determines whether the provided source path is an existing python file."""
+    return src.is_file() and src.suffix == ".py"
+
+
+class ProjectFileContextManager:
+    """
+    A context manager that encapsulates the logic required to update a project file
+    in processor logic. The processor can use this manager to gain access to the contents
+    of a file, and optionally provide replacement contents. If it does, the file is
+    correctly modified in the deploy root directory to reflect the new contents.
+    """
+
+    def __init__(self, path: Path):
+        self.path = path
+        self._contents = None
+        self.edited_contents = None
+
+    @property
+    def contents(self):
+        return self._contents
+
+    def __enter__(self):
+        self._contents = self.path.read_text(encoding="utf-8")
+
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if self.edited_contents is not None:
+            if self.path.is_symlink():
+                # if the file is a symlink, make sure we don't overwrite the original
+                self.path.unlink()
+
+            self.path.write_text(self.edited_contents, encoding="utf-8")
+
+
 class ArtifactProcessor(ABC):
     def __init__(
         self,
@@ -49,3 +86,6 @@ class ArtifactProcessor(ABC):
         **kwargs,
     ) -> None:
         pass
+
+    def edit_file(self, path: Path):
+        return ProjectFileContextManager(path)

snowflake/cli/plugins/nativeapp/codegen/compiler.py

@@ -24,12 +24,22 @@ from snowflake.cli.plugins.nativeapp.codegen.artifact_processor import (
     ArtifactProcessor,
     UnsupportedArtifactProcessorError,
 )
+from snowflake.cli.plugins.nativeapp.codegen.setup.native_app_setup_processor import (
+    NativeAppSetupProcessor,
+)
 from snowflake.cli.plugins.nativeapp.codegen.snowpark.python_processor import (
     SnowparkAnnotationProcessor,
 )
+from snowflake.cli.plugins.nativeapp.feature_flags import FeatureFlag
 from snowflake.cli.plugins.nativeapp.project_model import NativeAppProjectModel
 
 SNOWPARK_PROCESSOR = "snowpark"
+NA_SETUP_PROCESSOR = "native-app-setup"
+
+_REGISTERED_PROCESSORS_BY_NAME = {
+    SNOWPARK_PROCESSOR: SnowparkAnnotationProcessor,
+    NA_SETUP_PROCESSOR: NativeAppSetupProcessor,
+}
 
 
 class NativeAppCompiler:
@@ -54,28 +64,31 @@ class NativeAppCompiler:
         Go through every artifact object in the project definition of a native app, and execute processors in order of specification for each of the artifact object.
         May have side-effects on the filesystem by either directly editing source files or the deploy root.
         """
-        should_proceed = False
-        for artifact in self._na_project.artifacts:
-            if artifact.processors:
-                should_proceed = True
-                break
-        if not should_proceed:
+
+        if not self._should_invoke_processors():
             return
 
         with cc.phase("Invoking artifact processors"):
+            if self._na_project.generated_root.exists():
+                raise ClickException(
+                    f"Path {self._na_project.generated_root} already exists. Please choose a different name for your generated directory in the project definition file."
+                )
+
             for artifact in self._na_project.artifacts:
                 for processor in artifact.processors:
-                    artifact_processor = self._try_create_processor(
-                        processor_mapping=processor,
-                    )
-                    if artifact_processor is None:
-                        raise UnsupportedArtifactProcessorError(
-                            processor_name=processor.name
-                        )
-                    else:
-                        artifact_processor.process(
-                            artifact_to_process=artifact, processor_mapping=processor
+                    if self._is_enabled(processor):
+                        artifact_processor = self._try_create_processor(
+                            processor_mapping=processor,
                         )
+                        if artifact_processor is None:
+                            raise UnsupportedArtifactProcessorError(
+                                processor_name=processor.name
+                            )
+                        else:
+                            artifact_processor.process(
+                                artifact_to_process=artifact,
+                                processor_mapping=processor,
+                            )
 
     def _try_create_processor(
         self,
@@ -86,15 +99,32 @@ class NativeAppCompiler:
         Fetch processor object if one already exists in the cached_processors dictionary.
         Else, initialize a new object to return, and add it to the cached_processors dictionary.
         """
-        if processor_mapping.name.lower() == SNOWPARK_PROCESSOR:
-            curr_processor = self.cached_processors.get(SNOWPARK_PROCESSOR, None)
-            if curr_processor is not None:
-                return curr_processor
-            else:
-                curr_processor = SnowparkAnnotationProcessor(
-                    na_project=self._na_project,
-                )
-                self.cached_processors[SNOWPARK_PROCESSOR] = curr_processor
-                return curr_processor
-        else:
+        processor_name = processor_mapping.name.lower()
+        current_processor = self.cached_processors.get(processor_name)
+
+        if current_processor is not None:
+            return current_processor
+
+        processor_factory = _REGISTERED_PROCESSORS_BY_NAME.get(processor_name)
+        if processor_factory is None:
+            # No registered processor with the specified name
             return None
+
+        current_processor = processor_factory(
+            na_project=self._na_project,
+        )
+        self.cached_processors[processor_name] = current_processor
+
+        return current_processor
+
+    def _should_invoke_processors(self):
+        for artifact in self._na_project.artifacts:
+            for processor in artifact.processors:
+                if self._is_enabled(processor):
+                    return True
+        return False
+
+    def _is_enabled(self, processor: ProcessorMapping) -> bool:
+        if processor.name.lower() == NA_SETUP_PROCESSOR:
+            return FeatureFlag.ENABLE_NATIVE_APP_PYTHON_SETUP.is_enabled()
+        return True