Merge lp:~vanvugt/mir/test-pkgconfig into lp:mir

[Daniel van Vugt]

Add test coverage to exercise mirclient.pc.in and mirserver.pc.in and to
verify that they will work in external projects for building clients and
servers. (LP: #1352757)

This way we don't have to find out after-the-fact that qtmir/usc/gtk-3 aren't buildable any more.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1832
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/2328/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1224
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1230
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/1213
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/850
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/850/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/851
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/851/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/148
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/148/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/2330
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/11079

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/2328/rebuild

review: Approve (continuous-integration)

[Alan Griffiths (alan-griffiths)]

50 +set(LIBDIR ${Mir_BINARY_DIR}/lib)
51 +set(INCLUDEDIR ${Mir_SOURCE_DIR}/include/client)
52 +set(COMMON_INCLUDEDIR ${Mir_SOURCE_DIR}/include/shared)
53 +configure_file(${Mir_SOURCE_DIR}/src/client/mirclient.pc.in
54 + ${StandaloneClient_BINARY_DIR}/mirclient.pc)
55 +set(ENV{PKG_CONFIG_PATH} ${StandaloneClient_BINARY_DIR})

This is the code that is tested. Not the code in ${Mir_SOURCE_DIR}/src/client/CMakeLists.txt that generates the real mirclient.pc. Similarly the mirserver.pc code.

I'm not sure what the right way to test is, but cut, paste & edit of the code setting these variables before configure_file() isn't enough.

review: Needs Fixing

[Daniel van Vugt (vanvugt)]

Alan,

Yes it's an imperfect build-time test for the pkg-config source files *.pc.in

I think you're asking for a system test of the final released packages files. That's ideal, but also not necessary. I'm still testing real *.pc files here made from the same pc input text. The fact that the paths in the tested pc files are temporary ones isn't a bug but a feature. It allows us to test the correctness of our pkg-config within the build tree, before final installation. Although you could use the real pc files with a fake root into the build tree, the result is the same (albeit more awkward) than what's proposed here.

More importantly at the end of the exercise I came to realize that CMake's insertion of temporary hard-coded search paths (rpath) actually makes any build-time testing of *.pc insufficient either way. Because the build-time search paths are literally hacked out just before packaging (thanks CMake). So the results of final package testing could easily be different.

This proposal is a basic indication of major problems in *.pc.in but it won't catch everything. And for the reason just explained, even using the real *.pc output files in a fake root would be equally insufficient, unfortunately. You either have to test the final released packages (which we do later of course), or accept that what you're testing before packaging is not the same set of binaries with the same search paths as what is about to be released.

[lp:~vanvugt/mir/test-pkgconfig]

1833. By Daniel van Vugt on 2014-08-07

Merge latest development-branch

1834. By Daniel van Vugt on 2014-08-08

Merge latest development-branch

1835. By Daniel van Vugt on 2014-08-08

Add missing mirplatform.pc, which is now a requirement again.

[Chris Halse Rogers (raof)]

Hm. You actually could do a proper test - invoke “make install DESTDIR=tmp”, then set pkg-config to “pkg-config --define-variable=prefix=/where/we/are/tmp/” and set PKG_CONFIG_PATH appropriately.

CMake would then nicely strip the rpath from the libraries, and you'd be testing the .pc files as-installed.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1835
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/2349/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-utopic-i386-build/1254
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-utopic-amd64-build/1260
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-utopic-touch/1243
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/871
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-amd64-ci/871/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/872
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-utopic-armhf-ci/872/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/178
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-utopic-armhf/178/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/2352
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/11186

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/2349/rebuild

review: Approve (continuous-integration)

[Daniel van Vugt (vanvugt)]

OK, we're seeing linkage regressions that these tests are failing to notice: bug 1355021

That's probably because of the rpath madness I mentioned. I think this proposal is presently too impotent to be useful...

review: Needs Fixing

Unmerged revisions

1835. By Daniel van Vugt on 2014-08-08

Add missing mirplatform.pc, which is now a requirement again.

1834. By Daniel van Vugt on 2014-08-08

Merge latest development-branch

1833. By Daniel van Vugt on 2014-08-07

Merge latest development-branch

1832. By Daniel van Vugt on 2014-08-06

Actual working detection of cross-compiling.

1831. By Daniel van Vugt on 2014-08-06

Don't try testing pkg-config projects when cross compiling. Our cross-compile
environment is a little bit too wacky right now (many include and lib paths
don't exist).

1830. By Daniel van Vugt on 2014-08-06

Add tests for mirclient.pc

1829. By Daniel van Vugt on 2014-08-06

Remove old experimental examples/* changes

1828. By Daniel van Vugt on 2014-08-06

Much improved, and stricter testing of mirserver.pc

1827. By Daniel van Vugt on 2014-08-06

First working prototype test project that exercises mirserver.pc.in

1826. By Daniel van Vugt on 2014-08-06

First attempt at getting examples/ to use *.pc(.in)

=== modified file 'tests/CMakeLists.txt'
--- tests/CMakeLists.txt	2014-07-02 06:29:24 +0000
+++ tests/CMakeLists.txt	2014-08-08 06:13:52 +0000
@@ -50,5 +50,6 @@
 add_subdirectory(mir_test_doubles/)
 add_subdirectory(client-language/)
 add_subdirectory(mir-stress/)
+add_subdirectory(pkgconfig)
 
 mir_add_memcheck_test()

=== added directory 'tests/pkgconfig'
=== added file 'tests/pkgconfig/CMakeLists.txt'
--- tests/pkgconfig/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/pkgconfig/CMakeLists.txt	2014-08-08 06:13:52 +0000
@@ -0,0 +1,11 @@
+
+# FIXME: Can't run pkg-config build testing when cross-compiling. It tries
+#        to use a bunch of paths under MIR_NDK_PATH that actually don't exist.
+#        That probably needs fixing in our cross-compile setup scripts, but
+#        so long as these test projects get attempted on native builds,
+#        that is sufficient test coverage.
+
+if (NOT CMAKE_FIND_ROOT_PATH_MODE_PROGRAM MATCHES "NEVER")
+  add_subdirectory(standaloneserver)
+  add_subdirectory(standaloneclient)
+endif()

=== added directory 'tests/pkgconfig/standaloneclient'
=== added file 'tests/pkgconfig/standaloneclient/CMakeLists.txt'
--- tests/pkgconfig/standaloneclient/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/pkgconfig/standaloneclient/CMakeLists.txt	2014-08-08 06:13:52 +0000
@@ -0,0 +1,45 @@
+#
+# This project tests the correctness of mirclient.pc.in, ensuring it contains
+# everything an external project needs to successfully compile and link
+# a mir client.
+#
+project(StandaloneClient)
+
+# Forget everything you know about the parent "Mir" project. Pretend you're
+# a distant third-party project. This ensures the directories we do get are
+# coming from mirclient.pc ...
+set_directory_properties(PROPERTIES
+    INCLUDE_DIRECTORIES ""
+    LINK_DIRECTORIES ""
+)
+
+# Generate a temporary mirclient.pc file which points into the build tree ...
+set(LIBDIR ${Mir_BINARY_DIR}/lib)
+set(INCLUDEDIR ${Mir_SOURCE_DIR}/include/client)
+set(COMMON_INCLUDEDIR ${Mir_SOURCE_DIR}/include/shared)
+configure_file(${Mir_SOURCE_DIR}/src/client/mirclient.pc.in
+               ${StandaloneClient_BINARY_DIR}/mirclient.pc)
+set(ENV{PKG_CONFIG_PATH} ${StandaloneClient_BINARY_DIR})
+
+# Now use mirclient.pc like real projects do, verifying it provides all
+# the necessary information to build...
+find_package(PkgConfig)
+pkg_check_modules(LOCALMIRCLIENT REQUIRED mirclient)
+
+include_directories(${LOCALMIRCLIENT_INCLUDE_DIRS})
+link_directories(${LOCALMIRCLIENT_LIBRARY_DIRS})
+add_compile_options(${LOCALMIRCLIENT_CFLAGS})
+
+set(CLIENT_SRC "${Mir_SOURCE_DIR}/examples/flicker.c")
+add_compile_options("-std=c99")
+
+# Test CMake-style explicit linkage: "foo/libbar.so"
+add_executable(test_standaloneclient_directlink ${CLIENT_SRC})
+add_dependencies(test_standaloneclient_directlink mirclient)
+target_link_libraries(test_standaloneclient_directlink ${LOCALMIRCLIENT_LIBRARIES})
+
+# Test traditional linkage: "-Lfoo -lbar"
+add_executable(test_standaloneclient_searchlink ${CLIENT_SRC})
+add_dependencies(test_standaloneclient_searchlink mirclient)
+target_link_libraries(test_standaloneclient_searchlink ${LOCALMIRCLIENT_LDFLAGS})
+

=== added directory 'tests/pkgconfig/standaloneserver'
=== added file 'tests/pkgconfig/standaloneserver/CMakeLists.txt'
--- tests/pkgconfig/standaloneserver/CMakeLists.txt	1970-01-01 00:00:00 +0000
+++ tests/pkgconfig/standaloneserver/CMakeLists.txt	2014-08-08 06:13:52 +0000
@@ -0,0 +1,45 @@
+#
+# This project tests the correctness of mirserver.pc.in, ensuring it contains
+# everything an external project needs to successfully compile and link
+# a mir server.
+#
+project(StandaloneServer)
+
+# Forget everything you know about the parent "Mir" project. Pretend you're
+# a distant third-party project. This ensures the directories we do get are
+# coming from mirserver.pc ...
+set_directory_properties(PROPERTIES
+    INCLUDE_DIRECTORIES ""
+    LINK_DIRECTORIES ""
+)
+
+# Generate a temporary mirserver.pc file which points into the build tree ...
+set(LIBDIR ${Mir_BINARY_DIR}/lib)
+set(INCLUDEDIR ${Mir_SOURCE_DIR}/include/server)
+set(PLATFORM_INCLUDEDIR ${Mir_SOURCE_DIR}/include/platform)
+set(COMMON_INCLUDEDIR ${Mir_SOURCE_DIR}/include/shared)
+configure_file(${Mir_SOURCE_DIR}/src/platform/mirplatform.pc.in
+               ${StandaloneServer_BINARY_DIR}/mirplatform.pc)
+configure_file(${Mir_SOURCE_DIR}/src/server/mirserver.pc.in
+               ${StandaloneServer_BINARY_DIR}/mirserver.pc)
+set(ENV{PKG_CONFIG_PATH} ${StandaloneServer_BINARY_DIR})
+
+# Now use mirserver.pc like real projects do, verifying it provides all
+# the necessary information to build...
+find_package(PkgConfig)
+pkg_check_modules(LOCALMIRSERVER REQUIRED mirserver)
+
+include_directories(${LOCALMIRSERVER_INCLUDE_DIRS})
+link_directories(${LOCALMIRSERVER_LIBRARY_DIRS})
+add_compile_options(${LOCALMIRSERVER_CFLAGS})
+
+# Test CMake-style explicit linkage: "foo/libbar.so"
+add_executable(test_standaloneserver_directlink server.cpp)
+add_dependencies(test_standaloneserver_directlink mirserver)
+target_link_libraries(test_standaloneserver_directlink ${LOCALMIRSERVER_LIBRARIES})
+
+# Test traditional linkage: "-Lfoo -lbar"
+add_executable(test_standaloneserver_searchlink server.cpp)
+add_dependencies(test_standaloneserver_searchlink mirserver)
+target_link_libraries(test_standaloneserver_searchlink ${LOCALMIRSERVER_LDFLAGS})
+

=== added file 'tests/pkgconfig/standaloneserver/server.cpp'
--- tests/pkgconfig/standaloneserver/server.cpp	1970-01-01 00:00:00 +0000
+++ tests/pkgconfig/standaloneserver/server.cpp	2014-08-08 06:13:52 +0000
@@ -0,0 +1,38 @@
+/*
+ * Copyright © 2014 Canonical Ltd.
+ *
+ * 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.
+ *
+ * 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/>.
+ *
+ * Authored by: Daniel van Vugt <[e-mail]>
+ */
+
+#include "mir/default_server_configuration.h"
+#include "mir/run_mir.h"
+#include "mir/geometry/rectangle.h"
+
+using namespace mir;
+using namespace mir::geometry;
+
+int main(int argc, char const* argv[])
+{
+    // Exercise some symbols from libmircommon. Make sure users of
+    // mirserver.pc get these automatically in their link lines...
+    Rectangle a;
+    (void)a.bottom_right();
+    Rectangle b;
+    (void)a.contains(b);
+
+    DefaultServerConfiguration config(argc, argv);
+    run_mir(config, [](mir::DisplayServer&){} );
+    return 0;
+}