Merge lp:~nskaggs/autopilot/catch-stateerror-printtree into lp:autopilot

[Thomi Richards]

Don't abort print_tree when we catch 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.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:442
http://jenkins.qa.ubuntu.com/job/autopilot-ci/665/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/391
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/391/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/393
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/393/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/300
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/300/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-autopilot/117
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty-autopilot/102
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4707
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4707/artifact/work/output/*zip*/output.zip

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

review: Needs Fixing (continuous-integration)

Unmerged revisions

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2014-04-01 00:44:23 +0000
+++ autopilot/introspection/dbus.py	2014-04-07 21:35:38 +0000
@@ -262,6 +262,7 @@
         # Thomi: 2014-03-20: There used to be a call to 'self.refresh_state()'
         # here. That's not needed, since the only thing we use is the proxy
         # path, which isn't affected by the current state.
+
         query = self.get_class_query_string() + "/*"
         state_dicts = self.get_state_by_path(query)
         children = [self.make_introspection_object(i) for i in state_dicts]
@@ -652,12 +653,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/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 21:35:38 +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,23 @@
             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
+            Error: Object not found with name 'child'.
+            """))
+
     def test_print_tree_fileobj(self):
         """print_tree with file object output"""