Warehouse: l10n skeleton

Makefile

@@ -4,6 +4,7 @@ PR := $(shell echo "$${TRAVIS_PULL_REQUEST:-false}")
 BRANCH := $(shell echo "$${TRAVIS_BRANCH:-master}")
 DB := example
 IPYTHON := no
+LOCALES := $(shell find warehouse/locale -type d -depth 1 -exec basename {} \;)
 
 # set environment variable WAREHOUSE_IPYTHON_SHELL=1 if IPython
 # needed in development environment
@@ -168,4 +169,39 @@ purge: stop clean
 stop:
 	docker-compose down -v
 
-.PHONY: default build serve initdb shell tests docs deps travis-deps clean purge debug stop
+compile-pot:
+	$(BINDIR)/pybabel extract \
+		-F babel.cfg \
+		--copyright-holder="PyPA" \
+		--msgid-bugs-address="https://github.com/pypa/warehouse/issues/new" \
+		--project="Warehouse" \
+		--output="warehouse/locale/messages.pot" \
+		warehouse
+
+init-po:
+	$(BINDIR)/pybabel init \
+		--input-file="warehouse/locale/messages.pot" \
+		--output-dir="warehouse/locale/" \
+		--locale="$(L)"
+
+update-po:
+	$(BINDIR)/pybabel update \
+		--input-file="warehouse/locale/messages.pot" \
+		--output-file="warehouse/locale/$(L)/LC_MESSAGES/messages.po" \
+		--locale="$(L)"
+
+compile-po:
+	$(BINDIR)/pybabel compile \
+		--input-file="warehouse/locale/$(L)/LC_MESSAGES/messages.po" \
+		--directory="warehouse/locale/" \
+		--locale="$(L)"
+
+build-mos: compile-pot
+	for LOCALE in $(LOCALES) ; do \
+		if [[ -f warehouse/locale/$$LOCALE/LC_MESSAGES/messages.mo ]]; then \
+			L=$$LOCALE $(MAKE) update-po ; \
+		fi ; \
+		L=$$LOCALE $(MAKE) compile-po ; \
+		done
+
+.PHONY: default build serve initdb shell tests docs deps travis-deps clean purge debug stop compile-pot

babel.cfg

@@ -0,0 +1,4 @@
+[python: **.py]
+[jinja2: **.html]
+encoding = utf-8
+extensions=jinja2.ext.autoescape,jinja2.ext.with_

docker-compose.yml

@@ -45,7 +45,7 @@ services:
         # working on pypi-theme, this is a private repository due to the fact
         # that other people's IP is contained in it.
         #THEME_REPO:
-    command: hupper -m gunicorn.app.wsgiapp -b 0.0.0.0:8000 -c gunicorn.conf warehouse.wsgi:application
+    command: hupper -w 'warehouse/locale/**/*.mo' -m gunicorn.app.wsgiapp -b 0.0.0.0:8000 -c gunicorn.conf warehouse.wsgi:application
     env_file: dev/environment
     volumes:
       # We specify all of these directories instead of just . because we want to

tests/conftest.py

@@ -24,6 +24,7 @@
 import pytest
 import webtest as _webtest
 
+from pyramid.i18n import TranslationString
 from pyramid.static import ManifestCacheBuster
 from pytest_postgresql.factories import (
     drop_postgresql_database,
@@ -33,12 +34,15 @@
 from sqlalchemy import event
 
 from warehouse import admin, config, static
-from warehouse.accounts import services as account_services
+from warehouse.accounts import services as account_services, views as account_views
 from warehouse.macaroons import services as macaroon_services
+from warehouse.manage import views as manage_views
 from warehouse.metrics import IMetricsService
 
 from .common.db import Session
 
+L10N_TAGGED_MODULES = [account_views, manage_views]
+
 
 def pytest_collection_modifyitems(items):
     for item in items:
@@ -313,3 +317,25 @@ def pytest_runtest_makereport(item, call):
                 )
                 if data:
                     rep.sections.append(("Captured {} log".format(log_type), data))
+
+
+@pytest.fixture(scope="session")
+def monkeypatch_session():
+    # NOTE: This is a minor hack to avoid duplicate monkeypatching
+    # on every function scope for dummy_localize.
+    # https://github.com/pytest-dev/pytest/issues/1872#issuecomment-375108891
+    from _pytest.monkeypatch import MonkeyPatch
+
+    m = MonkeyPatch()
+    yield m
+    m.undo()
+
+
+@pytest.fixture(scope="session", autouse=True)
+def dummy_localize(monkeypatch_session):
+    def localize(message, **kwargs):
+        ts = TranslationString(message, **kwargs)
+        return ts.interpolate()
+
+    for mod in L10N_TAGGED_MODULES:
+        monkeypatch_session.setattr(mod, "_", localize)

tests/unit/accounts/test_forms.py

@@ -254,7 +254,7 @@ def test_password_confirm_required_error(self):
         assert not form.validate()
         assert form.password_confirm.errors.pop() == "This field is required."
 
