add error catch for zenlytic project file

metrics_layer/cli/seeding.py

@@ -249,6 +249,8 @@ def __init__(
         }
 
     def seed(self, auto_tag_searchable_fields: bool = False, tag_default_date: bool = True):
+        from metrics_layer.core.exceptions import ConfigError
+        from metrics_layer.core.model.project import Project
         from metrics_layer.core.parse import ProjectDumper, ProjectLoader
 
         if self.connection.type not in Definitions.supported_warehouses:
@@ -285,7 +287,11 @@ def seed(self, auto_tag_searchable_fields: bool = False, tag_default_date: bool
                 table_data = table_data[table_data["TABLE_NAME"].str.lower() == self.table.lower()].copy()
         folder = self._location()
         loader = ProjectLoader(folder)
-        project = loader.load()
+        try:
+            project = loader.load()
+        except ConfigError:
+            # No zenlytic_project.yml yet — seeding will create it
+            project = Project(models=[], views=[])
 
         current_models = project.models()
 

metrics_layer/core/exceptions.py

@@ -23,3 +23,7 @@ def __str__(self):
 
 class JoinError(QueryError):
     pass
+
+
+class ConfigError(MetricsLayerException):
+    pass

metrics_layer/core/parse/project_loader.py

@@ -1,6 +1,6 @@
 import os
 
-from metrics_layer.core.exceptions import MetricsLayerException
+from metrics_layer.core.exceptions import ConfigError, MetricsLayerException  # noqa: F401
 from metrics_layer.core.model.project import Project
 from metrics_layer.core.parse.connections import BaseConnection, connection_class_lookup
 
@@ -11,10 +11,6 @@
 from .project_reader_metrics_layer import MetricsLayerProjectReader
 
 
-class ConfigError(MetricsLayerException):
-    pass
-
-
 class ProjectLoader:
     def __init__(self, location: str, branch: str = "master", connections: list = [], **kwargs):
         self.kwargs = kwargs

metrics_layer/core/parse/project_reader_base.py

@@ -2,7 +2,7 @@
 
 import ruamel.yaml
 
-from metrics_layer.core.exceptions import MetricsLayerException
+from metrics_layer.core.exceptions import ConfigError, MetricsLayerException
 
 from .github_repo import BaseRepo
 
@@ -58,6 +58,17 @@ def dbt_folder(self):
 
     def get_folders(self, key: str, default: str = None, raise_errors: bool = True):
         if not self.zenlytic_project:
+            if raise_errors:
+                searched_paths = [
+                    os.path.join(self.repo.folder, "zenlytic_project.yml"),
+                    os.path.join(self.dbt_folder, "zenlytic_project.yml"),
+                ]
+                raise ConfigError(
+                    "Could not find zenlytic_project.yml. Searched in:\n"
+                    + "\n".join(f"  - {p}" for p in searched_paths)
+                    + "\nPlease ensure your repository contains a valid zenlytic_project.yml file. "
+                    "Learn more here: https://docs.zenlytic.com"
+                )
             return []
 
         if key in self.zenlytic_project:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "metrics_layer"
-version = "0.16.34"
+version = "0.16.35"
 description = "The open source metrics layer."
 authors = ["Paul Blankley <paul@zenlytic.com>"]
 keywords = ["Metrics Layer", "Business Intelligence", "Analytics"]

tests/test_config_parse.py

@@ -23,7 +23,9 @@ def __init__(self, repo_type: str = None):
     def folder(self):
         if self.repo_type == "dbt":
             return os.path.join(BASE_PATH, "config/dbt/")
-        return os.path.join(BASE_PATH, "config/metrics_layer/")
+        if self.repo_type == "metricflow":
+            return os.path.join(BASE_PATH, "config/metricflow/")
+        return os.path.join(BASE_PATH, "config/metrics_layer_config/")
 
     @property
     def warehouse_type(self):
@@ -55,8 +57,34 @@ def mock_dbt_search(pattern):
     return []
 
 
+class repo_mock_no_project_file(BaseRepo):
+    def __init__(self, tmp_path):
+        self.repo_type = None
+        self.dbt_path = None
+        self._folder = str(tmp_path)
+
+    @property
+    def folder(self):
+        return self._folder
+
+    def fetch(self, private_key=None):
+        return
+
+    def search(self, pattern, folders):
+        return []
+
+    def delete(self):
+        return
+
+
+def test_missing_zenlytic_project_file_raises_config_error(tmp_path):
+    reader = MetricsLayerProjectReader(repo=repo_mock_no_project_file(tmp_path))
+    with pytest.raises(ConfigError, match="Could not find zenlytic_project.yml"):
+        reader.load()
+
+
 def test_get_branch_options():
-    loader = MetricsLayerConnection(location=os.path.join(BASE_PATH, "config/metrics_layer/"))
+    loader = MetricsLayerConnection(location=os.path.join(BASE_PATH, "config/metrics_layer_config/"))
     loader.load()
     assert loader.get_branch_options() == []