[202012] Add DHCPv6 Relay counter and ipv6 helper CLI (sonic-net#1917)

Author: kellyyeh

clear/main.py

@@ -188,6 +188,20 @@ def dropcounters():
     """Clear drop counters"""
     command = "dropstat -c clear"
     run_command(command)
+    
+@click.command()
+@click.argument('interface', required=False)
+def dhcp6relay_counters(interface):
+    """ Clear dhcp6relay message counts """
+
+    if interface:
+        cmd = "show dhcp6relay_counters clear -i " + interface
+    else:
+        cmd = "show dhcp6relay_counters clear"
+
+    run_command(cmd)
+
+cli.add_command(dhcp6relay_counters)
 
 #
 # 'clear watermarks

doc/Command-Reference.md

@@ -38,6 +38,9 @@
   * [Console clear commands](#console-clear-commands)
 * [DHCP Relay](#dhcp-relay)
   * [DHCP Relay config commands](#dhcp-relay-config-commands)
+  * [DHCPv6 Relay show commands](#dhcpv6-relay-show-commands)
+  * [DHCPv6 Relay show counter commands](#dhcpv6-relay-show-counter-commands)
+  * [DHCPv6 Relay counter clear commands](#dhcpv6-relay-counter-clear-commands)
 * [Drop Counters](#drop-counters)
   * [Drop Counter show commands](#drop-counters-show-commands)
   * [Drop Counter config commands](#drop-counters-config-commands)
@@ -2205,6 +2208,82 @@ This command is used to delete a configured DHCP Relay Destination IP address fr
   Restarting DHCP relay service...
   ```
 
+### DHCPv6 Relay show commands
+
+This sub-section of commands is used to show the DHCPv6 Relay Destination IPv6 address for VLAN interfaces.
+
+**show dhcprelay_helper ipv6**
+
+This command is used to show DHCPv6 Relay Destination IPv6 address to Vlans.
+
+- Usage:
+  ```
+  show dhcprelay_helper ipv6
+  ```
+
+- Example:
+  admin@sonic:~$ sudo show dhcprelay_helper ipv6
+  ```
+   -------  ------------
+  Vlan1000  fc02:2000::1
+            fc02:2000::2
+            fc02:2000::3
+            fc02:2000::4
+   -------  ------------
+  ```
+
+### DHCPv6 Relay show counter commands
+
+This sub-section of commands is used to show the DHCPv6 Relay counters for VLAN interfaces.
+
+**show dhcp6relay_counters counts**
+
+This command is used to show the DHCPv6 Relay counter to Vlans.
+
+- Usage:
+  ```
+  show dhcp6relay_counters counts
+  ```
+
+- Example:
+  ```
+  admin@sonic:~$ sudo show dhcp6relay_counters counts
+   Message Type    Vlan1000
+  --------------  ---------
+        Unknown          0
+        Solicit          0
+      Advertise          0
+        Request          0
+        Confirm          0
+          Renew          0
+          Rebind         0
+          Reply          0
+        Release          0
+        Decline          0
+  Relay-Forward          0
+    Relay-Reply          0
+  ```
+### DHCPv6 Relay counter clear commands
+
+**sonic-clear dhcp6relay-counters**
+
+This comnmand is used to clear DHCPv6 Relay Counters. This is done by clearing all counters or per-vlan basis.
+
+- Usage:
+  ```
+  sonic-clear dhcp6relay-counters
+  sonic-clear dhcp6relay-counters "interface"
+  ```
+
+- Example:
+  ```
+  admin@sonic:~$ sonic-clear dhcp6relay-counters
+  Cleared DHCPv6 Relay Counters
+
+  admin@sonic:~$ sonic-clear dhcp6relay-counters Vlan1000
+  Cleared DHCPv6 Relay Counter Vlan1000
+  ```
+
 Go Back To [Beginning of the document](#) or [Beginning of this section](#dhcp-relay)
 
 

show/dhcp6relay_counters.py

@@ -0,0 +1,95 @@
+import click
+import utilities_common.cli as clicommon
+from tabulate import tabulate
+
+from swsscommon.swsscommon import SonicV2Connector
+
+
+# STATE_DB Table
+DHCPv6_COUNTER_TABLE = 'DHCPv6_COUNTER_TABLE'
+
+# DHCPv6 Counter Messages
+messages = ["Unknown", "Solicit", "Advertise", "Request", "Confirm", "Renew", "Rebind", "Reply", "Release", "Decline", "Relay-Forward", "Relay-Reply"]
+
+class DHCPv6_Counter(object):
+    def __init__(self):
+        self.db = SonicV2Connector(use_unix_socket_path=False)
+        self.db.connect(self.db.STATE_DB)
+        self.table_name = DHCPv6_COUNTER_TABLE + self.db.get_db_separator(self.db.STATE_DB)
+
+
+    def get_interface(self):
+        """ Get all names of all interfaces in DHCPv6_COUNTER_TABLE """
+        vlans = []
+        for key in self.db.keys(self.db.STATE_DB):
+            if DHCPv6_COUNTER_TABLE in key:
+                vlans.append(key[21:])
+        return vlans
+        
+
+    def get_dhcp6relay_msg_count(self, interface, msg):
+        """ Get count of a dhcp6relay message """
+        count = self.db.get(self.db.STATE_DB, self.table_name + str(interface), str(msg))
+        data = [str(msg), count]
+        return data
+
+    
+    def clear_table(self, interface):
+        """ Reset all message counts to 0 """
+        for msg in messages:
+            self.db.set(self.db.STATE_DB, self.table_name + str(interface), str(msg), '0') 
+
+def print_count(counter, intf):
+    """Print count of each message"""
+    data = []
+    for i in messages:
+        data.append(counter.get_dhcp6relay_msg_count(intf, i))
+    print(tabulate(data, headers = ["Message Type", intf], tablefmt='simple', stralign='right') + "\n")
+
+
+#
+# 'dhcp6relay_counters' group ###
+#
+
+
+@click.group(cls=clicommon.AliasedGroup, name="dhcp6relay_counters")
+def dhcp6relay_counters():
+    """Show DHCPv6 counter"""
+    pass
+
+
+# 'counts' subcommand ("show dhcp6relay_counters counts")
+@dhcp6relay_counters.command('counts')
+@click.option('-i', '--interface', required=False)
+@click.option('--verbose', is_flag=True, help="Enable verbose output")
+def counts(interface, verbose):
+    """Show dhcp6relay message counts"""
+
+    counter = DHCPv6_Counter()
+    counter_intf = counter.get_interface()
+
+    if interface:
+        print_count(counter, interface)
+    else:
+        for intf in counter_intf:
+            print_count(counter, intf)
+
+
+# 'clear' subcommand ("clear dhcp6relay_counters counts")
+@dhcp6relay_counters.command('clear')
+@click.option('-i', '--interface', required=False)
+@click.option('--verbose', is_flag=True, help="Enable verbose output")
+def clear(interface, verbose):
+    """Clear dhcp6relay message counts"""
+    
+    counter = DHCPv6_Counter()
+    counter_intf = counter.get_interface()
+
+    if interface:
+        counter.clear_table(interface)
+        print("Cleared DHCPv6 Relay Counter " + interface)
+    else:
+        for intf in counter_intf:
+            counter.clear_table(intf)
+        print("Cleared DHCPv6 Relay Counters")
+

show/dhcp_relay_helper.py

@@ -0,0 +1,37 @@
+import click
+from tabulate import tabulate
+from swsscommon.swsscommon import ConfigDBConnector
+
+import utilities_common.cli as clicommon
+
+DHCP_RELAY = 'DHCP_RELAY'
+config_db = ConfigDBConnector()
+
+@click.group(cls=clicommon.AliasedGroup, name="dhcprelay_helper")
+def dhcp_relay_helper():
+    """Show DHCP_Relay helper information"""
+    pass
+
+@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"""
+    if config_db is not None:
+        config_db.connect()
+        table_data = config_db.get_table(DHCP_RELAY)
+        if table_data is not None:
+            vlans = config_db.get_keys(DHCP_RELAY)
+            for vlan in vlans: 
+                output = get_data(table_data, vlan)
+                print(output)
+            
+
+def get_data(table_data, vlan):
+    vlan_data = table_data.get(vlan)
+    helpers_data = vlan_data.get('dhcpv6_servers')
+    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'
+    return output
+

show/main.py

@@ -19,6 +19,8 @@
 from . import acl
 from . import bgp_common
 from . import chassis_modules
+from . import dhcp6relay_counters
+from . import dhcp_relay_helper
 from . import dropcounters
 from . import feature
 from . import fgnhg
@@ -156,6 +158,8 @@ def cli(ctx):
 # Add groups from other modules
 cli.add_command(acl.acl)
 cli.add_command(chassis_modules.chassis_modules)
+cli.add_command(dhcp_relay_helper.dhcp_relay_helper)
+cli.add_command(dhcp6relay_counters.dhcp6relay_counters)
 cli.add_command(dropcounters.dropcounters)
 cli.add_command(feature.feature)
 cli.add_command(fgnhg.fgnhg)

tests/dhcp6relay_counter_test.py

@@ -0,0 +1,32 @@
+import sys
+import os
+
+import show.main as show
+from click.testing import CliRunner
+
+expected_counts = """\
+  Message Type    Vlan1000
+--------------  ----------
+       Unknown           0
+       Solicit           0
+     Advertise           0
+       Request           0
+       Confirm           0
+         Renew           0
+        Rebind           0
+         Reply           0
+       Release           0
+       Decline           0
+ Relay-Forward           0
+   Relay-Reply           0
+
+"""
+
+class TestDhcp6RelayCounters(object):
+
+    def test_show_counts(self):           
+        runner = CliRunner()
+        result = runner.invoke(show.cli.commands['dhcp6relay_counters'].commands["counts"], ["-i", "Vlan1000"])
+        print(result.output)
+        assert result.output == expected_counts
+

tests/dhcp_relay_helper_test.py

@@ -0,0 +1,22 @@
+import sys
+import os
+
+import show.main as show
+from click.testing import CliRunner
+
+expected_table = """\
+--------  ------------
+Vlan1000  fc02:2000::1
+          fc02:2000::2
+--------  ------------
+
+"""
+
+class TestDhcpRelayHelper(object):
+
+    def test_show_dhcpv6_helper(self):
+        runner = CliRunner()
+        result = runner.invoke(show.cli.commands["dhcprelay_helper"].commands["ipv6"])
+        print(result.output)
+        assert result.output == expected_table
+

tests/mock_tables/config_db.json

@@ -2399,5 +2399,8 @@
     },
     "QUEUE|Ethernet96|6": {
         "scheduler": "[SCHEDULER|scheduler.0]"
+    },
+    "DHCP_RELAY|Vlan1000": {
+        "dhcpv6_servers@": "fc02:2000::1,fc02:2000::2"
     }
 }

tests/mock_tables/state_db.json

@@ -621,5 +621,19 @@
         "linkmgrd_switch_standby_end": "2021-May-13 10:01:15.696728",
         "xcvrd_switch_standby_end": "2021-May-13 10:01:15.696051",
         "xcvrd_switch_standby_start": "2021-May-13 10:01:15.690835"
+    },
+    "DHCPv6_COUNTER_TABLE|Vlan1000": {
+        "Unknown": "0",
+        "Solicit": "0",
+        "Advertise": "0",
+        "Request": "0",
+        "Confirm": "0",
+        "Renew": "0",
+        "Rebind": "0",
+        "Reply": "0",
+        "Release": "0",
+        "Decline": "0",
+        "Relay-Forward": "0",
+        "Relay-Reply": "0"
     }
 }