Skip to content

[#24602] Unify filter aliases and fix help output for readers#151

Merged
Danipiza merged 2 commits into
mainfrom
hotfix/help-command
Jun 9, 2026
Merged

[#24602] Unify filter aliases and fix help output for readers#151
Danipiza merged 2 commits into
mainfrom
hotfix/help-command

Conversation

@Danipiza

@Danipiza Danipiza commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR updates the fastddsspy filter command so f, filter, and filters all use the same implementation, instead of treating filters as a special-case display/clear command.

It also fixes the help output so the readers command is shown correctly.

Changes

  • unify filter command handling for f, filter, and filters
  • update help output to use filters as the documented command prefix
  • fix the readers entry in the help command output
  • update application tests for the new help text and filter alias behavior
Insert a command for Fast DDS Spy:
>> h
Fast DDS Spy is an interactive CLI that allow to instrospect DDS networks.
Each command shows data related with the network in Yaml format.
Commands available and the information they show:
	help                                        : this help.
	version                                     : tool version.
	quit                                        : exit interactive CLI and close program.
	participants                                : DomainParticipants discovered in the network.
	participants verbose                        : verbose information about DomainParticipants discovered in the network.
	participants <Guid>                         : verbose information related with a specific DomainParticipant.
	writers                                     : DataWriters discovered in the network.
	writers verbose                             : verbose information about DataWriters discovered in the network.
	writers <Guid>                              : verbose information related with a specific DataWriter.

### Changed `reader` to `readers` 
	readers                                     : DataReaders discovered in the network.
	readers verbose                             : verbose information about DataReaders discovered in the network.
	readers <Guid>                              : verbose information related with a specific DataReader.
###
	topics                                      : Topics discovered in the network in compact format.
	topics v                                    : Topics discovered in the network.
	topics vv                                   : verbose information about Topics discovered in the network.
	topics <name>                               : Topics discovered in the network filtered by name (wildcard allowed (*)).
	topics <name> idl                           : Display the IDL type definition for topics matching <name> (wildcards allowed).
	topics <name> keys                          : Display the keys for topics matching <name> (wildcards allowed).
	topics <name> keys v                        : verbose information about keys discovered in the network.
	filters                                     : Display the active filters.
	filters clear                               : Clear all the filter lists.

### Changed `filter` to `filters` 
	filters clear <category>                    : Clear <category> filter list.
	filters add partitions <filter_str>         : Add <filter_str> in partitions filter list.
	filters remove partitions <filter_str>      : Remove <filter_str> in partitions filter list.
	filters set topic <topic_name> <filter_str> : Set topic filter list with <filter_str> as first value.
###
	echo <name>                                 : data of a specific Topic (Data Type must be discovered).
	echo <wildcard_name>                        : data of Topics matching the wildcard name (and whose Data Type is discovered).
	echo <name> verbose                         : data with additional source info of a specific Topic.
	echo <wildcard_name> verbose                : data with additional source info of Topics matching the topic name (wildcard allowed (*)).
	echo all                                    : verbose data of all topics (only those whose Data Type is discovered).

Notes and comments:
	To exit from data printing, press enter.
	Each command is accessible by using its first letter (h/v/q/p/w/r/t/s/f).

For more information about these commands and formats, please refer to the documentation:
https://fast-dds-spy.readthedocs.io/en/latest/

Signed-off-by: danipiza <dpizarrogallego@gmail.com>
Signed-off-by: danipiza <dpizarrogallego@gmail.com>
@Danipiza Danipiza changed the title [#24602] Fix 'reader' typo in help command output [#24602] Unify filter aliases and fix help output for readers Jun 8, 2026
@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 80.00000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 57.45%. Comparing base (faaa92a) to head (5be6f36).

Files with missing lines Patch % Lines
fastddsspy_tool/src/cpp/tool/Controller.cpp 80.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #151      +/-   ##
==========================================
- Coverage   62.12%   57.45%   -4.67%     
==========================================
  Files          29       28       -1     
  Lines        2508     1932     -576     
  Branches     1072      768     -304     
==========================================
- Hits         1558     1110     -448     
+ Misses        387      344      -43     
+ Partials      563      478      -85     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ZakariaTalbi ZakariaTalbi left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM

@Danipiza Danipiza merged commit 1c51730 into main Jun 9, 2026
32 of 34 checks passed
@Danipiza Danipiza deleted the hotfix/help-command branch June 9, 2026 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants