Ubuntu Application Launcher

Merge lp:~ted/ubuntu-app-launch/abi-compliance into lp:ubuntu-app-launch/16.10

abi-compliance
Merge into trunk.16.10

Proposed by Ted Gould on 2016-08-07

Status:

Merged

Approved by:

dobey on 2016-08-17

Approved revision:

247

Merged at revision:

242

Proposed branch:

lp:~ted/ubuntu-app-launch/abi-compliance

Merge into:

lp:ubuntu-app-launch/16.10

Prerequisite:

lp:~ted/ubuntu-app-launch/eventually-tests

Diff against target:

161 lines (+82/-8)

7 files modified

CMakeLists.txt (+15/-0)
debian/control (+5/-1)
libubuntu-app-launch/CMakeLists.txt (+1/-7)
libubuntu-app-launch/abi-check/CMakeLists.txt (+15/-0)
libubuntu-app-launch/abi-check/build.xml.in (+9/-0)
libubuntu-app-launch/abi-check/check-abi.sh.in (+28/-0)
libubuntu-app-launch/abi-check/installed.xml.in (+9/-0)

To merge this branch:

bzr merge lp:~ted/ubuntu-app-launch/abi-compliance

Critical

Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
Charles Kerr (community)			Approve on 2016-08-17
dobey (community)		2016-08-07	Approve on 2016-08-17
unity-api-1-bot	continuous-integration	2016-08-07	Approve on 2016-08-17
Review via email: mp+302216@code.launchpad.net

This proposal supersedes a proposal from 2016-08-05.

Commit Message

Add test for abi compatibility

Description of the Change

This is a bit of a hack, but it seems to work well. It makes the version of ubuntu-app-launch that is in the archive a build dependency so that it gets installed on the system. Then it generates the ABI profile of that version and compares it against the built version in this branch. If they match, we're all good, if not it is an error.

To make sure that we can bootstrap we also depend on valgrind. If there is no previous version then the test succeeds without checking.

unity-api-1-bot (unity-api-1-bot) wrote on 2016-08-05: Posted in a previous version of this proposal

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-ubuntu-app-launch-ci/29/rebuild

review: Needs Fixing (continuous-integration)

unity-api-1-bot (unity-api-1-bot) wrote on 2016-08-07:

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-ubuntu-app-launch-ci/41/rebuild

review: Approve (continuous-integration)

dobey (dobey) wrote on 2016-08-08:

I think this needs review by a core dev.

review: Needs Information

lp:~ted/ubuntu-app-launch/abi-compliance updated on 2016-08-08

246. By Ted Gould on 2016-08-08: Using build profiles to make it cleaner

unity-api-1-bot (unity-api-1-bot) wrote on 2016-08-08:

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-ubuntu-app-launch-ci/42/rebuild

review: Approve (continuous-integration)

Ted Gould (ted) wrote on 2016-08-08:

Discussed with seb128 and Laney in #ubuntu-desktop and they suggested changing to <!stage1> to solve the bootstrap issue, but otherwise were happy with the idea.

dobey (dobey) wrote on 2016-08-08:

I'm not really happy with it, because while this does theoretically somewhat guarantee stability in a specific series, it doesn't solve the core problem that we ship different ABIs with the same soname, in different versions of Ubuntu.

review: Needs Fixing

Ted Gould (ted) wrote on 2016-08-10:

Certainly it doesn't solve all the problems we could have, but I think it is general improvement from what is currently being done for UAL today. There is, AFAIK, not a solution that covers all of those cases for C++ libraries without maintaining a large array of ABI captures for every series/architecture.

lp:~ted/ubuntu-app-launch/abi-compliance updated on 2016-08-17

247. By Ted Gould on 2016-08-17: Pulling through eventually test updates

unity-api-1-bot (unity-api-1-bot) wrote on 2016-08-17:

Click here to trigger a rebuild:
https://jenkins.canonical.com/unity-api-1/job/lp-ubuntu-app-launch-ci/56/rebuild

review: Approve (continuous-integration)

dobey (dobey) wrote on 2016-08-17:

Really wish we could do this some other way than the ouroboros effect.

review: Approve

Charles Kerr (charlesk) wrote on 2016-08-17:

Approving the CMake. Optional comments inline.

As for the ABI part -- Since Ted's gotten in-IRC comment from Seb128 and Laney, I'd prefer to see one of them here for reviewing the actual ABI test.

+1 to the Dobey/Ted comments that this is a step forward rather than a total fix.

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Indicator Applet Developers

Ted Gould

 === modified file 'CMakeLists.txt'
 --- CMakeLists.txt	2016-04-21 01:01:47 +0000
 +++ CMakeLists.txt	2016-08-17 13:13:53 +0000
@@ -1,6 +1,17 @@
  project(ubuntu-app-launch C CXX)
  cmake_minimum_required(VERSION 2.8.9)
++##########################
++# Version Info
++##########################
++
++set(API_VERSION 2)
++set(ABI_VERSION 2)
++
++##########################
++# Options
++##########################
++
  option (enable_tests "Build tests" ON)
  option (enable_lcov "Generate Coverage Reports" ON)
@@ -8,6 +19,10 @@
  set(PACKAGE ${CMAKE_PROJECT_NAME})
++##########################
++# Dependent Packages
++##########################
++
  find_package(PkgConfig REQUIRED)
  find_package(GObjectIntrospection REQUIRED)
  include(GNUInstallDirs)
 === modified file 'debian/control'
 --- debian/control	2016-06-07 13:21:39 +0000
 +++ debian/control	2016-08-17 13:13:53 +0000
@@ -2,7 +2,8 @@
  Section: gnome
  Priority: optional
  Maintainer: Ted Gould <ted@ubuntu.com>
--Build-Depends: click-dev (>= 0.2.2),
++Build-Depends: abi-compliance-checker,
++               click-dev (>= 0.2.2),
                 cmake,
                 dbus-x11,
                 dbus-test-runner,
@@ -21,6 +22,9 @@
                 libnih-dbus-dev,
                 libnih-dev,
                 libproperties-cpp-dev,
++# For ABI check to distro version
++# Make sure to set DEB_BUILD_PROFILES when bootstrapping
++               libubuntu-app-launch2-dev <!stage1>,
                 libupstart-dev,
                 libzeitgeist-2.0-dev,
                 gobject-introspection,
 === modified file 'libubuntu-app-launch/CMakeLists.txt'
 --- libubuntu-app-launch/CMakeLists.txt	2016-06-07 04:01:41 +0000
 +++ libubuntu-app-launch/CMakeLists.txt	2016-08-17 13:13:53 +0000
@@ -1,13 +1,6 @@
  include_directories(${CMAKE_CURRENT_SOURCE_DIR})
  include_directories(${CMAKE_CURRENT_BINARY_DIR})
--##########################
--# Version Info
--##########################
--
--set(API_VERSION 2)
--set(ABI_VERSION 2)
--
  ##########################
  # Library
@@ -148,3 +141,4 @@
  list(APPEND INTROSPECTION_GIRS UbuntuAppLaunch-2.gir)
  gir_add_introspections(INTROSPECTION_GIRS)
++add_subdirectory(abi-check)
 === added directory 'libubuntu-app-launch/abi-check'
 === added file 'libubuntu-app-launch/abi-check/CMakeLists.txt'
 --- libubuntu-app-launch/abi-check/CMakeLists.txt	1970-01-01 00:00:00 +0000
 +++ libubuntu-app-launch/abi-check/CMakeLists.txt	2016-08-17 13:13:53 +0000
@@ -0,0 +1,15 @@
++
++set(ABI_BUILD_HEADERS ${LAUNCHER_HEADERS})
++list(APPEND ABI_BUILD_HEADERS ${LAUNCHER_CPP_HEADERS})
++list_prefix(ABI_BUILD_HEADERS_PATH ABI_BUILD_HEADERS "${CMAKE_SOURCE_DIR}/libubuntu-app-launch/")
++
++set(HEADER_AS_LIST "")
++foreach(HEADER IN LISTS ABI_BUILD_HEADERS_PATH)
++	set(HEADER_AS_LIST "${HEADER_AS_LIST}\n${HEADER}")
++endforeach()
++
++configure_file(${CMAKE_CURRENT_SOURCE_DIR}/check-abi.sh.in ${CMAKE_CURRENT_BINARY_DIR}/check-abi.sh @ONLY)
++configure_file(${CMAKE_CURRENT_SOURCE_DIR}/build.xml.in ${CMAKE_CURRENT_BINARY_DIR}/build.xml @ONLY)
++configure_file(${CMAKE_CURRENT_SOURCE_DIR}/installed.xml.in ${CMAKE_CURRENT_BINARY_DIR}/installed.xml @ONLY)
++
++add_test (NAME abi-check COMMAND ${CMAKE_CURRENT_BINARY_DIR}/check-abi.sh)
 === added file 'libubuntu-app-launch/abi-check/build.xml.in'
 --- libubuntu-app-launch/abi-check/build.xml.in	1970-01-01 00:00:00 +0000
 +++ libubuntu-app-launch/abi-check/build.xml.in	2016-08-17 13:13:53 +0000
@@ -0,0 +1,9 @@
++<version>
++@ABI_VERSION@
++</version>
++<headers>
++@HEADER_AS_LIST@
++</headers>
++<libs>
++@CMAKE_BINARY_DIR@/libubuntu-app-launch/libubuntu-app-launch.so.@ABI_VERSION@
++</libs>
 === added file 'libubuntu-app-launch/abi-check/check-abi.sh.in'
 --- libubuntu-app-launch/abi-check/check-abi.sh.in	1970-01-01 00:00:00 +0000
 +++ libubuntu-app-launch/abi-check/check-abi.sh.in	2016-08-17 13:13:53 +0000
@@ -0,0 +1,28 @@
++#!/bin/sh
++
++set -e
++
++if [ ! -e "/usr/lib/@UBUNTU_APP_LAUNCH_ARCH@/libubuntu-app-launch.so.@ABI_VERSION@" ] ; then
++	exit 0
++fi
++
++cd @CMAKE_CURRENT_BINARY_DIR@
++
++LIBRARY_NAME=@CMAKE_PROJECT_NAME@
++LIBRARY_VERSION=@ABI_VERSION@
++
++rm -rf abi_dumps
++rm -rf installed_dumps
++rm -rf build_dumps
++
++abi-compliance-checker -l ${LIBRARY_NAME} -dump @CMAKE_CURRENT_BINARY_DIR@/installed.xml
++mv abi_dumps installed_dumps
++
++abi-compliance-checker -l ${LIBRARY_NAME} -dump @CMAKE_CURRENT_BINARY_DIR@/build.xml
++mv abi_dumps build_dumps
++
++abi-compliance-checker \
++	-l ${LIBRARY_NAME} \
++	-old installed_dumps/${LIBRARY_NAME}/${LIBRARY_NAME}_${LIBRARY_VERSION}.abi.tar.gz \
++	-new build_dumps/${LIBRARY_NAME}/${LIBRARY_NAME}_${LIBRARY_VERSION}.abi.tar.gz
++
 === added file 'libubuntu-app-launch/abi-check/installed.xml.in'
 --- libubuntu-app-launch/abi-check/installed.xml.in	1970-01-01 00:00:00 +0000
 +++ libubuntu-app-launch/abi-check/installed.xml.in	2016-08-17 13:13:53 +0000
@@ -0,0 +1,9 @@
++<version>
++@ABI_VERSION@
++</version>
++<headers>
++/usr/include/libubuntu-app-launch-@API_VERSION@/
++</headers>
++<libs>
++/usr/lib/@UBUNTU_APP_LAUNCH_ARCH@/libubuntu-app-launch.so.@ABI_VERSION@
++</libs>