Merge lp:~nataliabidart/ubuntu-sso-client/reformat-tokens into lp:ubuntu-sso-client

[Natalia Bidart]

Token name is now built using '@'. Old quoted tokens are migrated to the new names (LP: #628158).

Token name is now built using '@'. Old quoted tokens are migrated to the new names (though the token name is not modified in the SSO side).

[Alejandro J. Cura (alecu)]

Looks great.

review: Approve

[lp:~nataliabidart/ubuntu-sso-client/reformat-tokens]

611. By Natalia Bidart on 2010-09-01

Fixing typos.

[Roman Yepishev (rye)]

"Ubuntu One @ buzz" - looks great! Thanks!

review: Approve (fieldtest)

=== modified file 'ubuntu_sso/keyring.py'
--- ubuntu_sso/keyring.py	2010-08-26 20:56:29 +0000
+++ ubuntu_sso/keyring.py	2010-09-01 20:41:39 +0000
@@ -28,6 +28,10 @@
 from ubuntu_sso.logger import setupLogging
 logger = setupLogging("ubuntu_sso.main")
 
+
+TOKEN_SEPARATOR = ' @ '
+SEPARATOR_REPLACEMENT = ' AT '
+
 U1_APP_NAME = "Ubuntu One"
 U1_KEY_NAME = "UbuntuOne token for https://ubuntuone.com"
 U1_KEY_ATTR = {
@@ -36,14 +40,22 @@
 }
 
 
-def get_token_name(app_name):
-    """Build the token name."""
+def get_old_token_name(app_name):
+    """Build the token name (old style)."""
     quoted_app_name = urllib.quote(app_name)
     computer_name = socket.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 = computer_name.replace(TOKEN_SEPARATOR,
+                                          SEPARATOR_REPLACEMENT)
+    return TOKEN_SEPARATOR.join((app_name, computer_name)).encode('utf-8')
+
+
 class Keyring(object):
     """A Keyring for a given application name."""
     KEYRING_NAME = "login"
@@ -61,12 +73,14 @@
         if not name in keyring_names:
             gnomekeyring.create_sync(name)
 
-    def _find_keyring_item(self):
+    def _find_keyring_item(self, attr=None):
         """Return the keyring item or None if not found."""
+        if attr is None:
+            attr = self._get_keyring_attr()
         try:
             items = gnomekeyring.find_items_sync(
                                         gnomekeyring.ITEM_GENERIC_SECRET,
-                                        self._get_keyring_attr())
+                                        attr)
         except gnomekeyring.NoMatchError:
             # if no items found, return None
             return None
@@ -98,10 +112,24 @@
                 gnomekeyring.ITEM_GENERIC_SECRET, self.app_name,
                 self._get_keyring_attr(), secret, True)
 
+    def _migrate_old_token_name(self):
+        """Migrate credentials with old name, store them with new name."""
+        attr = self._get_keyring_attr()
+        attr['token-name'] = get_old_token_name(self.app_name)
+        item = self._find_keyring_item(attr=attr)
+        if item is not None:
+            self.set_ubuntusso_attr(dict(urlparse.parse_qsl(item.secret)))
+            gnomekeyring.item_delete_sync(item.keyring, item.item_id)
+
+        return self._find_keyring_item()
+
     def get_ubuntusso_attr(self):
         """Return the secret of the SSO item in a dictionary."""
         # If we have no attributes, return None
         item = self._find_keyring_item()
+        if item is None:
+            item = self._migrate_old_token_name()
+
         if item is not None:
             return dict(urlparse.parse_qsl(item.secret))
         else:

=== modified file 'ubuntu_sso/tests/test_keyring.py'
--- ubuntu_sso/tests/test_keyring.py	2010-08-26 20:56:29 +0000
+++ ubuntu_sso/tests/test_keyring.py	2010-09-01 20:41:39 +0000
@@ -1,6 +1,7 @@
 # test_keyring - tests for ubuntu_sso.keyring
 #
 # Author: Alejandro J. Cura <[e-mail]>
+# Author: Natalia B. Bidart <[e-mail]>
 #
 # Copyright 2010 Canonical Ltd.
 #
@@ -26,6 +27,8 @@
 
 from ubuntu_sso import keyring
 
+APP_NAME = 'Yadda Yadda Doo'
+
 
 def build_fake_gethostname(fake_hostname):
     """Return a fake hostname getter."""
@@ -106,18 +109,29 @@
         """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(self):
+        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%20Eleven - Mate%2BCocido"
+        sample_hostname = "Mate @ Cocido"
+        expected_result = "Ubuntu Eleven @ Mate AT Cocido"
 
         fake_gethostname = build_fake_gethostname(sample_hostname)
         self.patch(socket, "gethostname", fake_gethostname)
@@ -167,6 +181,16 @@
         result = keyring.Keyring("appname").get_ubuntusso_attr()
         self.assertEqual(result, sample_creds)
 
+    def test_get_credentials_migrating_token(self):
+        """Test that credentials are properly retrieved and migrated."""
+        sample_creds = {"name": "sample creds name"}
+        obj = keyring.Keyring(APP_NAME)
+        obj.token_name = keyring.get_old_token_name(APP_NAME)
+        obj.set_ubuntusso_attr(sample_creds)
+
+        result = keyring.Keyring(APP_NAME).get_ubuntusso_attr()
+        self.assertEqual(result, sample_creds)
+
     def test_get_old_cred_found(self):
         """The method returns a new set of creds if old creds are found."""
         sample_oauth_token = "sample oauth token"