Merge lp:~veebers/autopilot/introspection-using-paths into lp:autopilot

[Christopher Lee]

Changes to xpathselect mean that the dbus tuple returns the objects full path (was just the object name).

Changes to xpathselect mean that the dbus tuple returns the objects full path (was just the object name).

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[lp:~veebers/autopilot/introspection-using-paths]

166. By Christopher Lee on 2013-04-22

fix use of path_info

167. By Christopher Lee on 2013-04-22

Update recommends version

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

review: Approve

=== modified file 'autopilot/introspection/__init__.py'
--- autopilot/introspection/__init__.py	2013-04-12 03:53:14 +0000
+++ autopilot/introspection/__init__.py	2013-04-22 02:07:28 +0000
@@ -32,6 +32,7 @@
     DBusIntrospectionObject,
     object_passes_filters,
     get_session_bus,
+    get_classname_from_path,
     )
 from autopilot.utilities import get_debug_logger, addCleanup
 
@@ -238,7 +239,8 @@
     """Return the class name and root state dictionary."""
     dbus_object = get_session_bus().get_object(service_name, obj_path)
     dbus_iface = dbus.Interface(dbus_object, AP_INTROSPECTION_IFACE)
-    return dbus_iface.GetState("/")[0]
+    object_path, object_state = dbus_iface.GetState("/")[0]
+    return get_classname_from_path(object_path), object_state
 
 
 class ApplicationProxyObect(DBusIntrospectionObject):

=== modified file 'autopilot/introspection/dbus.py'
--- autopilot/introspection/dbus.py	2013-04-05 05:10:14 +0000
+++ autopilot/introspection/dbus.py	2013-04-22 02:07:28 +0000
@@ -99,6 +99,10 @@
     return {k.replace('-','_'):v for k,v in state_dict.iteritems() }
 
 
+def get_classname_from_path(object_path):
+    return object_path.split("/")[-1]
+
+
 def object_passes_filters(instance, **kwargs):
     """Return true if *instance* satisifies all the filters present in kwargs."""
     with instance.no_automatic_refreshing():
@@ -124,16 +128,11 @@
     DBUS_SERVICE = None
     DBUS_OBJECT = None
 
-    def __init__(self, state_dict, path_info=None):
+    def __init__(self, state_dict, path):
         self.__state = {}
         self.__refresh_on_attribute = True
         self.set_properties(state_dict)
-        if path_info is None:
-            logger.warning("Constructing object '%s' without path information. This will make \
-queries on this object, and all child objects considerably slower." % self.__class__.__name__)
-            logger.warning("To avoid this, make sure objects are _not_ constructed with the \
-get_all_instances(...) class method.")
-        self.path_info = path_info
+        self.path = path
 
     def set_properties(self, state_dict):
         """Creates and set attributes of *self* based on contents of *state_dict*.
@@ -180,7 +179,7 @@
 
             time_left = timeout
             while True:
-                name, new_state = self.parent.get_new_state()
+                _, new_state = self.parent.get_new_state()
                 new_state = translate_state_keys(new_state)
                 new_value = new_state[self.name]
                 # Support for testtools.matcher classes:
@@ -274,8 +273,7 @@
 
         query = self.get_class_query_string() + "/*"
         state_dicts = self.get_state_by_path(query)
-        path_info = self.path_info + "/" if self.path_info else None
-        children = [self.make_introspection_object(i, path_info) for i in state_dicts]
+        children = [self.make_introspection_object(i) for i in state_dicts]
         return children
 
     def refresh_state(self):
@@ -284,7 +282,7 @@
         :raises: **StateNotFound** if the object in unity has been destroyed.
 
         """
-        name, new_state = self.get_new_state()
+        _, new_state = self.get_new_state()
         self.set_properties(new_state)
 
     @classmethod
@@ -313,7 +311,7 @@
         if len(instances) != 1:
             logger.error("Could not retrieve root object.")
             return None
-        return cls.make_introspection_object(instances[0], "/")
+        return cls.make_introspection_object(instances[0])
 
     def __getattr__(self, name):
         # avoid recursion if for some reason we have no state set (should never
@@ -362,34 +360,22 @@
 
     def get_class_query_string(self):
         """Get the XPath query string required to refresh this class's state."""
-        if self.path_info is None:
-            return "//%s[id=%d]" % (self.__class__.__name__, self.id)
-        else:
-            return self.path_info + "[id=%d]" % self.id
+        return self.path + "[id=%d]" % self.id
 
     @classmethod
-    def make_introspection_object(cls, dbus_tuple, path_info=None):
-        """Make an introspection object given a DBus tuple of (name, state_dict).
-
-        The optional 'path_info' parameter can be set to a string that contains
-        the full, absolute path in the introspection tree to this object.
+    def make_introspection_object(cls, dbus_tuple):
+        """Make an introspection object given a DBus tuple of (path, state_dict).
 
         This only works for classes that derive from DBusIntrospectionObject.
         """
-        name, state = dbus_tuple
+        path, state = dbus_tuple
+        name = get_classname_from_path(path)
         try:
             class_type = _object_registry[name]
         except KeyError:
             logger.warning("Generating introspection instance for type '%s' based on generic class.", name)
             class_type = type(str(name), (cls,), {})
-        if isinstance(path_info, basestring):
-            if not path_info.endswith(name):
-                if not path_info.endswith("/"):
-                    logger.error("path_info must end with '/' or class name.")
-                    path_info = None
-                else:
-                    path_info += name
-        return class_type(state, path_info)
+        return class_type(state, path)
 
     @contextmanager
     def no_automatic_refreshing(self):

=== modified file 'debian/control'
--- debian/control	2013-04-17 22:02:14 +0000
+++ debian/control	2013-04-22 02:07:28 +0000
@@ -38,8 +38,8 @@
          python-xdg,
          python-xlib,
          python-zeitgeist,
-Recommends: libautopilot-gtk,
-            libautopilot-qt,
+Recommends: libautopilot-gtk (>= 1.3),
+            libautopilot-qt (>= 1.3),
 Description: Utility to write and run integration tests easily
  The autopilot engine enables to ease the writing of python tests
  for your application manipulating your inputs like the mouse and