Merge lp:~thomir-deactivatedaccount/autopilot/fix-for-1172914 into lp:autopilot

[Thomi Richards]

Make it easier to specify an introspection type.

Make it easier to specify an introspection type.

[lp:~thomir-deactivatedaccount/autopilot/fix-for-1172914]

174. By Thomi Richards on 2013-04-25

whitespace fix.

[PS Jenkins bot (ps-jenkins)]

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

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

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good to me.

review: Approve

=== modified file 'autopilot/introspection/__init__.py'
--- autopilot/introspection/__init__.py	2013-04-23 21:07:58 +0000
+++ autopilot/introspection/__init__.py	2013-04-25 23:06:25 +0000
@@ -72,6 +72,19 @@
     return None
 
 
+def get_application_launcher_from_string_hint(hint):
+    """Return in instance of :class:`ApplicationLauncher` given a string hint."""
+    from autopilot.introspection.qt import QtApplicationLauncher
+    from autopilot.introspection.gtk import GtkApplicationLauncher
+
+    hint = hint.lower()
+    if hint == 'qt':
+        return QtApplicationLauncher()
+    elif hint == 'gtk':
+        return GtkApplicationLauncher()
+    return None
+
+
 def launch_application(launcher, application, *arguments, **kwargs):
     """Launch an application, and return a process object.
 
@@ -117,7 +130,7 @@
 
 
 def launch_process(application, args, capture_output, **kwargs):
-    """Launch an autopilot-enabled process and return the proxy object."""
+    """Launch an autopilot-enabled process and return the process object."""
     commandline = [application]
     commandline.extend(args)
     logger.info("Launching process: %r", commandline)

=== modified file 'autopilot/testcase.py'
--- autopilot/testcase.py	2013-04-23 21:07:58 +0000
+++ autopilot/testcase.py	2013-04-25 23:06:25 +0000
@@ -22,8 +22,6 @@
 
 from __future__ import absolute_import
 
-from dbus import DBusException
-from gi.repository import Gio
 import logging
 import os
 import signal
@@ -39,9 +37,9 @@
 from autopilot.input import Keyboard, Mouse
 from autopilot.introspection import (
     get_application_launcher,
+    get_application_launcher_from_string_hint,
     get_autopilot_proxy_object_for_process,
     launch_application,
-    launch_process,
     )
 from autopilot.display import Display
 from autopilot.globals import on_test_started
@@ -237,19 +235,37 @@
         is launched.
 
         This method is designed to be flexible enough to launch all supported
-        types of applications. For example, to launch a traditional Gtk application,
-        a test might start with::
+        types of applications. Autopilot can automatically determine how to enable
+        introspection support for dynamically linked binary applications. For
+        example, to launch a binary Gtk application, a test might start with::
 
             app_proxy = self.launch_test_application('gedit')
 
-        ... a Qt4 Qml application might be launched like this::
+        Applications can be given command line arguments by supplying positional
+        arguments to this method. For example, if we want to launch ``gedit``
+        with a certain document loaded, we might do this::
 
-            app_proxy = self.launch_test_application('qmlviewer', 'my_scene.qml')
+            app_proxy = self.launch_test_application('gedit', '/tmp/test-document.txt')
 
         ... a Qt5 Qml application is launched in a similar fashion::
 
             app_proxy = self.launch_test_application('qmlscene', 'my_scene.qml')
 
+        If you wish to launch an application that is not a dynamically linked
+        binary, you must specify the application type. For example, a Qt4 python
+        application might be launched like this::
+
+            app_proxy = self.launch_test_application('my_qt_app.py', app_type='qt')
+
+        Similarly, a python/Gtk application is launched like so::
+
+            app_proxy = self.launch_test_application('my_gtk_app.py', app_type='gtk')
+
+        .. seealso::
+
+            Method :py:meth:`AutopilotTestCase.pick_app_launcher`
+                Specify application introspection type globally.
+
         :param application: The application to launch. The application can be
             specified as:
 
@@ -257,6 +273,11 @@
              * A relative path to an executable file. (``./build/my_app``)
              * An app name, which will be searched for in $PATH (``my_app``)
 
+        :keyword app_type: If set, provides a hint to autopilot as to which kind
+            of introspection to enable. This is needed when the application you
+            wish to launch is *not* a dynamically linked binary. Valid values are
+            'gtk' or 'qt'. These strings are case insensitive.
+
         :keyword launch_dir:  If set to a directory that exists the process will be
             launched from that directory.
 
@@ -270,11 +291,15 @@
         """
         app_path = subprocess.check_output(['which',application]).strip()
         # Get a launcher, tests can override this if they need:
