snowflake-cli-labs 3.0.0rc4__tar.gz → 3.0.0rc5__tar.gz

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: snowflake-cli-labs
-Version: 3.0.0rc4
+Version: 3.0.0rc5
 Summary: Snowflake CLI
 Project-URL: Source code, https://github.com/snowflakedb/snowflake-cli
 Project-URL: Bug Tracker, https://github.com/snowflakedb/snowflake-cli/issues

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/RELEASE-NOTES.md

@@ -1,3 +1,19 @@
+<!--
+ 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.
+ -->
+
 # v3.0.0
 
 ## Backward incompatibility

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/src/snowflake/cli/__about__.py

@@ -14,4 +14,4 @@
 
 from __future__ import annotations
 
-VERSION = "3.0.0rc4"
+VERSION = "3.0.0rc5"

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/src/snowflake/cli/_plugins/helpers/commands.py

@@ -16,6 +16,7 @@ from __future__ import annotations
 
 import typer
 import yaml
+from click import ClickException
 from snowflake.cli.api.commands.snow_typer import SnowTyperFactory
 from snowflake.cli.api.output.types import MessageResult
 from snowflake.cli.api.project.definition_conversion import (
@@ -35,10 +36,36 @@ def v1_to_v2(
     accept_templates: bool = typer.Option(
         False, "-t", "--accept-templates", help="Allows the migration of templates."
     ),
+    migrate_local_yml: (bool | None) = typer.Option(
+        None,
+        "-l",
+        "--migrate-local-overrides/--no-migrate-local-overrides",
+        help=(
+            "Merge values in snowflake.local.yml into the main project definition. "
+            "The snowflake.local.yml file will not be migrated, "
+            "instead its values will be reflected in the output snowflake.yml file. "
+            "If unset and snowflake.local.yml is present, an error will be raised."
+        ),
+        show_default=False,
+    ),
     **options,
 ):
     """Migrates the Snowpark, Streamlit, and Native App project definition files from V1 to V2."""
     manager = DefinitionManager()
+    local_yml_path = manager.project_root / "snowflake.local.yml"
+    has_local_yml = local_yml_path in manager.project_config_paths
+    if has_local_yml:
+        if migrate_local_yml is None:
+            raise ClickException(
+                "snowflake.local.yml file detected, "
+                "please specify --migrate-local-overrides to include "
+                "or --no-migrate-local-overrides to exclude its values."
+            )
+        if not migrate_local_yml:
+            # If we don't want the local file,
+            # remove it from the list of paths to load
+            manager.project_config_paths.remove(local_yml_path)
+
     pd = manager.unrendered_project_definition
 
     if pd.meets_version_requirement("2"):
@@ -49,6 +76,8 @@ def v1_to_v2(
     )
 
     SecurePath("snowflake.yml").rename("snowflake_V1.yml")
+    if has_local_yml:
+        SecurePath("snowflake.local.yml").rename("snowflake_V1.local.yml")
     with open("snowflake.yml", "w") as file:
         yaml.dump(
             pd_v2.model_dump(

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/src/snowflake/cli/api/project/definition_conversion.py

@@ -6,7 +6,7 @@ from typing import Any, Dict, Literal, Optional
 
 from click import ClickException
 from snowflake.cli._plugins.nativeapp.artifacts import (
-    build_bundle,
+    BundleMap,
 )
 from snowflake.cli._plugins.snowpark.common import is_name_a_templated_one
 from snowflake.cli.api.constants import (
@@ -216,17 +216,22 @@ def convert_native_app_to_v2_data(
         # glob patterns. The simplest solution is to bundle the app and find the
         # manifest file from the resultant BundleMap, since the bundle process ensures
         # that only a single source path can map to the corresponding destination path
-        try:
-            bundle_map = build_bundle(
-                project_root, Path(native_app.deploy_root), native_app.artifacts
-            )
-        except Exception as e:
-            # The manifest field is required, so we can't gracefully handle bundle failures
-            raise ClickException(
-                f"{e}\nCould not bundle Native App artifacts, unable to perform migration"
-            ) from e
-
-        manifest_path = bundle_map.to_project_path(Path("manifest.yml"))
+        bundle_map = BundleMap(
+            project_root=project_root, deploy_root=Path(native_app.deploy_root)
+        )
+        for artifact in native_app.artifacts:
+            bundle_map.add(artifact)
+
+        manifest_path = next(
+            (
+                src
+                for src, dest in bundle_map.all_mappings(
+                    absolute=True, expand_directories=True
+                )
+                if dest.name == "manifest.yml"
+            ),
+            None,
+        )
         if not manifest_path:
             # The manifest field is required, so we can't gracefully handle it being missing
             raise ClickException(
@@ -236,7 +241,7 @@ def convert_native_app_to_v2_data(
 
         # Use a POSIX path to be consistent with other migrated fields
         # which use POSIX paths as default values
-        return manifest_path.as_posix()
+        return manifest_path.relative_to(project_root).as_posix()
 
     def _make_template(template: str) -> str:
         return f"{PROJECT_TEMPLATE_VARIABLE_OPENING} {template} {PROJECT_TEMPLATE_VARIABLE_CLOSING}"

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/src/snowflake/cli/api/project/definition_manager.py

@@ -41,7 +41,7 @@ class DefinitionManager:
     USER_DEFINITION_FILENAME = "snowflake.local.yml"
 
     project_root: Path
-    _project_config_paths: List[Path]
+    project_config_paths: List[Path]
 
     def __init__(
         self,
@@ -53,12 +53,12 @@ class DefinitionManager:
         )
 
         self.project_root = project_root
-        self._project_config_paths = self._find_definition_files(self.project_root)
+        self.project_config_paths = self._find_definition_files(self.project_root)
         self._context_overrides = context_overrides
 
     @functools.cached_property
     def has_definition_file(self):
-        return len(self._project_config_paths) > 0
+        return len(self.project_config_paths) > 0
 
     @staticmethod
     def _find_definition_files(project_root: Path) -> List[Path]:
@@ -126,11 +126,11 @@ class DefinitionManager:
 
     @functools.cached_property
     def _project_properties(self) -> ProjectProperties:
-        return load_project(self._project_config_paths, self._context_overrides)
+        return load_project(self.project_config_paths, self._context_overrides)
 
     @functools.cached_property
     def _raw_project_data(self) -> ProjectProperties:
-        return load_project(self._project_config_paths, {}, False)
+        return load_project(self.project_config_paths, {}, False)
 
     @functools.cached_property
     def project_definition(self) -> ProjectDefinitionV1:

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/tests/helpers/test_v1_to_v2.py

@@ -1,4 +1,5 @@
 import logging
+import shutil
 from pathlib import Path
 from textwrap import dedent
 
@@ -37,6 +38,27 @@ def test_migrations_with_all_app_entities(
     assert Path("snowflake_V1.yml").read_text() == os_agnostic_snapshot
 
 
+def test_migration_native_app_nested_manifest(runner, project_directory):
+    with project_directory("migration_multiple_entities") as project_dir:
+        with open("snowflake.yml", "r+") as snowflake_yml:
+            pdf = yaml.safe_load(snowflake_yml)
+            pdf["native_app"]["artifacts"] = [
+                dict(src="nested/nested/app", dest="nested/app/")
+            ]
+            snowflake_yml.seek(0)
+            yaml.safe_dump(pdf, snowflake_yml)
+            snowflake_yml.truncate()
+
+        shutil.move("app", "nested/nested/app")
+        result = runner.invoke(["helpers", "v1-to-v2"])
+        assert result.exit_code == 0
+        with open("snowflake.yml") as f:
+            pdf = yaml.safe_load(f)
+            assert (
+                pdf["entities"]["pkg"]["manifest"] == "nested/nested/app/manifest.yml"
+            )
+
+
 def test_migration_native_app_missing_manifest(runner, project_directory):
     with project_directory("migration_multiple_entities") as project_dir:
         (project_dir / "app" / "manifest.yml").unlink()
@@ -55,8 +77,7 @@ def test_migration_native_app_no_artifacts(runner, project_directory):
             snowflake_yml.truncate()
         result = runner.invoke(["helpers", "v1-to-v2"])
     assert result.exit_code == 1
-    assert "No artifacts mapping found in project definition" in result.output
-    assert "Could not bundle Native App artifacts" in result.output
+    assert "manifest.yml file not found" in result.output
 
 
 def test_migration_native_app_package_scripts(runner, project_directory):
@@ -106,7 +127,7 @@ def test_if_template_raises_error_during_migrations(
 
 def test_migration_with_only_envs(project_directory, runner):
     with project_directory("sql_templating"):
-        result = runner.invoke(["helpers", "v1-to-v2"])
+        result = runner.invoke(["helpers", "v1-to-v2", "--no-migrate-local-overrides"])
 
     assert result.exit_code == 0
 
@@ -151,3 +172,30 @@ def test_migrating_a_file_with_duplicated_keys_raises_an_error(
         result = runner.invoke(["helpers", "v1-to-v2"])
     assert result.exit_code == 1, result.output
     assert result.output == os_agnostic_snapshot
+
+
+@pytest.mark.parametrize("migrate_local_yml", [True, False])
+def test_migrating_with_local_yml(
+    runner, project_directory, os_agnostic_snapshot, migrate_local_yml
+):
+    with project_directory("migration_local_yml"):
+        flag = (
+            "--migrate-local-overrides"
+            if migrate_local_yml
+            else "--no-migrate-local-overrides"
+        )
+        result = runner.invoke(["helpers", "v1-to-v2", flag])
+        assert result.exit_code == 0, result.output
+        assert Path("snowflake_V1.local.yml").exists()
+        with Path("snowflake.yml").open() as f:
+            pdf = yaml.safe_load(f)
+            assert pdf["env"]["foo"] == "bar_local" if migrate_local_yml else "bar"
+
+
+def test_migrating_with_local_yml_no_flag(
+    runner, project_directory, os_agnostic_snapshot
+):
+    with project_directory("migration_local_yml"):
+        result = runner.invoke(["helpers", "v1-to-v2"])
+        assert result.exit_code == 1, result.output
+        assert "please specify --migrate-local-overrides" in result.output

{snowflake_cli_labs-3.0.0rc4 → snowflake_cli_labs-3.0.0rc5}/tests/project/test_definition_manager.py

@@ -38,7 +38,7 @@ class DefinitionManagerTest(TestCase):
     def test_no_project_parameter_provided(self, mock_getcwd):
         with mock_is_file_for("/hello/world/snowflake.yml") as mock_is_file:
             definition_manager = DefinitionManager()
-            assert definition_manager._project_config_paths == [  # noqa: SLF001
+            assert definition_manager.project_config_paths == [
                 Path("/hello/world/snowflake.yml")
             ]
 
@@ -48,7 +48,7 @@ class DefinitionManagerTest(TestCase):
             "/hello/world/snowflake.yml", "/hello/world/snowflake.local.yml"
         ) as mock_is_file:
             definition_manager = DefinitionManager()
-            assert definition_manager._project_config_paths == [  # noqa: SLF001
+            assert definition_manager.project_config_paths == [
                 Path("/hello/world/snowflake.yml"),
                 Path("/hello/world/snowflake.local.yml"),
             ]

snowflake_cli_labs-3.0.0rc5/tests/test_data/projects/migration_local_yml/snowflake.local.yml

@@ -0,0 +1,3 @@
+definition_version: 1.1
+env:
+  foo: bar_local

snowflake_cli_labs-3.0.0rc5/tests/test_data/projects/migration_local_yml/snowflake.yml

@@ -0,0 +1,3 @@
+definition_version: 1.1
+env:
+  foo: bar