Merge lp:~alecu/ubuntu-sso-client/extend-errdicts into lp:ubuntu-sso-client

[Alejandro J. Cura]

Turn exceptions into a dictionary able to go thru DBus (LP: #624018)

The lower DBus layer should pass the error messages sent by the webservice as DBus dictionaries, so the GUI can show the corresponding message next to each input field that failed the checks.

[lp:~alecu/ubuntu-sso-client/extend-errdicts]

588. By Alejandro J. Cura on 2010-08-25

the arguments for the exception are sent thru dbus as a value of the dict

[Natalia Bidart (nataliabidart)]

Awesome! Remember to put a commit message with the LP bug #. Thanks!

review: Approve

[Vincenzo Di Somma (vds)]

Looks good.

review: Approve

[Vincenzo Di Somma (vds)]

Looks good.

review: Approve

=== modified file 'ubuntu_sso/main.py'
--- ubuntu_sso/main.py	2010-08-24 14:13:53 +0000
+++ ubuntu_sso/main.py	2010-08-25 16:13:44 +0000
@@ -289,10 +289,18 @@
 
 def except_to_errdict(e):
     """Turn an exception into a dictionary to return thru DBus."""
-    return {
-        "errtype": type(e).__name__,
-        "message": "\n".join(str(arg) for arg in e.args),
+    result = {
+        "errtype": e.__class__.__name__,
+        "errargs": repr(e.args),
     }
+    if len(e.args) == 0:
+        result["message"] = e.__class__.__doc__
+    elif isinstance(e.args[0], dict):
+        result.update(e.args[0])
+    elif isinstance(e.args[0], basestring):
+        result["message"] = e.args[0]
+
+    return result
 
 
 def blocking(f, app_name, result_cb, error_cb):
@@ -302,7 +310,7 @@
         try:
             result_cb(app_name, f())
         except Exception, e:
-            msg = "Exception while running DBus blocking code in a thread."""
+            msg = "Exception while running DBus blocking code in a thread:"
             logger.exception(msg)
             error_cb(app_name, except_to_errdict(e))
     threading.Thread(target=_in_thread).start()

=== modified file 'ubuntu_sso/tests/test_main.py'
--- ubuntu_sso/tests/test_main.py	2010-08-24 13:46:12 +0000
+++ ubuntu_sso/tests/test_main.py	2010-08-25 16:13:44 +0000
@@ -735,6 +735,60 @@
         return d
 
 
+class TestExceptToErrdictException(Exception):
+    """A dummy exception for the following testcase."""
+
+
+class ExceptToErrdictTestCase(TestCase):
+    """Tests for the except_to_errdict function."""
+
+    def test_first_arg_is_dict(self):
+        """If the first arg is a dict, use it as the base dict."""
+        sample_dict = {
+            "errorcode1": "error message 1",
+            "errorcode2": "error message 2",
+            "errorcode3": "error message 3",
+        }
+        e = TestExceptToErrdictException(sample_dict)
+        result = except_to_errdict(e)
+
+        self.assertEqual(result["errtype"], e.__class__.__name__)
+        for k in sample_dict.keys():
+            self.assertIn(k, result)
+            self.assertEqual(result[k], sample_dict[k])
+
+    def test_first_arg_is_str(self):
+        """If the first arg is a str, use it as the message."""
+        sample_string = "a sample string"
+        e = TestExceptToErrdictException(sample_string)
+        result = except_to_errdict(e)
+        self.assertEqual(result["errtype"], e.__class__.__name__)
+        self.assertEqual(result["message"], sample_string)
+
+    def test_first_arg_is_unicode(self):
+        """If the first arg is a unicode, use it as the message."""
+        sample_string = u"a sample string"
+        e = TestExceptToErrdictException(sample_string)
+        result = except_to_errdict(e)
+        self.assertEqual(result["errtype"], e.__class__.__name__)
+        self.assertEqual(result["message"], sample_string)
+
+    def test_no_args_at_all(self):
+        """If there are no args, use the class docstring."""
+        e = TestExceptToErrdictException()
+        result = except_to_errdict(e)
+        self.assertEqual(result["errtype"], e.__class__.__name__)
+        self.assertEqual(result["message"], e.__class__.__doc__)
+
+    def test_some_other_thing_as_first_arg(self):
+        """If first arg is not basestring nor dict, then repr all args."""
+        sample_args = (None, u"unicode2\ufffd", "errorcode3")
+        e = TestExceptToErrdictException(*sample_args)
+        result = except_to_errdict(e)
+        self.assertEqual(result["errtype"], e.__class__.__name__)
+        self.assertEqual(result["errargs"], repr(sample_args))
+
+
 class KeyringCredentialsTestCase(MockerTestCase):
     """Checks the functions that access the keyring."""