ign-cmake requires component versions to match but debian metadata doesn't

[scpeters]

I recently saw a user report about a configration error in gazebo_ros when trying to find_package(Gazebo) related to different installed versions of libignition-common3* packages. In this case, the libignition-common3 and libignition-common3-core-dev have version 3.13.2, while all the other components have version 3.13.0. This leads to a cmake error due to a requirement in ign-cmake that all components have the same exact version as the core library. This becomes a problem because there is not such constraint expressed in the debian metadata for ign-common3 (it does constrain the -dev packages to match their corresponding lib package, but there aren't constraints between component libraries).

--- stderr: gazebo_ros                                                                                                                                   
CMake Error at /usr/share/cmake-3.16/Modules/CMakeFindDependencyMacro.cmake:47 (find_package):
  Could not find a configuration file for package "ignition-common3-graphics"
  that exactly matches requested version "3.13.2".
  The following configuration files were considered but not accepted:
    /usr/lib/x86_64-linux-gnu/cmake/ignition-common3-graphics/ignition-common3-graphics-config.cmake, version: 3.13.0
Call Stack (most recent call first):
  /usr/lib/x86_64-linux-gnu/cmake/ignition-common3/ignition-common3-config.cmake:203 (find_dependency)
  /usr/lib/x86_64-linux-gnu/cmake/gazebo/gazebo-config.cmake:250 (find_package)
  ws/install/gazebo_dev/share/gazebo_dev/cmake/gazebo_dev-extras.cmake:2 (find_package)
  ws/install/gazebo_dev/share/gazebo_dev/cmake/gazebo_devConfig.cmake:41 (include)
  CMakeLists.txt:26 (find_package)
---
Failed   <<< gazebo_ros [6.49s, exited with code 1]

$ dpkg-query --list | grep libignition-common3 
ii  libignition-common3:amd64                     3.13.2-1~focal                                      amd64        Ignition Common classes and functions for robot apps - Shared library 
ii  libignition-common3-av:amd64                  3.13.0-1~focal                                      amd64        Ignition Common classes and functions (AV) - Shared library 
ii  libignition-common3-av-dev:amd64              3.13.0-1~focal                                      amd64        Ignition Common classes and functions (AV) - Development files 
ii  libignition-common3-core-dev:amd64            3.13.2-1~focal                                      amd64        Ignition Common classes and functions (core) - Development files 
ii  libignition-common3-dev:amd64                 3.13.0-1~focal                                      amd64        Ignition Common classes and functions for robot apps - Metapackage 
ii  libignition-common3-events:amd64              3.13.0-1~focal                                      amd64        Ignition Common classes and functions (Events) - Shared library 
ii  libignition-common3-events-dev:amd64          3.13.0-1~focal                                      amd64        Ignition Common classes and functions (Events) - Development files 
ii  libignition-common3-graphics:amd64            3.13.0-1~focal                                      amd64        Ignition Common classes and functions (Graphics) - Shared library 
ii  libignition-common3-graphics-dev:amd64        3.13.0-1~focal                                      amd64        Ignition Common classes and functions (Graphics) - Development files 
ii  libignition-common3-profiler:amd64            3.13.0-1~focal                                      amd64        Ignition Common classes and functions (Profiler) - Shared library 
ii  libignition-common3-profiler-dev:amd64        3.13.0-1~focal                                      amd64        Ignition Common classes and functions (profiler) - Development files

[j-rivero]

With current setup, dependency chain is more flexible but I think that we can not assure that a particular version of the library X.Y.Z is going to make API fully compatible with X.W.V (adding new features that don't break current API could require to have all the components in the same version to make them work properly). Following semantic versioning, we could probably relax the restriction on ign-cmake to match MAJOR.MINOR and leave PATCH out of the check, I don't think that we can relax it to go without only MAJOR.

Quickest solution by now is to make components to depend on the binary versions, opencv is doing the same for official Debian packages.

Code changes are trivial gazebo-release/gz-common3-release#1 , we will need to run a new release bumping just the release number or wait until the next release.

[scpeters]

Code changes are trivial ignition-release/ign-common3-release#1 , we will need to run a new release bumping just the release number or wait until the next release.

thanks! I just tested that branch with ign-common3 3.13.2-2 and it looks good, so I approved and merged the PR. I'll work on forward-porting the changes to ignition-common4 and then assess which other packages should be updated

[scpeters]

I'll work on forward-porting the changes to ignition-common4 and then assess which other packages should be updated

gazebo-release/gz-common4-release#5

[scpeters]

it looks like the metadata is already in place for the eigen component of math6:

• https://github.com/ignition-release/ign-math6-release/blob/main/ubuntu/debian/control#L38

[scpeters]

it looks like the metadata is already in place for the eigen component of math6:

• https://github.com/ignition-release/ign-math6-release/blob/main/ubuntu/debian/control#L38

and math7 as well:

• https://github.com/ignition-release/ign-math7-release/blob/main/ubuntu/debian/control#L38

[scpeters]

release-repos to update (only those with ign-cmake components):

• ign-cmake: only a single debian package libignition-cmake2-dev for all components
• ign-common: Make all interdependencies to require the same binary version gazebo-release/gz-common3-release#1, Require component -dev packages use same version gazebo-release/gz-common4-release#5, Require component -dev packages use same version gazebo-release/gz-common5-release#1
• ign-gazebo: metadata is already in place
• ign-math: this metadata is already in place
• [ ] ign-msgs doesn't actually have cmake components
• ign-physics
  • Make interdependencies require same binary version gazebo-release/gz-physics2-release#10
  • Add Bullet gazebo-release/ign-physics3-release#3
  • Add Bullet metadata gazebo-release/ign-physics4-release#12
  • Add bullet and height map metadata gazebo-release/gz-physics5-release#2
  • 6: fix from 5 included from the start
• ign-plugin: only a single debian package libignition-plugin-dev for all components
• ign-rendering
  • Make interdependencies require same binary version gazebo-release/gz-rendering3-release#5
  • Make interdependencies require same binary version gazebo-release/ign-rendering4-release#6
  • Make interdependencies require same binary version gazebo-release/ign-rendering5-release#4
  • Make interdependencies require same binary version gazebo-release/gz-rendering6-release#6
  • Make interdependencies require same binary version gazebo-release/gz-rendering7-release#1
• ign-sensors
  • Make interdependencies require same binary version gazebo-release/gz-sensors3-release#3
  • Make interdependencies require same binary version gazebo-release/ign-sensors4-release#3
  • Make interdependencies require same binary version gazebo-release/ign-sensors5-release#6
  • Make interdependencies require same binary version gazebo-release/gz-sensors6-release#5
  • Make interdependencies require same binary version gazebo-release/gz-sensors7-release#2
• ign-transport:
  • Make interdependencies require same binary version gazebo-release/gz-transport8-release#1
  • Make interdependencies require same binary version gazebo-release/ign-transport9-release#1
  • Make interdependencies require same binary version gazebo-release/ign-transport10-release#5
  • Make interdependencies require same binary version gazebo-release/gz-transport11-release#2
• ign-utils: metadata is already in place

[scpeters]

I think each version of ignition-transport will need the fix:

• https://github.com/ignition-release/ign-transport10-release/blob/fb1f1ca97b7dab9db5a97da8e3e0ad8d854be051/ubuntu/debian/control#L55

[scpeters]

ign-physics versions will need the fix:

• https://github.com/ignition-release/ign-physics4-release/blob/b37a33762d1bb53c5009ae232d2c8ae09d440d95/ubuntu/debian/control#L49

[scpeters]

rendering and sensors need the fix too

• rendering: https://github.com/ignition-release/ign-rendering5-release/blob/75a7f31ea39061a3518e2be7b10d8cde9d456f01/ubuntu/debian/control#L66
• sensors: https://github.com/ignition-release/ign-sensors5-release/blob/main/ubuntu/debian/control#L60

[scpeters]

rebuilding ign-transport8 on focal:

• https://build.osrfoundation.org/job/ign-transport8-debbuilder/57/
• https://build.osrfoundation.org/job/ign-transport8-debbuilder/58/

[chapulina]

@scpeters , are you planning to address the 3 remaining libraries?

[scpeters]

@scpeters , are you planning to address the 3 remaining libraries?

yes, I will start working on this

[scpeters]

fixes are now merged or in pull requests for all affected packages