Add configuration to project execute command (#2296)

sfc-gh-pczajka · web-flow · commit 2c2b9753d076 · 2025-05-16T15:15:32.000+02:00
* Add configuration to project execute command

* example project with multiple configurations

* add integration test

* fix syntax

* update snapshots

* fix unit tests
diff --git a/src/snowflake/cli/_plugins/project/commands.py b/src/snowflake/cli/_plugins/project/commands.py
@@ -58,6 +58,12 @@
 variables_flag = variables_option(
     'Variables for the execution context; for example: `-D "<key>=<value>"`.'
 )
+configuration_flag = typer.Option(
+    None,
+    "--configuration",
+    help="Configuration of the project to use. If not specified default configuration is used.",
+    show_default=False,
+)
 from_option = OverrideableOption(
     None,
     "--from",
@@ -83,13 +89,17 @@ def execute(
     identifier: FQN = project_identifier,
     version: Optional[str] = version_flag,
     variables: Optional[List[str]] = variables_flag,
+    configuration: Optional[str] = configuration_flag,
     **options,
 ):
     """
     Executes a project.
     """
     result = ProjectManager().execute(
-        project_name=identifier, version=version, variables=variables
+        project_name=identifier,
+        configuration=configuration,
+        version=version,
+        variables=variables,
     )
     return SingleQueryResult(result)
 
@@ -99,13 +109,18 @@ def dry_run(
     identifier: FQN = project_identifier,
     version: Optional[str] = version_flag,
     variables: Optional[List[str]] = variables_flag,
+    configuration: Optional[str] = configuration_flag,
     **options,
 ):
     """
     Validates a project.
     """
     result = ProjectManager().execute(
-        project_name=identifier, version=version, dry_run=True, variables=variables
+        project_name=identifier,
+        configuration=configuration,
+        version=version,
+        dry_run=True,
+        variables=variables,
     )
     return SingleQueryResult(result)
 
diff --git a/src/snowflake/cli/_plugins/project/manager.py b/src/snowflake/cli/_plugins/project/manager.py
@@ -31,15 +31,20 @@ class ProjectManager(SqlExecutionMixin):
     def execute(
         self,
         project_name: FQN,
+        configuration: str | None = None,
         version: str | None = None,
         variables: List[str] | None = None,
         dry_run: bool = False,
     ):
         query = f"EXECUTE PROJECT {project_name.sql_identifier}"
+        if configuration or variables:
+            query += f" USING"
+        if configuration:
+            query += f" CONFIGURATION {configuration}"
         if variables:
             query += StageManager.parse_execute_variables(
                 parse_key_value_variables(variables)
-            )
+            ).removeprefix(" using")
         if version:
             query += f" WITH VERSION {version}"
         if dry_run:
diff --git a/tests/__snapshots__/test_help_messages.ambr b/tests/__snapshots__/test_help_messages.ambr
@@ -7873,11 +7873,13 @@
   |                            [required]                                        |
   +------------------------------------------------------------------------------+
   +- Options --------------------------------------------------------------------+
-  | --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.                        |
+  | --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>".                  |
+  | --configuration          TEXT  Configuration of the project to use. If not   |
+  |                                specified default configuration is used.      |
+  | --help           -h            Show this message and exit.                   |
   +------------------------------------------------------------------------------+
   +- Connection configuration ---------------------------------------------------+
   | --connection,--environment    -c      TEXT     Name of the connection, as    |
@@ -8000,11 +8002,13 @@
   |                            [required]                                        |
   +------------------------------------------------------------------------------+
   +- Options --------------------------------------------------------------------+
-  | --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.                        |
+  | --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>".                  |
+  | --configuration          TEXT  Configuration of the project to use. If not   |
+  |                                specified default configuration is used.      |
+  | --help           -h            Show this message and exit.                   |
   +------------------------------------------------------------------------------+
   +- Connection configuration ---------------------------------------------------+
   | --connection,--environment    -c      TEXT     Name of the connection, as    |
diff --git a/tests/dcm_project/test_commands.py b/tests/dcm_project/test_commands.py
@@ -140,6 +140,7 @@ def test_execute_project(mock_pm, runner, project_directory):
         project_name=FQN.from_string("fooBar"),
         version=None,
         variables=None,
+        configuration=None,
     )
 
 
@@ -154,13 +155,39 @@ def test_execute_project_with_variables(mock_pm, runner, project_directory):
         project_name=FQN.from_string("fooBar"),
         version="v1",
         variables=["key=value"],
+        configuration=None,
+    )
+
+
+@mock.patch(ProjectManager)
+def test_execute_project_with_configuration(mock_pm, runner, project_directory):
+    result = runner.invoke(
+        ["project", "execute", "fooBar", "--configuration", "some_configuration"]
+    )
+    assert result.exit_code == 0, result.output
+
+    mock_pm().execute.assert_called_once_with(
+        project_name=FQN.from_string("fooBar"),
+        configuration="some_configuration",
+        version=None,
+        variables=None,
     )
 
 
 @mock.patch(ProjectManager)
 def test_validate_project(mock_pm, runner, project_directory):
     result = runner.invoke(
-        ["project", "dry-run", "fooBar", "--version", "v1", "-D", "key=value"]
+        [
+            "project",
+            "dry-run",
+            "fooBar",
+            "--version",
+            "v1",
+            "-D",
+            "key=value",
+            "--configuration",
+            "some_configuration",
+        ]
     )
     assert result.exit_code == 0, result.output
 
