Changeset fd6da93 in OpenWorkouts-current for ow/tests/views/test_user.py

Timestamp:

Feb 26, 2019, 11:11:43 AM (5 years ago)

Author:

Borja Lopez <borja@…>

Branches:

current, feature/docs, master

Children:

a4e4799

Parents:

d411dae

Message:

(#56) Add support for different locale/language:

• Let users choose their lang/locale in the edit profile page

• Set the currently selected locale as a cookie (following pyramid docs on how to set the locale using the default locale negotiator)

• Save the locale setting for each user as an attribute on the User model

• Set the proper locale as a cookie on login

• Unset the locale cookie on logout

Default available locales for now are en (english) and es (spanish)

File:

• ow/tests/views/test_user.py (modified) (6 diffs)

ow/tests/views/test_user.py

@@ -20 +20 @@
 from PIL import Image
 
+from pytz import common_timezones
+
 from ow.models.root import OpenWorkouts
 from ow.models.user import User
 from ow.models.workout import Workout
 from ow.views.renderers import OWFormRenderer
+from ow.utilities import get_available_locale_names
 import ow.views.user as user_views
 
@@ -51 +54 @@
     def dummy_request(self, root):
         request = DummyRequest()
+        request.registry.settings = {
+            'pyramid.default_locale_name': 'en'
+        }
         request.root = root
         return request
@@ -561 +567 @@
         assert rem.called
         assert response.location == request.resource_url(john)
+        # the response headers contain the proper set_cookie for the default
+        # locale
+        default_locale_name = request.registry.settings[
+            'pyramid.default_locale_name']
+        expected_locale_header = '_LOCALE_=' + default_locale_name + '; Path=/'
+        assert response.headers['Set-Cookie'] == expected_locale_header
+
+    @patch('ow.views.user.remember')
+    def test_login_post_ok_set_locale(self, rem, dummy_request, john):
+        # same as the previous test, but this time the user has set a
+        # locale different than the default one
+        request = dummy_request
+        request.method = 'POST'
+        request.POST['submit'] = True
+        request.POST['email'] = 'john.doe@example.net'
+        request.POST['password'] = 's3cr3t'
+        # verify the user first
+        john.verified = True
+        # set the locale
+        john.locale = 'es'
+        response = user_views.login(request.root, request)
+        assert isinstance(response, HTTPFound)
+        assert rem.called
+        assert response.location == request.resource_url(john)
+        # the response headers contain the proper set_cookie for the user
+        # locale setting
+        expected_locale_header = '_LOCALE_=es; Path=/'
+        assert response.headers['Set-Cookie'] == expected_locale_header
 
     @patch('ow.views.user.forget')
@@ -569 +603 @@
         assert forg.called
         assert response.location == request.resource_url(request.root)
+        # the response headers contain the needed Set-Cookie header that
+        # invalidates the _LOCALE_ cookie, preventing problems with users
+        # sharing the same web browser (one locale setting being set for
+        # another user)
+        expected_locale_header = '_LOCALE_=; Max-Age=0; Path=/; expires='
+        assert expected_locale_header in response.headers['Set-Cookie']
 
     extensions = ('png', 'jpg', 'jpeg', 'gif')
@@ -639 +679 @@
         # loaded user profile
         data = ['firstname', 'lastname', 'email', 'nickname', 'bio',
-                'birth_date', 'height', 'weight', 'gender', 'timezone']
+                'birth_date', 'height', 'weight', 'gender', 'timezone',
+                'locale']
         assert list(response['form'].data.keys()) == data
         # and check the email to see data is properly loaded
         assert response['form'].data['email'] == 'john.doe@example.net'
+        assert response['timezones'] == common_timezones
+        assert response[
+            'available_locale_names'] == get_available_locale_names()
+        assert response['current_locale'] == request.registry.settings[
+            'pyramid.default_locale_name']
 
     def test_edit_profile_post_ok(self, profile_post_request, john):
@@ -654 +700 @@
         assert response.location == request.resource_url(user, 'profile')
         assert user.bio == bio
+
+    def test_edit_profile_post_ok_change_locale(
+            self, profile_post_request, john):
+        request = profile_post_request
+        user = john
+        # Update the locale
+        request.POST['locale'] = 'es'
+        response = user_views.edit_profile(user, request)
+        assert isinstance(response, HTTPFound)
+        assert response.location == request.resource_url(user, 'profile')
+        assert user.locale == 'es'
+
+    def test_edit_profile_post_ok_invalid_locale(
+            self, profile_post_request, john):
+        request = profile_post_request
+        user = john
+        # Update the locale with an invalid option
+        request.POST['locale'] = 'XX'
+        response = user_views.edit_profile(user, request)
+        assert isinstance(response['form'], OWFormRenderer)
+        # as an error happened, the current_locale had not changed
+        assert response['form'].errors == {
+            'locale': "Value must be one of: en; es (not 'XX')"}
+        assert user.locale == 'en'
 
     def test_edit_profile_post_missing_required(