Updating ruby script to use standalone executable #1489

sauk2 · 2024-10-14T19:13:52Z

🎉 New feature

Summary

Updated the ruby script to use the standalone executable.

I also tried to resolve the issue of building the package because of the FrameSemantics class. You can check the error in ci of your branch.

I updated the CMakeLists and am not sure if the following is the right approach ...

  add_library(gz STATIC gz.cc ../FrameSemantics.cc)

Test it

Test any of the SDF commands

  gz sdf --help

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.

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>

azeey · 2025-01-07T21:57:24Z

@sauk2 have you had a chance to push this further?

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

sauk2 · 2025-01-08T18:26:10Z

@sauk2 have you had a chance to push this further?

@azeey Do take a look, I have made some changes to the tests.

azeey · 2025-01-08T20:07:07Z

src/gz_TEST.cc

-{
-  return " --force-version " + std::string(SDF_VERSION_FULL);
-}
-


Any reason for removing this? The --foce-version argument is handled by gz-tools (see https://github.com/gazebosim/gz-tools/blob/2b228e5b956f1e966053dd860374670573580b41/src/gz.in#L244). We need to make sure it still works with the change to using executables.

Done. I added it back and the tests should pass now!

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

src/gz_TEST.cc

azeey · 2025-01-09T16:37:10Z

src/cmd/sdf.bash_completion.sh

  --inertial-stats
  -h --help
-  --force-version
-  --versions
+  -v --version


The following test failed when --force-version and --versions were kept in.

sdformat/src/gz_TEST.cc

Lines 2071 to 2073 in 181c0ef

/// \brief Check help message and bash completion script for consistent flags

TEST(HelpVsCompletionFlags, GZ_UTILS_TEST_DISABLED_ON_WIN32(SDF))

{

I noticed those tags were removed in bash_completion of gz-transport so I did the same here. Let me know what you think.

hmm, I think we'll need to keep it here. Otherwise, it would not show up in the bash completions. I think it'd be better to modify the HelpVsCompletionFlags test to make it pass in this case.

src/cmd/sdf_main.cc

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

azeey

Other than the --force-versions issue, it LGTM!

azeey · 2025-01-13T23:54:25Z

src/cmd/sdf.bash_completion.sh

  --inertial-stats
  -h --help
-  --force-version
-  --versions
+  -v --version


hmm, I think we'll need to keep it here. Otherwise, it would not show up in the bash completions. I think it'd be better to modify the HelpVsCompletionFlags test to make it pass in this case.

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

sauk2 · 2025-01-22T16:22:44Z

Other than the --force-versions issue, it LGTM!

Added dummy flags in the executable to make that HelpVsCompletionFlags test pass.

sauk2 requested review from azeey and scpeters as code owners October 14, 2024 19:13

sauk2 mentioned this pull request Oct 14, 2024

WIP: Implement gz sdf as standalone executable #1465

Closed

9 tasks

sauk2 and others added 4 commits December 6, 2024 18:12

Updated ruby script to use standalone executable

49c3d4a

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

Fixed cmake to find source file for FrameSemantics

404adc9

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

Updated exe location in ruby script

e61024e

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

Add a dependency on gz-sdformat-sdf to the sdf_descriptions target

615048c

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>

azeey force-pushed the gz_sdf_executable branch from 2be0d2d to 615048c Compare December 7, 2024 00:12

azeey added 2 commits December 6, 2024 18:23

Remove unused variables

fc22623

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>

Add dependency on tinyxml2

d84a745

Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>

sauk2 added 2 commits January 9, 2025 01:05

Updated cmd line arguments in executable tests

a326ca1

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

Fixed help completion test

952aff6

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

azeey requested changes Jan 8, 2025

View reviewed changes

sauk2 added 2 commits January 9, 2025 23:41

Added force-version arg to tests

3755e3b

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

Fixed linting errors

50991f3

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

sauk2 requested a review from azeey January 9, 2025 16:12

azeey reviewed Jan 9, 2025

View reviewed changes

Reverted tests and updated executable options to work without args

e5b5f3d

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

sauk2 requested a review from azeey January 11, 2025 18:21

azeey approved these changes Jan 13, 2025

View reviewed changes

traversaro mentioned this pull request Jan 22, 2025

Investigate using python bindings of sdformat instead of the gz command line ami-iit/rod#30

Open

Added dummy flags to make tests pass

c32b991

Signed-off-by: Saurabh Kamat <kamatsaurabh01@gmail.com>

azeey approved these changes Jan 23, 2025

View reviewed changes

azeey merged commit 891e490 into gazebosim:scpeters/gz_sdf_executable Jan 23, 2025
7 checks passed

sauk2 deleted the gz_sdf_executable branch February 6, 2025 14:17

sauk2 mentioned this pull request Feb 25, 2025

Standalone gz sdf executable #1539

Merged

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating ruby script to use standalone executable #1489

Updating ruby script to use standalone executable #1489

sauk2 commented Oct 14, 2024 •

edited

Loading

azeey commented Jan 7, 2025

sauk2 commented Jan 8, 2025

azeey Jan 8, 2025

sauk2 Jan 9, 2025

azeey Jan 9, 2025

sauk2 Jan 11, 2025 •

edited

Loading

azeey Jan 13, 2025

azeey left a comment

azeey Jan 13, 2025

sauk2 commented Jan 22, 2025

	/// \brief Check help message and bash completion script for consistent flags
	TEST(HelpVsCompletionFlags, GZ_UTILS_TEST_DISABLED_ON_WIN32(SDF))
	{

Updating ruby script to use standalone executable #1489

Updating ruby script to use standalone executable #1489

Conversation

sauk2 commented Oct 14, 2024 • edited Loading

🎉 New feature

Summary

Test it

Checklist

azeey commented Jan 7, 2025

sauk2 commented Jan 8, 2025

azeey Jan 8, 2025

Choose a reason for hiding this comment

sauk2 Jan 9, 2025

Choose a reason for hiding this comment

azeey Jan 9, 2025

Choose a reason for hiding this comment

sauk2 Jan 11, 2025 • edited Loading

Choose a reason for hiding this comment

azeey Jan 13, 2025

Choose a reason for hiding this comment

azeey left a comment

Choose a reason for hiding this comment

azeey Jan 13, 2025

Choose a reason for hiding this comment

sauk2 commented Jan 22, 2025

sauk2 commented Oct 14, 2024 •

edited

Loading

sauk2 Jan 11, 2025 •

edited

Loading