[debug dump util] Base Skeleton and Click Class added

[vivekrnv]

Signed-off-by: Vivek Reddy Karri [email protected]

DEBUG DUMP UTIL PR SEQ: 3

NOTE: PLEASE MERGE #1667 BEFORE MERGING THIS

What I did

HLD for Dump Utility: HLD.

• Added the top level CLI command i.e "dump state"
• Added corresponding UT's
• Added the bash autocompletion support files
• Added the implementation for the customization options provided, such as --db, --key-map, --show, --table & --namespace

How I did it

How to verify it

UT's are implemented

tests/dump_tests/dump_state_test.py::TestDumpState::test_identifier_single PASSED [ 81%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_identifier_multiple PASSED [ 81%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_option_key_map PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_option_db_filtering PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_option_tabular_display PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_option_tabular_display_no_db_filter PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_identifier_all_with_filtering PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpState::test_namespace_single_asic PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpStateMultiAsic::test_default_namespace PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpStateMultiAsic::test_namespace_asic0 PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpStateMultiAsic::test_namespace_asic1 PASSED [ 82%]
tests/dump_tests/dump_state_test.py::TestDumpStateMultiAsic::test_invalid_namespace PASSED [ 82%]

admin@sonic:~$ dump state --help
Usage: dump state [OPTIONS] MODULE IDENTIFIER

  Dump the redis-state of the identifier for the module specified

Options:
  -s, --show            Display Modules Available
  -d, --db TEXT         Only dump from these Databases
  -t, --table           Print in tabular format  [default: False]
  -k, --key-map         Only fetch the keys matched, don't extract field-value
                        dumps  [default: False]
  -v, --verbose         Prints any intermediate output to stdout useful for
                        dev & troubleshooting  [default: False]
  -n, --namespace TEXT  Dump the redis-state for this namespace.  [default: ]
  --help                Show this message and exit.


admin@sonic:~$ dump state --show
Module    Identifier
--------  ------------
copp      trap_id
port      port_name

admin@sonic:~$ dump state port Ethernet0 --table --db ASIC_DB --key-map
+-------------+-----------+-----------------------------------------------------------+
| port_name   | DB_NAME   | DUMP                                                      |
+=============+===========+===========================================================+
| Ethernet0   | ASIC_DB   | +-------------------------------------------------------+ |
|             |           | | Keys Collected                                        | |
|             |           | +=======================================================+ |
|             |           | | ASIC_STATE:SAI_OBJECT_TYPE_HOSTIF:oid:0xd000000000a21 | |
|             |           | +-------------------------------------------------------+ |
|             |           | | ASIC_STATE:SAI_OBJECT_TYPE_PORT:oid:0x10000000008d4   | |
|             |           | +-------------------------------------------------------+ |
|             |           | +---------------------+---------------------+             |
|             |           | | vid                 | rid                 |             |
|             |           | +=====================+=====================+             |
|             |           | | oid:0xd000000000a21 | oid:0xd             |             |
|             |           | +---------------------+---------------------+             |
|             |           | | oid:0x10000000008d4 | oid:0x1690000000001 |             |
|             |           | +---------------------+---------------------+             |
+-------------+-----------+-----------------------------------------------------------+

admin@sonic:~$ dump state port Ethernet0 --db ASIC_DB --key-map
{
    "Ethernet0": {
        "ASIC_DB": {
            "keys": [
                "ASIC_STATE:SAI_OBJECT_TYPE_HOSTIF:oid:0xd000000000a21",
                "ASIC_STATE:SAI_OBJECT_TYPE_PORT:oid:0x10000000008d4"
            ],
            "tables_not_found": [],
            "vidtorid": {
                "oid:0xd000000000a21": "oid:0xd",
                "oid:0x10000000008d4": "oid:0x1690000000001"
            }
        }
    }
}

Additional Output samples can be found in the HLD Link

[lgtm-com]

This pull request introduces 1 alert when merging 164a2ee into 5708497 - view on LGTM.com

new alerts:

• 1 for Unused import

[vivekrnv]

Request for 202106

[arlakshm]

As comments

[arlakshm]

lgtm.

[lgtm-com]

This pull request introduces 2 alerts when merging 4266484 into 29f4a16 - view on LGTM.com

new alerts:

• 1 for Unused import
• 1 for Wrong number of arguments in a class instantiation

[SuvarnaMeenakshi]

lgtm

[vivekrnv]

/azpw run

[mssonicbld]

/AzurePipelines run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).

[vivekrnv]

Hi @arlakshm, Can you review the changes and signoff?

[dgsudharsan]

@arlakshm Can you please review and sign off?