rosidl_cli: Add type description support #857

frneer · 2025-03-21T14:41:25Z

This patch adds support for type description generation in rosidl_cli. It introduces a new hash command to generate type descriptions. It also ensures they are always present as part of the generate command even if the user doesn't provide them.

Addresses #808

Recommended Review Order

I recommend starting with the new hash generator in rosidl_cli/rosidl_cli/command/hash, which utilizes the extension defined in rosidl_generator_type_description/rosidl_generator_type_description/cli.py, and then progressing to the other changes.

Notes

I verified that no updates were required in other parts of rosidl, such as rosidl_python and rosidl_typesupport.

hidmic · 2025-03-21T14:44:52Z

FYI @calderpg-tri

hidmic · 2025-03-21T15:02:53Z

@sloretz @fujitatomoya for review, perhaps?

fujitatomoya · 2025-03-25T20:36:09Z

@hidmic i can try but i do not have bandwidth for this week, probably next week.

hidmic · 2025-04-04T17:54:54Z

@fujitatomoya friendly ping.

sloretz · 2025-04-10T23:51:15Z

@Mergifyio rebase

Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com>

mergify · 2025-04-10T23:51:25Z

rebase

✅ Branch has been successfully rebased

sloretz

I don't totally understand what type description hash files are, but IIUC the rosidl_cli is not used in our normal builds. IIRC some people use it for Bazel builds.

I'm inclined to merge this PR if a full CI run passes.

sloretz · 2025-04-11T00:01:23Z

It looks the PR job is showing some test failures. @frneer mind addressing those, and then I can run full CI when that's done?

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>

hidmic · 2025-04-14T18:13:56Z

@sloretz linting issues addressed.

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>

hidmic · 2025-04-14T19:44:34Z

Hmm, I cannot fully reproduce all flake8 errors that CI reports in my local Rolling container. Let's see if it likes 12fabce

hidmic · 2025-04-21T19:19:13Z

@sloretz friendly ping

This patch adds support for `type_description` generation to `rosidl`. It depends on ros2/rosidl#857. **Warning**: This patch switches the main branch support to support `jazzy` (only) instead of `humble` (only). ## Testing the changes locally To test the changes follow these [instructions](https://gist.github.com/frneer/bfce42af74670d40df5ea240fa611cb5#file-instructions-md). Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com>

sloretz · 2025-04-25T20:40:53Z

@Mergifyio update

mergify · 2025-04-25T20:40:59Z

update

✅ Branch has been successfully updated

sloretz · 2025-04-25T20:42:22Z

Pulls: #857
Gist: https://gist.githubusercontent.com/sloretz/074c8f03de765e1bf1fd14c0e7601b96/raw/d055fd05809827eb89449e3ce092f4b7f3cdd4bb/ros2.repos
BUILD args:
TEST args:
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/15793

Linux
Linux-aarch64
Linux-rhel
Windows

hidmic · 2025-04-25T21:46:26Z

@sloretz it looks like Windows didn't like the recent Rust addition ros2/ros2@adcb538.

mjcarroll · 2025-04-25T22:19:17Z

@sloretz it looks like Windows didn't like the recent Rust addition ros2/ros2@adcb538.

Sorry, I thought it had already run through full CI, here is a revert: ros2/ros2#1677

mjcarroll · 2025-04-25T22:20:01Z

@esteve can you ptal and see what's going on with Windows here? It seems related to rosidl_generator_rs and is probably independent of this PR.

esteve · 2025-04-26T07:46:18Z

ros2-rust/rosidl_rust@77732ce should fix the Windows issue. We don't have a CI for Windows ros2-rust yet (ros2-rust/ros2_rust#110), but hopefully soon. Can you trigger another CI run?

christophebedard · 2025-04-26T16:09:32Z

I retriggered the Windows job above, which includes ros2-rust/rosidl_rust with ros2-rust/rosidl_rust#3 now

esteve · 2025-04-27T21:08:56Z

@christophebedard thanks

hidmic · 2025-04-28T15:13:57Z

Thanks @christophebedard! Failing tests on Windows seem unrelated. Could this move forward @sloretz?

hidmic · 2025-05-05T18:38:14Z

@sloretz @christophebedard @fujitatomoya friendly ping.

christophebedard · 2025-05-05T23:41:45Z

I'll update the branch and run CI again just to make sure. Then I'll merge it based on Shane's approval.

christophebedard · 2025-05-05T23:41:52Z

