Merge pull request #7240 from freedomofpress/l10n-ci-screenshots

ci(translation): save screenshots as workflow artifacts

Author: legoktm

.github/workflows/translation.yml

@@ -56,3 +56,8 @@ jobs:
       - name: Run translation tests
         run: |
           LOCALES="${{ matrix.locale }}" make translation-test
+      - name: Save screenshots
+        uses: actions/upload-artifact@v4
+        with:
+          name: screenshots-${{ matrix.locale }}
+          path: securedrop/tests/functional/pageslayout/screenshots/

Makefile

@@ -427,9 +427,10 @@ $(DESKTOP_POT): ${DESKTOP_BASE}/*.in
 		--output-file $@
 	@rm ${DESKTOP_LOCALE_DIR}/*.po
 
-# Render desktop list from "i18n.json".
+# Render the list of desktop locales from those in entries "i18n.json" that
+# include a "desktop" key.
 $(DESKTOP_I18N_CONF):
-	@jq --raw-output '.supported_locales[].desktop' ${I18N_CONF} > $@
+	@jq --raw-output '.supported_locales[].desktop | values' ${I18N_CONF} > $@
 
 ## Supported locales
 

securedrop/bin/dev-config

@@ -27,7 +27,6 @@ with open('securedrop/config.py', 'w') as f:
     text += '\n'
     supported_locales = subprocess.check_output(['make', '--quiet', 'supported-locales']).decode().strip()
     text += f'SUPPORTED_LOCALES = {supported_locales}\n'
-    text += 'SUPPORTED_LOCALES.append("en_US")\n'
     f.write(text)
 
 with open('securedrop/rq_config.py', 'w') as f:

securedrop/i18n.json

@@ -20,6 +20,9 @@
       "name": "Greek",
       "desktop": "el"
     },
+    "en_US": {
+      "name": "English"
+    },
     "es_ES": {
       "name": "Spanish",
       "desktop": "es_ES"

securedrop/i18n.rst

@@ -4,6 +4,7 @@
 * Czech (``cs``)
 * German (``de_DE``)
 * Greek (``el``)
+* English (``en_US``)
 * Spanish (``es_ES``)
 * French (``fr_FR``)
 * Hindi (``hi``)

securedrop/tests/functional/app_navigators/journalist_app_nav.py

@@ -33,8 +33,18 @@ def __init__(
         self._journalist_app_base_url = journalist_app_base_url
         self.nav_helper = NavigationHelper(web_driver)
         self.driver = web_driver
+
+        # Some string-based tests check this to avoid failing on translated strings.
         self.accept_languages = accept_languages
 
+    def got_expected_language(self, locale: str) -> None:
+        expected = locale.replace("_", "-")
+
+        html = self.nav_helper.wait_for(lambda: self.driver.find_element(By.TAG_NAME, "html"))
+        actual = html.get_attribute("lang")
+
+        assert actual == expected
+
     def is_on_journalist_homepage(self) -> WebElement:
         return self.nav_helper.wait_for(
             lambda: self.driver.find_element(By.CSS_SELECTOR, "div.journalist-view-all")
@@ -341,6 +351,7 @@ def admin_visits_user_edit_page(self, username_of_journalist_to_edit: str) -> No
         # Ensure the admin is allowed to edit the journalist
         def can_edit_user():
             h = self.driver.find_elements(By.TAG_NAME, "h1")[0]
-            assert f'Edit user "{username_of_journalist_to_edit}"' == h.text
+            if not self.accept_languages:
+                assert f'Edit user "{username_of_journalist_to_edit}"' == h.text
 
         self.nav_helper.wait_for(can_edit_user)

securedrop/tests/functional/app_navigators/source_app_nav.py

@@ -26,6 +26,8 @@ def __init__(
         self._source_app_base_url = source_app_base_url
         self.nav_helper = NavigationHelper(web_driver)
         self.driver = web_driver
+
+        # Some string-based tests check this to avoid failing on translated strings.
         self.accept_languages = accept_languages
 
     @classmethod

securedrop/tests/functional/conftest.py

@@ -18,12 +18,18 @@
 from tests.factories import SecureDropConfigFactory
 from tests.functional.db_session import get_database_session
 from tests.functional.web_drivers import WebDriverTypeEnum, get_web_driver
-
-
-# Function-scoped so that tests can be run in parallel if needed
-@pytest.fixture
-def firefox_web_driver() -> WebDriver:  # type: ignore
-    with get_web_driver(web_driver_type=WebDriverTypeEnum.FIREFOX) as web_driver:
+from tests.utils.i18n import get_test_locales
+
+
+# Function-scoped so that tests can be run in parallel if needed.  The fixture
+# needs to know the locale at setup time, so we do that parameterization here
+# rather than at the test level.
+@pytest.fixture(params=get_test_locales())
+def firefox_web_driver(request) -> WebDriver:  # type: ignore
+    locale = request.param.replace("_", "-")
+    with get_web_driver(
+        web_driver_type=WebDriverTypeEnum.FIREFOX, accept_languages=locale
+    ) as web_driver:
         yield web_driver
 
 
@@ -209,6 +215,7 @@ def sd_servers(
         GPG_KEY_DIR=gpg_key_dir,
         JOURNALIST_KEY=journalist_key_fingerprint,
         RQ_WORKER_NAME=worker_name,
+        SUPPORTED_LOCALES=get_test_locales(),
     )
 
     # Spawn the apps in separate processes
@@ -232,6 +239,7 @@ def sd_servers_with_clean_state(
         GPG_KEY_DIR=gpg_key_dir,
         JOURNALIST_KEY=journalist_key_fingerprint,
         RQ_WORKER_NAME=worker_name,
+        SUPPORTED_LOCALES=get_test_locales(),
     )
 
     # Spawn the apps in separate processes
@@ -255,6 +263,7 @@ def sd_servers_with_submitted_file(
         GPG_KEY_DIR=gpg_key_dir,
         JOURNALIST_KEY=journalist_key_fingerprint,
         RQ_WORKER_NAME=worker_name,
+        SUPPORTED_LOCALES=get_test_locales(),
     )
 
     # Spawn the apps in separate processes with a callback to create a submission

securedrop/tests/functional/pageslayout/test_journalist.py

@@ -17,22 +17,22 @@
 #
 import pytest
 from tests.functional.app_navigators.journalist_app_nav import JournalistAppNavigator
-from tests.functional.pageslayout.utils import list_locales, save_static_data
+from tests.functional.pageslayout.utils import save_static_data
 
 
-@pytest.mark.parametrize("locale", list_locales())
 @pytest.mark.pagelayout
 class TestJournalistLayout:
-    def test_login_index_and_edit(self, locale, sd_servers, firefox_web_driver):
+    def test_login_index_and_edit(self, sd_servers, firefox_web_driver, request):
+        locale = firefox_web_driver.locale
         # Given an SD server
         # And a journalist accessing the journalist interface
-        locale_with_commas = locale.replace("_", "-")
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.driver.get(f"{sd_servers.journalist_app_base_url}/login")
+        journ_app_nav.got_expected_language(locale)
         save_static_data(journ_app_nav.driver, locale, "journalist-login")
 
         # And they log into the app and are an admin
@@ -54,14 +54,14 @@ def test_login_index_and_edit(self, locale, sd_servers, firefox_web_driver):
         journ_app_nav.journalist_visits_edit_account()
         save_static_data(journ_app_nav.driver, locale, "journalist-edit_account_user")
 
-    def test_index_entered_text(self, locale, sd_servers, firefox_web_driver):
+    def test_index_entered_text(self, sd_servers, firefox_web_driver):
         # Given an SD server
         # And a journalist accessing the journalist interface
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
 
         # Take a screenshot of the login page with the form completed
@@ -74,15 +74,15 @@ def test_index_entered_text(self, locale, sd_servers, firefox_web_driver):
         save_static_data(journ_app_nav.driver, locale, "journalist-index_with_text")
 
     def test_index_with_submission_and_select_documents(
-        self, locale, sd_servers_with_submitted_file, firefox_web_driver
+        self, sd_servers_with_submitted_file, firefox_web_driver
     ):
         # Given an SD server with an already-submitted file
         # And a journalist logging into the journalist interface
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers_with_submitted_file.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
 
         # Take a screenshot of the index page when there is a source and submission
@@ -115,27 +115,27 @@ def test_index_with_submission_and_select_documents(
         )
         save_static_data(journ_app_nav.driver, locale, "journalist-composes_reply")
 
-    def test_fail_to_visit_admin(self, locale, sd_servers, firefox_web_driver):
+    def test_fail_to_visit_admin(self, sd_servers, firefox_web_driver):
         # Given an SD server
         # And someone accessing the journalist interface
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         # Take a screenshot of them trying to force-browse to the admin interface
         journ_app_nav.driver.get(f"{sd_servers.journalist_app_base_url}/admin")
         save_static_data(journ_app_nav.driver, locale, "journalist-code-fail_to_visit_admin")
 
-    def test_fail_login(self, locale, sd_servers, firefox_web_driver):
+    def test_fail_login(self, sd_servers, firefox_web_driver):
         # Given an SD server
         # And someone accessing the journalist interface
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
 
         # Take a screenshot of trying to log in using invalid credentials

securedrop/tests/functional/pageslayout/test_journalist_account.py

@@ -21,22 +21,21 @@
 from selenium.webdriver import ActionChains
 from selenium.webdriver.common.by import By
 from tests.functional.app_navigators.journalist_app_nav import JournalistAppNavigator
-from tests.functional.pageslayout.utils import list_locales, save_static_data
+from tests.functional.pageslayout.utils import save_static_data
 
 
-@pytest.mark.parametrize("locale", list_locales())
 @pytest.mark.pagelayout
 class TestJournalistLayoutAccount:
     def test_account_edit_and_set_hotp_secret(
-        self, locale, sd_servers_with_clean_state, firefox_web_driver
+        self, sd_servers_with_clean_state, firefox_web_driver
     ):
         # Given an SD server
         # And a journalist logging into the journalist interface
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers_with_clean_state.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.journalist_logs_in(
             username=sd_servers_with_clean_state.journalist_username,
@@ -87,7 +86,7 @@ def explanatory_tooltip_is_correct() -> None:
             explanatory_tooltip_opacity = explanatory_tooltip.value_of_css_property("opacity")
             assert explanatory_tooltip_opacity == "1"
 
-            if assert_tooltip_text_is:
+            if assert_tooltip_text_is and not journ_app_nav.accept_languages:
                 assert explanatory_tooltip.text == assert_tooltip_text_is
 
         journ_app_nav.nav_helper.wait_for(explanatory_tooltip_is_correct)
@@ -97,16 +96,14 @@ def explanatory_tooltip_is_correct() -> None:
         alert = journ_app_nav.driver.switch_to.alert
         alert.accept()
 
-    def test_account_new_two_factor_totp(
-        self, locale, sd_servers_with_clean_state, firefox_web_driver
-    ):
+    def test_account_new_two_factor_totp(self, sd_servers_with_clean_state, firefox_web_driver):
         # Given an SD server
         # And a journalist logging into the journalist interface
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers_with_clean_state.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.journalist_logs_in(
             username=sd_servers_with_clean_state.journalist_username,

securedrop/tests/functional/pageslayout/test_journalist_admin.py

@@ -25,23 +25,22 @@
 from selenium.webdriver import ActionChains
 from selenium.webdriver.common.by import By
 from tests.functional.app_navigators.journalist_app_nav import JournalistAppNavigator
-from tests.functional.pageslayout.utils import list_locales, save_static_data
+from tests.functional.pageslayout.utils import save_static_data
 
 
-@pytest.mark.parametrize("locale", list_locales())
 @pytest.mark.pagelayout
 class TestAdminLayoutAddAndEditUser:
     def test_admin_adds_user_hotp_and_edits_hotp(
-        self, locale, sd_servers_with_clean_state, firefox_web_driver
+        self, sd_servers_with_clean_state, firefox_web_driver
     ):
         # Given an SD server
         # And a journalist logging into the journalist interface as an admin
         assert sd_servers_with_clean_state.journalist_is_admin
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers_with_clean_state.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.journalist_logs_in(
             username=sd_servers_with_clean_state.journalist_username,
@@ -118,16 +117,16 @@ def _admin_visits_reset_2fa_hotp_step() -> None:
         )
 
     def test_admin_adds_user_totp_and_edits_totp(
-        self, locale, sd_servers_with_clean_state, firefox_web_driver
+        self, sd_servers_with_clean_state, firefox_web_driver
     ):
         # Given an SD server
         # And a journalist logging into the journalist interface as an admin
         assert sd_servers_with_clean_state.journalist_is_admin
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers_with_clean_state.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.journalist_logs_in(
             username=sd_servers_with_clean_state.journalist_username,
@@ -223,18 +222,17 @@ def _retry_2fa_pop_ups(
                 logging.info("Selenium has failed to click; retrying.")
 
 
-@pytest.mark.parametrize("locale", list_locales())
 @pytest.mark.pagelayout
 class TestAdminLayoutEditConfig:
-    def test_admin_changes_logo(self, locale, sd_servers_with_clean_state, firefox_web_driver):
+    def test_admin_changes_logo(self, sd_servers_with_clean_state, firefox_web_driver):
         # Given an SD server
         # And a journalist logging into the journalist interface as an admin
         assert sd_servers_with_clean_state.journalist_is_admin
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers_with_clean_state.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.journalist_logs_in(
             username=sd_servers_with_clean_state.journalist_username,
@@ -257,22 +255,23 @@ def test_admin_changes_logo(self, locale, sd_servers_with_clean_state, firefox_w
         # Then it succeeds
         def updated_image() -> None:
             flash_msg = journ_app_nav.driver.find_element(By.CSS_SELECTOR, ".flash")
-            assert "Image updated." in flash_msg.text
+            if not journ_app_nav.accept_languages:
+                assert "Image updated." in flash_msg.text
 
         journ_app_nav.nav_helper.wait_for(updated_image, timeout=20)
 
         # Take a screenshot
         save_static_data(journ_app_nav.driver, locale, "journalist-admin_changes_logo_image")
 
-    def test_ossec_alert_button(self, locale, sd_servers, firefox_web_driver):
+    def test_ossec_alert_button(self, sd_servers, firefox_web_driver):
         # Given an SD server
         # And a journalist logging into the journalist interface as an admin
         assert sd_servers.journalist_is_admin
-        locale_with_commas = locale.replace("_", "-")
+        locale = firefox_web_driver.locale
         journ_app_nav = JournalistAppNavigator(
             journalist_app_base_url=sd_servers.journalist_app_base_url,
             web_driver=firefox_web_driver,
-            accept_languages=locale_with_commas,
+            accept_languages=locale,
         )
         journ_app_nav.journalist_logs_in(
             username=sd_servers.journalist_username,
@@ -290,7 +289,8 @@ def test_ossec_alert_button(self, locale, sd_servers, firefox_web_driver):
         # Then it succeeds
         def test_alert_sent():
             flash_msg = journ_app_nav.driver.find_element(By.CSS_SELECTOR, ".flash")
-            assert "Test alert sent. Please check your email." in flash_msg.text
+            if not journ_app_nav.accept_languages:
+                assert "Test alert sent. Please check your email." in flash_msg.text
 
         journ_app_nav.nav_helper.wait_for(test_alert_sent)