Update bash completions for sonic-utilities commands #4163
+216
−253
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update the bash completion files for all sonic-utilities commands to make them compatible with the current Click version. Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes bash completion scripts for sonic-utilities commands to be compatible with the current version of Click. The changes migrate from Click's deprecated completion format (_COMPLETE=complete) to the modern format (_COMPLETE=bash_complete), which properly handles different completion types (directories, files, and plain text).
Key Changes:
- Updated all bash completion files to use Click's new
bash_completecompletion API - Standardized all completion scripts to a consistent 29-line template
- Fixed typos in rshell and rexec completion setup function names
Reviewed changes
Copilot reviewed 39 out of 40 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| watermarkstat | New completion file following the standardized template |
| watchdogutil | New completion file following the standardized template |
| undebug | Updated from old Click completion format to new bash_complete format |
| switchstat | New completion file following the standardized template |
| spm | Replaced reference to sonic-package-manager with full completion implementation |
| sonic_installer | Updated from old format to new bash_complete format |
| sonic-package-manager | Updated from old format to new bash_complete format |
| sonic-installer | Updated from old format to new bash_complete format |
| sonic-cli-gen | Updated from old format to new bash_complete format |
| sonic-clear | Updated from old format to new bash_complete format, but removed 'clear' alias |
| sonic-bootchart | New completion file following the standardized template |
| show | Updated from old format to new bash_complete format |
| sfputil | Updated from old format to new bash_complete format |
| sfpshow | New completion file following the standardized template |
| rshell | Updated from old format, fixed typo in function name, removed bash version check |
| rexec | Updated from old format, fixed typo in function name, removed bash version check |
| queuestat | New completion file following the standardized template |
| psuutil | Updated from old format to new bash_complete format |
| pfcwd | Updated from old format to new bash_complete format |
| pfc | Updated from old format to new bash_complete format |
| pddf_thermalutil | Updated from old format to new bash_complete format |
| pddf_psuutil | Updated from old format to new bash_complete format |
| pddf_ledutil | Updated from old format to new bash_complete format |
| pddf_fanutil | Updated from old format to new bash_complete format |
| pcieutil | New completion file following the standardized template |
| null_route_helper | New completion file following the standardized template |
| mmuconfig | New completion file following the standardized template |
| fwutil | Entire file deleted - completion removed for fwutil command |
| ecnconfig | New completion file following the standardized template |
| dump | Updated from old format to new bash_complete format |
| dropstat | New completion file following the standardized template |
| debug | Updated from old format to new bash_complete format |
| crm | Updated from old format to new bash_complete format |
| counterpoll | Updated from old format to new bash_complete format |
| consutil | Updated from old format to new bash_complete format |
| connect | Updated from old format to new bash_complete format |
| config | Updated from old format to new bash_complete format |
| buffershow | New completion file following the standardized template |
| acl-loader | Updated from old format to new bash_complete format, changed return code from 1 to 0 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| complete -F _sonic_clear_completion -o default sonic-clear; | ||
| complete -F _sonic_clear_completion clear; | ||
| _sonic_clear_completion_setup() { | ||
| complete -o nosort -F _sonic_clear_completion sonic-clear |
There was a problem hiding this comment.
The old completion file included a second complete command for the 'clear' alias: complete -F _sonic_clear_completion clear;. This line should be restored to maintain backward compatibility with the 'clear' command alias.
Suggested change
| complete -o nosort -F _sonic_clear_completion sonic-clear | |
| complete -o nosort -F _sonic_clear_completion sonic-clear | |
| complete -F _sonic_clear_completion clear; |
| fi | ||
| done | ||
|
|
||
| return 0 |
There was a problem hiding this comment.
The old completion function returned 1, but the new implementation returns 0. While returning 0 is more standard for bash completion functions, verify that this change doesn't break any expected behavior, as the original non-zero return may have been intentional.
Suggested change
| return 0 | |
| return 1 |
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Contributor
|
Is it possible to automate to generate the bash completion scripts? |
anders-nexthop
approved these changes
Jan 14, 2026
Contributor
anders-nexthop
left a comment
anders-nexthop
left a comment
There was a problem hiding this comment.
Looks okay to me but I agree with @qiluo-msft that having a way to generate these would be desirable. It would be pretty easy to miss adding the completion script for new commands.
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Update the show and watchdog CLIs so that the modules are at least importable outside of SONiC so that completion code can be generated. Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Signed-off-by: Saikrishna Arcot <sarcot@microsoft.com>
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
Update the bash completion files for all sonic-utilities commands to make them compatible with the current Click version.
Fixes sonic-net/sonic-buildimage#24594.
How I did it
Use Click's documentation to generate the bash completion script for each command that is packaged from sonic-utilities and uses Click.
How to verify it
Tested in KVM in Trixie image.
Previous command output (if the output of a command-line utility has changed)
New command output (if the output of a command-line utility has changed)