Add `ros2 service info` command by schornakj · Pull Request #703 · ros2/ros2cli

schornakj · 2022-03-27T22:33:45Z

Adds a new info verb to ros2 service, which lists the nodes that advertise clients and servers for a given service. I found that I needed a tool like this to help introspect big collections of ROS nodes, especially since some problems are really difficult to diagnose without it (for example, two nodes having service servers with the same type and topic name).

The pattern of implementation is similar to ros2 action info, and it produces similar output:

$ ros2 service info /my_service
Service:  /my_service
Service clients: 1
    /some_client_node
Service servers: 1
    /some_server_node

I modified the tests for ros2service to include a service client node in addition to the existing service server node. This required some changes to tests for other CLI tools since they have built-in assumptions about the number of nodes being run.

Signed-off-by: Joe Schornak joe.schornak@gmail.com

Signed-off-by: Joe Schornak <joe.schornak@gmail.com>

fujitatomoya · 2022-03-28T04:17:29Z

@schornakj 👍 IMO, this option is worth to keep. i will have a look.

schornakj · 2022-03-28T14:13:03Z

I'm seeing failures in the new unit tests when I run them locally that I think are caused by the output text getting mangled when it's parsed. Not sure how to resolve that right now, since these tests follow the same pattern as the other ones that deal with printed output.

