Merge lp:~mikemc/ubiquity/keyring-double-keynames into lp:~mikemc/ubiquity/main-u1

[Mike McCracken]

- Duplicate two keys in stored token for compatibility with v1 clients

- Duplicate two keys in stored token for compatibility with v1 clients

[Roberto Alsina (ralsina)]

8 lines of code, 59 lines of tests :-)

review: Approve

[lp:~mikemc/ubiquity/keyring-double-keynames]

5817. By Mike McCracken on 2013-03-01

merge with main-u1

[dobey (dobey)]

review: Approve

=== modified file 'tests/test_ubi_ubuntuone.py'
--- tests/test_ubi_ubuntuone.py	2013-02-27 16:08:49 +0000
+++ tests/test_ubi_ubuntuone.py	2013-03-01 19:02:21 +0000
@@ -102,7 +102,7 @@
 
 @patch('syslog.syslog', new=print)
 @patch.object(ubi_ubuntuone, 'get_token_name')
[e-mail](Gtk, 'main')
+@patch('gi.repository.Gtk')
 class NextButtonActionTestCase(BaseTestPageGtk):
 
     def _call_register(self, mock_token_name, create_success=True):
@@ -132,13 +132,13 @@
                 ml.assert_called_once_with("[e-mail]", "pw", 'tokenname',
                                            ubi_ubuntuone.PAGE_REGISTER)
 
-    def test_call_register_success(self, mock_gtk_main, mock_token_name):
+    def test_call_register_success(self, mock_gtk, mock_token_name):
         self._call_register(mock_token_name)
 
-    def test_call_register_err(self, mock_gtk_main, mock_token_name):
+    def test_call_register_err(self, mock_gtk, mock_token_name):
         self._call_register(mock_token_name, create_success=False)
 
-    def test_call_login(self, mock_gtk_main, mock_token_name):
+    def test_call_login(self, mock_gtk, mock_token_name):
         mock_token_name.return_value = 'tokenname'
 
         self.page.entry_existing_email.set_text("foo")
@@ -152,7 +152,7 @@
 
 
 @patch('syslog.syslog', new=print)
[e-mail](Gtk, 'main')
+@patch('gi.repository.Gtk')
 class SSOAPITestCase(BaseTestPageGtk):
 
     def _call_handle_done(self, status, response_body, action, from_page):
@@ -170,39 +170,39 @@
         self.assertEqual(self.page.notebook_main.get_current_page(),
                          from_page)
 
-    def test_handle_done_token_OK(self, mock_gtk_main):
-        expected_body = "TESTBODY"
-        self._call_handle_done(http.client.OK, expected_body,
-                               ubi_ubuntuone.TOKEN_CALLBACK_ACTION,
-                               ubi_ubuntuone.PAGE_REGISTER)
-        self.assertEqual(self.page.oauth_token_json,
-                         expected_body)
-
-    def test_handle_done_token_CREATED(self, mock_gtk_main):
-        expected_body = "TESTBODY"
-        self._call_handle_done(http.client.CREATED,
-                               expected_body,
-                               ubi_ubuntuone.TOKEN_CALLBACK_ACTION,
-                               ubi_ubuntuone.PAGE_REGISTER)
-        self.assertEqual(self.page.oauth_token_json,
-                         expected_body)
-
-    def test_handle_done_ping_OK(self, mock_gtk_main):
-        expected_body = "TESTBODY"
-        self._call_handle_done(http.client.OK, expected_body,
-                               ubi_ubuntuone.PING_CALLBACK_ACTION,
-                               ubi_ubuntuone.PAGE_REGISTER)
-        self.assertTrue(self.page.ping_successful)
-
-    def test_handle_done_ping_CREATED(self, mock_gtk_main):
-        expected_body = "TESTBODY"
-        self._call_handle_done(http.client.CREATED,
-                               expected_body,
-                               ubi_ubuntuone.PING_CALLBACK_ACTION,
-                               ubi_ubuntuone.PAGE_REGISTER)
-        self.assertTrue(self.page.ping_successful)
-
-    def test_handle_done_error_token(self, mock_gtk_main):
+    def test_handle_done_token_OK(self, mock_gtk):
+        expected_body = "TESTBODY"
+        self._call_handle_done(http.client.OK, expected_body,
+                               ubi_ubuntuone.TOKEN_CALLBACK_ACTION,
+                               ubi_ubuntuone.PAGE_REGISTER)
+        self.assertEqual(self.page.oauth_token_json,
+                         expected_body)
+
+    def test_handle_done_token_CREATED(self, mock_gtk):
+        expected_body = "TESTBODY"
+        self._call_handle_done(http.client.CREATED,
+                               expected_body,
+                               ubi_ubuntuone.TOKEN_CALLBACK_ACTION,
+                               ubi_ubuntuone.PAGE_REGISTER)
+        self.assertEqual(self.page.oauth_token_json,
+                         expected_body)
+
+    def test_handle_done_ping_OK(self, mock_gtk):
+        expected_body = "TESTBODY"
+        self._call_handle_done(http.client.OK, expected_body,
+                               ubi_ubuntuone.PING_CALLBACK_ACTION,
+                               ubi_ubuntuone.PAGE_REGISTER)
+        self.assertTrue(self.page.ping_successful)
+
+    def test_handle_done_ping_CREATED(self, mock_gtk):
+        expected_body = "TESTBODY"
+        self._call_handle_done(http.client.CREATED,
+                               expected_body,
+                               ubi_ubuntuone.PING_CALLBACK_ACTION,
+                               ubi_ubuntuone.PAGE_REGISTER)
+        self.assertTrue(self.page.ping_successful)
+
+    def test_handle_done_error_token(self, mock_gtk):
         expected_body = json.dumps({"message": "tstmsg"})
         # GONE or anything other than OK/CREATED:
         self._call_handle_done(http.client.GONE, expected_body,
@@ -212,7 +212,7 @@
         self.assertEqual(self.page.label_global_error.get_text(),
                          "tstmsg")
 
-    def test_handle_done_error_ping(self, mock_gtk_main):
+    def test_handle_done_error_ping(self, mock_gtk):
         expected_body = "error"
         with patch.object(self.page.label_global_error,
                           'get_text') as mock_get_text:
@@ -226,7 +226,7 @@
                              "err")
 
     @patch('json.dumps')
