[ros2doctor] Environment Report by InvincibleRMC · Pull Request #1045 · ros2/ros2cli

InvincibleRMC · 2025-06-04T18:35:05Z

Description

Adds gathering environment information to ros2 doctor --report

Fixes #1046

Is this user-facing behavior change?

It will allow reports to contain more useful debugging information.

Did you use Generative AI?

No

Additional Information

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC · 2025-08-02T02:38:15Z

Updated this PR: to use list as dicussed in #1046. CC: @fujitatomoya

fujitatomoya

test would be ideal.

but before adding the test, i would like to bring this PR to ROS PMC meeting for the approval. IMO this is still helpful information.

ros2doctor/ros2doctor/api/__init__.py

ros2doctor/ros2doctor/api/qos_compatibility.py

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC · 2025-08-04T17:38:23Z

test would be ideal.

but before adding the test, i would like to bring this PR to ROS PMC meeting for the approval. IMO this is still helpful information.

Sure let me know their thoughts and if they are fine with this approach will add tests. Just didn't want to spend time writing tests for an approach they disagree with.

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

… into environment-report

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC · 2025-08-05T16:35:55Z

Consensus from the meeting seems to be that the variables living here for now is fine. Until a better place is found for them in the future.

ros2doctor/ros2doctor/api/__init__.py

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

ros-discourse · 2025-08-05T21:39:40Z

This pull request has been mentioned on Open Robotics Discourse. There might be relevant details there:

https://discourse.openrobotics.org/t/ros-pmc-minutes-for-august-5-2025/49439/1

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

fujitatomoya

lgtm with green CI.

ros2doctor/test/test_report_environment.py

fujitatomoya · 2025-08-06T02:27:07Z

Pulls: #1045
Gist: https://gist.githubusercontent.com/fujitatomoya/f9b219b77fc09a8d54637d3f574d05ea/raw/5b4372e91d9b9a819b32032b884c91a4d8cd3325/ros2.repos
BUILD args: --packages-above-and-dependencies ros2doctor
TEST args: --packages-above ros2doctor
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/16667

Linux
Linux-aarch64
Linux-rhel
Windows

InvincibleRMC · 2025-08-06T02:33:50Z

@fujitatomoya fyi the tests are not all working yet. Working on some kinks still. will ping when complete.

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC · 2025-08-06T08:07:07Z

Got it down to only zenoh problems. Probably some problem in how I have EnableRmwIsolation set up. I have spent literally over 12 hours writing these trying to find the right voodoo spells to make it all work. Will give it another shot tomorrow.

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC · 2025-08-06T17:43:51Z

@fujitatomoya Ok there seems to be some flakeyness on the ros2cli tests still but, the test_environment_report seems to be passing now.

fujitatomoya · 2025-08-07T03:12:27Z

Linux
Linux-aarch64
Linux-rhel
Windows

ros2doctor/ros2doctor/api/environment.py

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

fujitatomoya · 2025-08-08T03:59:40Z

@InvincibleRMC @christophebedard thanks! and 🤞🤞🤞

Linux
Linux-aarch64
Linux-rhel
Windows

christophebedard

LGTM with green CI!

ros2doctor/test/test_environment_report.py

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

christophebedard · 2025-08-08T17:51:07Z

Pulls: #1045
Gist: https://gist.githubusercontent.com/christophebedard/d907f6afd2b86d15cf805265d93591a3/raw/5b4372e91d9b9a819b32032b884c91a4d8cd3325/ros2.repos
BUILD args: --packages-above-and-dependencies ros2doctor
TEST args: --packages-above ros2doctor
ROS Distro: rolling
Job: ci_launcher
ci_launcher ran: https://ci.ros2.org/job/ci_launcher/16686

Linux
Linux-aarch64
Linux-rhel
Windows

christophebedard · 2025-08-08T22:24:03Z

@ros-pull-request-builder retest this please

christophebedard · 2025-08-08T23:36:03Z

ros2doctor.ros2doctor.test.test_qos_compatibility.TestROS2DoctorQoSCompatibility.{test_check,test_report} seem to be failing pretty consistently, but I don't think it's related to this PR.

I created an issue with more information: #1088

christophebedard · 2025-08-08T23:41:10Z

@fujitatomoya what do you think?

fujitatomoya · 2025-08-09T03:06:40Z

@christophebedard thanks for the information, i do agree with you. those failures are not related to this PR. i think we can take this PR and address #1088 with another PR.

fujitatomoya · 2025-08-09T03:07:53Z

@InvincibleRMC as we talked bi-weekly meeting, can you update the ros2_documentation about the support for service/action endpoint list and environmental variables a bit?

christophebedard · 2025-08-19T22:22:58Z

ros2doctor/ros2doctor/api/__init__.py

