feat: add validation for filter definition and geometry and type (#983)

* add validation for filter definition and geometry and type

* change ValidationError to ValueError

* add test topic filter validation

* cleane test_topic_definitions.py / add test topic filter validation for geometry and type / add filter validation OhsomeFilter

Author: SylviaMaria123

ohsome_quality_api/topics/models.py

@@ -8,6 +8,7 @@
 from typing import Literal
 
 from fastapi_i18n import _
+from ohsome_filter_to_sql.main import OhsomeFilter
 from pydantic import BaseModel, ConfigDict, field_validator
 
 from ohsome_quality_api.projects.definitions import ProjectEnum
@@ -37,12 +38,20 @@ class Topic(BaseTopic):
 
     endpoint: Literal["elements"]
     aggregation_type: Literal["area", "count", "length", "perimeter", "area/density"]
-    filter: str
+    filter: OhsomeFilter
     indicators: list[str]
     projects: list[ProjectEnum]
     source: str | None = None
     ratio_filter: str | None = None
 
+    @field_validator("filter", mode="before")
+    @classmethod
+    def ensure_filter_geometry_or_type(cls, value: str) -> str:
+        if "geometry" not in value and "type" not in value:
+            raise ValueError("Filter does not contain geometry or type specification.")
+        else:
+            return value
+
 
 class TopicData(BaseTopic):
     """Includes the data associated with the topic."""

tests/unittests/test_topic.py

@@ -20,6 +20,32 @@ def test_base_topic_extra():
         BaseTopic(name="name", key="key", description="description", foo="bar")
 
 
+def test_topic_filter_validation():
+    with pytest.raises(ValidationError):
+        Topic(
+            endpoint="elements",
+            aggregation_type=["area", "count", "length", "perimeter", "area/density"],
+            filter="filter",
+            indicators=["indicators"],
+            projects=["projects"],
+            source="source",
+            ratio_filter="ratio_filter",
+        )
+
+
+def test_topic_filter_validation_geom_type():
+    with pytest.raises(ValidationError):
+        Topic(
+            endpoint="elements",
+            aggregation_type=["area", "count", "length", "perimeter", "area/density"],
+            filter="building=yes",
+            indicators=["indicators"],
+            projects=["projects"],
+            source="source",
+            ratio_filter="ratio_filter",
+        )
+
+
 def test_topic_definition():
     Topic(
         key="key",
@@ -29,7 +55,7 @@ def test_topic_definition():
         projects=["core"],
         endpoint="elements",
         aggregation_type="count",
-        filter="filter",
+        filter="building=yes and geometry:polygon",
     )
     Topic(
         key="key",
@@ -39,7 +65,7 @@ def test_topic_definition():
         projects=["core"],
         endpoint="elements",
         aggregation_type="count",
-        filter="filter",
+        filter="building=yes and geometry:polygon",
         source="source",
     )
     Topic(
@@ -50,7 +76,7 @@ def test_topic_definition():
         projects=["core"],
         endpoint="elements",
         aggregation_type="count",
-        filter="filter",
+        filter="type:way and highway=residential",
         source="source",
     )
     Topic(
@@ -61,7 +87,7 @@ def test_topic_definition():
         projects=["core", "experimental"],
         endpoint="elements",
         aggregation_type="count",
-        filter="filter",
+        filter="geometry:polygon and building=*",
         source="source",
     )
     Topic(
@@ -72,7 +98,7 @@ def test_topic_definition():
         projects=["core"],
         endpoint="elements",
         aggregation_type="count",
-        filter="filter",
+        filter="geometry:polygon and building=*",
         source="source",
     )
     Topic(
@@ -83,7 +109,7 @@ def test_topic_definition():
         projects=["core"],
         endpoint="elements",
         aggregation_type="count",
-        filter="filter",
+        filter="type:way and highway=residential",
         source="source",
         ratio_filter="ration_filter",
     )

tests/unittests/test_topics_definitions.py

@@ -17,8 +17,8 @@ def test_get_valid_topics():
 
 def test_load_topic_definition():
     topics = definitions.load_topic_presets()
-    for topic in topics:
-        assert isinstance(topics[topic], models.Topic)
+    for topic in topics.values():
+        assert isinstance(topic, models.Topic)
 
 
 def test_get_topic_definition():