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

[ros2doctor] Add QoS compatibility check and report #621

Merged
merged 13 commits into from
Apr 23, 2021

Conversation

audrow
Copy link
Member

@audrow audrow commented Apr 10, 2021

Here is an example of what the check looks like if an incompatibility error is detected;

/root/ros2_ws/build/ros2doctor/ros2doctor/api/qos_compatibility.py: 49: UserWarning: ERROR: QOS compatibility error found on topic '/my_chatter'. Use `ros2 doctor --report` for more details.

Here is what a report looks like with two pub/sub pairs, one compatible and one incompatible:

   QOS COMPATIBILITY LIST
topic [type]            : /chatter [std_msgs/msg/String]
publisher node          : talker
subscriber node         : listener
compatibility status    : OK
topic [type]            : /my_chatter [std_msgs/msg/String]
publisher node          : mynode
subscriber node         : mynode
compatibility status    : ERROR: Best effort publisher and reliable subscription;

The messages for warnings are similar.

Here is the report if there are no publisher/subscription pairs:

   QOS COMPATIBILITY LIST
compatibility status    : No publisher/subscriber pairs found

I haven't written any tests for this yet and would be happy for suggestions on how to do so.

Signed-off-by: Audrow Nash <audrow@hey.com>
@audrow audrow added the enhancement New feature or request label Apr 10, 2021
@audrow audrow self-assigned this Apr 10, 2021
Signed-off-by: Audrow Nash <audrow@hey.com>
Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

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

i am good to go with this, test would be ideal.

Signed-off-by: Audrow Nash <audrow@hey.com>
Copy link
Member

@jacobperron jacobperron left a comment

Choose a reason for hiding this comment

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

Looks good! I've left some comments/suggestions below.

I haven't tried it out yet. I agree that it would be good to add a test.

ros2doctor/ros2doctor/api/__init__.py Outdated Show resolved Hide resolved
ros2doctor/ros2doctor/api/__init__.py Outdated Show resolved Hide resolved
ros2doctor/ros2doctor/api/qos_compatibility.py Outdated Show resolved Hide resolved
ros2doctor/ros2doctor/api/qos_compatibility.py Outdated Show resolved Hide resolved
Signed-off-by: Audrow Nash <audrow@hey.com>
Signed-off-by: Audrow Nash <audrow@hey.com>
Signed-off-by: Audrow Nash <audrow@hey.com>
Signed-off-by: Audrow Nash <audrow@hey.com>
Signed-off-by: Audrow Nash <audrow@hey.com>
@audrow
Copy link
Member Author

audrow commented Apr 14, 2021

The new check error output is as follows:

/root/ros2_ws/build/ros2doctor/ros2doctor/api/qos_compatibility.py: 49: UserWarning: ERROR: QoS compatibility error found on topic '/chatter': Best effort publisher and reliable subscription;

Warnings are displayed similarly.

@audrow audrow marked this pull request as ready for review April 14, 2021 20:13
Copy link
Member

@jacobperron jacobperron left a comment

Choose a reason for hiding this comment

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

LGTM pending CI

Copy link
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

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

lgtm with a couple of nitpicks.

@fujitatomoya
Copy link
Collaborator

fujitatomoya commented Apr 15, 2021

CI:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

Signed-off-by: Audrow Nash <audrow@hey.com>
Signed-off-by: Audrow Nash <audrow@hey.com>
@audrow
Copy link
Member Author

audrow commented Apr 15, 2021

Another CI run:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

Signed-off-by: Audrow Nash <audrow@hey.com>
@audrow audrow force-pushed the audrow/add-qos-compatibilty-to-ros2doctor branch from de62ba6 to b58c083 Compare April 15, 2021 20:59
@audrow
Copy link
Member Author

audrow commented Apr 15, 2021

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

Signed-off-by: Audrow Nash <audrow@hey.com>
Signed-off-by: Audrow Nash <audrow@hey.com>
@audrow
Copy link
Member Author

audrow commented Apr 17, 2021

I weakened the tests because I was still getting the errors on CI with repeated retries. I'm not sure why several ROS2 doctor checks fail on CI, but not on my local machine.

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

@audrow audrow merged commit 2f0ed23 into master Apr 23, 2021
@delete-merged-branch delete-merged-branch bot deleted the audrow/add-qos-compatibilty-to-ros2doctor branch April 23, 2021 15:41
@RDaneelOlivav
Copy link

Is this feture in the debians already? Because I've run this in my local isntalation og Galactic and it just doesnt generate this Compatibility info. Any ideas?

@fujitatomoya
Copy link
Collaborator

I think that this is merged only to master (Humble), so galactic does not support this feature.

@jacobperron
Copy link
Member

That's correct, this is only available in Rolling (to be Humble). However, I think the nature of the change makes it backportable if someone would like to open up a backport PR to Galactic (and maybe Foxy).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants