Merge lp:~veebers/autopilot/recursive-object-tree into lp:autopilot

[Christopher Lee]

Queries are now recursive from the node itself, not the root.

As per bug lp:1144288 queries were from the root 'downwards', now the query starts from the given node.

[Thomi Richards (thomir-deactivatedaccount)]

Still need to do:

1) Update docstring to mention that:
  a) The search is recursive
  b) The search starts with the node you call this method on.
  c) You must either specify a type name, or keyword parameters, or both.
     i) When this happens. Raise an exception.
     ii) Show doctest examples in the docstring for each scenarios.

2) Fix copyright header in autopilot/tests/test_dbus_query. Merge autopilot trunk and copy a header from another python file.

3) Fix docstring formatting on diff line 151 - closing quotes should be on a line by themselves, preceeded by a newline.

Things that are not tested:

Calling select_single with:
 * neither type name nor keyword parameters specified.
 * Type name specified that does not match anything in the tree (should return None)
 * keyword arguments specified that does not match anything in the tree (should return None)

Calling select single with a query that returns more than one item (must raise ValueError).

Calling select_many with:
 * Neither type name nor keyword arguments specified.
 * kwargs only.
 * a query that returns nothing.

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:171
http://jenkins.qa.ubuntu.com/job/autopilot-ci/38/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-raring-amd64-ci/38
    FAILURE: http://jenkins.qa.ubuntu.com/job/autopilot-raring-armhf-ci/37/console

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

review: Needs Fixing (continuous-integration)

[lp:~veebers/autopilot/recursive-object-tree]

172. By Christopher Lee on 2013-04-24

Added failing test

173. By Christopher Lee on 2013-04-24

Fixed failing tests

174. By Christopher Lee on 2013-04-26

Fixes re: MP comments. Formatting, documentation and extra tests.

175. By Christopher Lee on 2013-04-26

Merge trunk

176. By Christopher Lee on 2013-04-26

Updated license comment in test

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:176
http://jenkins.qa.ubuntu.com/job/autopilot-ci/40/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-raring-amd64-ci/40
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-raring-armhf-ci/39

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

review: Approve (continuous-integration)

[lp:~veebers/autopilot/recursive-object-tree]

177. By Christopher Lee on 2013-04-26

Further MP fixes, documentation and removed 'pick_app_launcher' in the test