-    def test_login_to_sso(self, mock_json_dumps, mock_gtk_main):
+    def test_login_to_sso(self, mock_json_dumps, mock_gtk):
         email = 'email'
         password = 'pass'
         token_name = 'tok'
@@ -266,7 +266,7 @@
             self.assertEqual(mocks['session'].mock_calls, e)
 
     @patch('json.dumps')
-    def test_register_new_sso_account(self, mock_json_dumps, mock_gtk_main):
+    def test_register_new_sso_account(self, mock_json_dumps, mock_gtk):
         email = 'email'
         password = 'pass'
         displayname = 'mr tester'
@@ -306,7 +306,7 @@
     @patch('json.loads')
     @patch.multiple(ubi_ubuntuone, Client=DEFAULT, get_ping_info=DEFAULT)
     def test_ping_u1_url(self, mock_json_loads,
-                         mock_gtk_main, Client, get_ping_info):
+                         mock_gtk, Client, get_ping_info):
 
         from_page = 1
         email = 'email'
@@ -354,15 +354,29 @@
 
 class CreateKeyringTestCase(BaseTestPageGtk):
 
+    def test_duplicate_token_data_for_v1(self):
+        token = dict(token_key="token_key",
+                     token_name="token_name",
+                     other_key="other")
+        newtoken = self.page._duplicate_token_data_for_v1(token)
+        self.assertEqual(newtoken["token"], "token_key")
+        self.assertEqual(newtoken["name"], "token_name")
+        self.assertEqual(newtoken["other_key"], "other")
+
     @patch('ubiquity.misc.drop_all_privileges', sentinel.drop_privs)
     @patch('subprocess.PIPE', sentinel.PIPE)
     @patch('subprocess.Popen')
     @patch('os.environ.get')
     def test_create_keyring_urlencoded(self, mock_os_env_get, mock_Popen):
         mock_os_env_get.return_value = 'cmd'
-        d_json = json.dumps({'A': 'b/f'})
+        fake_token_dict = {'A': 'b/f'}
+        d_json = json.dumps(fake_token_dict)
         self.page._user_password = "test password"
-        self.page._create_keyring_and_store_u1_token(d_json)
+        with patch.object(self.page,
+                          '_duplicate_token_data_for_v1') as mock_dup:
+            mock_dup.side_effect = lambda x: x
+            self.page._create_keyring_and_store_u1_token(d_json)
+            mock_dup.assert_called_once_with(fake_token_dict)
 
         mock_Popen.assert_called_with(['cmd'], stdin=sentinel.PIPE,
                                       preexec_fn=sentinel.drop_privs)

=== modified file 'ubiquity/plugins/ubi-ubuntuone.py'
--- ubiquity/plugins/ubi-ubuntuone.py	2013-03-01 13:43:35 +0000
+++ ubiquity/plugins/ubi-ubuntuone.py	2013-03-01 19:02:21 +0000
@@ -316,6 +316,14 @@
 
         return False
 
+    def _duplicate_token_data_for_v1(self, token_dict):
+        """Duplicate two keys in the stored token, for compatibility
+         with clients expecting V1 API keys. See bug LP: #1136590 to
+         check if we can remove this."""
+        token_dict['token'] = token_dict['token_key']
+        token_dict['name'] = token_dict['token_name']
+        return token_dict
+
     def _create_keyring_and_store_u1_token(self, token_json):
         """Helper that spawns a external helper to create the keyring"""
         # this needs to be a external helper as ubiquity is running as
@@ -324,6 +332,7 @@
         # gnome-keyring daemon
 
         token_dict = json.loads(token_json)
+        token_dict = self._duplicate_token_data_for_v1(token_dict)
         urlencoded_token = urlencode(token_dict)
 
         cmd = os.environ.get("U1_KEYRING_HELPER",