Merge lp:~autopilot/autopilot-qt/magic-driver-loading-awesomeness into lp:autopilot-qt

[Thomi Richards]

autopilot-qt is now a single package with drivers that load correctly for each supported Qt version.

This branch changes the way autopilot-qt works. Instead of creatinbg multiple binary packages for each version of qt, we create a small driver library that links to nothing. This gets loaded by the Qt app the user wants to test. This small library works out which version of Qt the app that loaded it is linked to, and loads the appropriate autopilot driver library.

Things that still need to be done before this branch can merge (mostly packaging stuff):

1) The binary package name should be renamed to 'libautopilot-qt' to make it in line with the gtk plugin.
2) The package ends up depending on all the Qt4 and Qt5 packages - I think this is '${shlibs:Depends}' in action. We don't want that, since it forces users to install Qt5 whenever they're testing a Qt4 app, and vice versa. We can be assured that they have the correct Qt libraries installed anyway, since our driver library was loaded by Qt. So we need to find a way around this - possibly just remove '${shlibs:Depends}' (but then remember to depend on libxpathselect).
3) Currently the driver library (libqt_testability) is built twice - once in the qt4 and once in the qt5 directory. Ideally we'd just build it once.

Over to you....

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:38
http://s-jenkins:8080/job/autopilot-qt-ci/38/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/autopilot-qt-ci/./build=pbuilder,distribution=quantal,flavor=amd64/38/console

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:39
http://s-jenkins:8080/job/autopilot-qt-ci/39/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/autopilot-qt-ci/./build=pbuilder,distribution=quantal,flavor=amd64/39/console

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:42
http://s-jenkins:8080/job/autopilot-qt-ci/41/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/autopilot-qt-ci/./build=pbuilder,distribution=quantal,flavor=amd64/41/console

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

review: Approve (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:44
http://s-jenkins:8080/job/autopilot-qt-ci/42/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/autopilot-qt-ci/./build=pbuilder,distribution=quantal,flavor=amd64/42/console

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

review: Approve (continuous-integration)

[Michael Zanetti (mzanetti)]

1) The binary package name should be renamed to 'libautopilot-qt' to make it in line with the gtk plugin.

Done.

2) The package ends up depending on all the Qt4 and Qt5 packages - I think this is '${shlibs:Depends}' in action. We don't want that, since it forces users to install Qt5 whenever they're testing a Qt4 app, and vice versa. We can be assured that they have the correct Qt libraries installed anyway, since our driver library was loaded by Qt. So we need to find a way around this - possibly just remove '${shlibs:Depends}' (but then remember to depend on libxpathselect).

Done.

3) Currently the driver library (libqt_testability) is built twice - once in the qt4 and once in the qt5 directory. Ideally we'd just build it once.

Done. For now, I kinda workarounded it and only build the main lib with the Qt5 build run. A probably cleaner solution would be to split the projects up and build them indeoendently. However, this produces just the same result and causes less maintainance efforts.

[Omer Akram (om26er)]

builds fine for me, replaces autopilot-qt and -qt5 as it should. Also my autopilot tests work.

review: Approve

[Juhapekka Piiroinen (juhapekka-piiroinen)]

looks great to me :)

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
Approved revid is not set in launchpad (maybe a permission problem?).
http://s-jenkins:8080/job/autopilot-qt-autolanding/18/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/autopilot-qt-autolanding/./build=pbuilder,distribution=quantal,flavor=amd64/18/console

review: Needs Fixing (continuous-integration)

[Juhapekka Piiroinen (juhapekka-piiroinen)]

I withdrawed the Approved, Could somebody check if the Description is still valid and update it accordingly: "Things that still need to be done before this branch can merge (mostly packaging stuff):"

=== modified file 'autopilot-qt.pro'
--- autopilot-qt.pro	2012-07-30 15:14:44 +0000
+++ autopilot-qt.pro	2013-01-14 13:13:22 +0000
@@ -1,3 +1,8 @@
-
 TEMPLATE = subdirs
-SUBDIRS = lib # test
+
+# only build the main lib once, with the qt5 driver
+contains(QT_VERSION, ^5\\..\\..*) {
+    SUBDIRS += lib
+}
+
+SUBDIRS += driver

=== removed file 'debian/autopilot-qt.install'
--- debian/autopilot-qt.install	2012-10-09 16:21:50 +0000
+++ debian/autopilot-qt.install	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-usr/lib/lib*.so.*

=== removed file 'debian/autopilot-qt5.install'
--- debian/autopilot-qt5.install	2012-10-09 16:21:50 +0000
+++ debian/autopilot-qt5.install	1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
-opt/qt5/lib/lib*.so.*

=== modified file 'debian/changelog'
--- debian/changelog	2012-11-14 15:57:58 +0000
+++ debian/changelog	2013-01-14 13:13:22 +0000
@@ -1,10 +1,10 @@
-autopilot-qt (0.2) quantal; urgency=low
+libautopilot-qt (0.2) quantal; urgency=low
 
   * Release
 
  -- Michael Zanetti <[e-mail]>  Wed, 14 Nov 2012 16:55:45 +0100
 
-autopilot-qt (0.1) quantal; urgency=low
+libautopilot-qt (0.1) quantal; urgency=low
 
   * Initial release
 

=== modified file 'debian/control'
--- debian/control	2012-11-19 17:18:59 +0000
+++ debian/control	2013-01-14 13:13:22 +0000
@@ -1,4 +1,4 @@
-Source: autopilot-qt
+Source: libautopilot-qt
 Priority: extra
 Maintainer: Michael Zanetti <[e-mail]>
 Build-Depends: debhelper (>= 8.0.0), libindicate-qt-dev, pkg-config, qt4-qmake, libqt4-dev, qtbase, qtdeclarative, libxpathselect-dev, mesa-common-dev, libgl1-mesa-dev, libgles2-mesa-dev
@@ -6,20 +6,15 @@
 Section: libs
 Homepage: https://launchpad.net/autopilot-qt
 
-Package: autopilot-qt
-Section: libs
-Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}
-Recommends: python-autopilot
-Description: This project makes Qt4 applications introspectable by autopilot.
- This allows autopilot to test any existing Qt4 application, 
- without having to rebuild the application under test.
-
-Package: autopilot-qt5
-Section: libs
-Architecture: any
-Depends: ${shlibs:Depends}, ${misc:Depends}
-Recommends: python-autopilot
-Description: This project makes Qt5 applications introspectable by autopilot.
- This allows autopilot to test any existing Qt5 application, 
+Package: libautopilot-qt
+Section: libs
+Architecture: any
+Depends: ${misc:Depends},
+         libxpathselect1.1,
+Replaces: autopilot-qt, autopilot-qt5
+Conflicts: autopilot-qt, autopilot-qt5
+Provides: autopilot-qt, autopilot-qt5
+Recommends: python-autopilot
+Description: This project makes Qt applications introspectable by autopilot.
+ This allows autopilot to test any existing Qt4 or Qt5 application,
  without having to rebuild the application under test.

=== modified file 'debian/copyright'
--- debian/copyright	2012-10-09 16:21:50 +0000
+++ debian/copyright	2013-01-14 13:13:22 +0000
@@ -1,5 +1,5 @@
 Format: http://dep.debian.net/deps/dep5
-Upstream-Name: autopilot-qt
+Upstream-Name: libautopilot-qt
 Source: https://code.launchpad.net/~private-ps-quality-team/autopilot-qt/trunk
 
 Files: *

=== added file 'debian/libautopilot-qt.install'
--- debian/libautopilot-qt.install	1970-01-01 00:00:00 +0000
+++ debian/libautopilot-qt.install	2013-01-14 13:13:22 +0000
@@ -0,0 +1,1 @@
+usr/lib/lib*.so.*

=== modified file 'debian/lintian-overrides'
--- debian/lintian-overrides	2012-10-10 07:42:18 +0000
+++ debian/lintian-overrides	2013-01-14 13:13:22 +0000
@@ -1,1 +1,1 @@
-autopilot-qt binary: non-dev-pkg-with-shlib-symlink
+libautopilot-qt binary: non-dev-pkg-with-shlib-symlink