[Thomi Richards (thomir-deactivatedaccount)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:177
http://jenkins.qa.ubuntu.com/job/autopilot-ci/41/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-raring-amd64-ci/41
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-raring-armhf-ci/40

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

review: Approve (continuous-integration)

=== modified file 'autopilot/introspection/__init__.py'
--- autopilot/introspection/__init__.py	2013-04-25 22:45:51 +0000
+++ autopilot/introspection/__init__.py	2013-04-26 02:36:26 +0000
@@ -268,55 +268,10 @@
 class ApplicationProxyObect(DBusIntrospectionObject):
     """A class that better supports query data from an application."""
 
-    def __init__(self, state, path_info=None):
-        super(ApplicationProxyObect, self).__init__(state, path_info)
+    def __init__(self, state, path):
+        super(ApplicationProxyObect, self).__init__(state, path)
         self._process = None
 
-    def select_single(self, type_name='*', **kwargs):
-        """Get a single node from the introspection tree, with type equal to
-        *type_name* and (optionally) matching the keyword filters present in
-        *kwargs*.
-
-        For example:
-
-        >>> app.select_single('QPushButton', objectName='clickme')
-        ... returns a QPushButton whose 'objectName' property is 'clickme'.
-
-        If nothing is returned from the query, this method returns None.
-
-        :raises: **ValueError** if the query returns more than one item. *If you
-         want more than one item, use select_many instead*.
-
-        """
-        instances = self.select_many(type_name, **kwargs)
-        if len(instances) > 1:
-            raise ValueError("More than one item was returned for query")
-        if not instances:
-            return None
-        return instances[0]
-
-    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
-        *kwargs*.
-
-        For example:
-
-        >>> app.select_many('QPushButton', enabled=True)
-        ... returns a list of QPushButtons that are enabled.
-
-        If you only want to get one item, use select_single instead.
-
-        """
-        logger.debug("Selecting objects of %s with attributes: %r",
-            'any type' if type_name == '*' else 'type ' + type_name,
-            kwargs)
-
-        path = "//%s" % type_name
-        state_dicts = self.get_state_by_path(path)
-        instances = [self.make_introspection_object(i) for i in state_dicts]
-        return filter(lambda i: object_passes_filters(i, **kwargs), instances)
-
     def set_process(self, process):
         """Set the subprocess.Popen object of the process that this is a proxy for.
 

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2013-04-23 04:15:54 +0000
+++ autopilot/introspection/dbus.py	2013-04-26 02:36:26 +0000
@@ -287,6 +287,76 @@
         children = [self.make_introspection_object(i) for i in state_dicts]
         return children
 
+    def select_single(self, type_name='*', **kwargs):
+        """Get a single node from the introspection tree, with type equal to
+        *type_name* and (optionally) matching the keyword filters present in
+        *kwargs*.
+        You must specify either *type_name*, keyword filters or both.
+
+        Searches recursively from the node this method is called on. For
+        example:
+
+        >>> app.select_single('QPushButton', objectName='clickme')
+        ... returns a QPushButton whose 'objectName' property is 'clickme'.
+
+        If nothing is returned from the query, this method returns None.
+
+        :raises: **ValueError** if the query returns more than one item. *If you
+         want more than one item, use select_many instead*.
+
+        :raises: **TypeError** if neither *type_name* or keyword filters are
+        provided.
+
+        """
+        instances = self.select_many(type_name, **kwargs)
+        if len(instances) > 1:
+            raise ValueError("More than one item was returned for query")
+        if not instances:
+            return None
+        return instances[0]
+
+    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
+        *kwargs*.
+        You must specify either *type_name*, keyword filters or both.
+
+        Searches recursively from the node this method is called on.
+
+        For example:
+
+        >>> app.select_many('QPushButton', enabled=True)
+        ... returns a list of QPushButtons that are enabled.
+
+        >>> file_menu = app.select_one('QMenu', title='File')
+        >>> file_menu.select_many('QAction')
+        ... returns a list of QAction objects who appear below file_menu in the
+        object tree.
+
+        If you only want to get one item, use select_single instead.
+
+        :raises: **TypeError** if neither *type_name* or keyword filters are
+        provided.
+
+        """
+        if type_name == "*" and not kwargs:
+            raise TypeError("You must specify either a type name or a filter.")
+
+        logger.debug("Selecting objects of %s with attributes: %r",
+            'any type' if type_name == '*' else 'type ' + type_name,
+            kwargs)
+
+        first_param = ''
+        if kwargs:
+            first_param = '[{}={}]'.format(*kwargs.popitem())
+        query_path = "%s//%s%s" % (self.get_class_query_string(),
+                                   type_name,
+                                   first_param)
+
+        state_dicts = self.get_state_by_path(query_path)
+        instances = [self.make_introspection_object(i) for i in state_dicts]
+        return filter(lambda i: object_passes_filters(i, **kwargs), instances)
+
     def refresh_state(self):
         """Refreshes the object's state from unity.
 

=== added file 'autopilot/tests/test_dbus_query.py'
--- autopilot/tests/test_dbus_query.py	1970-01-01 00:00:00 +0000
+++ autopilot/tests/test_dbus_query.py	2013-04-26 02:36:26 +0000
@@ -0,0 +1,161 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Autopilot Functional Test Tool
+# Copyright (C) 2012-2013 Canonical
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+
+import json
+import os
+from tempfile import mktemp
+
+from autopilot.testcase import AutopilotTestCase
+from testtools.matchers import Equals, NotEquals, raises
+
+
+class DbusQueryTests(AutopilotTestCase):
+    """A collection of dbus query tests for autopilot."""
+
+    def start_fully_featured_app(self):
+        """Create an application that includes menus and other nested
+        elements.
+
+        """
+        window_spec = {
+            "Menu": [
+                {
+                    "Title": "File",
+                    "Menu": [
+                        "Open",
+                        "Save",
+                        "Save As",
+                        "Quit"
+                    ]
+                },
+                {
+                    "Title": "Help",
+                    "Menu": [
+                        "Help 1",
+                        "Help 2",
+                        "Help 3",
+                        "Help 4"
+                    ]
+                }
+            ],
+            "Contents": "TextEdit"
+        }
+
+        file_path = mktemp()
+        json.dump(window_spec, open(file_path, 'w'))
+        self.addCleanup(os.remove, file_path)
+
+        return self.launch_test_application('window-mocker', file_path, app_type="qt")
+
+    def test_select_single_selects_only_available_object(self):
+        """Must be able to select a single unique object."""
+        app = self.start_fully_featured_app()
+        main_window = app.select_single('QMainWindow')
+        self.assertThat(main_window, NotEquals(None))
+
+    def test_single_select_on_object(self):
+        """Must be able to select a single unique child of an object."""
+        app = self.start_fully_featured_app()
+        main_win = app.select_single('QMainWindow')
+        menu_bar = main_win.select_single('QMenuBar')
+        self.assertThat(menu_bar, NotEquals(None))
+
+    def test_select_multiple_on_object_returns_all(self):
+        """Must be able to select all child objects."""
+        app = self.start_fully_featured_app()
+        main_win = app.select_single('QMainWindow')
+        menu_bar = main_win.select_single('QMenuBar')
+        menus = menu_bar.select_many('QMenu')
+        self.assertThat(len(menus), Equals(2))
+
+    def test_select_multiple_on_object_with_parameter(self):
+        """Must be able to select a specific object determined by a
+        parameter.
+
+        """
+        app = self.start_fully_featured_app()
+        main_win = app.select_single('QMainWindow')
+        menu_bar = main_win.select_single('QMenuBar')
+        help_menu = menu_bar.select_many('QMenu', title='Help')
+        self.assertThat(len(help_menu), Equals(1))
+        self.assertThat(help_menu[0].title, Equals('Help'))
+
+    def test_select_single_on_object_with_param(self):
+        """Must only select a single unique object using a parameter."""
+        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')
+        self.assertThat(help_menu, NotEquals(None))
+        self.assertThat(help_menu.title, Equals('Help'))
+
+    def test_select_many_uses_unique_object(self):
+        """Given 2 objects of the same type with childen, selection on one will
+        only get its children.
+
+        """
+        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))
+
+    def test_select_single_no_name_no_parameter_raises_exception(self):
+        app = self.start_fully_featured_app()
+        fn = lambda: app.select_single()
+        self.assertThat(fn, raises(TypeError))
+
+    def test_select_single_no_match_returns_none(self):
+        app = self.start_fully_featured_app()
+        failed_match = app.select_single("QMadeupType")
+        self.assertThat(failed_match, Equals(None))
+
+    def test_select_single_parameters_only(self):
+        app = self.start_fully_featured_app()
+        main_win = app.select_single('QMainWindow')
+        titled_help = main_win.select_single(title='Help')
+        self.assertThat(titled_help, NotEquals(None))
+        self.assertThat(titled_help.title, Equals('Help'))
+
+    def test_select_single_parameters_no_match_returns_none(self):
+        app = self.start_fully_featured_app()
+        failed_match = app.select_single(title="Non-existant object")
+        self.assertThat(failed_match, Equals(None))
+
+    def test_select_single_returning_multiple_raises(self):
+        app = self.start_fully_featured_app()
+        fn = lambda: app.select_single('QMenu')
+        self.assertThat(fn, raises(ValueError))
+
+    def test_select_many_no_name_no_parameter_raises_exception(self):
+        app = self.start_fully_featured_app()
+        fn = lambda: app.select_single()
+        self.assertThat(fn, raises(TypeError))
+
+    def test_select_many_only_using_parameters(self):
+        app = self.start_fully_featured_app()
+        many_help_menus = app.select_many(title='Help')
+        self.assertThat(len(many_help_menus), Equals(2))
+
+    def test_select_many_with_no_parameter_matches_returns_empty_list(self):
+        app = self.start_fully_featured_app()
+        failed_match = app.select_many('QMenu', title='qwerty')
+        self.assertThat(failed_match, Equals([]))