feat: add ohsomedb feature flag to api request models

Author: matthiasschaub

ohsome_quality_api/api/request_models.py

@@ -77,6 +77,7 @@ class IndicatorRequest(BaseBpolys, BaseRequestContext):
         alias="topic",
     )
     include_figure: bool = True
+    ohsomedb: bool = False
 
     @field_validator("topic")
     @classmethod

ohsome_quality_api/oqt.py

@@ -6,6 +6,7 @@
 from geojson import Feature, FeatureCollection
 
 from ohsome_quality_api.indicators.base import BaseIndicator as Indicator
+from ohsome_quality_api.indicators.currentness.indicator import Currentness
 from ohsome_quality_api.topics.models import BaseTopic as Topic
 from ohsome_quality_api.topics.models import TopicData, TopicDefinition
 from ohsome_quality_api.utils.helper import get_class_from_key
@@ -58,6 +59,7 @@ async def _create_indicator(
     feature: Feature,
     topic: Topic,
     include_figure: bool = True,
+    ohsomedb: bool = False,
     **kwargs,
 ) -> Indicator:
     """Create an indicator from scratch."""
@@ -74,7 +76,10 @@ async def _create_indicator(
     )
 
     logging.info("Run preprocessing")
-    await indicator.preprocess()
+    if isinstance(indicator, Currentness):
+        await indicator.preprocess(ohsomedb=ohsomedb)
+    else:
+        await indicator.preprocess()
 
     logging.info("Run calculation")
     indicator.calculate()

tests/integrationtests/api/test_indicators.py

@@ -122,6 +122,20 @@ def test_indicators(
     assert schema.is_valid(response.json())
 
 
+@oqapi_vcr.use_cassette
+def test_indicators_currentness(
+    client,
+    bpolys,
+    headers,
+    schema,
+):
+    """Minimal viable request for a single bpoly."""
+    endpoint = ENDPOINT + "currentness"
+    parameters = {"bpolys": bpolys, "topic": "building-count", "ohsomedb": True}
+    response = client.post(endpoint, json=parameters, headers=headers)
+    assert schema.is_valid(response.json())
+
+
 @oqapi_vcr.use_cassette
 def test_indicators_attribute_completeness(
     client,

tests/integrationtests/test_geodatabase.py

@@ -19,6 +19,13 @@ async def _test_get_connection():
     assert result[0] == 1
 
 
+@pytest.mark.asyncio
+async def test_get_connection_ohsomedb():
+    async with db_client.get_connection() as conn:
+        result = await conn.fetchrow("SELECT 1")
+    assert result[0] == 1
+
+
 def test_get_shdi_single_intersection_feature(feature):
     """Input geometry intersects only with one SHDI region."""
     result = asyncio.run(db_client.get_shdi(feature))

tests/unittests/api/test_request_models.py

@@ -95,6 +95,12 @@ def test_indicator_request_include_figure(bpolys, topic_key_minimal):
     IndicatorRequest(bpolys=bpolys, topic=topic_key_minimal, include_figure=False)
 
 
+@pytest.mark.usefixtures("mock_request_context_minimal")
+def test_indicator_request_ohsomedb(bpolys, topic_key_minimal):
+    IndicatorRequest(bpolys=bpolys, topic=topic_key_minimal, ohsomedb=False)
+    IndicatorRequest(bpolys=bpolys, topic=topic_key_minimal, ohsomedb=True)
+
+
 def test_indicator_request_invalid_topic(bpolys):
     with pytest.raises(ValidationError):
         IndicatorRequest(bpolys=bpolys, topic="foo")