FAIL: test_cli.TestROS2ServiceCLI.test_info[rmw_cyclonedds_cpp]
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Traceback (most recent call last):
  File "/opt/ros/rolling/lib/python3.8/site-packages/launch_testing/markers.py", line 57, in _wrapper
    return func(self, *args, **kwargs)
  File "/home/jschornak/workspaces/ros2_cli_ws/src/ros2cli/ros2service/test/test_cli.py", line 230, in test_info
    assert launch_testing.tools.expect_output(
AssertionError: assert False
 +  where False = <function expect_output at 0x7f506d5c7a60>(expected_lines=['Service: /my_ns/echo', 'Service clients: 1', '    /my_ns/echo_client', 'Service servers: 1', '    /my_ns/echo_server'], text='Service: /my_ns/echo\nService clients: 1\n    //m/y/_/n/secho_client\nService servers: 1\n    //m/y/_/n/secho_server\n', strict=True)
 +    where <function expect_output at 0x7f506d5c7a60> = <module 'launch_testing.tools' from '/opt/ros/rolling/lib/python3.8/site-packages/launch_testing/tools/__init__.py'>.expect_output
 +      where <module 'launch_testing.tools' from '/opt/ros/rolling/lib/python3.8/site-packages/launch_testing/tools/__init__.py'> = launch_testing.tools
 +    and   'Service: /my_ns/echo\nService clients: 1\n    //m/y/_/n/secho_client\nService servers: 1\n    //m/y/_/n/secho_server\n' = <launch_testing.tools.process.ProcessProxy object at 0x7f50689ec100>.output

schornakj · 2022-04-06T22:33:31Z

@fujitatomoya Do you think it's possible for me to get this in before the feature freeze for Humble?

Right now, CI testing is failing for reasons that seem unrelated to the content of this PR, so I'm not sure how to approach resolving that.

clalancette · 2022-04-06T23:35:55Z

@fujitatomoya Do you think it's possible for me to get this in before the feature freeze for Humble?

No, sorry. The feature freeze was already yesterday; we are now feature and API complete for Humble. That said, this is still valuable to get in (once freeze is lifted), and if it doesn't break API we can consider backporting it once Humble is released.

gbiggs

LGTM pending CI and tests passing.

gbiggs · 2022-12-29T01:27:01Z

CI:

Linux
Linux-aarch64
Windows

fujitatomoya

ros2cli implementation conflicts with #771, probably we can merge them into one implementation, especially test scenario.

fujitatomoya · 2023-01-03T22:27:25Z

ros2service/ros2service/verb/info.py

+        parser.add_argument(
+            '-t', '--show-types', action='store_true',
+            help='Additionally show the service type')
+        parser.add_argument(
+            '-c', '--count', action='store_true',
+            help='Only display the number of service clients and service servers')


Since this is info command, these should be always printed?

ros2 topic info command always prints type and count, there is not even opt-out option.

if possible, It seems good to be consistent in the same format and option. (https://docs.ros.org/en/rolling/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Topics/Understanding-ROS2-Topics.html#ros2-topic-info)

leeminju531 · 2023-01-11T16:23:21Z

ros2service/ros2service/api/__init__.py

+    service_servers = []
+
+    expanded_name = expand_topic_name(service_name, node.get_name(), node.get_namespace())
+    validate_full_topic_name(expanded_name)


Suggested change

validate_full_topic_name(expanded_name)

validate_full_topic_name(expanded_name,is_service=True)

fujitatomoya · 2023-09-10T06:01:26Z

i think we can come back to this PR after #771 is merged.

Ryanf55 · 2024-01-19T00:10:52Z

i think we can come back to this PR after #771 is merged.

Yay, 771 is merged!

This is a great feature and would be very handy when connecting non-ROS DDS systems to ROS based systems. Introspection is great, especially with a -v flag similar to ros2 topic -v that shows the QOS settings.

fujitatomoya · 2024-01-19T18:39:22Z

I think we can close this PR, mostly has been done with #771.

@schornakj what do you think? if you have the support -v option in mind, that requires rmw changes as well.

fujitatomoya · 2024-01-19T18:56:47Z

#877 created to follow up ros2 service info -v support for introspection.

clalancette · 2024-02-01T18:26:53Z

Given the work that went into #771, and the follow-up in #877, I'm going to close this out. If you feel there is still value in some of the other work here, please feel free to open a new PR with those changes.

add verb to get service client and server info

a8140c2

Signed-off-by: Joe Schornak <joe.schornak@gmail.com>

clalancette self-assigned this Apr 21, 2022

audrow changed the base branch from master to rolling June 28, 2022 14:23

schornakj mentioned this pull request Dec 15, 2022

why is there no option 'info' in ros2 service ? #766

Closed

gbiggs approved these changes Dec 29, 2022

View reviewed changes

schornakj mentioned this pull request Jan 2, 2023

Add ros2 service info #771

Merged

fujitatomoya reviewed Jan 3, 2023

View reviewed changes

leeminju531 reviewed Jan 11, 2023

View reviewed changes

clalancette closed this Feb 1, 2024

	validate_full_topic_name(expanded_name)
	validate_full_topic_name(expanded_name,is_service=True)

Conversation

schornakj commented Mar 27, 2022

Uh oh!

fujitatomoya commented Mar 28, 2022

Uh oh!

schornakj commented Mar 28, 2022

Uh oh!

schornakj commented Apr 6, 2022

Uh oh!

clalancette commented Apr 6, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gbiggs left a comment

Choose a reason for hiding this comment

Uh oh!

gbiggs commented Dec 29, 2022

Uh oh!

fujitatomoya left a comment

Choose a reason for hiding this comment

Uh oh!

fujitatomoya Jan 3, 2023

Choose a reason for hiding this comment

Uh oh!

fujitatomoya Jan 3, 2023

Choose a reason for hiding this comment

Uh oh!

leeminju531 Jan 15, 2023

Choose a reason for hiding this comment

Uh oh!

leeminju531 Jan 11, 2023

Choose a reason for hiding this comment

Uh oh!

fujitatomoya commented Sep 10, 2023

Uh oh!

Ryanf55 commented Jan 19, 2024

Uh oh!

fujitatomoya commented Jan 19, 2024

Uh oh!

fujitatomoya commented Jan 19, 2024

Uh oh!

clalancette commented Feb 1, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

clalancette commented Apr 6, 2022 •

edited

Loading