Merge lp:~thomir-deactivatedaccount/autopilot/fix-ap-launch-bugs into lp:autopilot

[Thomi Richards]

Fix bugs in the launch command. Don't swallow launched process stdout & stderr, and allow launching non-binary applications.

This branch fixes two bugs with the autopilot launch command:

1) It's not possible to use autopilot launch to launch a non-dynamically linked binary.
2) The launch command swallows stdout and stderr of the application launched.

This branch fixes both bugs.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:144
http://jenkins.qa.ubuntu.com/job/autopilot-ci/143/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-ci/./distribution=quantal,flavor=amd64/143/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-ci/./distribution=quantal,flavor=i386/143/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/autopilot-ci/143//rebuild/?

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good

review: Approve

=== modified file 'autopilot/introspection/__init__.py'
--- autopilot/introspection/__init__.py	2013-02-12 22:02:05 +0000
+++ autopilot/introspection/__init__.py	2013-02-21 02:47:24 +0000
@@ -56,6 +56,9 @@
          * *launch_dir*. If set to a directory that exists the process will be
            launched from that directory.
 
+         * *capture_output*. If set to True (the default), the process output
+           will be captured and attached to the test as test detail.
+
         :raises: **ValueError** if unknown keyword arguments are passed.
         :return: A proxy object that represents the application. Introspection
          data is retrievable via this object.
@@ -64,6 +67,7 @@
         if not isinstance(application, basestring):
             raise TypeError("'application' parameter must be a string.")
         cwd = kwargs.pop('launch_dir', None)
+        capture_output = kwargs.pop('capture_output', True)
         if kwargs:
             raise ValueError("Unknown keyword arguments: %s." %
                 (', '.join( repr(k) for k in kwargs.keys())))
@@ -74,7 +78,10 @@
 
         path, args = self.prepare_environment(application, list(arguments))
 
-        process = launch_autopilot_enabled_process(path, args, cwd=cwd)
+        process = launch_autopilot_enabled_process(path,
+                                                    args,
+                                                    capture_output,
+                                                    cwd=cwd)
         self.addCleanup(self._kill_process_and_attach_logs, process)
         return get_autopilot_proxy_object_for_process(process)
 
@@ -96,15 +103,18 @@
         self.addDetail('process-stderr', text_content(stderr))
 
 
-def launch_autopilot_enabled_process(application, args, **kwargs):
+def launch_autopilot_enabled_process(application, args, capture_output, **kwargs):
     """Launch an autopilot-enabled process and return the proxy object."""
     commandline = [application]
     commandline.extend(args)
     logger.info("Launching process: %r", commandline)
+    cap_mode = None
+    if capture_output:
+        cap_mode = subprocess.PIPE
     process = subprocess.Popen(commandline,
         stdin=subprocess.PIPE,
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
+        stdout=cap_mode,
+        stderr=cap_mode,
         close_fds=True,
         **kwargs)
     return process

=== modified file 'autopilot/tests/test_autopilot_functional.py'
--- autopilot/tests/test_autopilot_functional.py	2013-02-12 23:33:28 +0000
+++ autopilot/tests/test_autopilot_functional.py	2013-02-21 02:47:24 +0000
@@ -594,7 +594,7 @@
 
         self.assertThat(rc, Equals(1))
         self.assertThat(stdout,
-            Contains("Error: Only dynamically linked binaries are supported at the moment."))
+            Contains("Error: Cannot auto-detect introspection plugin to load.\nUse the '-i' argument to specify an interface."))
 
 
 class AutopilotVerboseFunctionalTests(AutopilotFunctionalTestsBase):

=== modified file 'bin/autopilot'
--- bin/autopilot	2013-02-12 23:33:28 +0000
+++ bin/autopilot	2013-02-21 02:47:24 +0000
@@ -27,7 +27,8 @@
 from argparse import ArgumentParser
 from unittest.loader import TestLoader
 from unittest import TestSuite
-
+from autopilot.introspection.gtk import GtkIntrospectionTestMixin
+from autopilot.introspection.qt import QtIntrospectionTestMixin
 
 # list autopilot depends here, with the form:
 # ('python module name', 'ubuntu package name'),
@@ -126,6 +127,11 @@
 
     parser_launch = subparsers.add_parser('launch',
                             help="Launch an application with introspection enabled")
+    parser_launch.add_argument('-i', '--interface',
+                            choices=('Gtk', 'Qt', 'Auto'), default='Auto',
+                            help="Specify which introspection interface to load. \
+                            The default ('Auto') uses ldd to try and detect which \
+                            interface to load.")
     parser_launch.add_argument('-v', '--verbose', required=False, default=False,
                             action='count', help="Show autopilot log messages. \
                             Set twice to also log data useful for debugging \
@@ -339,7 +345,13 @@
             exit(1)
 
     # We now have a full path to the application.
-    IntrospectionBase = get_application_introspection_base(app_name)
+    IntrospectionBase = None
+    if args.interface == 'Auto':
+        IntrospectionBase = get_application_introspection_base(app_name)
+    elif args.interface == 'Gtk':
+        IntrospectionBase = GtkIntrospectionTestMixin
+    elif args.interface == 'Qt':
+        IntrospectionBase = QtIntrospectionTestMixin
     if IntrospectionBase is None:
         print "Error: Could not determine introspection type to use for application '%s'." % app_name
         exit(1)
@@ -353,7 +365,7 @@
 
     b = IntrospectionBase()
     try:
-        b.launch_test_application(app_name)
+        b.launch_test_application(app_name, capture_output=False)
     except RuntimeError as e:
         print "Error: " + e.message
         exit(1)
@@ -371,13 +383,12 @@
     try:
         ldd_output = subprocess.check_output(["ldd", app_path]).strip().lower()
     except subprocess.CalledProcessError:
-        print "Error: Only dynamically linked binaries are supported at the moment."
+        print "Error: Cannot auto-detect introspection plugin to load."
+        print "Use the '-i' argument to specify an interface."
         exit(1)
     if 'libqtcore' in ldd_output:
-        from autopilot.introspection.qt import QtIntrospectionTestMixin
         return QtIntrospectionTestMixin
     elif 'libgtk' in ldd_output:
-        from autopilot.introspection.gtk import GtkIntrospectionTestMixin
         return GtkIntrospectionTestMixin
     return None