Merge lp:~maxiberta/canonical-identity-provider/fix-set-language into lp:canonical-identity-provider/release

[Maximiliano Bertacchini]

Fix explicitly setting the active language.

Set the active language in the session as described in Django docs (https://docs.djangoproject.com/en/1.11/topics/i18n/translation/#explicitly-setting-the-active-language).

Curiously, two tests were explicitly validating the current (wrong) behaviour. Some archaeology:
- webui.tests.test_views_ui.LogoutTestCase.test_preferred_language_is_kept_after_logout(): introduced in r1255 "Redirect to return_url on logout for known rpconfigs, when the query string return_now was given".
- identityprovider.tests.test_views_server.MultiLangOpenIDTestCase.test_language_persists_in_session(): modified in r1392 "Move to django-1.8 from 1.7 and fix the test fallouts".

[Daniel Manrique (roadmr)]

WOw, thanks! LGTM.

review: Approve

[Otto Co-Pilot (otto-copilot)]

Running landing tests failed
https://jenkins.ols.canonical.com/online-services/job/canonical-identity-provider/189/

[Maximiliano Bertacchini (maxiberta)]

<maxiberta> roadmr: hm, I think the failing test needs a previous "make compilemessages"... o just not look for a German string
<maxiberta> roadmr: ftr, jenkaas runs `make bootstrap makemessages` for setup
<maxiberta> I'd make that `make bootstrap makemessages compilemessages`... ?
<maxiberta> uhm... that somehow messes with `make test`!!
<maxiberta> okey, I'll just skip the German string comparison
<maxiberta> there's still a check for 'de' in the cookie
<roadmr> sounds good, I think we're fairly certain that if the cookie has the right value, we do the right thing
<roadmr> if the translation is present
<maxiberta> yup

=== modified file 'src/identityprovider/middleware/useraccount.py'
--- src/identityprovider/middleware/useraccount.py	2018-05-28 21:18:30 +0000
+++ src/identityprovider/middleware/useraccount.py	2018-09-07 21:30:32 +0000
@@ -4,6 +4,7 @@
 from django.conf import settings
 from django.contrib.auth import logout
 from django.contrib.auth.models import User
+from django.utils.translation import LANGUAGE_SESSION_KEY
 
 from identityprovider.const import SESSION_TOKEN_KEY
 from identityprovider.models import Account
@@ -61,5 +62,5 @@
             if isinstance(request.user, Account):
                 lang = request.user.preferredlanguage
                 if lang is not None:
-                    request.session['django_language'] = lang
+                    request.session[LANGUAGE_SESSION_KEY] = lang
                 self._validate_session(request, request.user)

=== modified file 'src/identityprovider/tests/test_views_server.py'
--- src/identityprovider/tests/test_views_server.py	2018-09-05 14:17:55 +0000
+++ src/identityprovider/tests/test_views_server.py	2018-09-07 21:30:32 +0000
@@ -17,6 +17,7 @@
 from django.test.utils import override_settings, patch_logger
 from django.urls import reverse
 from django.utils.timezone import now
+from django.utils.translation import LANGUAGE_SESSION_KEY
 from gargoyle.testutils import switches
 from mock import Mock
 from openid.extensions.ax import (
@@ -538,38 +539,35 @@
                          quote_plus(openid_identity_url))
 
 
-@override_settings(LANGUAGE_CODE='en', SUPPORTED_LANGUAGES=['en', 'de'])
+@override_settings(SUPPORTED_LANGUAGES=['en', 'de'])
 class MultiLangOpenIDTestCase(SSOBaseTestCase):
 
     def test_no_lang_specified(self):
         response = self.client.get(reverse('server-openid'))
         expected = "This is Ubuntu One, built on OpenID"
         self.assertContains(response, expected)
-        self.assertEqual('en', self.client.session['django_language'])
+        self.assertEqual('en', self.client.session[LANGUAGE_SESSION_KEY])
 
     def test_german(self):
         self.client.get(reverse('server-openid', kwargs=dict(lang='de')))
-        self.assertEqual('de', self.client.session['django_language'])
+        self.assertEqual('de', self.client.session[LANGUAGE_SESSION_KEY])
 
     def test_german_with_country_code(self):
         # This should default back to 'de'.
         self.client.get(reverse('server-openid', kwargs=dict(lang='de_CH')))
-        self.assertEqual('de', self.client.session['django_language'])
+        self.assertEqual('de', self.client.session[LANGUAGE_SESSION_KEY])
 
     def test_unsupported_language(self):
         self.client.get(reverse('server-openid', kwargs=dict(lang='sw')))
-        self.assertEqual('en', self.client.session['django_language'])
+        self.assertEqual('en', self.client.session[LANGUAGE_SESSION_KEY])
 
     def test_language_persists_in_session(self):
         self.client.get(reverse('server-openid', kwargs=dict(lang='de')))
-        self.assertEqual('de', self.client.session['django_language'])
+        self.assertEqual('de', self.client.session[LANGUAGE_SESSION_KEY])
         # Requesting a second time will still bring back German
         # if no other setting takes precedence (like the user's preference).
-        # XXX: 2016-01-07 psivaa: But from django-1.8, `When a translation
-        # doesn’t exist for a specific literal, the fallback is now taken
-        # from the LANGUAGE_CODE`
         self.client.get(reverse('server-openid'))
-        self.assertEqual('en', self.client.session['django_language'])
+        self.assertEqual('de', self.client.session[LANGUAGE_SESSION_KEY])
 
 
 class ValidOpenIDTestCase(SSOBaseTestCase):

=== modified file 'src/identityprovider/views/server.py'
--- src/identityprovider/views/server.py	2018-09-04 13:40:22 +0000
+++ src/identityprovider/views/server.py	2018-09-07 21:30:32 +0000
@@ -113,7 +113,7 @@
     if lang not in settings.SUPPORTED_LANGUAGES:
         lang = 'en'
     if hasattr(request, 'session'):
-        request.session['django_language'] = lang
+        request.session[translation.LANGUAGE_SESSION_KEY] = lang
     else:
         response.set_cookie(settings.LANGUAGE_COOKIE_NAME, lang)
 

=== modified file 'src/webui/tests/test_views_ui.py'
--- src/webui/tests/test_views_ui.py	2018-05-28 21:00:28 +0000
+++ src/webui/tests/test_views_ui.py	2018-09-07 21:30:32 +0000
@@ -636,6 +636,10 @@
         self.set_language('de')
         response = self.logout()
 
+        # The logout page should be rendered in German in real life, but
+        # the CI environment lacks the needed translations at the moment.
+        # Thus, right here the message defaults to "You have been logged out"
+        # instead of "Sie haben sich abgemeldet".
         self.assert_logged_out_in_sso(response)
         self.assertEqual(
             response.cookies[settings.LANGUAGE_COOKIE_NAME].value, 'de')