feat: translate indicator and result description

call translate on input parameters before indicator metadata and
indicator result template models are initialized

Author: matthiasschaub

ohsome_quality_api/indicators/models.py

@@ -1,7 +1,8 @@
 from datetime import datetime, timezone
 from typing import Literal
 
-from pydantic import BaseModel, ConfigDict, Field, computed_field
+from fastapi_i18n import _
+from pydantic import BaseModel, ConfigDict, Field, computed_field, field_validator
 
 from ohsome_quality_api.projects.definitions import ProjectEnum
 from ohsome_quality_api.quality_dimensions.definitions import QualityDimensionEnum
@@ -23,6 +24,11 @@ class IndicatorMetadata(BaseModel):
         populate_by_name=True,
     )
 
+    @field_validator("name", "description", mode="before")
+    @classmethod
+    def translate(cls, value: str) -> str:
+        return _(value)
+
 
 class LabelDescription(BaseModel):
     green: str

ohsome_quality_api/locale/de/LC_MESSAGES/messages.po

@@ -287,7 +287,7 @@ msgstr ""
 msgid ""
 "Calculate if mapping has saturated. High saturation has been reached if "
 "the growth of the fitted curve is minimal."
-msgstr ""
+msgstr "Berechne ob das Kartieren gesättigt ist. Bei hohe Sättigung ist die Steigung der Kurve minimal."
 
 #: ohsome_quality_api/indicators/indicators.yaml
 msgid "Density"
@@ -464,23 +464,23 @@ msgstr ""
 
 #: ohsome_quality_api/indicators/mapping_saturation/templates.yaml
 msgid "No saturation identified (Saturation ≤ 30%)."
-msgstr ""
+msgstr "Kein Sättigung erkannt (Sättigung ≤ 30%)."
 
 #: ohsome_quality_api/indicators/mapping_saturation/templates.yaml
 msgid "Saturation is in progress (30% < Saturation ≤ 97%)."
-msgstr ""
+msgstr "Sättigung fortschreitend (30% < Sättigung ≤ 97%)."
 
 #: ohsome_quality_api/indicators/mapping_saturation/templates.yaml
 msgid "High saturation has been reached (97% < Saturation ≤ 100%)."
-msgstr ""
+msgstr "Hohe Sättigung ereicht (97% < Sättigung ≤ 100%)."
 
 #: ohsome_quality_api/indicators/mapping_saturation/templates.yaml
 msgid "Saturation could not be calculated."
-msgstr ""
+msgstr "Sättigung konnte nicht berechnet werden."
 
 #: ohsome_quality_api/indicators/mapping_saturation/templates.yaml
 msgid "The saturation of the last 3 years is $saturation%."
-msgstr ""
+msgstr "Die Sättigung der letzten 3 Jahre ist $saturation%."
 
 #: ohsome_quality_api/indicators/minimal/templates.yaml
 msgid "Bad data quality."

tests/conftest.py

@@ -4,6 +4,7 @@
 
 import geojson
 import pytest
+from fastapi_i18n.main import Translator, translator
 from geojson import Feature, FeatureCollection, Polygon
 
 from ohsome_quality_api.attributes.models import Attribute
@@ -265,3 +266,14 @@ def metadata_indicator_minimal() -> dict[str, IndicatorMetadata]:
 @pytest.fixture
 def indicators_metadata() -> dict[str, IndicatorMetadata]:
     return get_indicator_metadata()
+
+
+@pytest.fixture
+def locale_de(monkeypatch):
+    monkeypatch.setenv(
+        "FASTAPI_I18N_LOCALE_DIR",
+        "/home/matthias/work/projects/oqapi/ohsome_quality_api/locale",
+    )
+    token = translator.set(Translator(locale="de"))
+    yield
+    translator.reset(token)

tests/integrationtests/api/test_i18n.py

@@ -0,0 +1,44 @@
+import pytest
+from approvaltests import verify
+
+from tests.integrationtests.utils import PytestNamer, oqapi_vcr
+
+ENDPOINT = "/indicators/"
+
+# TODO: Remove and recreate VCR cassette for this test
+
+
+@pytest.fixture
+@oqapi_vcr.use_cassette
+def indicator(client, bpolys, monkeypatch):
+    monkeypatch.setenv(
+        "FASTAPI_I18N_LOCALE_DIR",
+        "/home/matthias/work/projects/oqapi/ohsome_quality_api/locale",
+    )
+    endpoint = "/indicators/mapping-saturation"
+    parameters = {
+        "bpolys": bpolys,
+        "topic": "building-count",
+    }
+    response = client.post(
+        endpoint,
+        json=parameters,
+        headers={
+            "Accept-Language": "de",
+            "accept": "application/json",
+        },
+    )
+    return response.json()
+
+
+def test_translation_indicator_metadata_description(indicator):
+    verify(indicator["result"][0]["metadata"]["description"], namer=PytestNamer())
+
+
+def test_translation_indicator_result_description(indicator):
+    """Test successful translation of result description.
+
+    Result description are string templates. This tests checks if translations
+    of string templates is working as expected.
+    """
+    verify(indicator["result"][0]["result"]["description"], namer=PytestNamer())

tests/integrationtests/approved/api/test_i18n.py-test_translation_indicator_metadata_description.approved.txt

@@ -0,0 +1 @@
+Berechne ob das Kartieren gesättigt ist. Bei hohe Sättigung ist die Steigung der Kurve minimal.

tests/integrationtests/approved/api/test_i18n.py-test_translation_indicator_result_description.approved.txt

@@ -0,0 +1 @@
+Die Sättigung der letzten 3 Jahre ist 99.5%.Hohe Sättigung ereicht (97% < Sättigung ≤ 100%).

tests/integrationtests/approved/indicators/test_mapping_saturation.py-TestCalculation-test_calculate.approved.txt

@@ -0,0 +1 @@
+Die Sättigung der letzten 3 Jahre ist 99.5%.Hohe Sättigung ereicht (97% < Sättigung ≤ 100%).

tests/integrationtests/approved/unittests/test_indicators_definitions.py-test_get_indicator_de.approved.txt

@@ -0,0 +1,16 @@
+{
+  "name": "Mapping Saturation",
+  "description": "Berechne ob das Kartieren gesättigt ist. Bei hohe Sättigung ist die Steigung der Kurve minimal.",
+  "projects": [
+    "core",
+    "corine-land-cover",
+    "expanse",
+    "experimental",
+    "idealvgi",
+    "mapaction",
+    "sketchmap",
+    "bkg",
+    "unicef"
+  ],
+  "quality_dimension": "completeness"
+}

tests/integrationtests/fixtures/vcr_cassettes/api/test_i18n.yaml

@@ -3,9 +3,11 @@
 
 import geojson
 import pytest
+from approvaltests import verify
 from geojson import Feature, Polygon
 
 from ohsome_quality_api.indicators import definitions, models
+from tests.integrationtests.utils import PytestNamer
 
 
 @pytest.fixture(scope="class")
@@ -61,6 +63,12 @@ def test_get_indicator(metadata_indicator_minimal):
     assert indicator == metadata_indicator_minimal["minimal"]
 
 
+@pytest.mark.usefixtures("locale_de")
+def test_get_indicator_de():
+    indicator = definitions.get_indicator("mapping-saturation")
+    verify(indicator.model_dump_json(indent=2), namer=PytestNamer())
+
+
 def test_get_coverage(mock_get_reference_coverage):
     coverage = asyncio.run(
         definitions.get_coverage("building-comparison", inverse=False)