Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Protobuf_IMPORT_DIRS instead of PROTOBUF_IMPORT_DIRS for compatibility with Protobuf CMake config #715

Merged
merged 1 commit into from
Apr 5, 2021

Conversation

traversaro
Copy link
Contributor

@traversaro traversaro commented Mar 28, 2021

🦟 Bug fix

Fixes the compilation of Ignition Gazebo on Windows or in any case on a platform in which Protobuf installs its CMake Config files.

Summary

Ignition Gazebo uses the PROTOBUF_GENERATE_CPP CMake function to generate C++ code from the .proto files.
Depending on the system and the protobuf version installed, this function can be defined in two possible places:

As currently ignition-gazebo only sets the PROTOBUF_IMPORT_DIRS variable, if a Protobuf CMake config is used, the generation of messages fails with error:

2021-03-27T23:20:08.8623834Z -- Build files have been written to: D:/bld/libignition-gazebo4_1616885912413/work/build
2021-03-27T23:20:09.2594171Z [1/408] cmd.exe /C "cd /D %SRC_DIR%\build\src\msgs && %PREFIX%\Library\bin\protoc.exe --cpp_out D:/bld/libignition-gazebo4_1616885912413/work/build/src/msgs -I D:/bld/libignition-gazebo4_1616885912413/work/src/msgs D:/bld/libignition-gazebo4_1616885912413/work/src/msgs/peer_info.proto"
2021-03-27T23:20:09.2597900Z FAILED: src/msgs/peer_info.pb.h src/msgs/peer_info.pb.cc 
2021-03-27T23:20:09.2605328Z cmd.exe /C "cd /D %SRC_DIR%\build\src\msgs && %PREFIX%\Library\bin\protoc.exe --cpp_out D:/bld/libignition-gazebo4_1616885912413/work/build/src/msgs -I D:/bld/libignition-gazebo4_1616885912413/work/src/msgs D:/bld/libignition-gazebo4_1616885912413/work/src/msgs/peer_info.proto"
2021-03-27T23:20:09.2606754Z ignition/msgs/header.proto: File not found.
2021-03-27T23:20:09.2613215Z peer_info.proto:22:1: Import "ignition/msgs/header.proto" was not found or had errors.
2021-03-27T23:20:09.2614568Z peer_info.proto:28:3: "ignition.msgs.Header" is not defined.
2021-03-27T23:20:09.2616338Z [2/408] cmd.exe /C "cd /D %SRC_DIR%\build\src\msgs && %PREFIX%\Library\bin\protoc.exe --cpp_out D:/bld/libignition-gazebo4_1616885912413/work/build/src/msgs -I D:/bld/libignition-gazebo4_1616885912413/work/src/msgs D:/bld/libignition-gazebo4_1616885912413/work/src/msgs/peer_control.proto"
2021-03-27T23:20:09.2618072Z FAILED: src/msgs/peer_control.pb.h src/msgs/peer_control.pb.cc 
2021-03-27T23:20:09.2619552Z cmd.exe /C "cd /D %SRC_DIR%\build\src\msgs && %PREFIX%\Library\bin\protoc.exe --cpp_out D:/bld/libignition-gazebo4_1616885912413/work/build/src/msgs -I D:/bld/libignition-gazebo4_1616885912413/work/src/msgs D:/bld/libignition-gazebo4_1616885912413/work/src/msgs/peer_control.proto"
2021-03-27T23:20:09.2621084Z ignition/msgs/header.proto: File not found.
2021-03-27T23:20:09.2625509Z peer_control.proto:22:1: Import "ignition/msgs/header.proto" was not found or had errors.
2021-03-27T23:20:09.2627093Z peer_control.proto:30:3: "ignition.msgs.Header" is not defined.
2021-03-27T23:20:09.2628926Z [3/408] cmd.exe /C "cd /D %SRC_DIR%\build\src\msgs && %PREFIX%\Library\bin\protoc.exe --cpp_out D:/bld/libignition-gazebo4_1616885912413/work/build/src/msgs -I D:/bld/libignition-gazebo4_1616885912413/work/src/msgs D:/bld/libignition-gazebo4_1616885912413/work/src/msgs/simulation_step.proto"
2021-03-27T23:20:09.2630539Z FAILED: src/msgs/simulation_step.pb.h src/msgs/simulation_step.pb.cc 
2021-03-27T23:20:09.2638659Z cmd.exe /C "cd /D %SRC_DIR%\build\src\msgs && %PREFIX%\Library\bin\protoc.exe --cpp_out D:/bld/libignition-gazebo4_1616885912413/work/build/src/msgs -I D:/bld/libignition-gazebo4_1616885912413/work/src/msgs D:/bld/libignition-gazebo4_1616885912413/work/src/msgs/simulation_step.proto"
2021-03-27T23:20:09.2639864Z ignition/msgs/world_stats.proto: File not found.
2021-03-27T23:20:09.2640359Z ignition/msgs/entity.proto: File not found.

