Autopilot

Reviewer	Review Type	Date Requested	Status
Nicholas Skaggs (community)			Approve on 2014-03-21
PS Jenkins bot	continuous-integration	2014-03-20	Needs Fixing on 2014-03-20
Chris Gagnon		2014-03-20	Pending
Thomi Richards		2014-03-20	Pending
Max Brustkern		2014-03-20	Pending
Review via email: mp+212053@code.launchpad.net

This proposal supersedes a proposal from 2014-02-05.

Commit message

Add support to complete dump even if a StateNotFound error occurs.

Description of the change

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.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-05: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:421
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~nskaggs/autopilot/catch-stateerror-printtree/+merge/204976/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/autopilot-ci/462/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/188/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/188/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2917/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2919/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Chris Gagnon (chris.gagnon) wrote on 2014-02-05: Posted in a previous version of this proposal

This needs tests

review: Needs Fixing

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-05: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:424
http://jenkins.qa.ubuntu.com/job/autopilot-ci/463/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/189/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/189/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2919/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2921/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-05: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:425
http://jenkins.qa.ubuntu.com/job/autopilot-ci/464/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/190/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/190/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2922/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2924/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-05: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:426
http://jenkins.qa.ubuntu.com/job/autopilot-ci/465/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/191/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/191/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/2926/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/2928/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-05: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2014-02-05: Posted in a previous version of this proposal

@ChrisGagnon, I'll try playing with AssertRaises to add a test for this path.

Revision history for this message

Thomi Richards (thomir-deactivatedaccount) wrote on 2014-02-09: Posted in a previous version of this proposal

Setting this back to a WIP MP since we all agree that it needs tests before being merged.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-20: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:432
http://jenkins.qa.ubuntu.com/job/autopilot-ci/502/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/228/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/228/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/137/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3367/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3369/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-24: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-24: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-25: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-25: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Thomi Richards (thomir-deactivatedaccount) wrote on 2014-02-26: Posted in a previous version of this proposal

at the end of your test, could you please add an assertion for the error message you expect to see?

Please set this MP back to 'Needs review' when you want another review.

Thanks

review: Needs Fixing

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2014-03-07: Posted in a previous version of this proposal

Argh, bzr lost my changes I made.. they never pushed I see. I'll redo.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-18: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-18: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-18: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Max Brustkern (nuclearbob) wrote on 2014-03-19: Posted in a previous version of this proposal

Seems reasonable to me.

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-19: Posted in a previous version of this proposal

FAILED: Continuous integration, rev:438
http://jenkins.qa.ubuntu.com/job/autopilot-ci/600/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/326/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/326/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/235/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-autopilot/52/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4154/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-19: Posted in a previous version of this proposal

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2014-03-20: Posted in a previous version of this proposal

I have concerns this may have introduced an issue with print_tree, which is not shown by the tests. The dump seems to get stuck in the regression loop. Namely the change from

for p in sorted(self.get_properties()):

for prop, value in sorted(self.get_properties().items()):

is the likely cause.

Can someone help setup a test object that contains a larger tree to vet these changes a bit better?

We create a fake object like so:

        fake_object = DBusIntrospectionObject(
            dict(id=[0, 123], path=[0, '/some/path'], text=[0, 'Hello']),
            '/some/path',
            Mock()
        )

I tried making the dict larger but failed. I'm missing something basic; how can i make a tree like this?

            == /some/path ==
            id: 123
            path: '/some/path'
            text: 'Hello'
                == /some/path/child ==
               id: 456
               path: '/some/path/child'
               text: 'Hello Child'
                == /some/path/child2 ==
               id: 789
               path: '/some/path/child2'
               text: 'Hello Child2'
            == /some/other/path ==
            id: 542
            path: '/some/other/path'
            text: 'Hello'

Revision history for this message

Thomi Richards (thomir-deactivatedaccount) wrote on 2014-03-20: Posted in a previous version of this proposal

Hi,

I doubt that turning this:

for p in sorted(self.get_properties()):

into this:

for prop, value in sorted(self.get_properties().items()):

Is the cause of your problems. You're correct though - we need a better way to create fake proxy objects. This is something I've been thinking about for a looong time.

I suggest that you merge in my branch, which already has many of the changes in here, and add your exception handling and test code.

lp:~nskaggs/autopilot/catch-stateerror-printtree updated on 2014-03-20

440. By Nicholas Skaggs on 2014-03-20: merge thomi's tweaks
441. By Nicholas Skaggs on 2014-03-20: tweak merge
442. By Nicholas Skaggs on 2014-03-20: fix spacing :-)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-20:

FAILED: Continuous integration, rev:441
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~nskaggs/autopilot/catch-stateerror-printtree/+merge/212053/+edit-commit-message

http://jenkins.qa.ubuntu.com/job/autopilot-ci/607/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-amd64-ci/333/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-armhf-ci/333/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-trusty-i386-ci/242/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-autopilot/59/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/4198/console

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2014-03-20:

Something in the tweaks breaks things:

Checkout this branch

lp:~nskaggs/ubuntu-calendar-app/test-print-tree

Running calendar_app.tests.test_calendar.TestMainView.test_dump takes about 100 seconds to do a good print. Under the proposed changes it seems to get stuck reexamining objects again and again, never finishing.

review: Needs Fixing

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-03-20:

FAILED: Continuous integration, rev:442
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~nskaggs/autopilot/catch-stateerror-printtree/+merge/212053/+edit-commit-message

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

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2014-03-21:

Thomi says I'm dreaming and it works for him, so +1.

review: Approve

Unmerged revisions

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Autopilot Hackers

Chris Gagnon

Nicholas Skaggs

 === modified file 'autopilot/introspection/dbus.py'
 --- autopilot/introspection/dbus.py	2014-03-20 21:26:27 +0000
 +++ autopilot/introspection/dbus.py	2014-03-20 21:26:27 +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]
@@ -661,12 +662,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-03-11 17:36:53 +0000
 +++ autopilot/tests/unit/test_introspection_features.py	2014-03-20 21:26:27 +0000
@@ -55,6 +55,7 @@
      _object_passes_filters,
      CustomEmulatorBase,
      DBusIntrospectionObject,
++    StateNotFoundError,
+ )
  from autopilot.utilities import sleep
@@ -305,6 +306,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"""