tests: add language route test and get_locale unit tests

Author: TheoLechemia

.gitignore

@@ -36,3 +36,5 @@ atlas/debug.py
 Makefile.perso.mk
 robots.txt
 !atlas/static/sample/robots.txt
+
+.github/*instructions.md

atlas/static/sample/templates/navbar.html

@@ -51,7 +51,7 @@
                 <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="dropdown09">
                     {% for language in configuration.AVAILABLE_LANGUAGES %}
                     <li>
-                        <a class="dropdown-item d-flex align-items-center" href="{{ url_for(request.change_language, lang_code=language) }}">
+                        <a class="dropdown-item d-flex align-items-center" href="{{ url_for('main.change_language', lang_code=language) }}">
                             <span class="flag-icon {{ configuration.AVAILABLE_LANGUAGES[language]['flag_icon'] }}"></span>
                             <div class="d-none d-lg-block ms-2">{{ configuration.AVAILABLE_LANGUAGES[language]['name'] }}</div>
                         </a>

atlas/tests/conftest.py

@@ -1,7 +1,11 @@
-# pylint: disable=redefined-outer-name
-from copy import deepcopy
+import os
 from pathlib import Path
 
+# IMPORTANT: Set ATLAS_SETTINGS before any atlas.* import!
+# Set ATLAS_SETTINGS to test config by default if not already set
+if "ATLAS_SETTINGS" not in os.environ:
+    os.environ["ATLAS_SETTINGS"] = str(Path(__file__).parent / "test_config.py")
+
 import pytest
 from sqlalchemy import text
 

atlas/tests/test_app.py

@@ -2,6 +2,7 @@
 from fixtures.main_fixtures import captured_templates
 
 from atlas.configuration.config_schema import SecretSchemaConf
+from atlas.tests.conftest import with_config
 
 
 def test_context_processor(app, client, captured_templates):
@@ -10,7 +11,14 @@ def test_context_processor(app, client, captured_templates):
     template, context = captured_templates[0]
 
     # test @app.context_processor for global vars in all app
-    injected_context_vars = ["configuration", "translations", "now", "timedelta", "page_name"]
+    injected_context_vars = [
+        "configuration",
+        "translations",
+        "now",
+        "timedelta",
+        "page_name",
+        "current_language",
+    ]
     for var in injected_context_vars:
         assert var in context
 
@@ -19,3 +27,19 @@ def test_context_processor(app, client, captured_templates):
     configuration = context["configuration"]
     for key, val in configuration.items():
         assert key not in secret_fields
+
+
+def test_change_language_sets_session_and_persists(app, client, captured_templates):
+    # Call change language route
+    resp = client.get(url_for("main.change_language", lang_code="en"), follow_redirects=False)
+    assert resp.status_code in (302, 303)
+
+    # Session should have been set by the route
+    with client.session_transaction() as sess:
+        assert sess.get("language") == "en"
+
+    # Calling another route (index) should keep the language in injected context
+    client.get(url_for("main.index"))
+    template, context = captured_templates[0]
+    assert "current_language" in context
+    assert context["current_language"] == "en"

atlas/tests/test_config.py

@@ -4,3 +4,4 @@
 SQLALCHEMY_DATABASE_URI = (
     "postgresql://geonatadmin:monpassachanger@localhost:5432/geonatureatlas_test"
 )
+MULTILINGUAL = True

atlas/tests/test_utils.py

@@ -0,0 +1,53 @@
+from atlas.utils import get_locale
+from atlas.tests.conftest import with_config
+
+
+@with_config(MULTILINGUAL=False, DEFAULT_LANGUAGE="fr")
+def test_get_locale_not_multilingual_returns_default(app):
+    with app.test_request_context("/"):
+        assert get_locale() == "fr"
+
+
+@with_config(
+    MULTILINGUAL=True,
+    AVAILABLE_LANGUAGES={"fr": {}, "en": {}},
+    DEFAULT_LANGUAGE="fr",
+)
+def test_get_locale_session_language_valid(app, client):
+
+    # register a simple endpoint that returns the computed locale
+    def _locale():
+        return get_locale()
+
+    app.add_url_rule("/_locale_valid", "_locale_valid", _locale)
+
+    with client.session_transaction() as sess:
+        sess["language"] = "en"
+
+    r = client.get("/_locale_valid")
+    assert r.data.decode() == "en"
+
+
+@with_config(
+    MULTILINGUAL=True,
+    AVAILABLE_LANGUAGES={"fr": {}, "en": {}},
+    DEFAULT_LANGUAGE="fr",
+)
+def test_get_locale_session_language_invalid_fallback_accept_language(app, client):
+    with client.session_transaction() as sess:
+        sess["language"] = "xx"
+
+    r = client.get("/", headers={"Accept-Language": "en-US,en;q=0.9"})
+    with app.test_request_context("/", headers={"Accept-Language": "en-US,en;q=0.9"}):
+        assert get_locale() == "en"
+
+
+@with_config(
+    MULTILINGUAL=True,
+    AVAILABLE_LANGUAGES={"fr": {}, "en": {}},
+    DEFAULT_LANGUAGE="fr",
+)
+def test_get_locale_no_session_no_match_returns_default(app, client):
+    r = client.get("/", headers={"Accept-Language": "es"})
+    with app.test_request_context("/", headers={"Accept-Language": "es"}):
+        assert get_locale() == "fr"