[action] [PR:4020] Fix show int transceiver EEPROM crash for for Backplane cartridge + enhance EEPROM CLI output

[mssonicbld]

Summary

This PR fixes a crash in the show interface transceiver eeprom command when dealing with Backplane cartridge modules and enhances the overall EEPROM CLI (show + sfputil) output consistency and organization.

This change should be merged along with sonic-net/sonic-platform-common#590

Following traceback is seen with the Backplane cartridge cables. Hence, we need to resolve the traceback.

root@admin:/home/admin# show int transceiver info Ethernet128
Traceback (most recent call last):
  File "/usr/local/bin/sfpshow", line 824, in <module>
    cli()
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 764, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 717, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 1137, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 956, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/dist-packages/click/core.py", line 555, in invoke
    return callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/bin/sfpshow", line 764, in info
    sfp.get_eeprom()
  File "/usr/local/lib/python3.11/dist-packages/utilities_common/multi_asic.py", line 156, in wrapped_run_on_all_asics
    func(self,  *args, **kwargs)
  File "/usr/local/bin/sfpshow", line 641, in get_eeprom
    self.intf_eeprom[self.intf_name] = self.convert_interface_sfp_info_to_cli_output_string(
                                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/bin/sfpshow", line 473, in convert_interface_sfp_info_to_cli_output_string
    sfp_info_output = self.convert_sfp_info_to_output_string(sfp_info_dict, sfp_firmware_info_dict)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/bin/sfpshow", line 354, in convert_sfp_info_to_output_string
    output += '{}{}: {}\n'.format(indent, data_map[key], sfp_info_dict[key])
                                                         ~~~~~~~~~~~~~^^^^^
KeyError: 'active_apsel_hostlane1'

🐛 Primary Bug Fix

• Fixed crash for Backplane cartridge modules: Resolved issue where show interface transceiver eeprom command would crash when processing Backplane cartridge transceivers
  • Using the sfp_info_dict rather than a pre-defined dictionary (CMIS_DATA_MAP, C_CMIS_DATA_MAP, QSFP_DATA_MAP, QSFP_DD_DATA_MAP, QSFP_DATA_MAP) to display the EEPROM fields. This helps to avoid modifying the pre-defined dictionary upon introducing new fields in sfp_info_dict for a new transceiver

🚀 EEPROM CLI Enhancements

Code Refactoring & Shared Utilities

• Created shared utility functions in utilities_common/sfp_helper.py:
  • get_data_map_sort_key(): Provides consistent sorting logic for SFP info keys
  • get_transceiver_data_map(): Automatically selects appropriate data map based on transceiver type

Improved Field Organization

• Consistent Field Ordering: Both sfputil and sfpshow now display transceiver fields in logical, sorted order

Code Quality Improvements

• Removed Code Duplication: Eliminated redundant sorting and display logic between utilities
• Better Maintainability: Shared functions make future updates and bug fixes easier

🧪 Testing

• Verified fix resolves Backplane cartridge crash issue
• Confirmed consistent field ordering across both CLIs

Field differences between nightly (left) and current changes (right) for CLI output of different types of transceivers
(the red and greyed out portion depict differences)

1. CMIS transceiver
   show int transceiver info CLI

sfputil show eeprom CLI

2. CMIS transceiver with flat memory
   show int transceiver info CLI

sfputil show eeprom CLI

3. C-CMIS transceiver
   show int transceiver info CLI

sfputil show eeprom CLI

4. SFF-8636 with non-flat memory
   show int transceiver info CLI

sfputil show eeprom CLI

5. SFF-8636 with flat memory
   show int transceiver info CLI

sfputil show eeprom CLI

6. SFF-8436 with flat memory (DAC)
   show int transceiver info CLI

sfputil show eeprom CLI

7. SFF-8472 transceiver
   show int transceiver info CLI

sfputil show eeprom CLI

[mssonicbld]

Original PR: #4020

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yejianquan]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yejianquan]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[yejianquan]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[mssonicbld]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).