Jw/snow 2306298 dcm improve ux (#2583)

feat: [SNOW-2306298] improve UX of dcm commands

Author: sfc-gh-jwilkowski

src/snowflake/cli/_plugins/dcm/manager.py

@@ -113,21 +113,15 @@ def sync_local_files(project_identifier: FQN) -> str:
             if MANIFEST_FILE_NAME not in definitions:
                 definitions.append(MANIFEST_FILE_NAME)
 
-        # Create a temporary stage for this deployment session
-        stage_manager = StageManager()
-        unquoted_name = unquote_identifier(project_identifier.name)
-        stage_fqn = FQN.from_string(
-            f"DCM_{unquoted_name}_{int(time.time())}_TMP_STAGE"
-        ).using_context()
-
-        with cli_console.phase("Creating temporary stage for deployment"):
-            stage_manager.create(fqn=stage_fqn, temporary=True)
-            cli_console.step(f"Created temporary stage: {stage_fqn}")
-
-        with cli_console.phase("Syncing local files to temporary stage"):
+        with cli_console.phase(f"Uploading definition files"):
+            unquoted_name = unquote_identifier(project_identifier.name)
+            stage_fqn = FQN.from_string(
+                f"DCM_{unquoted_name}_{int(time.time())}_TMP_STAGE"
+            ).using_context()
             sync_artifacts_with_stage(
                 project_paths=ProjectPaths(project_root=Path.cwd()),
                 stage_root=stage_fqn.identifier,
+                use_temporary_stage=True,
                 artifacts=[PathMapping(src=definition) for definition in definitions],
                 pattern_type=PatternMatchingType.REGEX,
             )

src/snowflake/cli/_plugins/nativeapp/sf_sql_facade.py

@@ -632,6 +632,7 @@ def create_stage(
         role: str | None = None,
         database: str | None = None,
         schema: str | None = None,
+        temporary: bool = False,
     ):
         """
         Creates a stage.
@@ -641,13 +642,14 @@ def create_stage(
         @param [Optional] role: Role to switch to while running this script. Current role will be used if no role is passed in.
         @param [Optional] database: Database to use while running this script, unless the stage name is database-qualified.
         @param [Optional] schema: Schema to use while running this script, unless the stage name is schema-qualified.
+        @param [Optional] temporary: determines if stage should be temporary. Default is false.
         """
         fqn = FQN.from_string(name)
         identifier = to_identifier(fqn.name)
         database = fqn.database or database
         schema = fqn.schema or schema
 
-        query = f"create stage if not exists {identifier}"
+        query = f"create{' temporary' if temporary else ''} stage if not exists {identifier}"
         if encryption_type:
             query += f" encryption = (type = '{encryption_type}')"
         if enable_directory:

src/snowflake/cli/api/artifacts/upload.py

@@ -13,6 +13,7 @@
 def sync_artifacts_with_stage(
     project_paths: ProjectPaths,
     stage_root: str,
+    use_temporary_stage: bool = False,
     prune: bool = False,
     artifacts: Optional[List[PathMapping]] = None,
     pattern_type: PatternMatchingType = PatternMatchingType.GLOB,
@@ -33,6 +34,7 @@ def sync_artifacts_with_stage(
         prune=prune,
         recursive=True,
         stage_path_parts=stage_path_parts,
+        use_temporary_stage=use_temporary_stage,
         print_diff=True,
     )
     project_paths.clean_up_output()

src/snowflake/cli/api/entities/utils.py

@@ -87,6 +87,7 @@ def sync_deploy_root_with_stage(
     prune: bool,
     recursive: bool,
     stage_path_parts: StagePathParts,
+    use_temporary_stage: bool = False,
     role: str | None = None,
     package_name: str | None = None,
     local_paths_to_sync: List[Path] | None = None,
@@ -103,6 +104,7 @@ def sync_deploy_root_with_stage(
         prune (bool): Whether to prune artifacts from the stage that don't exist locally.
         recursive (bool): Whether to traverse directories recursively.
         stage_path_parts (StagePathParts): stage path parts object.
+        use_temporary_stage (bool): specifies if new stage should be temporary.
 
         package_name (str): supported for Native App compatibility. Should be None out of Native App context.
 
@@ -120,8 +122,11 @@ def sync_deploy_root_with_stage(
     elif not package_name:
         # ensure stage exists
         stage_fqn = FQN.from_stage(stage_path_parts.stage)
-        console.step(f"Creating stage {stage_fqn} if not exists.")
-        StageManager().create(fqn=stage_fqn)
+        if use_temporary_stage:
+            console.step(f"Creating temporary stage {stage_fqn}.")
+        else:
+            console.step(f"Creating stage {stage_fqn} if not exists.")
+        StageManager().create(fqn=stage_fqn, temporary=use_temporary_stage)
     else:
         # ensure stage exists - nativeapp behavior
         sql_facade = get_snowflake_facade()
@@ -134,10 +139,10 @@ def sync_deploy_root_with_stage(
         )
         if not sql_facade.stage_exists(stage_fqn):
             sql_facade.create_schema(schema, database=package_name)
-            sql_facade.create_stage(stage_fqn)
+            sql_facade.create_stage(stage_fqn, temporary=use_temporary_stage)
 
     # Perform a diff operation and display results to the user for informational purposes
-    if print_diff:
+    if print_diff and not use_temporary_stage:
         console.step(
             f"Performing a diff between the Snowflake stage: {stage_path_parts.path} and your local deploy_root: {deploy_root.resolve()}."
         )
@@ -199,8 +204,7 @@ def sync_deploy_root_with_stage(
     # Upload diff-ed files to the stage
     if diff.has_changes():
         console.step(
-            "Updating the Snowflake stage from your local %s directory."
-            % deploy_root.resolve(),
+            f"Uploading files from local {deploy_root.resolve()} directory to{' temporary' if use_temporary_stage else ''} stage."
         )
         sync_local_diff_with_stage(
             role=role,

tests/dcm/test_commands.py

@@ -5,9 +5,6 @@
 
 DCMProjectManager = "snowflake.cli._plugins.dcm.commands.DCMProjectManager"
 ObjectManager = "snowflake.cli._plugins.dcm.commands.ObjectManager"
-get_entity_for_operation = (
-    "snowflake.cli._plugins.dcm.commands.get_entity_for_operation"
-)
 
 
 @pytest.fixture

tests/dcm/test_manager.py

@@ -295,6 +295,7 @@ def test_calls_sync_artifacts_with_stage(
                 PathMapping(src="manifest.yml", dest=None, processors=[]),
             ]
             assert call_args.kwargs["pattern_type"] == PatternMatchingType.REGEX
+            assert call_args.kwargs["use_temporary_stage"] is True
 
             actual_project_root = call_args.kwargs["project_paths"].project_root
             expected_project_root = project_dir.resolve()

tests/nativeapp/test_manager.py

@@ -157,7 +157,7 @@ def test_sync_deploy_root_with_stage(
     mock_stage_exists.assert_called_once_with(stage_fqn)
     if not stage_exists:
         mock_create_schema.assert_called_once_with(stage_schema, database=package_name)
-        mock_create_stage.assert_called_once_with(stage_fqn)
+        mock_create_stage.assert_called_once_with(stage_fqn, temporary=False)
     mock_compute_stage_diff.assert_called_once_with(
         local_root=dm.project_root / pkg_model.deploy_root,
         stage_path=DefaultStagePathParts.from_fqn("app_pkg.app_src.stage"),
@@ -222,7 +222,7 @@ def test_sync_deploy_root_with_stage_subdir(
     mock_stage_exists.assert_called_once_with(stage_fqn)
     if not stage_exists:
         mock_create_schema.assert_called_once_with(stage_schema, database=package_name)
-        mock_create_stage.assert_called_once_with(stage_fqn)
+        mock_create_stage.assert_called_once_with(stage_fqn, temporary=False)
     mock_compute_stage_diff.assert_called_once_with(
         local_root=dm.project_root / pkg_model.deploy_root,
         stage_path=DefaultStagePathParts.from_fqn(stage_fqn, "v1"),

tests_integration/nativeapp/__snapshots__/test_deploy.ambr

@@ -8,7 +8,7 @@
     added:    app/README.md -> README.md
     added:    app/manifest.yml -> manifest.yml
     added:    app/setup_script.sql -> setup_script.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully. Application package and stage are up-to-date.
 
@@ -23,7 +23,7 @@
     added:    app/README.md -> README.md
     added:    app/manifest.yml -> manifest.yml
     added:    app/setup_script.sql -> setup_script.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully. Application package and stage are up-to-date.
 
@@ -38,7 +38,7 @@
     added:    app/README.md -> README.md
     added:    app/manifest.yml -> manifest.yml
     added:    app/setup_script.sql -> setup_script.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully.
 
@@ -53,7 +53,7 @@
     added:    app/README.md -> README.md
     added:    app/manifest.yml -> manifest.yml
     added:    app/setup_script.sql -> setup_script.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully. Application package and stage are up-to-date.
 
@@ -67,7 +67,7 @@
   Local changes to be deployed:
     added:    app/manifest.yml -> manifest.yml
     added:    app/setup_script.sql -> setup_script.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Deployed successfully. Application package and stage are up-to-date.
 
   '''
@@ -81,7 +81,7 @@
     added:    app/v2/README.md -> README.md
     added:    app/v2/manifest.yml -> manifest.yml
     added:    app/v2/setup.sql -> setup.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@/v2 directory.
+  Uploading files from local @@DEPLOY_ROOT@@/v2 directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully. Application package and stage are up-to-date.
 
@@ -96,7 +96,7 @@
     added:    app/README.md -> README.md
     added:    app/manifest.yml -> manifest.yml
     added:    app/setup_script.sql -> setup_script.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully. Application package and stage are up-to-date.
 
@@ -109,7 +109,7 @@
   Performing a diff between the Snowflake stage: stage and your local deploy_root: @@DEPLOY_ROOT@@.
   Local changes to be deployed:
     added:    app/nested/dir/file.txt -> nested/dir/file.txt
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Deployed successfully. Application package and stage are up-to-date.
 
   '''
@@ -134,7 +134,7 @@
   Performing a diff between the Snowflake stage: stage and your local deploy_root: @@DEPLOY_ROOT@@.
   Deleted paths to be removed from your stage:
     deleted:  README.md
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Deployed successfully. Application package and stage are up-to-date.
 
   '''
@@ -145,7 +145,7 @@
   Performing a diff between the Snowflake stage: stage and your local deploy_root: @@DEPLOY_ROOT@@.
   Deleted paths to be removed from your stage:
     deleted:  README.md
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Deployed successfully. Application package and stage are up-to-date.
 
   '''
@@ -170,7 +170,7 @@
   Performing a diff between the Snowflake stage: stage and your local deploy_root: @@DEPLOY_ROOT@@.
   Deleted paths to be removed from your stage:
     deleted:  README.md
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Deployed successfully.
 
   '''
@@ -181,7 +181,7 @@
   Performing a diff between the Snowflake stage: stage and your local deploy_root: @@DEPLOY_ROOT@@.
   Deleted paths to be removed from your stage:
     deleted:  README.md
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@ directory.
+  Uploading files from local @@DEPLOY_ROOT@@ directory to stage.
   Deployed successfully.
 
   '''
@@ -206,7 +206,7 @@
   Performing a diff between the Snowflake stage: stage/v1 and your local deploy_root: @@DEPLOY_ROOT@@/v1.
   Deleted paths to be removed from your stage:
     deleted:  README.md
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@/v1 directory.
+  Uploading files from local @@DEPLOY_ROOT@@/v1 directory to stage.
   Deployed successfully. Application package and stage are up-to-date.
 
   '''
@@ -217,7 +217,7 @@
   Performing a diff between the Snowflake stage: stage/v1 and your local deploy_root: @@DEPLOY_ROOT@@/v1.
   Deleted paths to be removed from your stage:
     deleted:  README.md
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@/v1 directory.
+  Uploading files from local @@DEPLOY_ROOT@@/v1 directory to stage.
   Deployed successfully. Application package and stage are up-to-date.
 
   '''
@@ -231,7 +231,7 @@
     added:    app/v1/README.md -> README.md
     added:    app/v1/manifest.yml -> manifest.yml
     added:    app/v1/setup.sql -> setup.sql
-  Updating the Snowflake stage from your local @@DEPLOY_ROOT@@/v1 directory.
+  Uploading files from local @@DEPLOY_ROOT@@/v1 directory to stage.
   Validating Snowflake Native App setup script.
   Deployed successfully. Application package and stage are up-to-date.