@Mergifyio update

mergify · 2025-05-05T23:41:58Z

update

❌ Mergify doesn't have permission to update

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/check-copied-type-description-sources.yaml without workflows permission

christophebedard · 2025-05-05T23:56:44Z

Pulls: #857
Gist: https://gist.githubusercontent.com/christophebedard/46e34c7d0555cbae9876684e42664479/raw/db2cc394bbcb77ff87914985115d07de3aba69f5/ros2.repos
BUILD args:
TEST args:
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/15912

Linux
Linux-aarch64
Linux-rhel
Windows

fujitatomoya

i do not really understand the details, just a couple of comments in general. both does not block this PR.

rosidl_cli/rosidl_cli/command/hash/__init__.py

rosidl_cli/rosidl_cli/command/generate/api.py

fujitatomoya · 2025-05-06T21:38:26Z

@frneer @hidmic thanks for being patient on this.

@christophebedard should we restart the CI? it has been a day...

hidmic · 2025-05-06T21:39:00Z

should we restart the CI? it has been a day...

I was going to ask. That'd be great.

christophebedard · 2025-05-06T21:41:09Z

I already re-triggered the Linux and Linux-rhel jobs this morning because they failed (infra-related). They should be starting soon ™️

christophebedard · 2025-05-06T22:25:12Z

That was soon enough, both jobs are running now! Fingers crossed that they don't fail 🤞

fujitatomoya · 2025-05-06T22:37:25Z

BTW, Linux-aarch64 and windows warnings are unrelated.

hidmic · 2025-05-07T10:44:05Z

Network hiccup on RHEL?

christophebedard · 2025-05-07T12:42:07Z