+        launcher_hint = kwargs.pop('app_type', '')
         launcher = None
-        try:
-            launcher = self.pick_app_launcher(app_path)
-        except RuntimeError:
-            pass
+        if launcher_hint != '':
+            launcher = get_application_launcher_from_string_hint(launcher_hint)
+        if launcher is None:
+            try:
+                launcher = self.pick_app_launcher(app_path)
+            except RuntimeError:
+                pass
         if launcher is None:
             raise RuntimeError("Autopilot could not determine the correct \
 introspection type to use. You can specify one by overriding the \

=== modified file 'autopilot/tests/test_ap_apps.py'
--- autopilot/tests/test_ap_apps.py	2013-04-23 21:07:58 +0000
+++ autopilot/tests/test_ap_apps.py	2013-04-25 23:06:25 +0000
@@ -70,13 +70,8 @@
         except subprocess.CalledProcessError:
             self.skip("qmlscene not found.")
 
-    def pick_app_launcher(self, app_path):
-        # force Qt app introspection:
-        from autopilot.introspection.qt import QtApplicationLauncher
-        return QtApplicationLauncher()
-
     def test_can_launch_qt_app(self):
-        app_proxy = self.launch_test_application(self.app_path)
+        app_proxy = self.launch_test_application(self.app_path, app_type='qt')
         self.assertTrue(app_proxy is not None)
 
     def test_can_launch_qt_script(self):
@@ -90,7 +85,7 @@
             win.show()
             app.exec_()
             """))
-        app_proxy = self.launch_test_application(path)
+        app_proxy = self.launch_test_application(path, app_type='qt')
         self.assertTrue(app_proxy is not None)
 
     def test_can_launch_wrapper_script(self):
@@ -111,7 +106,7 @@
             %s $*
             """ % (path, path)),
             extension=".sh")
-        app_proxy = self.launch_test_application(wrapper_path)
+        app_proxy = self.launch_test_application(wrapper_path, app_type='qt')
         self.assertTrue(app_proxy is not None)
 
 
@@ -125,11 +120,6 @@
         except subprocess.CalledProcessError:
             self.skip("gnome-mahjongg not found.")
 
-    def pick_app_launcher(self, app_path):
-        # force Gtk app introspection:
-        from autopilot.introspection.gtk import GtkApplicationLauncher
-        return GtkApplicationLauncher()
-
     def test_can_launch_gtk_app(self):
         app_proxy = self.launch_test_application(self.app_path)
         self.assertTrue(app_proxy is not None)
@@ -144,7 +134,7 @@
             win.show_all()
             Gtk.main()
             """))
-        app_proxy = self.launch_test_application(path)
+        app_proxy = self.launch_test_application(path, app_type='gtk')
         self.assertTrue(app_proxy is not None)
 
     def test_can_launch_wrapper_script(self):
@@ -164,5 +154,5 @@
             %s
             """ % (path, path)),
             extension=".sh")
-        app_proxy = self.launch_test_application(wrapper_path)
+        app_proxy = self.launch_test_application(wrapper_path, app_type='gtk')
         self.assertTrue(app_proxy is not None)

=== modified file 'bin/autopilot'
--- bin/autopilot	2013-04-23 21:07:58 +0000
+++ bin/autopilot	2013-04-25 23:06:25 +0000
@@ -351,7 +351,8 @@
 
 def launch_app(args):
     """Launch an application, with introspection support."""
-    from autopilot.introspection import launch_application, get_application_launcher
+    from autopilot.introspection import launch_application, get_application_launcher, get_application_launcher_from_string_hint
+
     setup_logging(args.verbose)
     app_name = args.application[0]
     if not isabs(app_name) or not exists(app_name):
@@ -370,12 +371,8 @@
             print "Error detecting launcher: %s" % e.message
             print "(Perhaps use the '-i' argument to specify an interface.)"
             exit(1)
-    elif args.interface == 'Gtk':
-        from autopilot.introspection.gtk import GtkApplicationLauncher
-        launcher = GtkApplicationLauncher()
-    elif args.interface == 'Qt':
-        from autopilot.introspection.qt import QtApplicationLauncher
-        launcher = QtApplicationLauncher()
+    else:
+        launcher = get_application_launcher_from_string_hint(args.interface)
     if launcher is None:
         print "Error: Could not determine introspection type to use for application '%s'." % app_name
         print "(Perhaps use the '-i' argument to specify an interface.)"