+
+RMW_FASTRTPS_ENVIRONMENT_VARIABLES: Final = [
+    'FASTDDS_BUILTIN_TRANSPORTS',
+    'FASTRTPS_DEFAULT_PROFILES_FILE',


@InvincibleRMC weird follow-up, but I think this was renamed to FASTDDS_DEFAULT_PROFILES_FILE now, see ros2/rmw_fastrtps#806

Do you think it would be better to flat out update it or have both with a note that one of them is deprecated?

I think it should be updated to the new name here.

Separately, maybe there should be a list of deprecated env vars for which we list values (if set) and warn that they are deprecated?

InvincibleRMC added 2 commits June 4, 2025 09:52

Add environment information

0e751cf

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

Add support for different casings

fafc439

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC mentioned this pull request Jun 4, 2025

Adding Environment Information to ros2doctor #1046

Closed

InvincibleRMC added 3 commits August 1, 2025 17:07

Merge branch 'rolling' into environment-report

e16e91d

Update to use ros2doctor list rather than dynamic lookup

ab32bd1

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

fix bug in name

8796a84

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC marked this pull request as ready for review August 2, 2025 02:37

fujitatomoya reviewed Aug 3, 2025

View reviewed changes

ros2doctor/ros2doctor/api/__init__.py Outdated Show resolved Hide resolved

ros2doctor/ros2doctor/api/__init__.py Show resolved Hide resolved

ros2doctor/ros2doctor/api/qos_compatibility.py Outdated Show resolved Hide resolved

fujitatomoya assigned InvincibleRMC Aug 3, 2025

Update ros2doctor/ros2doctor/api/__init__.py

f289bb3

Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC added 4 commits August 4, 2025 10:41

removing pure typing changes

1c7af4d

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

Merge branch 'environment-report' of github.com:InvincibleRMC/ros2cli…

c3e8d4b

… into environment-report

remove extra newline

3f8e332

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

add back collections from typing import

839c566

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

christophebedard reviewed Aug 5, 2025

View reviewed changes

ros2doctor/ros2doctor/api/__init__.py Outdated Show resolved Hide resolved

InvincibleRMC added 2 commits August 5, 2025 11:00

Add tracing environment variables and switch order

108769f

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

add test

45d642a

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC added 5 commits August 5, 2025 14:49

Fix spelling

91bb685

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

Add warning

cf565a5

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

remove junk

afc215e

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

remove log

898379d

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

test setUp

235de49

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

fujitatomoya approved these changes Aug 6, 2025

View reviewed changes

ros2doctor/test/test_report_environment.py Outdated Show resolved Hide resolved

fujitatomoya requested a review from christophebedard August 6, 2025 02:26

InvincibleRMC added 8 commits August 5, 2025 22:54

test other arg

7d594bb

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

sort environment first

69b833b

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

finally something that works

9e35116

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

switch zenoh environ var

b09efec

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

cleanup

81ee161

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

cleanup

ad461f3

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

change rust log files

eab235e

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

rename test file

ebc74b1

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

InvincibleRMC added 3 commits August 6, 2025 09:44

update test name

33bd4ca

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

simplify launch

5b0fb76

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

remove bonus space in name

dc58512

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

christophebedard requested changes Aug 7, 2025

View reviewed changes

InvincibleRMC and others added 2 commits August 7, 2025 16:25

Update ros2doctor/ros2doctor/api/environment.py

692f804

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

update with feedback

c331e7a

Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

christophebedard reviewed Aug 8, 2025

View reviewed changes

ros2doctor/test/test_environment_report.py Outdated Show resolved Hide resolved

christophebedard approved these changes Aug 8, 2025

View reviewed changes

Update ros2doctor/test/test_environment_report.py

4bc166e

Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Michael Carlstrom <rmc@carlstrom.com>

christophebedard mentioned this pull request Aug 8, 2025

ros2doctor.test.test_qos_compatibility.{test_check,test_report} are flaky #1088

Closed

fujitatomoya merged commit 26dccbf into ros2:rolling Aug 9, 2025
2 of 3 checks passed

christophebedard reviewed Aug 19, 2025

View reviewed changes

Conversation

InvincibleRMC commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Is this user-facing behavior change?

Did you use Generative AI?

Additional Information

Uh oh!

InvincibleRMC commented Aug 2, 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!

Uh oh!

InvincibleRMC commented Aug 4, 2025

Uh oh!

InvincibleRMC commented Aug 5, 2025

Uh oh!

Uh oh!

ros-discourse commented Aug 5, 2025

Uh oh!

fujitatomoya left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

fujitatomoya commented Aug 6, 2025

Uh oh!

InvincibleRMC commented Aug 6, 2025

Uh oh!

InvincibleRMC commented Aug 6, 2025

Uh oh!

InvincibleRMC commented Aug 6, 2025

Uh oh!

fujitatomoya commented Aug 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fujitatomoya commented Aug 8, 2025

Uh oh!

christophebedard left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

christophebedard commented Aug 8, 2025

Uh oh!

christophebedard commented Aug 8, 2025

Uh oh!

christophebedard commented Aug 8, 2025

Uh oh!

christophebedard commented Aug 8, 2025

Uh oh!

fujitatomoya commented Aug 9, 2025

Uh oh!

Uh oh!

fujitatomoya commented Aug 9, 2025

Uh oh!

christophebedard Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

InvincibleRMC Aug 19, 2025

Choose a reason for hiding this comment

Uh oh!

christophebedard Aug 20, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

InvincibleRMC commented Jun 4, 2025 •

edited

Loading

InvincibleRMC commented Aug 2, 2025 •

edited

Loading