(error taken from conda-forge/libignition-gazebo-feedstock#3).

To avoid this errors, I switched the Ignition Gazebo to set the Protobuf_IMPORT_DIRS variable that will work fine regardless of whether a CMake config file for ProtoBuf is used or not.

However, as the use of Protobuf_IMPORT_DIRS (instead of PROTOBUF_IMPORT_DIRS) was only introduced in CMake 3.6 (see https://github.com/Kitware/CMake/blob/v3.20.0/Modules/FindProtobuf.cmake#L13), I also bumped the minimum required version to 3.10.2 (for consistency with ignition-cmake2). CMake 3.10.2 is available in apt in Ubuntu 18.04 (see https://repology.org/project/cmake/versions).

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

@github-actions github-actions bot added the 🏰 citadel Ignition Citadel label Mar 28, 2021
@traversaro
Copy link
Contributor Author

(I will fix the DCO soon).

…ility with Protobuf CMake config

Signed-off-by: Silvio Traversaro <[email protected]>
@traversaro
Copy link
Contributor Author

(I will fix the DCO soon).

Done.

@traversaro
Copy link
Contributor Author

traversaro commented Mar 28, 2021

Added tests

I did not add tests, I am not sure if they are needed for something like that, probably a relevant coverage could be done by setting up Windows CI, but that probably calls for a separate endeavor.

@traversaro
Copy link
Contributor Author

While waiting for a review on your PR, please help review another open pull request to support the maintainers

I reviewed gazebosim/gz-gui#202, even if it is probably an easy one. :D

@chapulina chapulina added bug Something isn't working Windows Windows support labels Mar 29, 2021
Copy link
Contributor

@chapulina chapulina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! The bump in CMake version shouldn't have negative effects, as pointed out in the PR description, upstream libraries already require it.

@chapulina chapulina merged commit dfb43a0 into gazebosim:ign-gazebo3 Apr 5, 2021
scpeters added a commit that referenced this pull request May 19, 2021
* 🎈 3.8.0 (#688)

Signed-off-by: Louise Poubel <[email protected]>

* Make it so joint state publisher is quieter (#696)

Signed-off-by: Michael Carroll <[email protected]>

* [BULLET] Making GetContactsFromLastStepFeature optional in Collision Features (#690)

* GetContactsFromLastStepFeature made optional

Signed-off-by: Tomas Lorente <[email protected]>

Co-authored-by: Addisu Z. Taddese <[email protected]>

* Add test for thermal object temperatures below 0 kelvin (#621)

Signed-off-by: Ashton Larkin <[email protected]>

* Scenebroadcaster sensors (#698)

* Add sensors to scene broadcaster

Signed-off-by: Nate Koenig <[email protected]>

* Update src/systems/scene_broadcaster/SceneBroadcaster.cc

Co-authored-by: Michael Carroll <[email protected]>

* Fix codecheck

Signed-off-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>
Co-authored-by: Michael Carroll <[email protected]>

* Fix diffuse and ambient values for ackermann example (#707)

Signed-off-by: Ammaar Solkar <[email protected]>

* 🎈 5.0.0 (#731)

Signed-off-by: Louise Poubel <[email protected]>

* Support configuring particle scatter ratio in particle emitter system (#674)

* set particle scatter ratio through sdf

Signed-off-by: Ian Chen <[email protected]>

* address feedback

Signed-off-by: Ian Chen <[email protected]>

* add todo note about merging forward

Signed-off-by: Ian Chen <[email protected]>

Co-authored-by: Ashton Larkin <[email protected]>

* Update PlaybackScrubber description (#733)

Signed-off-by: Ammaar Solkar <[email protected]>

* Iterate through changed links only in UpdateSim (#678)

Signed-off-by: Ashton Larkin <[email protected]>

* Do not pass -Wno-unused-parameter to MSVC compiler (#716)

Signed-off-by: Silvio Traversaro <[email protected]>

* Use Protobuf_IMPORT_DIRS instead of PROTOBUF_IMPORT_DIRS for compatibility with Protobuf CMake config (#715)

Signed-off-by: Silvio Traversaro <[email protected]>

* Fix component inspector shutdown crash (#724)

Signed-off-by: Louise Poubel <[email protected]>

Co-authored-by: Alejandro Hernández Cordero <[email protected]>

* Validate step size and RTF parameters (#740)

Only set them if they are strictly positive.

Signed-off-by: Luca Della Vedova <[email protected]>

* Fix compute_rtfs arguments (#737)

Signed-off-by: Caio Amaral <[email protected]>

* Fixed collision visual bounding boxes (#746)

Signed-off-by: Jenn Nguyen <[email protected]>

* Fix CMakelists.txt merge

Signed-off-by: Nate Koenig <[email protected]>

* ECM's ChangedState gets message with modified components (#742)

* ecm's ChangedState to contain modified components

Signed-off-by: Jenn Nguyen <[email protected]>

* updated log_system test

Signed-off-by: Jenn Nguyen <[email protected]>

* removed unnecessary calls

Signed-off-by: Jenn Nguyen <[email protected]>

Co-authored-by: Ian Chen <[email protected]>

* fixed particle emitter forward playback (#745)

Signed-off-by: Jenn Nguyen <[email protected]>

* Merge pull request #730 from ignitionrobotics/particle_emitter

Particle emitter based on SDF

* 4 7 0 prep (#755)

* Prepare for 4.7.0

Signed-off-by: Nate Koenig <[email protected]>

* Added placeholder

Signed-off-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

* Fix 'invalid animation update data' msg for actors (#754)

Signed-off-by: Ashton Larkin <[email protected]>

* Update benchmark comparison instructions (#766) (#766)

Signed-off-by: Ashton Larkin <[email protected]>

* [DiffDrive] add enable/disable (#772)

* add enable/disable diffdrive

Signed-off-by: Guillaume Doisy <[email protected]>

* remove debug

Signed-off-by: Guillaume Doisy <[email protected]>

* do not subscribe to enable if topic is empty

Signed-off-by: Guillaume Doisy <[email protected]>

* add test

Signed-off-by: Guillaume Doisy <[email protected]>

* lint and style

Signed-off-by: Guillaume Doisy <[email protected]>

* change enable type to bool and renamed to enabled

Signed-off-by: Guillaume Doisy <[email protected]>

* Add odometry publisher system (#547)

* Create Initial Odometry Publisher system plugin

Add code for initial plugin that gets position from Pose component and
calculates velocities based on rolling mean from displacement data.

Signed-off-by: Maganty Rushyendra <[email protected]>

* Remove Linear and Angular Velocity components

Also renames frames in Odometry msg to include model name, and makes
various style changes.

Signed-off-by: Maganty Rushyendra <[email protected]>

* Get World pose instead of pose of robot base frame

Signed-off-by: Maganty Rushyendra <[email protected]>

* Add documentation for variables and functions

Includes minor stylistic changes.

Signed-off-by: Maganty Rushyendra <[email protected]>

* Check for valid odomTopic and update copyright year

Signed-off-by: Maganty Rushyendra <[email protected]>

* Add tests for OdometryPublisherSystem and fix velocity calculation bug

Swap X and Y linear velocities when calculating odometry velocities
relative to robotBaseFrame.

Signed-off-by: Maganty Rushyendra <[email protected]>

Co-authored-by: ahcorde <[email protected]>

* Patch particle emitter2 service (#777)

* Patch particle emitter2 service

Signed-off-by: Nate Koenig <[email protected]>

* Remove condition variable

Signed-off-by: Nate Koenig <[email protected]>

* Set emitter frame and relative pose

Signed-off-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

* Preparing for 4.8.0 release (#780)

Signed-off-by: Nate Koenig <[email protected]>

Co-authored-by: Nate Koenig <[email protected]>

* 👩‍🌾 Enable Focal CI (#646)

Signed-off-by: Louise Poubel <[email protected]>

Co-authored-by: Michael Carroll <[email protected]>

* [TPE] Support setting individual link velocity  (#427)

Signed-off-by: claireyywang <[email protected]>
Signed-off-by: Ian Chen <[email protected]>

Co-authored-by: Ian Chen <[email protected]>
Co-authored-by: Louise Poubel <[email protected]>

* Don't store duplicate ComponentTypeId in ECM (#751)

Signed-off-by: Louise Poubel <[email protected]>

* Feature/hydrodynamics (#749)

Implement hydrodynamics and thruster plugin.

Signed-off-by: Arjo Chakravarty <[email protected]>
Co-authored-by: Mabel Zhang <[email protected]>
Co-authored-by: Carlos Agüero <[email protected]>

* Fix macOS build: components::Name in benchmark (#784)

Signed-off-by: Louise Poubel <[email protected]>

Co-authored-by: Steve Peters <[email protected]>

* Fix ColladaExporter submesh index bug (#763)

Signed-off-by: Jorge Perez <[email protected]>

* 👩‍🌾 Fix Windows build and some warnings (#782)

Signed-off-by: Louise Poubel <[email protected]>

Co-authored-by: Alejandro Hernández Cordero <[email protected]>

* Prevent crash on Plotting plugin with mutex (#747)

Signed-off-by: Louise Poubel <[email protected]>

* Bump ign-physics version to 3.2 (#792)

Signed-off-by: Louise Poubel <[email protected]>

* Bump to ign-msgs 7.1 / sdformat 11.1, Windows fixes (#758)

Signed-off-by: Louise Poubel <[email protected]>

* Util: Use public API from libsdformat for detecting non-file source (#794)

Signed-off-by: Eric Cousineau <[email protected]>

* Fix included nested model expansion in SDF generation (#768)

* fixed included nested model expansion

Signed-off-by: Jenn Nguyen <[email protected]>

* added resource path to test

Signed-off-by: Jenn Nguyen <[email protected]>

* use orig URIs & support multi level nesting

Signed-off-by: Jenn Nguyen <[email protected]>

* save fuel version when enabled

Signed-off-by: Jenn Nguyen <[email protected]>

* retrieve uri from map

Signed-off-by: Jenn Nguyen <[email protected]>

* copy included element

Signed-off-by: Jenn Nguyen <[email protected]>

* clear attributes before copying include element

Signed-off-by: Jenn Nguyen <[email protected]>

* Map canonical links to their models (#736)

Signed-off-by: Ashton Larkin <[email protected]>

* ColladaExporter, export submesh selected (#802)

* Export only submesh if selected
* Add test case for the PR
* Attempting a unified solution

Signed-off-by: Jorge Perez <[email protected]>
Co-authored-by: Nate Koenig <[email protected]>

Co-authored-by: Michael Carroll <[email protected]>
Co-authored-by: Jose Tomas Lorente <[email protected]>
Co-authored-by: Addisu Z. Taddese <[email protected]>
Co-authored-by: Ashton Larkin <[email protected]>
Co-authored-by: Nate Koenig <[email protected]>
Co-authored-by: Nate Koenig <[email protected]>
Co-authored-by: Ammaar Solkar <[email protected]>
Co-authored-by: Ian Chen <[email protected]>
Co-authored-by: Ashton Larkin <[email protected]>
Co-authored-by: Silvio Traversaro <[email protected]>
Co-authored-by: Alejandro Hernández Cordero <[email protected]>
Co-authored-by: Luca Della Vedova <[email protected]>
Co-authored-by: Caio Amaral <[email protected]>
Co-authored-by: Jenn Nguyen <[email protected]>
Co-authored-by: G.Doisy <[email protected]>
Co-authored-by: Rushyendra Maganty <[email protected]>
Co-authored-by: Claire Wang <[email protected]>
Co-authored-by: Arjo Chakravarty <[email protected]>
Co-authored-by: Mabel Zhang <[email protected]>
Co-authored-by: Carlos Agüero <[email protected]>
Co-authored-by: Steve Peters <[email protected]>
Co-authored-by: Jorge Perez <[email protected]>
Co-authored-by: Eric Cousineau <[email protected]>
Co-authored-by: Jorge Perez <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working 🏰 citadel Ignition Citadel Windows Windows support
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants