Add header for show dhcp_relay

Author: yaqiangz

dockers/docker-dhcp-relay/cli-plugin-tests/mock_config.py

@@ -1,6 +1,6 @@
 TEST_DATA = [
     [
-        "ipv6",
+        "ipv6_with_header",
         {
             "config_db": {
                 "DHCP_RELAY": {
@@ -16,7 +16,38 @@
         },
     ],
     [
-        "ipv4",
+        "ipv6_without_header",
+        {
+            "config_db": {
+                "DHCP_RELAY": {
+                    "Vlan1000": {
+                        "dhcpv6_servers": [
+                            "fc02:2000::1",
+                            "fc02:2000::2"
+                        ],
+                        "dhcpv6_option|rfc6939_support": "true"
+                    }
+                }
+            }
+        },
+    ],
+    [
+        "ipv4_with_header",
+        {
+            "config_db": {
+                "VLAN": {
+                    "Vlan1000": {
+                        "dhcp_servers": [
+                            "192.0.0.1",
+                            "192.0.0.2"
+                        ]
+                    }
+                }
+            }
+        }
+    ],
+    [
+        "ipv4_without_header",
         {
             "config_db": {
                 "VLAN": {

dockers/docker-dhcp-relay/cli-plugin-tests/test_show_dhcp_relay.py

@@ -17,14 +17,32 @@
 except KeyError:
     pass
 
-expected_ipv6_table = """\
+expected_ipv6_table_with_header = """\
++-------------+----------------------+
+|   Interface |   DHCP Relay Address |
++=============+======================+
+|    Vlan1000 |         fc02:2000::1 |
+|             |         fc02:2000::2 |
++-------------+----------------------+
+"""
+
+expected_ipv4_table_with_header = """\
++-------------+----------------------+
+|   Interface |   DHCP Relay Address |
++=============+======================+
+|    Vlan1000 |            192.0.0.1 |
+|             |            192.0.0.2 |
++-------------+----------------------+
+"""
+
+expected_ipv6_table_without_header = """\
 --------  ------------
 Vlan1000  fc02:2000::1
           fc02:2000::2
 --------  ------------
 """
 
-expected_ipv4_table = """\
+expected_ipv4_table_without_header = """\
 --------  ---------
 Vlan1000  192.0.0.1
           192.0.0.2
@@ -66,6 +84,15 @@ def test_show_dhcp_relay(test_name, test_data, fs):
         fs.create_file(DBCONFIG_PATH)
     MockConfigDb.set_config_db(test_data["config_db"])
     config_db = MockConfigDb()
-    table = config_db.get_table(IP_VER_TEST_PARAM_MAP[test_name]["table"])
-    result = show.get_data(table, "Vlan1000", IP_VER_TEST_PARAM_MAP[test_name]["entry"])
-    assert result == (expected_ipv4_table if test_name == "ipv4" else expected_ipv6_table)
+    ip_version = "ipv4" if "ipv4" in test_name else "ipv6"
+    table = config_db.get_table(IP_VER_TEST_PARAM_MAP[ip_version]["table"])
+    result = show.get_data(table, "Vlan1000", IP_VER_TEST_PARAM_MAP[ip_version]["entry"], "with_header" in test_name)
+    if test_name == "ipv4_with_header":
+        expected_output = expected_ipv4_table_with_header
+    elif test_name == "ipv4_without_header":
+        expected_output = expected_ipv4_table_without_header
+    elif test_name == "ipv6_with_header":
+        expected_output = expected_ipv6_table_with_header
+    elif test_name == "ipv6_without_header":
+        expected_output = expected_ipv6_table_without_header
+    assert result == expected_output

dockers/docker-dhcp-relay/cli/show/plugins/show_dhcp_relay.py

@@ -110,31 +110,36 @@ def dhcp_relay_helper():
     pass
 
 
-def get_dhcp_relay(table_name, entry_name):
+def get_dhcp_relay(table_name, entry_name, with_header):
     if config_db is not None:
         config_db.connect()
         table_data = config_db.get_table(table_name)
         if table_data is not None:
             vlans = config_db.get_keys(table_name)
             for vlan in vlans:
-                output = get_data(table_data, vlan, entry_name)
+                output = get_data(table_data, vlan, entry_name, with_header)
                 print(output)
 
 
 @dhcp_relay_helper.command('ipv6')
 def get_dhcpv6_helper_address():
     """Parse through DHCP_RELAY table for each interface in config_db.json and print dhcpv6 helpers in table format"""
-    get_dhcp_relay(DHCP_RELAY, DHCPV6_SERVERS)
+    get_dhcp_relay(DHCP_RELAY, DHCPV6_SERVERS, with_header=False)
 
 
-def get_data(table_data, vlan, entry_name):
+def get_data(table_data, vlan, entry_name, with_header=True):
     vlan_data = table_data.get(vlan)
     helpers_data = vlan_data.get(entry_name)
     if helpers_data is not None:
         addr = {vlan: []}
         for ip in helpers_data:
             addr[vlan].append(ip)
-    output = tabulate({'Interface': [vlan], vlan: addr.get(vlan)}, tablefmt='simple', stralign='right') + '\n'
+
+    data = {'Interface': [vlan], 'DHCP Relay Address': ["\n".join(addr.get(vlan))]}
+    if with_header:
+        output = tabulate(data, tablefmt='grid', stralign='right', headers='keys') + '\n'
+    else:
+        output = tabulate(data, tablefmt='simple', stralign='right') + '\n'
     return output
 
 
@@ -156,12 +161,12 @@ def dhcp_relay_ipv4():
 
 @dhcp_relay_ipv4.command("helper")
 def dhcp_relay_ipv4_destination():
-    get_dhcp_relay(VLAN, DHCPV4_SERVERS)
+    get_dhcp_relay(VLAN, DHCPV4_SERVERS, with_header=True)
 
 
 @dhcp_relay_ipv6.command("destination")
 def dhcp_relay_ipv6_destination():
-    get_dhcp_relay(DHCP_RELAY, DHCPV6_SERVERS)
+    get_dhcp_relay(DHCP_RELAY, DHCPV6_SERVERS, with_header=True)
 
 
 @dhcp_relay_ipv6.command("counters")