-    def test_passwords_mismatch_error(self):
+    def test_passwords_mismatch_error(self, pyramid_config):
         user_service = pretend.stub(
             find_userid_by_email=pretend.call_recorder(lambda _: pretend.stub())
         )
@@ -266,7 +266,7 @@ def test_passwords_mismatch_error(self):
 
         assert not form.validate()
         assert (
-            form.password_confirm.errors.pop()
+            str(form.password_confirm.errors.pop())
             == "Your passwords don't match. Try again."
         )
 
@@ -299,7 +299,7 @@ def test_email_required_error(self):
         assert not form.validate()
         assert form.email.errors.pop() == "This field is required."
 
-    def test_invalid_email_error(self):
+    def test_invalid_email_error(self, pyramid_config):
         form = forms.RegistrationForm(
             data={"email": "bad"},
             user_service=pretend.stub(
@@ -309,7 +309,9 @@ def test_invalid_email_error(self):
         )
 
         assert not form.validate()
-        assert form.email.errors.pop() == "The email address isn't valid. Try again."
+        assert (
+            str(form.email.errors.pop()) == "The email address isn't valid. Try again."
+        )
 
     def test_exotic_email_success(self):
         form = forms.RegistrationForm(
@@ -323,7 +325,7 @@ def test_exotic_email_success(self):
         form.validate()
         assert len(form.email.errors) == 0
 
-    def test_email_exists_error(self):
+    def test_email_exists_error(self, pyramid_config):
         form = forms.RegistrationForm(
             data={"email": "foo@bar.com"},
             user_service=pretend.stub(
@@ -334,12 +336,12 @@ def test_email_exists_error(self):
 
         assert not form.validate()
         assert (
-            form.email.errors.pop()
+            str(form.email.errors.pop())
             == "This email address is already being used by another account. "
             "Use a different email."
         )
 
-    def test_blacklisted_email_error(self):
+    def test_blacklisted_email_error(self, pyramid_config):
         form = forms.RegistrationForm(
             data={"email": "foo@bearsarefuzzy.com"},
             user_service=pretend.stub(
@@ -350,12 +352,12 @@ def test_blacklisted_email_error(self):
 
         assert not form.validate()
         assert (
-            form.email.errors.pop()
+            str(form.email.errors.pop())
             == "You can't use an email address from this domain. Use a "
             "different email."
         )
 
-    def test_username_exists(self):
+    def test_username_exists(self, pyramid_config):
         form = forms.RegistrationForm(
             data={"username": "foo"},
             user_service=pretend.stub(
@@ -365,13 +367,13 @@ def test_username_exists(self):
         )
         assert not form.validate()
         assert (
-            form.username.errors.pop()
+            str(form.username.errors.pop())
             == "This username is already being used by another account. "
             "Choose a different username."
         )
 
     @pytest.mark.parametrize("username", ["_foo", "bar_", "foo^bar"])
-    def test_username_is_valid(self, username):
+    def test_username_is_valid(self, username, pyramid_config):
         form = forms.RegistrationForm(
             data={"username": username},
             user_service=pretend.stub(
@@ -381,7 +383,7 @@ def test_username_is_valid(self, username):
         )
         assert not form.validate()
         assert (
-            form.username.errors.pop() == "The username is invalid. Usernames "
+            str(form.username.errors.pop()) == "The username is invalid. Usernames "
             "must be composed of letters, numbers, "
             "dots, hyphens and underscores. And must "
             "also start and finish with a letter or number. "
@@ -423,7 +425,7 @@ def test_password_breached(self):
             "compromised and cannot be used."
         )
 
-    def test_name_too_long(self):
+    def test_name_too_long(self, pyramid_config):
         form = forms.RegistrationForm(
             data={"full_name": "hello " * 50},
             user_service=pretend.stub(
@@ -433,7 +435,7 @@ def test_name_too_long(self):
         )
         assert not form.validate()
         assert (
-            form.full_name.errors.pop()
+            str(form.full_name.errors.pop())
             == "The name is too long. Choose a name with 100 characters or less."
         )
 
@@ -493,7 +495,7 @@ def test_password_confirm_required_error(self):
         assert not form.validate()
         assert form.password_confirm.errors.pop() == "This field is required."
 
-    def test_passwords_mismatch_error(self):
+    def test_passwords_mismatch_error(self, pyramid_config):
         form = forms.ResetPasswordForm(
             data={
                 "new_password": "password",
@@ -507,7 +509,7 @@ def test_passwords_mismatch_error(self):
 
         assert not form.validate()
         assert (
-            form.password_confirm.errors.pop()
+            str(form.password_confirm.errors.pop())
             == "Your passwords don't match. Try again."
         )
 
@@ -578,7 +580,7 @@ def test_creation(self):
 
         assert form.user_service is user_service
 
-    def test_totp_secret_exists(self):
+    def test_totp_secret_exists(self, pyramid_config):
         form = forms.TOTPAuthenticationForm(
             data={"totp_value": ""}, user_id=pretend.stub(), user_service=pretend.stub()
         )
@@ -591,15 +593,15 @@ def test_totp_secret_exists(self):
             user_service=pretend.stub(check_totp_value=lambda *a: True),
         )
         assert not form.validate()
-        assert form.totp_value.errors.pop() == "TOTP code must be 6 digits."
+        assert str(form.totp_value.errors.pop()) == "TOTP code must be 6 digits."
 
         form = forms.TOTPAuthenticationForm(
             data={"totp_value": "123456"},
             user_id=pretend.stub(),
             user_service=pretend.stub(check_totp_value=lambda *a: False),
         )
         assert not form.validate()
-        assert form.totp_value.errors.pop() == "Invalid TOTP code."
+        assert str(form.totp_value.errors.pop()) == "Invalid TOTP code."
 
         form = forms.TOTPAuthenticationForm(
             data={"totp_value": "123456"},
@@ -627,7 +629,7 @@ def test_creation(self):
 
         assert form.challenge is challenge
 
-    def test_credential_bad_payload(self):
+    def test_credential_bad_payload(self, pyramid_config):
         form = forms.WebAuthnAuthenticationForm(
             credential="not valid json",
             user_id=pretend.stub(),
@@ -637,7 +639,10 @@ def test_credential_bad_payload(self):
             rp_id=pretend.stub(),
         )
         assert not form.validate()
-        assert form.credential.errors.pop() == "Invalid WebAuthn assertion: Bad payload"
+        assert (
+            str(form.credential.errors.pop())
+            == "Invalid WebAuthn assertion: Bad payload"
+        )
 
     def test_credential_invalid(self):
         form = forms.WebAuthnAuthenticationForm(

tests/unit/accounts/test_views.py

@@ -37,16 +37,17 @@
 
 
 class TestFailedLoginView:
-    exc = TooManyFailedLogins(resets_in=datetime.timedelta(seconds=600))
-    request = pretend.stub()
+    def test_too_many_failed_logins(self):
+        exc = TooManyFailedLogins(resets_in=datetime.timedelta(seconds=600))
+        request = pretend.stub(localizer=pretend.stub(translate=lambda tsf: tsf()))
 
-    resp = views.failed_logins(exc, request)
+        resp = views.failed_logins(exc, request)
 
-    assert resp.status == "429 Too Many Failed Login Attempts"
-    assert resp.detail == (
-        "There have been too many unsuccessful login attempts. " "Try again later."
-    )
-    assert dict(resp.headers).get("Retry-After") == "600"
+        assert resp.status == "429 Too Many Failed Login Attempts"
+        assert resp.detail == (
+            "There have been too many unsuccessful login attempts. Try again later."
+        )
+        assert dict(resp.headers).get("Retry-After") == "600"
 
 
 class TestUserProfile:
@@ -595,7 +596,7 @@ def test_webauthn_get_options_invalid_token(self, monkeypatch):
         assert request.session.flash.calls == [
             pretend.call("Invalid or expired two factor login.", queue="error")
         ]
-        assert result == {"fail": {"errors": ["Invalid two factor token"]}}
+        assert result == {"fail": {"errors": ["Invalid or expired two factor login."]}}
 
     def test_webauthn_get_options(self, monkeypatch):
         _get_two_factor_data = pretend.call_recorder(
@@ -642,7 +643,7 @@ def test_webauthn_validate_invalid_token(self, monkeypatch):
         assert request.session.flash.calls == [
             pretend.call("Invalid or expired two factor login.", queue="error")
         ]
-        assert result == {"fail": {"errors": ["Invalid two factor token"]}}
+        assert result == {"fail": {"errors": ["Invalid or expired two factor login."]}}
 
     def test_webauthn_validate_invalid_form(self, monkeypatch):
         _get_two_factor_data = pretend.call_recorder(
@@ -929,10 +930,8 @@ def test_register_fails_with_admin_flag_set(self, db_request):
         assert isinstance(result, HTTPSeeOther)
         assert db_request.session.flash.calls == [
             pretend.call(
-                (
-                    "New user registration temporarily disabled. "
-                    "See https://pypi.org/help#admin-intervention for details."
-                ),
+                "New user registration temporarily disabled. "
+                "See https://pypi.org/help#admin-intervention for details.",
                 queue="error",
             )
         ]
@@ -1450,8 +1449,8 @@ def test_verify_email(
     @pytest.mark.parametrize(
         ("exception", "message"),
         [
-            (TokenInvalid, "Invalid token: request a new verification link"),
-            (TokenExpired, "Expired token: request a new verification link"),
+            (TokenInvalid, "Invalid token: request a new email verification link"),
+            (TokenExpired, "Expired token: request a new email verification link"),
             (TokenMissing, "Invalid token: no token supplied"),
         ],
     )