Yeah, it's the same infra flake that's been happening a lot lately. The RHEL job queue has 8 jobs currently, so running this would take a(nother) while. We could just merge this based on the fact that the 3 other jobs passed and that the RHEL job passed last time (#857 (comment)).

@fujitatomoya what do you think?

fujitatomoya · 2025-05-07T16:21:20Z

Linux-rhel

last shot 🔫 btw, CI does not assign the unique build id when the job is in the queue. i think 2940 is ours.

hidmic · 2025-05-09T15:55:23Z

@fujitatomoya @christophebedard @sloretz looks like another infra fluke on RHEL

fujitatomoya · 2025-05-09T18:10:15Z

Linux-rhel

@hidmic let me try this again, i will keep my eyes on this during weekend. if that comes back green, i will go ahead to merge this.

fujitatomoya · 2025-05-11T23:32:15Z

https://ci.ros2.org/job/ci_linux-rhel/3031/testReport/junit/ros2param.ros2param.test/test_verb_load/test_verb_load/ is not related to this PR.

hidmic · 2025-05-12T12:10:23Z

Amazing, thank you @fujitatomoya! Can we summon MergifyIO and backport to Jazzy? Tagging @christophebedard @sloretz too for completeness.

fujitatomoya · 2025-05-12T16:31:27Z

@Mergifyio backport kilted jazzy

mergify · 2025-05-12T16:31:33Z

backport kilted jazzy

✅ Backports have been created

#866 rosidl_cli: Add type description support (backport #857) has been created for branch kilted
#867 rosidl_cli: Add type description support (backport #857) has been created for branch jazzy but encountered conflicts

* Add type description support to rosidl_cli Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> * Fix typing annotation Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> * Please flake8, mypy Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> * Please flake8 take 2 Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> --------- Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> (cherry picked from commit c9a3084)

* Add type description support to rosidl_cli Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> * Fix typing annotation Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> * Please flake8, mypy Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> * Please flake8 take 2 Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> --------- Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> (cherry picked from commit c9a3084) # Conflicts: # rosidl_cli/rosidl_cli/cli.py # rosidl_cli/rosidl_cli/command/generate/api.py # rosidl_cli/rosidl_cli/command/generate/extensions.py # rosidl_cli/rosidl_cli/command/helpers.py

* rosidl_cli: Add type description support (#857) * Add type description support to rosidl_cli Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> * Fix typing annotation Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> * Please flake8, mypy Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> * Please flake8 take 2 Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> --------- Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> (cherry picked from commit c9a3084) # Conflicts: # rosidl_cli/rosidl_cli/cli.py # rosidl_cli/rosidl_cli/command/generate/api.py # rosidl_cli/rosidl_cli/command/generate/extensions.py # rosidl_cli/rosidl_cli/command/helpers.py * Solve conflicts (#868) Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> * Please flake8 (#870) Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> --------- Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: Francisco Rossi <50388097+frneer@users.noreply.github.com> Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com>

* Add type description support to rosidl_cli * Fix typing annotation * Please flake8, mypy * Please flake8 take 2 --------- (cherry picked from commit c9a3084) Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com> Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: Francisco Rossi <50388097+frneer@users.noreply.github.com> Co-authored-by: Michel Hidalgo <michel@ekumenlabs.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>

frneer mentioned this pull request Mar 25, 2025

Add rosidl type description support RobotLocomotion/drake-ros#381

Merged

fujitatomoya self-requested a review March 25, 2025 20:36

fujitatomoya added the enhancement New feature or request label Mar 25, 2025

frneer added 2 commits April 10, 2025 23:51

Add type description support to rosidl_cli

a2e4e32

Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com>

Fix typing annotation

1952bfe

Signed-off-by: Francisco Rossi <frossi@ekumenlabs.com>

sloretz force-pushed the frn/rolling/cli_type_description_support branch from 4f72aab to 1952bfe Compare April 10, 2025 23:51

sloretz approved these changes Apr 11, 2025

View reviewed changes

Please flake8, mypy

6d2a6b5

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>

Please flake8 take 2

12fabce

Signed-off-by: Michel Hidalgo <michel@ekumenlabs.com>

Merge branch 'rolling' into frn/rolling/cli_type_description_support

71d0c28

Merge branch 'rolling' into frn/rolling/cli_type_description_support

5b002ef

fujitatomoya reviewed May 6, 2025

View reviewed changes

rosidl_cli/rosidl_cli/command/hash/__init__.py Show resolved Hide resolved

rosidl_cli/rosidl_cli/command/generate/api.py Show resolved Hide resolved

fujitatomoya merged commit c9a3084 into ros2:rolling May 11, 2025
3 checks passed

mergify bot mentioned this pull request May 12, 2025

rosidl_cli: Add type description support (backport #857) #866

Merged

mergify bot mentioned this pull request May 12, 2025

rosidl_cli: Add type description support (backport #857) #867

Merged

rosidl_cli: Add type description support #857

rosidl_cli: Add type description support #857

Uh oh!

Conversation

frneer commented Mar 21, 2025

Recommended Review Order

Notes

Uh oh!

hidmic commented Mar 21, 2025

Uh oh!

hidmic commented Mar 21, 2025

Uh oh!

fujitatomoya commented Mar 25, 2025

Uh oh!

hidmic commented Apr 4, 2025

Uh oh!

sloretz commented Apr 10, 2025

Uh oh!

mergify bot commented Apr 10, 2025

✅ Branch has been successfully rebased

Uh oh!

sloretz left a comment

Choose a reason for hiding this comment

Uh oh!

sloretz commented Apr 11, 2025

Uh oh!

hidmic commented Apr 14, 2025

Uh oh!

hidmic commented Apr 14, 2025

Uh oh!

hidmic commented Apr 21, 2025

Uh oh!

sloretz commented Apr 25, 2025

Uh oh!

mergify bot commented Apr 25, 2025

✅ Branch has been successfully updated

Uh oh!

sloretz commented Apr 25, 2025 • edited by christophebedard Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hidmic commented Apr 25, 2025

Uh oh!

mjcarroll commented Apr 25, 2025

Uh oh!

mjcarroll commented Apr 25, 2025

Uh oh!

esteve commented Apr 26, 2025

Uh oh!

christophebedard commented Apr 26, 2025

Uh oh!

esteve commented Apr 27, 2025

Uh oh!

hidmic commented Apr 28, 2025

Uh oh!

hidmic commented May 5, 2025

Uh oh!

christophebedard commented May 5, 2025

Uh oh!

christophebedard commented May 5, 2025

Uh oh!

mergify bot commented May 5, 2025

❌ Mergify doesn't have permission to update

Uh oh!

christophebedard commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fujitatomoya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fujitatomoya commented May 6, 2025

Uh oh!

hidmic commented May 6, 2025

Uh oh!

christophebedard commented May 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

christophebedard commented May 6, 2025

Uh oh!

sloretz commented Apr 25, 2025 •

edited by christophebedard

Loading

christophebedard commented May 5, 2025 •

edited

Loading

christophebedard commented May 6, 2025 •

edited

Loading

hidmic commented May 12, 2025 •

edited

Loading

mergify bot commented May 12, 2025 •

edited

Loading