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

Allow using plugin file names and environment variables compatible with Garden and later #2275

Merged
merged 7 commits into from
Jan 12, 2024

Conversation

azeey
Copy link
Contributor

@azeey azeey commented Jan 4, 2024

🎉 New feature

Summary

Allows using gz-* in plugin filenames (eg. <plugin filename="gz-sim-physics-system" name="gz::sim::systems::Physics"/>) and using GZ_* environment variables in Fortress. This is meant to help users (especially ROS users) maintain SDF files and launch files that work in both Fortress and Garden/Harmonic.

Test it

I've added tests that exercise:

  • Using gz-sim-* filenames in <plugin> tags (src/SystemLoader_TEST.cc)
  • Using GZ_SIM_SYSTEM_PLUGIN_PATH (src/SystemLoader_TEST.cc)
  • Using GZ_SIM_RESOURCE_PATH (src/Server.cc)
  • Using GZ_SIM_SERVER_CONFIG_PATH (src/ServerConfig_TEST.cc)

I have not added a test for GZ_SIM_RENDER_ENGINE_PATH since I couldn't find a test for IGN_GAZEBO_RENDER_ENGINE_PATH and I don't think it's a commonly used environment variable.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • 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 and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

@github-actions github-actions bot added the 🏯 fortress Ignition Fortress label Jan 4, 2024
@azeey azeey self-assigned this Jan 4, 2024
Signed-off-by: Addisu Z. Taddese <[email protected]>
@azeey azeey marked this pull request as ready for review January 4, 2024 22:09
@azeey azeey requested a review from iche033 as a code owner January 4, 2024 22:09
Signed-off-by: Addisu Z. Taddese <[email protected]>
Copy link
Contributor

@iche033 iche033 left a comment

Choose a reason for hiding this comment

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

just minor comments otherwise looks good

src/SystemLoader_TEST.cc Outdated Show resolved Hide resolved
src/ServerPrivate.hh Outdated Show resolved Hide resolved
@azeey
Copy link
Contributor Author

azeey commented Jan 5, 2024

I found that GZ_SIM_RESOURCE_PATH wasn't working even though the tests I added were passing. I've made some fixes and added tests in 68a129a. @iche033 PTAL

@iche033
Copy link
Contributor

iche033 commented Jan 6, 2024

the UNIT_Server_TEST failure in gz_sim_ci-pr_any-focal-amd64 build could be unrelated. The tests pass locally for me

azeey added 2 commits January 11, 2024 20:52
Also use the user-commands system for testing instead of physics since the
physics system does not load properly on windows CI.

Signed-off-by: Addisu Z. Taddese <[email protected]>
Signed-off-by: Addisu Z. Taddese <[email protected]>
src/SystemLoader_TEST.cc Outdated Show resolved Hide resolved
Signed-off-by: Addisu Z. Taddese <[email protected]>
@azeey
Copy link
Contributor Author

azeey commented Jan 12, 2024

CI is good. Windows warnings are preexisting, so I'll go ahead and merge.

@azeey azeey merged commit 45a01a8 into gazebosim:ign-gazebo6 Jan 12, 2024
8 of 10 checks passed
@azeey azeey deleted the use_gz_vars_in_fortress branch January 12, 2024 22:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏯 fortress Ignition Fortress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants