feat: [SNOW-2026174] make project's manifest.yml required (#2178)

* feat: [SNOW-2026174] make project's manifest.yml required

* fix: [SNOW-2026174] remove unnecessary error handling

Author: sfc-gh-jwilkowski

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

@@ -13,26 +13,45 @@
 # limitations under the License.
 from __future__ import annotations
 
-from typing import Literal, Optional, TypeVar
+from typing import List, Literal, Optional, TypeVar
 
-from pydantic import Field
+from pydantic import Field, field_validator
+from snowflake.cli.api.cli_global_context import get_cli_context
 from snowflake.cli.api.entities.common import EntityBase, attach_spans_to_entity_actions
+from snowflake.cli.api.exceptions import CliError
 from snowflake.cli.api.project.schemas.entities.common import (
+    Artifacts,
     EntityModelBaseWithArtifacts,
+    PathMapping,
 )
 from snowflake.cli.api.project.schemas.updatable_model import (
     DiscriminatorField,
 )
+from snowflake.cli.api.secure_path import SecurePath
 
 T = TypeVar("T")
 
 
+MANIFEST_FILE_NAME = "manifest.yml"
+
+
 class ProjectEntityModel(EntityModelBaseWithArtifacts):
     type: Literal["project"] = DiscriminatorField()  # noqa: A003
     stage: Optional[str] = Field(
         title="Stage in which the project artifacts will be stored", default=None
     )
-    main_file: Optional[str] = Field(title="Path to the main file of the project")
+
+    @field_validator("artifacts")
+    @classmethod
+    def transform_artifacts(cls, orig_artifacts: Artifacts) -> List[PathMapping]:
+        if not (
+            SecurePath(get_cli_context().project_root) / MANIFEST_FILE_NAME
+        ).exists():
+            raise CliError(
+                f"{MANIFEST_FILE_NAME} was not found in project root directory"
+            )
+        orig_artifacts.append(PathMapping(src=MANIFEST_FILE_NAME))
+        return super().transform_artifacts(orig_artifacts)
 
 
 @attach_spans_to_entity_actions(entity_name="project")

tests/dcm_project/test_project_entity_model.py

@@ -0,0 +1,21 @@
+import pytest
+from click import ClickException
+from snowflake.cli._plugins.project.project_entity_model import MANIFEST_FILE_NAME
+from snowflake.cli.api.cli_global_context import get_cli_context
+from snowflake.cli.api.commands.utils import get_entity_for_operation
+
+
+def test_project_entity_raises_when_manifest_file_does_not_exist(project_directory):
+    with project_directory("dcm_project") as project_root:
+        (project_root / MANIFEST_FILE_NAME).unlink()
+        with pytest.raises(ClickException) as err:
+            cli_context = get_cli_context()
+            get_entity_for_operation(
+                cli_context=cli_context,
+                entity_id="my_project",
+                project_definition=cli_context.project_definition,
+                entity_type="project",
+            )
+        assert f"{MANIFEST_FILE_NAME} was not found in project root directory" == str(
+            err.value
+        )

tests/test_data/projects/dcm_project/snowflake.yml

@@ -4,7 +4,5 @@ entities:
     type: project
     identifier: "my_project"
     stage: "my_project_stage"
-    main_file: manifest.yml
     artifacts:
       - definitions/
-      - manifest.yml

tests_integration/test_data/projects/dcm_project/snowflake.yml

@@ -3,7 +3,5 @@ entities:
   my_project:
     type: project
     stage: "my_project_stage"
-    main_file: manifest.yml
     artifacts:
       - file_a.sql
-      - manifest.yml