Merge lp:~alecu/ubuntu-sso-client/fix-get-token-name into lp:ubuntu-sso-client

[Alejandro J. Cura]

The hostname can now contain characters in the system encoding. (LP: #875331)

The hostname can now contain characters in the system encoding. (LP: #875331)

[Natalia Bidart (nataliabidart)]

Looks great!

review: Approve

[Diego Sarmentero (diegosarmentero)]

+1

review: Approve

=== modified file 'ubuntu_sso/keyring/__init__.py'
--- ubuntu_sso/keyring/__init__.py	2011-03-03 15:19:29 +0000
+++ ubuntu_sso/keyring/__init__.py	2011-10-17 18:30:32 +0000
@@ -40,20 +40,27 @@
 }
 
 
+def gethostname():
+    """Get the hostname, encoded in utf-8."""
+    sys_encoding = sys.getfilesystemencoding()
+    hostname = socket.gethostname().decode(sys_encoding)
+    return hostname.encode("utf-8")
+
+
 def get_old_token_name(app_name):
     """Build the token name (old style)."""
     quoted_app_name = urllib.quote(app_name)
-    computer_name = socket.gethostname()
+    computer_name = gethostname()
     quoted_computer_name = urllib.quote(computer_name)
     return "%s - %s" % (quoted_app_name, quoted_computer_name)
 
 
 def get_token_name(app_name):
     """Build the token name."""
-    computer_name = socket.gethostname()
+    computer_name = gethostname().decode("utf-8")
     computer_name = computer_name.replace(TOKEN_SEPARATOR,
                                           SEPARATOR_REPLACEMENT)
-    return TOKEN_SEPARATOR.join((app_name, computer_name)).encode('utf-8')
+    return TOKEN_SEPARATOR.join((app_name, computer_name)).encode("utf-8")
 
 
 @inlineCallbacks
 
=== added file 'ubuntu_sso/keyring/tests/test_common.py'
--- ubuntu_sso/keyring/tests/test_common.py	1970-01-01 00:00:00 +0000
+++ ubuntu_sso/keyring/tests/test_common.py	2011-10-17 18:30:32 +0000
@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+#
+# test_keyring - tests for ubuntu_sso.keyring
+#
+# Author: Alejandro J. Cura <[e-mail]>
+# Author: Natalia B. Bidart <[e-mail]>
+#
+# Copyright 2010-2011 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/>.
+"""Tests for the keyring common module."""
+
+from twisted.trial.unittest import TestCase
+
+from ubuntu_sso import keyring
+
+
+class TestGetHostname(TestCase):
+    """Test the function that gets the hostname."""
+
+    def test_get_hostname(self):
+        """The common case."""
+        fake_hostname = "fake hostname"
+        self.patch(keyring.socket, "gethostname", lambda: fake_hostname)
+        self.assertEqual(keyring.gethostname(), fake_hostname)
+
+    def test_get_hostname_uses_filesystem_encoding(self):
+        """The fs encoding is used to decode the name returned by socket."""
+        fake_hostname = u"Привет-ПК"
+        hostname_koi8r = fake_hostname.encode("koi8-r")
+        hostname_utf8 = fake_hostname.encode("utf-8")
+        self.patch(keyring.socket, "gethostname", lambda: hostname_koi8r)
+        self.patch(keyring.sys, "getfilesystemencoding", lambda: "koi8-r")
+        self.assertEqual(keyring.gethostname(), hostname_utf8)
+
+
+class TestTokenNameBuilder(TestCase):
+    """Test the function that builds the token name."""
+
+    def check_build(self, sample_app_name, sample_hostname, expected_result):
+        """Check the build of a given token."""
+        self.patch(keyring, "gethostname", lambda *a: sample_hostname)
+        result = keyring.get_token_name(sample_app_name)
+        self.assertEqual(result, expected_result)
+
+    def test_get_simple_token_name(self):
+        """A simple token name is built right."""
+        sample_app_name = u"UbuntuTwo"
+        sample_hostname = "Darkstar"
+        expected_result = "UbuntuTwo @ Darkstar"
+        self.check_build(sample_app_name, sample_hostname, expected_result)
+
+    def test_get_complex_token_name_for_app_name(self):
+        """A complex token name is built right too."""
+        sample_app_name = u"Ubuntu @ Eleven"
+        sample_hostname = "Mate+Cocido"
+        expected_result = "Ubuntu @ Eleven @ Mate+Cocido"
+        self.check_build(sample_app_name, sample_hostname, expected_result)
+
+    def test_get_complex_token_name_for_hostname(self):
+        """A complex token name is built right too."""
+        sample_app_name = u"Ubuntu Eleven"
+        sample_hostname = "Mate @ Cocido"
+        expected_result = "Ubuntu Eleven @ Mate AT Cocido"
+        self.check_build(sample_app_name, sample_hostname, expected_result)
+
+    def test_get_unicode_appname_token_name(self):
+        """A token name with unicode in the app name."""
+        sample_app_name = u"Ubuntu 四百六十九"
+        sample_hostname = "Darkstar"
+        expected_result = u"Ubuntu 四百六十九 @ Darkstar".encode("utf-8")
+        self.check_build(sample_app_name, sample_hostname, expected_result)
+
+    def test_get_utf8_hostname_token_name(self):
+        """A token name with utf8 in the host name."""
+        sample_app_name = u"Ubuntu Eleven"
+        sample_hostname = u"Привет-ПК".encode("utf-8")
+        expected_result = u"Ubuntu Eleven @ Привет-ПК".encode("utf-8")
+        self.check_build(sample_app_name, sample_hostname, expected_result)
 
=== modified file 'ubuntu_sso/keyring/tests/test_linux.py'
--- ubuntu_sso/keyring/tests/test_linux.py	2011-03-18 09:30:20 +0000
+++ ubuntu_sso/keyring/tests/test_linux.py	2011-10-17 18:30:32 +0000
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# test_keyring - tests for ubuntu_sso.keyring
+# test_linux - tests for ubuntu_sso.keyring under linux
 #
 # Author: Alejandro J. Cura <[e-mail]>
 # Author: Natalia B. Bidart <[e-mail]>
@@ -20,8 +20,6 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Tests for the keyring.py module."""
 
-import socket
-
 from twisted.internet import defer
 from twisted.internet.defer import inlineCallbacks
 from twisted.trial.unittest import TestCase
@@ -31,11 +29,6 @@
 from ubuntu_sso.tests import APP_NAME
 
 
-def build_fake_gethostname(fake_hostname):
-    """Return a fake hostname getter."""
-    return lambda *a: fake_hostname
-
-
 class MockItem(object):
     """An item contains a secret, lookup attributes and has a label."""
 
@@ -116,43 +109,6 @@
         return defer.succeed(self.collections["default"])
 
 
-class TestTokenNameBuilder(TestCase):
-    """Test the method that builds the token name."""
-
-    def test_get_simple_token_name(self):
-        """A simple token name is built right."""
-        sample_app_name = "UbuntuTwo"
-        sample_hostname = "Darkstar"
-        expected_result = "UbuntuTwo @ Darkstar"
-
-        fake_gethostname = build_fake_gethostname(sample_hostname)
-        self.patch(socket, "gethostname", fake_gethostname)
-        result = keyring.get_token_name(sample_app_name)
-        self.assertEqual(result, expected_result)
-
-    def test_get_complex_token_name_for_app_name(self):
-        """A complex token name is built right too."""
-        sample_app_name = "Ubuntu @ Eleven"
-        sample_hostname = "Mate+Cocido"
-        expected_result = "Ubuntu @ Eleven @ Mate+Cocido"
-
-        fake_gethostname = build_fake_gethostname(sample_hostname)
-        self.patch(socket, "gethostname", fake_gethostname)
-        result = keyring.get_token_name(sample_app_name)
-        self.assertEqual(result, expected_result)
-
-    def test_get_complex_token_name_for_hostname(self):
-        """A complex token name is built right too."""
-        sample_app_name = "Ubuntu Eleven"
-        sample_hostname = "Mate @ Cocido"
-        expected_result = "Ubuntu Eleven @ Mate AT Cocido"
-
-        fake_gethostname = build_fake_gethostname(sample_hostname)
-        self.patch(socket, "gethostname", fake_gethostname)
-        result = keyring.get_token_name(sample_app_name)
-        self.assertEqual(result, expected_result)
-
-
 class TestKeyring(TestCase):
     """Test the keyring related functions."""
 
@@ -163,8 +119,7 @@
         self.mock_service = None
         self.service = self.patch(keyring, "SecretService",
                                   self.get_mock_service)
-        fake_gethostname = build_fake_gethostname("darkstar")
-        self.patch(socket, "gethostname", fake_gethostname)
+        self.patch(common_keyring, "gethostname", lambda: "darkstar")
 
     def get_mock_service(self):
         """Create only one instance of the mock service per test."""