feat: [SNOW-2017083] make version flag optional in snow project execu… (#2163)

feat: [SNOW-2017083] make version flag optional in snow project execute/dry-run

Author: sfc-gh-jwilkowski

src/snowflake/cli/_plugins/project/commands.py

@@ -47,7 +47,10 @@
 
 project_identifier = identifier_argument(sf_object="project", example="MY_PROJECT")
 version_flag = typer.Option(
-    ..., "--version", help="Version of the project to use.", show_default=False
+    None,
+    "--version",
+    help="Version of the project to use. If not specified default version is used",
+    show_default=False,
 )
 variables_flag = variables_option(
     'Variables for the execution context; for example: `-D "<key>=<value>"`.'
@@ -69,7 +72,7 @@
 @app.command(requires_connection=True)
 def execute(
     identifier: FQN = project_identifier,
-    version: str = version_flag,
+    version: Optional[str] = version_flag,
     variables: Optional[List[str]] = variables_flag,
     **options,
 ):
@@ -85,7 +88,7 @@ def execute(
 @app.command(requires_connection=True)
 def dry_run(
     identifier: FQN = project_identifier,
-    version: str = version_flag,
+    version: Optional[str] = version_flag,
     variables: Optional[List[str]] = variables_flag,
     **options,
 ):

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

@@ -19,6 +19,7 @@
 from snowflake.cli.api.identifiers import FQN
 from snowflake.cli.api.sql_execution import SqlExecutionMixin
 from snowflake.cli.api.stage_path import StagePath
+from snowflake.connector.cursor import SnowflakeCursor
 
 
 class ProjectManager(SqlExecutionMixin):
@@ -43,7 +44,7 @@ def execute(
     def create(
         self,
         project_name: FQN,
-    ) -> str:
+    ) -> SnowflakeCursor:
         queries = dedent(f"CREATE PROJECT IF NOT EXISTS {project_name.sql_identifier}")
         return self.execute_query(query=queries)
 

tests/__snapshots__/test_help_messages.ambr

@@ -6208,11 +6208,11 @@
   |                            [required]                                        |
   +------------------------------------------------------------------------------+
   +- Options --------------------------------------------------------------------+
-  | *  --version           TEXT  Version of the project to use.                  |
-  |                              [required]                                      |
-  |    --variable  -D      TEXT  Variables for the execution context; for        |
-  |                              example: -D "<key>=<value>".                    |
-  |    --help      -h            Show this message and exit.                     |
+  | --version           TEXT  Version of the project to use. If not specified    |
+  |                           default version is used                            |
+  | --variable  -D      TEXT  Variables for the execution context; for example:  |
+  |                           -D "<key>=<value>".                                |
+  | --help      -h            Show this message and exit.                        |
   +------------------------------------------------------------------------------+
   +- Connection configuration ---------------------------------------------------+
   | --connection,--environment     -c      TEXT     Name of the connection, as   |
@@ -6306,11 +6306,11 @@
   |                            [required]                                        |
   +------------------------------------------------------------------------------+
   +- Options --------------------------------------------------------------------+
-  | *  --version           TEXT  Version of the project to use.                  |
-  |                              [required]                                      |
-  |    --variable  -D      TEXT  Variables for the execution context; for        |
-  |                              example: -D "<key>=<value>".                    |
-  |    --help      -h            Show this message and exit.                     |
+  | --version           TEXT  Version of the project to use. If not specified    |
+  |                           default version is used                            |
+  | --variable  -D      TEXT  Variables for the execution context; for example:  |
+  |                           -D "<key>=<value>".                                |
+  | --help      -h            Show this message and exit.                        |
   +------------------------------------------------------------------------------+
   +- Connection configuration ---------------------------------------------------+
   | --connection,--environment     -c      TEXT     Name of the connection, as   |

tests/dcm_project/test_dcm_project.py

@@ -89,12 +89,12 @@ def test_add_version(mock_pm, runner, project_directory):
 
 @mock.patch(ProjectManager)
 def test_execute_project(mock_pm, runner, project_directory):
-    result = runner.invoke(["project", "execute", "fooBar", "--version", "v1"])
+    result = runner.invoke(["project", "execute", "fooBar"])
     assert result.exit_code == 0, result.output
 
     mock_pm().execute.assert_called_once_with(
         project_name=FQN.from_string("fooBar"),
-        version="v1",
+        version=None,
         variables=None,
     )
 

tests/dcm_project/test_dcm_project_manager.py

@@ -42,6 +42,19 @@ def test_execute_project(mock_execute_query, runner, project_directory):
     )
 
 
+@mock.patch(execute_queries)
+def test_execute_project_with_default_version(
+    mock_execute_query, runner, project_directory
+):
+    mgr = ProjectManager()
+
+    mgr.execute(project_name=TEST_PROJECT, version=None)
+
+    mock_execute_query.assert_called_once_with(
+        query="EXECUTE PROJECT IDENTIFIER('my_project')"
+    )
+
+
 @mock.patch(execute_queries)
 def test_validate_project(mock_execute_query, runner, project_directory):
     mgr = ProjectManager()

tests_integration/test_dcm_project.py

@@ -38,8 +38,6 @@ def test_project_deploy(
                 "project",
                 "execute",
                 "my_project",
-                "--version",
-                "last",
                 "-D",
                 f"table_name='{test_database}.PUBLIC.MyTable'",
             ]