Merge lp:~alecu/ubuntu-sso-client/fix-997326 into lp:ubuntu-sso-client

[Alejandro J. Cura]

- Use a standard LC_CTYPE locale when the LANG is turkish. (LP: #997326).

[Michał Karnicki (karni)]

review: Approve

[Manuel de la Peña (mandel)]

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~alecu/ubuntu-sso-client/fix-997326 into lp:ubuntu-sso-client failed. Below is the output from the failed tests.

*** Running QT test suite for ubuntu_sso ***
running build
Compiled data/qt/ssl_dialog.ui into ubuntu_sso/qt/ui/ssl_dialog_ui.py
compiled data/qt/resources.qrc into ubuntu_sso/qt/ui/resources_rc.py
Compiled data/qt/loadingoverlay.ui into ubuntu_sso/qt/ui/loadingoverlay_ui.py
Compiled data/qt/proxy_credentials_dialog.ui into ubuntu_sso/qt/ui/proxy_credentials_dialog_ui.py
Compiled data/qt/reset_password.ui into ubuntu_sso/qt/ui/reset_password_ui.py
Compiled data/qt/network_detection.ui into ubuntu_sso/qt/ui/network_detection_ui.py
Compiled data/qt/email_verification.ui into ubuntu_sso/qt/ui/email_verification_ui.py
Compiled data/qt/setup_account.ui into ubuntu_sso/qt/ui/setup_account_ui.py
Compiled data/qt/forgotten_password.ui into ubuntu_sso/qt/ui/forgotten_password_ui.py
Compiled data/qt/current_user_sign_in.ui into ubuntu_sso/qt/ui/current_user_sign_in_ui.py
Compiled data/qt/success_message.ui into ubuntu_sso/qt/ui/success_message_ui.py
Compiled data/qt/error_message.ui into ubuntu_sso/qt/ui/error_message_ui.py
running build_py
creating build
creating build/lib.linux-x86_64-2.7
creating build/lib.linux-x86_64-2.7/ubuntu_sso
copying ubuntu_sso/account.py -> build/lib.linux-x86_64-2.7/ubuntu_sso
copying ubuntu_sso/logger.py -> build/lib.linux-x86_64-2.7/ubuntu_sso
copying ubuntu_sso/__init__.py -> build/lib.linux-x86_64-2.7/ubuntu_sso
copying ubuntu_sso/credentials.py -> build/lib.linux-x86_64-2.7/ubuntu_sso
creating build/lib.linux-x86_64-2.7/ubuntu_sso/tests
copying ubuntu_sso/tests/linux.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/tests
copying ubuntu_sso/tests/__init__.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/tests
copying ubuntu_sso/tests/test_credentials.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/tests
copying ubuntu_sso/tests/test_account.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/tests
creating build/lib.linux-x86_64-2.7/ubuntu_sso/keyring
copying ubuntu_sso/keyring/linux.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring
copying ubuntu_sso/keyring/__init__.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring
copying ubuntu_sso/keyring/pykeyring.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring
creating build/lib.linux-x86_64-2.7/ubuntu_sso/keyring/tests
copying ubuntu_sso/keyring/tests/__init__.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring/tests
copying ubuntu_sso/keyring/tests/test_pykeyring.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring/tests
copying ubuntu_sso/keyring/tests/test_linux.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring/tests
copying ubuntu_sso/keyring/tests/test_common.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/keyring/tests
creating build/lib.linux-x86_64-2.7/ubuntu_sso/main
copying ubuntu_sso/main/glib.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/main
copying ubuntu_sso/main/perspective_broker.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/main
copying ubuntu_sso/main/linux.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/main
copying ubuntu_sso/main/windows.py -> build/lib.linux-x86_64-2.7/ubuntu_sso/main
copying ubuntu_sso/main/qt.py -> build/lib.linux-x86_64-2.7/...

[dobey (dobey)]

A couple issues found by pep8:

./ubuntu_sso/utils/locale.py:34:1: E302 expected 2 blank lines, found 1
./ubuntu_sso/utils/tests/test_locale.py:80:1: W391 blank line at end of file

Also, I am wondering why you're checking LANG for changing LC_CTYPE, instead of just checking LC_CTYPE itself, or always changing it.

And can you please be sure to update the Copyright years at the top of the files you change, if they aren't already modified to include the new year? Thanks.

review: Needs Fixing

[dobey (dobey)]

Also, instead of poking the environment, it's probably better to use the locale module from the Python stdlib.

[lp:~alecu/ubuntu-sso-client/fix-997326]

1017. By Alejandro J. Cura on 2013-01-15

Do not change the LC_CTYPE if already present and non-turkish

[dobey (dobey)]

review: Approve

=== modified file 'ubuntu_sso/main/qt.py'
--- ubuntu_sso/main/qt.py	2012-04-09 17:38:24 +0000
+++ ubuntu_sso/main/qt.py	2013-01-15 22:06:21 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2012 Canonical Ltd.
+# Copyright 2012-2013 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -38,6 +38,8 @@
 
 from PyQt4 import QtCore
 
+from ubuntu_sso.utils.locale import fix_turkish_locale
+
 
 TIMERS = set()
 
@@ -72,6 +74,7 @@
 
 def start_setup():
     """Setup the env to run the service."""
+    fix_turkish_locale()
     # this has to be created before calling dbus.mainloop.qt.DBusQtMainLoop
     loop = QtCore.QCoreApplication(sys.argv)
     dbus.mainloop.qt.DBusQtMainLoop(set_as_default=True)

=== modified file 'ubuntu_sso/main/tests/test_qt.py'
--- ubuntu_sso/main/tests/test_qt.py	2012-04-09 17:38:24 +0000
+++ ubuntu_sso/main/tests/test_qt.py	2013-01-15 22:06:21 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2012 Canonical Ltd.
+# Copyright 2012-2013 Canonical Ltd.
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
@@ -80,3 +80,15 @@
         qt.timeout_func(0, self._set_called, 1, name="a")
         QtCore.QCoreApplication.instance().processEvents()
         self.assertEqual(self._called, ((1,), {"name": "a"}))
+
+    def test_start_setup_calls_turkish_fix(self):
+        """The start_setup function calls the turkish fix function."""
+        self.patch(qt.QtCore, "QCoreApplication",
+                   lambda *args, **kwargs: object())
+        self.patch(qt.dbus.mainloop.qt, "DBusQtMainLoop",
+                   lambda **kwargs: None)
+        called = []
+        self.patch(qt, "fix_turkish_locale", lambda: called.append(1))
+
+        qt.start_setup()
+        self.assertEqual(called, [1])

=== added file 'ubuntu_sso/utils/locale.py'
--- ubuntu_sso/utils/locale.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/utils/locale.py	2013-01-15 22:06:21 +0000
@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Utility modules related to locale."""
+
+import os
+
+# this locale is always installed in Ubuntu
+SAFE_LOCALE = "en_US.UTF-8"
+
+
+def is_turkish(locale_identifier):
+    """Return whether the locale identifier is turkish."""
+    return locale_identifier.startswith("tr_")
+
+
+def fix_turkish_locale():
+    """Change the LC_CTYPE when the LANG is turkish. Fixes lp:997326"""
+    lang = os.environ.get("LANG", "")
+    ctype = os.environ.get("LC_CTYPE", "")
+    if (is_turkish(lang) and ctype == "") or is_turkish(ctype):
+        os.environ["LC_CTYPE"] = SAFE_LOCALE

=== added file 'ubuntu_sso/utils/tests/test_locale.py'
--- ubuntu_sso/utils/tests/test_locale.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/utils/tests/test_locale.py	2013-01-15 22:06:21 +0000
@@ -0,0 +1,96 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2013 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# In addition, as a special exception, the copyright holders give
+# permission to link the code of portions of this program with the
+# OpenSSL library under certain conditions as described in each
+# individual source file, and distribute linked combinations
+# including the two.
+# You must obey the GNU General Public License in all respects
+# for all of the code used other than OpenSSL.  If you modify
+# file(s) with this exception, you may extend this exception to your
+# version of the file(s), but you are not obligated to do so.  If you
+# do not wish to do so, delete this exception statement from your
+# version.  If you delete this exception statement from all source
+# files in the program, then also delete it here.
+"""Tests for the locale utilities."""
+
+from twisted.trial.unittest import TestCase
+
+from ubuntu_sso.utils import locale
+
+NO_VALUE = object()
+
+
+class LocaleTestCase(TestCase):
+    """Test case for functions related to locale."""
+
+    def setUp(self):
+        d = super(LocaleTestCase, self).setUp()
+        self.save_environ("LC_CTYPE")
+        self.save_environ("LANG")
+        return d
+
+    def save_environ(self, env_var_name):
+        """Save the value of an environment variable."""
+        old_value = locale.os.environ.get(env_var_name, NO_VALUE)
+        self.addCleanup(self.restore_environ, env_var_name, old_value)
+        locale.os.environ[env_var_name] = "fake_locale"
+
+    def restore_environ(self, env_var_name, old_value):
+        """Restore the value of an environment variable."""
+        if old_value is NO_VALUE:
+            if env_var_name in locale.os.environ:
+                del(locale.os.environ[env_var_name])
+        else:
+            locale.os.environ[env_var_name] = old_value
+
+    def test_fix_turkish_locale_when_turkish(self):
+        """The fix_turkish_locale function skips when no locale set."""
+        locale.os.environ["LANG"] = "tr_TR.UTF-8"
+        del(locale.os.environ["LC_CTYPE"])
+        locale.fix_turkish_locale()
+        self.assertEqual(locale.os.environ["LC_CTYPE"], locale.SAFE_LOCALE)
+
+    def test_fix_turkish_locale_when_other(self):
+        """The fix_turkish_locale function skips when no locale set."""
+        locale.os.environ["LANG"] = "en_EN.UTF-8"
+        del(locale.os.environ["LC_CTYPE"])
+        locale.fix_turkish_locale()
+        self.assertEqual(locale.os.environ.get("LC_CTYPE", NO_VALUE), NO_VALUE)
+
+    def test_fix_turkish_locale_when_LANG_unset(self):
+        """The fix_turkish_locale function skips when no locale set."""
+        del(locale.os.environ["LANG"])
+        del(locale.os.environ["LC_CTYPE"])
+        locale.fix_turkish_locale()
+        self.assertEqual(locale.os.environ.get("LC_CTYPE", NO_VALUE), NO_VALUE)
+
+    def test_fix_turkish_locale_when_LC_CTYPE_not_turkish(self):
+        """The fix is skipped if the LC_CTYPE is already non-turkish."""
+        original = "es_ES.UTF-8"
+        locale.os.environ["LANG"] = "tr_TR.UTF-8"
+        locale.os.environ["LC_CTYPE"] = original
+        locale.fix_turkish_locale()
+        self.assertEqual(locale.os.environ.get("LC_CTYPE", NO_VALUE), original)
+
+    def test_fix_turkish_locale_when_LC_CTYPE_is_turkish(self):
+        """The fix is applied if the LC_CTYPE is turkish."""
+        locale.os.environ["LANG"] = "es_ES.UTF-8"
+        locale.os.environ["LC_CTYPE"] = "tr_TR.UTF-8"
+        locale.fix_turkish_locale()
+        self.assertEqual(locale.os.environ.get("LC_CTYPE", NO_VALUE),
+                         locale.SAFE_LOCALE)