Merge lp:~chris.gagnon/autopilot/select_many_length into lp:~autopilot/autopilot/temp-dev

[Chris Gagnon]

add length param to select_many, it will wait for a specified number of objects to be found

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:488
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/126/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/87
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/87/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/87
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/87/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/87
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/87/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-autopilot/133
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-touch/114
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/137
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/533
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/533/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/882
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/882/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6683
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7641

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

review: Approve (continuous-integration)

[Chris Gagnon (chris.gagnon)]

We might want to make this it's own function, what if a qml property's name is length?

something like wait_select_many(6, 'Label', visible=True)

instead of this merge proposal's select_many('Label', length=6 visible=True)

let me know what you think.

[lp:~chris.gagnon/autopilot/select_many_length]

489. By Chris Gagnon on 2014-05-24

Their might be a length kwarg, use wait_select_many instead

490. By Chris Gagnon on 2014-05-25

undo doc string in select_many which moved to wait_select_many

491. By Chris Gagnon on 2014-05-25

update to doc string

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:491
http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-ci/128/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/89
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-amd64-ci/89/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/89
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-armhf-ci/89/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/89
        deb: http://jenkins.qa.ubuntu.com/job/autopilot-autopilot-temp-dev-utopic-i386-ci/89/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-autopilot/135
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-utopic-touch/116
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-utopic-autopilot/165
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/535
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-amd64/535/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/884
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-utopic-armhf/884/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/6710
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/7670

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