@@ -169,6 +196,7 @@ def test_validate_project(mock_pm, runner, project_directory):
         version="v1",
         dry_run=True,
         variables=["key=value"],
+        configuration="some_configuration",
     )
 
 
diff --git a/tests/dcm_project/test_manager.py b/tests/dcm_project/test_manager.py
@@ -103,11 +103,15 @@ def test_create(mock_sync_artifacts, mock_execute_query, initialize_version):
 def test_execute_project(mock_execute_query):
     mgr = ProjectManager()
     mgr.execute(
-        project_name=TEST_PROJECT, version="v42", variables=["key=value", "aaa=bbb"]
+        project_name=TEST_PROJECT,
+        version="v42",
+        variables=["key=value", "aaa=bbb"],
+        configuration="some_configuration",
     )
 
     mock_execute_query.assert_called_once_with(
-        query="EXECUTE PROJECT IDENTIFIER('my_project') using (key=>value, aaa=>bbb) WITH VERSION v42"
+        query="EXECUTE PROJECT IDENTIFIER('my_project') USING CONFIGURATION some_configuration"
+        " (key=>value, aaa=>bbb) WITH VERSION v42"
     )
 
 
@@ -125,10 +129,16 @@ def test_execute_project_with_default_version(mock_execute_query, project_direct
 @mock.patch(execute_queries)
 def test_validate_project(mock_execute_query, project_directory):
     mgr = ProjectManager()
-    mgr.execute(project_name=TEST_PROJECT, version="v42", dry_run=True)
+    mgr.execute(
+        project_name=TEST_PROJECT,
+        version="v42",
+        dry_run=True,
+        configuration="some_configuration",
+    )
 
     mock_execute_query.assert_called_once_with(
-        query="EXECUTE PROJECT IDENTIFIER('my_project') WITH VERSION v42 DRY_RUN=TRUE"
+        query="EXECUTE PROJECT IDENTIFIER('my_project') USING CONFIGURATION some_configuration"
+        " WITH VERSION v42 DRY_RUN=TRUE"
     )
 
 
diff --git a/tests_integration/test_data/projects/dcm_project_multiple_configurations/file_a.sql b/tests_integration/test_data/projects/dcm_project_multiple_configurations/file_a.sql
@@ -0,0 +1 @@
+define table identifier('{{ db }}.public.snowcli_test_table_{{ table_name_suffix }}') (fooBar string);
diff --git a/tests_integration/test_data/projects/dcm_project_multiple_configurations/manifest.yml b/tests_integration/test_data/projects/dcm_project_multiple_configurations/manifest.yml
@@ -0,0 +1,10 @@
+manifest_version: 1
+include_definitions:
+  - file_a.sql
+configurations:
+  dev:
+    table_name_suffix: "dev"
+  test:
+    table_name_suffix: "test"
+  prod:
+    table_name_suffix: "prod"
diff --git a/tests_integration/test_data/projects/dcm_project_multiple_configurations/snowflake.yml b/tests_integration/test_data/projects/dcm_project_multiple_configurations/snowflake.yml
@@ -0,0 +1,8 @@
+definition_version: 2
+entities:
+  my_project:
+    type: project
+    stage: "my_project_stage"
+    identifier: "project_descriptive_name"
+    artifacts:
+      - file_a.sql
diff --git a/tests_integration/test_dcm_project.py b/tests_integration/test_dcm_project.py
@@ -91,6 +91,39 @@ def test_project_deploy(
         assert project["name"].lower() == project_name.lower()
 
 
+@pytest.mark.integration
+@pytest.mark.qa_only
+def test_execute_multiple_configurations(
+    runner,
+    test_database,
+    project_directory,
+):
+    project_name = "project_descriptive_name"
+    entity_id = "my_project"
+    with project_directory("dcm_project_multiple_configurations"):
+        result = runner.invoke_with_connection(["project", "create", entity_id])
+        assert result.exit_code == 0, result.output
+
+        for configuration in ["test", "dev", "prod"]:
+            for command in ["dry-run", "execute"]:
+                result = runner.invoke_with_connection_json(
+                    [
+                        "project",
+                        command,
+                        project_name,
+                        "--configuration",
+                        configuration,
+                        "-D",
+                        f"db='{test_database}'",
+                    ]
+                )
+                assert result.exit_code == 0, result.output
+                assert (
+                    f"SNOWCLI_TEST_TABLE_{configuration}".upper()
+                    in result.json["operations"]
+                )
+
+
 @pytest.mark.integration
 @pytest.mark.qa_only
 def test_create_corner_cases(

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+define table identifier('{{ db }}.public.snowcli_test_table_{{ table_name_suffix }}') (fooBar string);`