=== modified file 'debian/rules'
--- debian/rules	2012-10-09 16:21:50 +0000
+++ debian/rules	2013-01-14 13:13:22 +0000
@@ -10,7 +10,7 @@
 export DH_VERBOSE=1
 
 %:
-	dh $@ 
+	dh $@
 
 override_dh_auto_configure:
 	mkdir qt4
@@ -28,7 +28,7 @@
 	rm -rf qt5
 
 override_dh_install:
-	mkdir -p $(CURDIR)/debian/autopilot-qt/usr/lib/
-	mkdir -p $(CURDIR)/debian/autopilot-qt5/opt/qt5/lib/
-	cp -pP qt4/libqttestability* $(CURDIR)/debian/autopilot-qt/usr/lib/
-	cp -pP qt5/libqttestability* $(CURDIR)/debian/autopilot-qt5/opt/qt5/lib/
+	mkdir -p $(CURDIR)/debian/libautopilot-qt/usr/lib/
+	mkdir -p $(CURDIR)/debian/libautopilot-qt5/opt/qt5/lib/
+	cp -pP qt4/*.so* $(CURDIR)/debian/libautopilot-qt/usr/lib/
+	cp -pP qt5/*.so* $(CURDIR)/debian/libautopilot-qt/usr/lib/

=== renamed directory 'lib' => 'driver'
=== added file 'driver/driver.pro'
--- driver/driver.pro	1970-01-01 00:00:00 +0000
+++ driver/driver.pro	2013-01-14 13:13:22 +0000
@@ -0,0 +1,38 @@
+TEMPLATE = lib
+
+#version check qt
+contains(QT_VERSION, ^5\\..\\..*) {
+    DEFINES += QT5_SUPPORT
+    TARGET = autopilot_driver_qt5
+} else {
+  TARGET = autopilot_driver_qt4
+}
+
+DESTDIR=..
+QT = core gui dbus quick widgets testlib
+CONFIG += link_pkgconfig
+PKGCONFIG += xpathselect
+QMAKE_CXXFLAGS += -std=c++0x -Wl,--no-undefined
+
+SOURCES = qttestability.cpp \
+          dbus_adaptor.cpp \
+          dbus_object.cpp \
+          introspection.cpp \
+    rootnode.cpp \
+    qtnode.cpp \
+    dbus_adaptor_qt.cpp
+
+HEADERS = qttestability.h \
+          dbus_adaptor.h \
+          dbus_object.h \
+          introspection.h \
+    rootnode.h \
+    qtnode.h \
+          introspection.h \
+    dbus_adaptor_qt.h
+
+target.file = libtestability*
+
+
+target.path = /usr/lib
+INSTALLS += target

=== added directory 'lib'
=== added file 'lib/lib.pro'
--- lib/lib.pro	1970-01-01 00:00:00 +0000
+++ lib/lib.pro	2013-01-14 13:13:22 +0000
@@ -0,0 +1,15 @@
+TEMPLATE = lib
+TARGET = qttestability
+DESTDIR=..
+
+# disable qt includes and linkage (core and gui are enabled per default with Qt4)
+QT -= core gui
+
+QMAKE_CXXFLAGS += -std=c++0x -Wl,--no-undefined
+QMAKE_CXXFLAGS -= -pedantic
+
+SOURCES = qttestability.cpp
+HEADERS = qttestability.h
+
+target.file = libtestability*
+INSTALLS += target

=== removed file 'lib/lib.pro'
--- lib/lib.pro	2012-11-06 14:28:41 +0000
+++ lib/lib.pro	1970-01-01 00:00:00 +0000
@@ -1,37 +0,0 @@
-
-TEMPLATE = lib
-TARGET = qttestability
-DESTDIR=..
-QT = core gui dbus quick widgets testlib
-CONFIG += link_pkgconfig
-PKGCONFIG += xpathselect
-QMAKE_CXXFLAGS += -std=c++0x -Wl,--no-undefined
-
-SOURCES = qttestability.cpp \
-          dbus_adaptor.cpp \
-          dbus_object.cpp \
-          introspection.cpp \
-    rootnode.cpp \
-    qtnode.cpp \
-    dbus_adaptor_qt.cpp
-
-HEADERS = qttestability.h \
-          dbus_adaptor.h \
-          dbus_object.h \
-          introspection.h \
-    rootnode.h \
-    qtnode.h \
-          introspection.h \
-    dbus_adaptor_qt.h
-
-target.file = libtestability*
-
-#version check qt
-contains(QT_VERSION, ^5\\..\\..*) {
-    DEFINES += QT5_SUPPORT
-    target.path = /opt/qt5/lib
-} else {
-    target.path = /usr/lib
-}
-
-INSTALLS += target

=== added file 'lib/qttestability.cpp'
--- lib/qttestability.cpp	1970-01-01 00:00:00 +0000
+++ lib/qttestability.cpp	2013-01-14 13:13:22 +0000
@@ -0,0 +1,87 @@
+/*
+Copyright 2012 Canonical
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 3, as published
+by the Free Software Foundation.
+*/
+
+#include "qttestability.h"
+
+#include <link.h>
+#include <string>
+#include <iostream>
+
+typedef enum
+{
+    QT_VERSION_4,
+    QT_VERSION_5,
+    QT_VERSION_UNKNOWN
+} QtVersion;
+
+static int
+callback(struct dl_phdr_info *info, size_t size, void *data)
+{
+    (void) size;
+    QtVersion *v = (QtVersion*) data;
+
+    if (*v == QT_VERSION_UNKNOWN)
+    {
+        std::string lib_path(info->dlpi_name);
+        if (lib_path.rfind("libQtCore.so.4") != std::string::npos)
+        {
+            *v = QT_VERSION_4;
+        }
+        else if (lib_path.rfind("libQtCore.so.5") != std::string::npos)
+        {
+            *v = QT_VERSION_5;
+        }
+    }
+
+    return 0;
+}
+
+void qt_testability_init(void)
+{
+    QtVersion version = QT_VERSION_UNKNOWN;
+    dl_iterate_phdr(callback, &version);
+
+    std::string driver_name;
+    if (version == QT_VERSION_4)
+    {
+        driver_name = "libautopilot_driver_qt4.so.1";
+    }
+    else if (version == QT_VERSION_5)
+    {
+        driver_name = "libautopilot_driver_qt5.so.1";
+    }
+    else
+    {
+        std::cerr << "We don't seem to link to version 4 or 5 of QtCore." << std::endl
+            << "Unable to determine which autopilot driver to load." << std::endl
+            << "Autopilot introspection will not be available for this process." << std::endl;
+            return;
+    }
+
+    void* driver = dlopen(driver_name.c_str(), RTLD_LAZY);
+    if (!driver)
+    {
+        std::cerr << "Cannot load library: " << dlerror() << std::endl
+            << "Autopilot introspection will not be available for this process." << std::endl;
+            return;
+    }
+
+    // load the entry point function for the actual driver:
+    typedef void (*entry_t)();
+    // clear errors:
+    dlerror();
+    entry_t entry_point = (entry_t) dlsym(driver, "qt_testability_init");
+    const char* err = dlerror();
+    if (err)
+    {
+        std::cerr << "Cannot load library entry point symbol: " << err << std::endl
+        << "Autopilot introspection will not be available for this process." << std::endl;
+            return;
+    }
+    entry_point();
+}

=== added file 'lib/qttestability.h'
--- lib/qttestability.h	1970-01-01 00:00:00 +0000
+++ lib/qttestability.h	2013-01-14 13:13:22 +0000
@@ -0,0 +1,16 @@
+/*
+Copyright 2012 Canonical
+
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 3, as published
+by the Free Software Foundation.
+*/
+
+#ifndef QTTESTABILITY_H
+#define QTTESTABILITY_H
+
+extern "C" void qt_testability_init(void);
+
+
+#endif
+