review: Approve (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

Hmm, I'm not sure about this.

I'm concerned that we're adding a parameter to the existing API, making it harder to use, and harder to understand.

I wonder if we can achieve this with a matcher instead? How about something like:

--
from testtools.matchers import AfterProcessing, HasLength

self.assertThat(
    AfterProcessing(lambda: proxy.select_many('Foo')),
    Eventually(HasLength(5))
)
--

[Chris Gagnon (chris.gagnon)]

I want to use this in a custom proxy object, so we can't use assertThat

[Chris Gagnon (chris.gagnon)]

thomi mentioned this test https://github.com/testing-cabal/testtools/pull/70 so I'll work on getting this abandon merge request in.

Unmerged revisions

491. By Chris Gagnon on 2014-05-25

update to doc string

490. By Chris Gagnon on 2014-05-25

undo doc string in select_many which moved to wait_select_many

489. By Chris Gagnon on 2014-05-24

Their might be a length kwarg, use wait_select_many instead

488. By Chris Gagnon on 2014-05-24

add length param to select_many to wait for specified number of objects to be returned

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2014-05-13 05:03:21 +0000
+++ autopilot/introspection/dbus.py	2014-05-25 06:43:18 +0000
@@ -302,6 +302,91 @@
                     raise
                 sleep(1)
 
+    def wait_select_many(
+            self,
+            num_of_objects_to_wait_for,
+            type_name='*',
+            **kwargs
+    ):
+        """Wait for a number of objects from the introspection tree,
+        retrying until the specified number of objects to wait for are found
+
+        This method is used in the same way :meth:`select_many` method, except
+        that this method will poll the application under test for 10 seconds.
+        It should be used only when you need to wait for a specific number of
+        objects matching *type_name* and (optionally) matching the keywordi
+        filters present in *kwargs*.
+
+        You must specify num_of_objects_to_wait_for and either *type_name*,
+        keyword filters or both.
+
+        This method searches recursively from the instance this method is
+        called on. Calling :meth:`wait_select_many` on the application (root)
+        proxy object will search the entire tree. Calling
+        :meth:`wait_select_many` on an object in the tree will only search
+        it's descendants.
+
+        Example Usage::
+
+            app.wait_select_many(5, 'QPushButton', enabled=True)
+            # returns a list of QPushButtons that are enabled, when 5
+            # enabled QPushButtons are found.
+
+        As mentioned above, this method searches the object tree recursively::
+
+            file_menu = app.select_one('QMenu', title='File')
+            file_menu.wait_select_many(5, 'QAction')
+            # returns a list of QAction objects who appear below file_menu in
+            # the object tree when 5 Action objects appear below file_menu.
+
+        .. warning::
+            The order in which objects are returned is not guaranteed. It is
+            bad practise to write tests that depend on the order in which
+            this method returns objects. (see :ref:`object_ordering` for more
+            information).
+
+        If you only want to get one item, use :meth:`wait_select_single`
+        instead.
+
+        :param type_name: Either a string naming the type you want, or a class
+            of the appropriate type (the latter case is for overridden emulator
+            classes).
+        :param num_of_objects_to_wait_for: the number of objects in query to
+        wait for
+
+        :raises ValueError: if neither *type_name* or keyword filters are
+            provided.
+
+        :raises RuntimeError: if the specified number of objects are not
+            found after waiting for them.
+
+        .. seealso::
+            Tutorial Section :ref:`custom_proxy_classes`
+
+        """
+        type_name_str = get_type_name(type_name)
+        new_query = self._query.select_descendant(
+            type_name_str,
+            kwargs
+        )
+        _logger.debug(
+            "Selecting objects of %s with attributes: %r",
+            'any type'
+            if type_name_str == '*' else 'type ' + type_name_str, kwargs
+        )
+        for i in range(self._poll_time):
+            instances = self._execute_query(new_query)
+            if len(instances) == num_of_objects_to_wait_for:
+                return instances
+            sleep(1)
+        raise RuntimeError(
+            "Not enough objects were found. "
+            "Number of objects found {}, expected length={}".format(
+                len(instances),
+                num_of_objects_to_wait_for
+            )
+        )
+
     def select_many(self, type_name='*', **kwargs):
         """Get a list of nodes from the introspection tree, with type equal to
         *type_name* and (optionally) matching the keyword filters present in

=== modified file 'autopilot/tests/functional/test_dbus_query.py'
--- autopilot/tests/functional/test_dbus_query.py	2014-04-28 12:05:31 +0000
+++ autopilot/tests/functional/test_dbus_query.py	2014-05-25 06:43:18 +0000
@@ -138,6 +138,38 @@
         actions = help_menu.select_many('QAction')
         self.assertThat(len(actions), Equals(5))
 
+    def test_wait_select_many_is_not_enough_raises_runtime_error(self):
+        """wait_select_many must return RunTimeError when number of objects
+        to wait for is greater than number of instances returned
+
+        """
+        app = self.start_fully_featured_app()
+        main_win = app.select_single('QMainWindow')
+        menu_bar = main_win.select_single('QMenuBar')
+        help_menu = menu_bar.select_single('QMenu', title='Help')
+        actions = help_menu.select_many('QAction')
+        self.assertThat(len(actions), Equals(5))
+        fn = lambda: help_menu.wait_select_many(6, 'QAction')
+        self.assertThat(fn, raises(RuntimeError))
+
+    def test_wait_select_many_finds_all_objects(self):
+        app = self.start_fully_featured_app()
+        main_win = app.select_single('QMainWindow')
+        menu_bar = main_win.select_single('QMenuBar')
+        help_menu = menu_bar.select_single('QMenu', title='Help')
+        actions = help_menu.wait_select_many(5, 'QAction')
+        self.assertThat(len(actions), Equals(5))
+
+    def test_wait_select_many_no_parameters_raises_exception(self):
+        app = self.start_fully_featured_app()
+        fn = lambda: app.wait_select_many()
+        self.assertThat(fn, raises(TypeError))
+
+    def test_wait_select_many_no_name_no_parameter_raises_exception(self):
+        app = self.start_fully_featured_app()
+        fn = lambda: app.wait_select_many(5)
+        self.assertThat(fn, raises(ValueError))
+
     def test_select_single_no_name_no_parameter_raises_exception(self):
         app = self.start_fully_featured_app()
         fn = lambda: app.select_single()