[sfputil] add support for sfputil debug tx-output/rx-output {port} enable/disable #3811

vdahiya12 · 2025-03-17T21:55:26Z

Summary of Changes

What I did

Added a new debug.py module to handle SFP diagnostics and debugging.
Replaced existing utility methods with functions from utilities_common.platform_sfputil_helper.
Registered debug as a subcommand in sfputil/main.py.

How I did it

Created a new debug.py file under sfputil/.
Implemented the debug command group with the following subcommands:
- loopback: Configures SFP loopback modes.
- tx-output: Enables or disables TX output.
- rx-output: Enables or disables RX output.
Used helper functions from utilities_common.platform_sfputil_helper for better modularity and maintainability.
Updated sfputil/main.py to integrate the new debug command.

How to verify it

UT and deploy changed on a testbed

Run the following command to check if debug is now available:
```
sfputil debug --help
```
sfputil debug tx-output Ethernet0 enable
sfputil debug rx-output Ethernet0 disable

Usage: sfputil debug [OPTIONS] COMMAND [ARGS]...
Try "sfputil debug --help" for help.

Error: no such option: -h
admin@sonic:~$ sudo sfputil debug --help
Usage: sfputil debug [OPTIONS] COMMAND [ARGS]...

  Group for debugging and diagnostic control commands.

  This command group loads platform-specific utilities and prepares them for
  use in diagnostic commands.

Options:
  --help  Show this message and exit.

Commands:
  loopback   Set module diagnostic loopback mode.
  rx-output  Enable or disable RX output on a port.
  tx-output  Enable or disable TX output on a port.
admin@sonic:~$ sudo sfputil debug rx-output --help
Usage: sfputil debug rx-output [OPTIONS] PORT_NAME [enable|disable]

  Enable or disable RX output on a port.

Options:
  --help  Show this message and exit.
admin@sonic:~$

enable/disable Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-17T21:55:33Z

/azp run

azure-pipelines · 2025-03-17T21:55:43Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-17T22:23:38Z

/azp run

azure-pipelines · 2025-03-17T22:23:47Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-17T22:26:17Z

/azp run

azure-pipelines · 2025-03-17T22:26:32Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-17T22:37:49Z

/azp run

azure-pipelines · 2025-03-17T22:37:59Z

Azure Pipelines successfully started running 1 pipeline(s).

prgeor · 2025-03-17T22:41:56Z

@vdahiya12 can you paste the complte output of --help for debug in the pr "How to verify it"

sfputil/debug.py

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-17T23:16:08Z

/azp run

azure-pipelines · 2025-03-17T23:16:17Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-18T02:06:41Z

/azp run

azure-pipelines · 2025-03-18T02:06:51Z

Azure Pipelines successfully started running 1 pipeline(s).

Copilot

Pull Request Overview

This PR adds a new "debug" command group to sfputil to support diagnostic operations on SFP modules, including loopback, tx-output, and rx-output commands. Key changes include:

Creation of a new sfputil/debug.py module implementing debug and its subcommands.
Updates to tests in tests/sfputil_test.py to cover tx-output and rx-output functionality.
Minor refactoring in utilities_common/platform_sfputil_helper.py and integration in sfputil/main.py to support the changes.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
sfputil/debug.py	New module providing debug commands for loopback and enabling/disabling outputs.
tests/sfputil_test.py	Added tests for tx-output and rx-output commands; potential mismatch in error output.
utilities_common/platform_sfputil_helper.py	Refactored chassis and port mapping functions to support new debug functionality.
sfputil/main.py	Integrated the debug command into the CLI and removed the old debug subgroup.

tests/sfputil_test.py

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-18T22:35:35Z

/azp run

azure-pipelines · 2025-03-18T22:35:45Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-18T23:07:19Z

/azp run

azure-pipelines · 2025-03-18T23:07:29Z

Azure Pipelines successfully started running 1 pipeline(s).

mssonicbld · 2025-03-25T20:25:03Z

/azp run

azure-pipelines · 2025-03-25T20:25:15Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-25T20:30:22Z

/azp run

vdahiya12 · 2025-03-25T21:14:16Z

/azpw run

mssonicbld · 2025-03-25T21:14:19Z

/AzurePipelines run

azure-pipelines · 2025-03-25T21:14:30Z

Azure Pipelines successfully started running 1 pipeline(s).

Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-03-25T21:16:57Z

/azp run

azure-pipelines · 2025-03-25T21:17:08Z

Azure Pipelines successfully started running 1 pipeline(s).

Junchao-Mellanox · 2025-03-31T04:00:31Z

Hi @prgeor , will this be cherry-picked to 202412?

…able/disable (sonic-net#3811) * [sfputil] add support for sfputil debug tx-output/rx-output enable/disable Signed-off-by: Vaibhav Dahiya <[email protected]> * refactor Signed-off-by: Vaibhav Dahiya <[email protected]> * add p Signed-off-by: Vaibhav Dahiya <[email protected]> * add tests Signed-off-by: Vaibhav Dahiya <[email protected]> * retab Signed-off-by: Vaibhav Dahiya <[email protected]> * fix tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add jhg Signed-off-by: Vaibhav Dahiya <[email protected]> * add tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add tests Signed-off-by: Vaibhav Dahiya <[email protected]> * fix comments Signed-off-by: Vaibhav Dahiya <[email protected]> * add ss Signed-off-by: Vaibhav Dahiya <[email protected]> * add suggestions Signed-off-by: Vaibhav Dahiya <[email protected]> * pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * add pop Signed-off-by: Vaibhav Dahiya <[email protected]> * add pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * add f Signed-off-by: Vaibhav Dahiya <[email protected]> * add more tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add more tests Signed-off-by: Vaibhav Dahiya <[email protected]> * remove pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * formatting Signed-off-by: Vaibhav Dahiya <[email protected]> * static analysis Signed-off-by: Vaibhav Dahiya <[email protected]> * add more formatting Signed-off-by: Vaibhav Dahiya <[email protected]> * fixed Signed-off-by: Vaibhav Dahiya <[email protected]> * fix tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add hkh Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * restore code Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add all fixes Signed-off-by: Vaibhav Dahiya <[email protected]> * add ll Signed-off-by: Vaibhav Dahiya <[email protected]> * fix ll Signed-off-by: Vaibhav Dahiya <[email protected]> * add kk Signed-off-by: Vaibhav Dahiya <[email protected]> * add uniform changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add all Signed-off-by: Vaibhav Dahiya <[email protected]> * fix doc Signed-off-by: Vaibhav Dahiya <[email protected]> * fix per comments Signed-off-by: Vaibhav Dahiya <[email protected]> * fix warn Signed-off-by: Vaibhav Dahiya <[email protected]> * fix more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add cosmetic Signed-off-by: Vaibhav Dahiya <[email protected]> --------- Signed-off-by: Vaibhav Dahiya <[email protected]>

mssonicbld · 2025-04-07T21:34:07Z

Cherry-pick PR to msft-202412: Azure/sonic-utilities.msft#162

…able/disable (sonic-net#3811) * [sfputil] add support for sfputil debug tx-output/rx-output enable/disable Signed-off-by: Vaibhav Dahiya <[email protected]> * refactor Signed-off-by: Vaibhav Dahiya <[email protected]> * add p Signed-off-by: Vaibhav Dahiya <[email protected]> * add tests Signed-off-by: Vaibhav Dahiya <[email protected]> * retab Signed-off-by: Vaibhav Dahiya <[email protected]> * fix tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add jhg Signed-off-by: Vaibhav Dahiya <[email protected]> * add tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add tests Signed-off-by: Vaibhav Dahiya <[email protected]> * fix comments Signed-off-by: Vaibhav Dahiya <[email protected]> * add ss Signed-off-by: Vaibhav Dahiya <[email protected]> * add suggestions Signed-off-by: Vaibhav Dahiya <[email protected]> * pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * add pop Signed-off-by: Vaibhav Dahiya <[email protected]> * add pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * add f Signed-off-by: Vaibhav Dahiya <[email protected]> * add more tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add more tests Signed-off-by: Vaibhav Dahiya <[email protected]> * remove pep8 Signed-off-by: Vaibhav Dahiya <[email protected]> * formatting Signed-off-by: Vaibhav Dahiya <[email protected]> * static analysis Signed-off-by: Vaibhav Dahiya <[email protected]> * add more formatting Signed-off-by: Vaibhav Dahiya <[email protected]> * fixed Signed-off-by: Vaibhav Dahiya <[email protected]> * fix tests Signed-off-by: Vaibhav Dahiya <[email protected]> * add hkh Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * restore code Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add all fixes Signed-off-by: Vaibhav Dahiya <[email protected]> * add ll Signed-off-by: Vaibhav Dahiya <[email protected]> * fix ll Signed-off-by: Vaibhav Dahiya <[email protected]> * add kk Signed-off-by: Vaibhav Dahiya <[email protected]> * add uniform changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add all Signed-off-by: Vaibhav Dahiya <[email protected]> * fix doc Signed-off-by: Vaibhav Dahiya <[email protected]> * fix per comments Signed-off-by: Vaibhav Dahiya <[email protected]> * fix warn Signed-off-by: Vaibhav Dahiya <[email protected]> * fix more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add more changes Signed-off-by: Vaibhav Dahiya <[email protected]> * add cosmetic Signed-off-by: Vaibhav Dahiya <[email protected]> --------- Signed-off-by: Vaibhav Dahiya <[email protected]>

[sfputil] add support for sfputil debug tx-output/rx-output

f6ec7b8

enable/disable Signed-off-by: Vaibhav Dahiya <[email protected]>

refactor

85e2ef8

Signed-off-by: Vaibhav Dahiya <[email protected]>

add p

b79ed2e

Signed-off-by: Vaibhav Dahiya <[email protected]>

add tests

1f3b79c

Signed-off-by: Vaibhav Dahiya <[email protected]>

prgeor reviewed Mar 17, 2025

View reviewed changes

sfputil/debug.py Outdated Show resolved Hide resolved

prgeor reviewed Mar 17, 2025

View reviewed changes

sfputil/debug.py Outdated Show resolved Hide resolved

retab

26dc176

Signed-off-by: Vaibhav Dahiya <[email protected]>

fix tests

6151881

Signed-off-by: Vaibhav Dahiya <[email protected]>

prgeor requested a review from mihirpat1 March 18, 2025 22:16

mihirpat1 requested a review from Copilot March 18, 2025 22:19

Copilot AI reviewed Mar 18, 2025

View reviewed changes

tests/sfputil_test.py Show resolved Hide resolved

tests/sfputil_test.py Show resolved Hide resolved

add jhg

904552e

Signed-off-by: Vaibhav Dahiya <[email protected]>

add tests

06df66e

Signed-off-by: Vaibhav Dahiya <[email protected]>

vdahiya12 dismissed prgeor’s stale review via e385665 March 25, 2025 20:24

add more changes

51abaf5

Signed-off-by: Vaibhav Dahiya <[email protected]>

prgeor previously approved these changes Mar 25, 2025

View reviewed changes

mihirpat1 previously approved these changes Mar 25, 2025

View reviewed changes

add cosmetic

328b0c6

Signed-off-by: Vaibhav Dahiya <[email protected]>

vdahiya12 dismissed stale reviews from mihirpat1 and prgeor via 328b0c6 March 25, 2025 21:16

mihirpat1 approved these changes Mar 25, 2025

View reviewed changes

prgeor approved these changes Mar 25, 2025

View reviewed changes

prgeor merged commit 7cbb2f2 into sonic-net:master Mar 25, 2025
7 checks passed

Junchao-Mellanox added the Request for msft-202412 Branch label Apr 3, 2025

r12f added the Approved for msft-202412 Branch label Apr 7, 2025

mssonicbld mentioned this pull request Apr 7, 2025

[action] [PR:3811] [sfputil] add support for sfputil debug tx-output/rx-output {port} enable/disable Azure/sonic-utilities.msft#162

Merged

mssonicbld added the Created PR to msft-202412 Branch label Apr 7, 2025

mssonicbld added Included in msft-202412 Branch and removed Created PR to msft-202412 Branch labels Apr 11, 2025

vdahiya12 mentioned this pull request Apr 15, 2025

Local fault and remote fault sonic-net/SONiC#1882

Closed

mihirpat1 mentioned this pull request Jul 8, 2025

[202411] DOM enhancement changes for transceiver CLIs #3957

Closed

[sfputil] add support for sfputil debug tx-output/rx-output {port} enable/disable #3811

[sfputil] add support for sfputil debug tx-output/rx-output {port} enable/disable #3811

Uh oh!

Conversation

vdahiya12 commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary of Changes

What I did

How I did it

How to verify it

Uh oh!

mssonicbld commented Mar 17, 2025

Uh oh!

azure-pipelines bot commented Mar 17, 2025

Uh oh!

mssonicbld commented Mar 17, 2025

Uh oh!

azure-pipelines bot commented Mar 17, 2025

Uh oh!

mssonicbld commented Mar 17, 2025

Uh oh!

azure-pipelines bot commented Mar 17, 2025

Uh oh!

mssonicbld commented Mar 17, 2025

Uh oh!

azure-pipelines bot commented Mar 17, 2025

Uh oh!

prgeor commented Mar 17, 2025

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Mar 17, 2025

Uh oh!

azure-pipelines bot commented Mar 17, 2025

Uh oh!

mssonicbld commented Mar 18, 2025

Uh oh!

azure-pipelines bot commented Mar 18, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

mssonicbld commented Mar 18, 2025

Uh oh!

azure-pipelines bot commented Mar 18, 2025

Uh oh!

mssonicbld commented Mar 18, 2025

Uh oh!

azure-pipelines bot commented Mar 18, 2025

Uh oh!

mssonicbld commented Mar 25, 2025

Uh oh!

azure-pipelines bot commented Mar 25, 2025

Uh oh!

mssonicbld commented Mar 25, 2025

Uh oh!

vdahiya12 commented Mar 25, 2025

Uh oh!

mssonicbld commented Mar 25, 2025

Uh oh!

azure-pipelines bot commented Mar 25, 2025

Uh oh!

mssonicbld commented Mar 25, 2025

Uh oh!

azure-pipelines bot commented Mar 25, 2025

Uh oh!

Uh oh!

Junchao-Mellanox commented Mar 31, 2025

Uh oh!

mssonicbld commented Apr 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

vdahiya12 commented Mar 17, 2025 •

edited

Loading