From 8c1bd85830aac6bb2bc3b68bff62b1a656cc3825 Mon Sep 17 00:00:00 2001 From: Sudharsan Dhamal Gopalarathnam Date: Thu, 23 Nov 2023 04:59:31 -0800 Subject: [PATCH] [yang]Fixing sonic-cfg-help to handle nested container (#17260) Why I did it Fixing sonic-cfg-help to handle nested container scenario. In case of nested container, the inner container name acts as key for the table. For e.g. "AUTO_TECHSUPPORT": { "GLOBAL": { } } Previous output AUTO_TECHSUPPORT Description: AUTO_TECHSUPPORT part of config_db.json +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | Field | Description | Mandatory | Default | Reference | +=========================+====================================================+=============+===========+=============+ | state | Knob to make techsupport invocation event-driven | | | | | | based on core-dump generation | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | rate_limit_interval | Minimum time in seconds between two successive | | | | | | techsupport invocations. Configure 0 to explicitly | | | | | | disable | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | max_techsupport_limit | Max Limit in percentage for the cummulative size | | | | | | of ts dumps. No cleanup is performed if the value | | | | | | isn't configured or is 0.0 | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | max_core_limit | Max Limit in percentage for the cummulative size | | | | | | of core dumps. No cleanup is performed if the | | | | | | value isn't congiured or is 0.0 | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | available_mem_threshold | Memory threshold; 0 to disable techsupport | | 10.0 | | | | invocation on memory usage threshold crossing | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | min_available_mem | Minimum Free memory (in MB) that should be | | 200 | | | | available for the techsupport execution to start | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | since | Only collect the logs & core-dumps generated since | | | | | | the time provided. A default value of '2 days ago' | | | | | | is used if this value is not set explicitly or a | | | | | | non-valid string is provided | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ New output AUTO_TECHSUPPORT Description: AUTO_TECHSUPPORT part of config_db.json key - GLOBAL +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | Field | Description | Mandatory | Default | Reference | +=========================+====================================================+=============+===========+=============+ | state | Knob to make techsupport invocation event-driven | | | | | | based on core-dump generation | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | rate_limit_interval | Minimum time in seconds between two successive | | | | | | techsupport invocations. Configure 0 to explicitly | | | | | | disable | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | max_techsupport_limit | Max Limit in percentage for the cummulative size | | | | | | of ts dumps. No cleanup is performed if the value | | | | | | isn't configured or is 0.0 | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | max_core_limit | Max Limit in percentage for the cummulative size | | | | | | of core dumps. No cleanup is performed if the | | | | | | value isn't congiured or is 0.0 | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | available_mem_threshold | Memory threshold; 0 to disable techsupport | | 10.0 | | | | invocation on memory usage threshold crossing | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | min_available_mem | Minimum Free memory (in MB) that should be | | 200 | | | | available for the techsupport execution to start | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | since | Only collect the logs & core-dumps generated since | | | | | | the time provided. A default value of '2 days ago' | | | | | | is used if this value is not set explicitly or a | | | | | | non-valid string is provided | | | | +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ Work item tracking Microsoft ADO (number only): How I did it Fixing sonic-cfg-help tool to handle nested container How to verify it Added UT to verify it. --- src/sonic-yang-mgmt/sonic-cfg-help | 9 +++++++- src/sonic-yang-mgmt/tests/test_cfghelp.py | 26 +++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/src/sonic-yang-mgmt/sonic-cfg-help b/src/sonic-yang-mgmt/sonic-cfg-help index 4c14cebc44..bd842b3c4d 100755 --- a/src/sonic-yang-mgmt/sonic-cfg-help +++ b/src/sonic-yang-mgmt/sonic-cfg-help @@ -54,7 +54,14 @@ class SonicCfgDescriber: self.print_field_desc(table['list'], field) print() elif table.get('container') is not None: - self.print_field_desc(table.get('container'), field) + if isinstance(table['container'], dict): + print("key - " + table['container'].get('@name')) + self.print_field_desc(table.get('container'), field) + elif isinstance(table['container'], list): + for c in table['container']: + print("key - " + c.get('@name')) + self.print_field_desc(c, field) + print() def get_referenced_table_field(self, ref): diff --git a/src/sonic-yang-mgmt/tests/test_cfghelp.py b/src/sonic-yang-mgmt/tests/test_cfghelp.py index 2eebebe7be..70b3a1edb1 100644 --- a/src/sonic-yang-mgmt/tests/test_cfghelp.py +++ b/src/sonic-yang-mgmt/tests/test_cfghelp.py @@ -25,6 +25,7 @@ techsupport_table_output="""\ AUTO_TECHSUPPORT Description: AUTO_TECHSUPPORT part of config_db.json +key - GLOBAL +-------------------------+----------------------------------------------------+-------------+-----------+-------------+ | Field | Description | Mandatory | Default | Reference | +=========================+====================================================+=============+===========+=============+ @@ -62,6 +63,7 @@ techsupport_table_field_output="""\ AUTO_TECHSUPPORT Description: AUTO_TECHSUPPORT part of config_db.json +key - GLOBAL +---------+--------------------------------------------------+-------------+-----------+-------------+ | Field | Description | Mandatory | Default | Reference | +=========+==================================================+=============+===========+=============+ @@ -118,6 +120,25 @@ key - ACL_TABLE_NAME:RULE_NAME """ +snmp_table_output="""\ + +SNMP + +key - CONTACT ++---------+----------------------+-------------+-----------+-------------+ +| Field | Description | Mandatory | Default | Reference | ++=========+======================+=============+===========+=============+ +| Contact | SNMP System Contact. | | | | ++---------+----------------------+-------------+-----------+-------------+ +key - LOCATION ++----------+-----------------------+-------------+-----------+-------------+ +| Field | Description | Mandatory | Default | Reference | ++==========+=======================+=============+===========+=============+ +| Location | SNMP System Location. | | | | ++----------+-----------------------+-------------+-----------+-------------+ + +""" + class TestCfgHelp(TestCase): def setUp(self): @@ -167,3 +188,8 @@ class TestCfgHelp(TestCase): argument = ['-t', 'ACL_RULE', '-f', 'ICMP_TYPE'] output = self.run_script(argument) self.assertEqual(output, acl_rule_table_field_output) + + def test_nested_container(self): + argument = ['-t', 'SNMP'] + output = self.run_script(argument) + self.assertEqual(output, snmp_table_output)