Add --if-not-exists flag to project create (#2299)

* Add --if-not-exists flag to project create

* update snapshots

Author: sfc-gh-pczajka

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

@@ -26,6 +26,7 @@
 from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.commands.decorators import with_project_definition
 from snowflake.cli.api.commands.flags import (
+    IfNotExistsOption,
     OverrideableOption,
     PruneOption,
     entity_argument,
@@ -118,6 +119,9 @@ def create(
         "--no-version",
         help="Do not initialize project with a new version, only create the snowflake object.",
     ),
+    if_not_exists: bool = IfNotExistsOption(
+        help="Do nothing if the project already exists."
+    ),
     **options,
 ):
     """
@@ -133,7 +137,11 @@ def create(
     )
     om = ObjectManager()
     if om.object_exists(object_type="project", fqn=project.fqn):
-        raise CliError(f"Project '{project.fqn}' already exists.")
+        message = f"Project '{project.fqn}' already exists."
+        if if_not_exists:
+            return MessageResult(message)
+        raise CliError(message)
+
     if not no_version and om.object_exists(
         object_type="stage", fqn=FQN.from_stage(project.stage)
     ):

tests/__snapshots__/test_help_messages.ambr

@@ -7620,14 +7620,15 @@
   |                               [default: None]                                |
   +------------------------------------------------------------------------------+
   +- Options --------------------------------------------------------------------+
-  | --no-version                Do not initialize project with a new version,    |
-  |                             only create the snowflake object.                |
-  | --project     -p      TEXT  Path where the Snowflake project is stored.      |
-  |                             Defaults to the current working directory.       |
-  | --env                 TEXT  String in the format key=value. Overrides        |
-  |                             variables from the env section used for          |
-  |                             templates.                                       |
-  | --help        -h            Show this message and exit.                      |
+  | --no-version                   Do not initialize project with a new version, |
+  |                                only create the snowflake object.             |
+  | --if-not-exists                Do nothing if the project already exists.     |
+  | --project        -p      TEXT  Path where the Snowflake project is stored.   |
+  |                                Defaults to the current working directory.    |
+  | --env                    TEXT  String in the format key=value. Overrides     |
+  |                                variables from the env section used for       |
+  |                                templates.                                    |
+  | --help           -h            Show this message and exit.                   |
   +------------------------------------------------------------------------------+
   +- Connection configuration ---------------------------------------------------+
   | --connection,--environment    -c      TEXT     Name of the connection, as    |

tests/dcm_project/test_commands.py

@@ -37,6 +37,23 @@ def test_create(mock_om, mock_pm, runner, project_directory, no_version):
         assert create_kwargs["project"].fqn == FQN.from_string("my_project")
 
 
+@mock.patch(ProjectManager)
+@mock.patch(ObjectManager)
+@pytest.mark.parametrize("if_not_exists", [False, True])
+def test_create_object_exists(
+    mock_om, mock_pm, runner, project_directory, if_not_exists
+):
+    mock_om().object_exists.return_value = True
+    with project_directory("dcm_project"):
+        command = ["project", "create"]
+        if if_not_exists:
+            command.append("--if-not-exists")
+        result = runner.invoke(command)
+        assert result.exit_code == 0 if if_not_exists else 1, result.output
+        assert "Project 'my_project' already exists." in result.output
+        mock_pm().create.assert_not_called()
+
+
 @mock.patch(ProjectManager)
 @pytest.mark.parametrize(
     "prune,_from,expected_prune_value",

tests_integration/test_dcm_project.py

@@ -124,6 +124,12 @@ def test_create_corner_cases(
         _assert_project_has_versions(
             runner, project_name, expected_versions={("VERSION$1", None)}
         )
+        result = runner.invoke_with_connection(["project", "create", "--if-not-exists"])
+        assert result.exit_code == 0, result.output
+        assert f"Project '{project_name}' already exists." in result.output
+        _assert_project_has_versions(
+            runner, project_name, expected_versions={("VERSION$1", None)}
+        )
 
 
 @pytest.mark.integration