Merge lp:~thomir-deactivatedaccount/autopilot/catch-stateerror-printtree into lp:autopilot

[Thomi Richards]

Don't abort print_tree when we catch the StateNotFoundError exception.

Dumping the object tree with print_tree often fails to complete due to StateNotFound errors. This modifies the print call to catch these errors and continue to print the largest possible tree. Other errors could be considered as well to try and print as complete a dump as possible.

[Thomi Richards (thomir-deactivatedaccount)]

LGTM, but since this is now some of my code, I'm abstaining.

review: Abstain

[lp:~thomir-deactivatedaccount/autopilot/catch-stateerror-printtree]

445. By Thomi Richards on 2014-04-07

Fix flake8 error.

446. By Thomi Richards on 2014-04-07

Fix test to print all the properties.

[Christopher Lee (veebers)]

LGTM

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:444
http://jenkins.qa.ubuntu.com/job/autopilot-ci/666/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/392/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/394/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/301/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-autopilot/118/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4708/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/autopilot-ci/666/rebuild

review: Needs Fixing (continuous-integration)

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2014-04-01 00:44:23 +0000
+++ autopilot/introspection/dbus.py	2014-04-07 23:07:16 +0000
@@ -652,12 +652,15 @@
         else:
             properties = self.get_properties()
         # print properties
-        for key in sorted(properties.keys()):
-            output.write("%s%s: %r\n" % (indent, key, properties[key]))
-        # print children
-        if maxdepth is None or _curdepth < maxdepth:
-            for c in self.get_children():
-                c.print_tree(output, maxdepth, _curdepth + 1)
+        try:
+            for key in sorted(properties.keys()):
+                output.write("%s%s: %r\n" % (indent, key, properties[key]))
+            # print children
+            if maxdepth is None or _curdepth < maxdepth:
+                for c in self.get_children():
+                    c.print_tree(output, maxdepth, _curdepth + 1)
+        except StateNotFoundError as error:
+            output.write("%sError: %s\n" % (indent, error))
 
     @contextmanager
     def no_automatic_refreshing(self):

=== modified file 'autopilot/introspection/types.py'
--- autopilot/introspection/types.py	2014-04-01 00:46:18 +0000
+++ autopilot/introspection/types.py	2014-04-07 23:07:16 +0000
@@ -46,7 +46,7 @@
 import six
 
 from autopilot.introspection.utilities import translate_state_keys
-from autopilot.utilities import sleep, compatible_repr, cached_result
+from autopilot.utilities import sleep, compatible_repr
 
 
 logger = logging.getLogger(__name__)

=== modified file 'autopilot/tests/unit/test_introspection_features.py'
--- autopilot/tests/unit/test_introspection_features.py	2014-04-01 01:30:00 +0000
+++ autopilot/tests/unit/test_introspection_features.py	2014-04-07 23:07:16 +0000
@@ -61,6 +61,7 @@
     _try_custom_proxy_classes,
     CustomEmulatorBase,
     DBusIntrospectionObject,
+    StateNotFoundError,
 )
 from autopilot.introspection.qt import QtObjectProxyMixin
 import autopilot.introspection as _i
@@ -313,6 +314,25 @@
             text: 'Hello'
             """))
 
+    def test_print_tree_exception(self):
+        """print_tree with StateNotFound exception"""
+
+        fake_object = self._print_test_fake_object()
+        child = Mock()
+        child.print_tree.side_effect = StateNotFoundError('child')
+
+        with patch.object(fake_object, 'get_children', return_value=[child]):
+            out = StringIO()
+            print_func = lambda: fake_object.print_tree(out)
+            self.assertThat(print_func, Not(Raises(StateNotFoundError)))
+            self.assertEqual(out.getvalue(), dedent("""\
+            == /some/path ==
+            id: 123
+            path: '/some/path'
+            text: 'Hello'
+            Error: Object not found with name 'child'.
+            """))
+
     def test_print_tree_fileobj(self):
         """print_tree with file object output"""