[SRv6] add support for SRv6 counters (#3841)

* [SRv6] add support for SRv6 counters

* extend counterpoll
* extend sonic-clear
* add 'show srv6 stats' command

Signed-off-by: Yakiv Huryk <[email protected]>

* [SRv6] move SRv6Stat into a separate module under utilities_common

Signed-off-by: Yakiv Huryk <[email protected]>

---------

Signed-off-by: Yakiv Huryk <[email protected]>

Author: Yakiv-Huryk

clear/main.py

@@ -218,6 +218,13 @@ def tunnelcounters():
     command = ["tunnelstat", "-c"]
     run_command(command)
 
+
+@cli.command()
+def srv6counters():
+    """Clear SRv6 counters"""
+    command = ["srv6stat", "-c"]
+    run_command(command)
+
 #
 # 'clear watermarks
 #

counterpoll/main.py

@@ -505,6 +505,41 @@ def wredport_disable(ctx):
     wred_port_info['FLEX_COUNTER_STATUS'] = 'disable'
     ctx.obj.mod_entry("FLEX_COUNTER_TABLE", "WRED_ECN_PORT", wred_port_info)
 
+
+# SRv6 counter commands
+@cli.group()
+@click.pass_context
+def srv6(ctx):
+    """ SRv6 counter commands """
+    ctx.obj = ConfigDBConnector()
+    ctx.obj.connect()
+
+
+@srv6.command()
+@click.pass_context
+@click.argument('poll_interval', type=click.IntRange(1000, 30000))
+def interval(ctx, poll_interval):  # noqa: F811
+    """ Set SRv6 counter query interval """
+    srv6_info = {'POLL_INTERVAL': poll_interval}
+    ctx.obj.mod_entry("FLEX_COUNTER_TABLE", "SRV6", srv6_info)
+
+
+@srv6.command()
+@click.pass_context
+def enable(ctx):  # noqa: F811
+    """ Enable SRv6 counter query """
+    srv6_info = {'FLEX_COUNTER_STATUS': ENABLE}
+    ctx.obj.mod_entry("FLEX_COUNTER_TABLE", "SRV6", srv6_info)
+
+
+@srv6.command()
+@click.pass_context
+def disable(ctx):  # noqa: F811
+    """ Disable SRv6 counter query """
+    srv6_info = {'FLEX_COUNTER_STATUS': DISABLE}
+    ctx.obj.mod_entry("FLEX_COUNTER_TABLE", "SRV6", srv6_info)
+
+
 @cli.command()
 def show():
     """ Show the counter configuration """
@@ -525,6 +560,7 @@ def show():
     eni_info = configdb.get_entry('FLEX_COUNTER_TABLE', ENI)
     wred_queue_info = configdb.get_entry('FLEX_COUNTER_TABLE', 'WRED_ECN_QUEUE')
     wred_port_info = configdb.get_entry('FLEX_COUNTER_TABLE', 'WRED_ECN_PORT')
+    srv6_info = configdb.get_entry('FLEX_COUNTER_TABLE', 'SRV6')
 
     header = ("Type", "Interval (in ms)", "Status")
     data = []
@@ -559,6 +595,9 @@ def show():
     if wred_port_info:
         data.append(["WRED_ECN_PORT_STAT", wred_port_info.get("POLL_INTERVAL", DEFLT_1_SEC),
                     wred_port_info.get("FLEX_COUNTER_STATUS", DISABLE)])
+    if srv6_info:
+        data.append(["SRV6_STAT", srv6_info.get("POLL_INTERVAL", DEFLT_10_SEC),
+                    srv6_info.get("FLEX_COUNTER_STATUS", DISABLE)])
 
     if is_dpu(configdb) and eni_info:
         data.append(["ENI_STAT", eni_info.get("POLL_INTERVAL", DEFLT_10_SEC),

scripts/srv6stat

@@ -0,0 +1,33 @@
+#!/usr/bin/python3
+
+import argparse
+import sys
+
+from utilities_common.srv6stat import SRv6Stat
+
+def main():
+    parser = argparse.ArgumentParser(description='Display SONiC SRv6 MySID counters',
+                                     formatter_class=argparse.RawTextHelpFormatter)
+    parser.add_argument('-c', '--clear', action='store_true', help='Clear SRv6 MySID counters statistics')
+    parser.add_argument('-d', '--delete', action='store_true', help='Delete saved SRv6 MySID counters statistics')
+    parser.add_argument('-s', '--sid', type=str, help='Show a specific SID', default=None)
+    parser.add_argument('-v', '--version', action='version', version='%(prog)s 1.0')
+    args = parser.parse_args()
+
+    try:
+        stats = SRv6Stat()
+        if args.clear:
+            stats.clear()
+            return
+        if args.delete:
+            stats.remove_cache()
+            return
+        stats.show(args.sid)
+
+    except Exception as e:
+        print(str(e), file=sys.stderr)
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

setup.py

@@ -170,6 +170,7 @@
         'scripts/soft-reboot',
         'scripts/storyteller',
         'scripts/syseeprom-to-json',
+        'scripts/srv6stat',
         'scripts/teamd_increase_retry_count.py',
         'scripts/tempershow',
         'scripts/tunnelstat',

show/main.py

@@ -68,6 +68,7 @@
 from . import dns
 from . import bgp_cli
 from . import stp
+from . import srv6
 
 # Global Variables
 PLATFORM_JSON = 'platform.json'
@@ -320,6 +321,7 @@ def cli(ctx):
 cli.add_command(warm_restart.warm_restart)
 cli.add_command(dns.dns)
 cli.add_command(stp.spanning_tree)
+cli.add_command(srv6.srv6)
 
 # syslog module
 cli.add_command(syslog.syslog)

show/srv6.py

@@ -0,0 +1,20 @@
+import click
+import utilities_common.cli as clicommon
+
+
+@click.group(cls=clicommon.AliasedGroup)
+def srv6():
+    """Show SRv6 related information"""
+    pass
+
+
+# 'stats' subcommand  ("show srv6 stats")
+@srv6.command()
+@click.option('--verbose', is_flag=True, help="Enable verbose output")
+@click.argument('sid', required=False)
+def stats(verbose, sid):
+    """Show SRv6 counter statistic"""
+    cmd = ['srv6stat']
+    if sid:
+        cmd += ['-s', sid]
+    clicommon.run_command(cmd, display_cmd=verbose)

tests/clear_test.py

@@ -101,6 +101,13 @@ def test_clear_fdb(self, run_command):
         assert result.exit_code == 0
         run_command.assert_called_with(['fdbclear'])
 
+    @patch('clear.main.run_command')
+    def test_clear_srv6counters(self, run_command):
+        runner = CliRunner()
+        result = runner.invoke(clear.cli.commands['srv6counters'])
+        assert result.exit_code == 0
+        run_command.assert_called_with(['srv6stat', '-c'])
+
     def teardown(self):
         print('TEAR DOWN')
 

tests/counterpoll_test.py

@@ -33,6 +33,7 @@
 FLOW_CNT_ROUTE_STAT   10000               enable
 WRED_ECN_QUEUE_STAT   10000               enable
 WRED_ECN_PORT_STAT    1000                enable
+SRV6_STAT             10000               enable
 """
 
 expected_counterpoll_show_dpu = """Type                  Interval (in ms)    Status
@@ -49,6 +50,7 @@
 FLOW_CNT_ROUTE_STAT   10000               enable
 WRED_ECN_QUEUE_STAT   10000               enable
 WRED_ECN_PORT_STAT    1000                enable
+SRV6_STAT             10000               enable
 ENI_STAT              1000                enable
 """
 
@@ -335,6 +337,31 @@ def test_update_wred_queue_counter_interval(self):
         print(table)
         assert test_interval == table["WRED_ECN_QUEUE"]["POLL_INTERVAL"]
 
+    @pytest.mark.parametrize("status", ["disable", "enable"])
+    def test_update_srv6_status(self, status):
+        runner = CliRunner()
+        db = Db()
+
+        result = runner.invoke(counterpoll.cli.commands["srv6"].commands[status], [], obj=db.cfgdb)
+        print(result.exit_code, result.output)
+        assert result.exit_code == 0
+
+        table = db.cfgdb.get_table("FLEX_COUNTER_TABLE")
+        assert status == table["SRV6"]["FLEX_COUNTER_STATUS"]
+
+    def test_update_srv6_interval(self):
+        runner = CliRunner()
+        db = Db()
+        test_interval = "20000"
+
+        result = runner.invoke(counterpoll.cli.commands["srv6"].commands["interval"], [test_interval], obj=db.cfgdb)
+        print(result.exit_code, result.output)
+        assert result.exit_code == 0
+
+        table = db.cfgdb.get_table("FLEX_COUNTER_TABLE")
+        assert test_interval == table["SRV6"]["POLL_INTERVAL"]
+
+
     @classmethod
     def teardown_class(cls):
         print("TEARDOWN")

tests/mock_tables/config_db.json

@@ -1828,6 +1828,10 @@
         "POLL_INTERVAL": "1000",
         "FLEX_COUNTER_STATUS": "enable"
     },
+    "FLEX_COUNTER_TABLE|SRV6": {
+        "POLL_INTERVAL": "10000",
+        "FLEX_COUNTER_STATUS": "enable"
+    },
     "PFC_WD|Ethernet0": {
         "action": "drop",
         "detection_time": "600",

tests/mock_tables/counters_db.json

@@ -2853,5 +2853,17 @@
     "COUNTERS:oid:0x1600000000035f":{
         "SAI_COUNTER_STAT_PACKETS": 1000,
         "SAI_COUNTER_STAT_BYTES": 25000
+    },
+    "COUNTERS_SRV6_NAME_MAP": {
+        "1000:2:30::/48": "oid:0x17000000001000",
+        "2000:2:30::/48": "oid:0x17000000002000"
+    },
+    "COUNTERS:oid:0x17000000001000":{
+        "SAI_COUNTER_STAT_PACKETS": 100,
+        "SAI_COUNTER_STAT_BYTES": 102400
+    },
+    "COUNTERS:oid:0x17000000002000":{
+        "SAI_COUNTER_STAT_PACKETS": 200,
+        "SAI_COUNTER_STAT_BYTES": 204800
     }
 }

tests/show_test.py

@@ -1109,3 +1109,29 @@ def test_ntp(self):
     @classmethod
     def teardown_class(cls):
         print('TEARDOWN')
+
+
+class TestShowSRv6Counters(object):
+    def setup(self):
+        print('SETUP')
+
+    @patch('utilities_common.cli.run_command')
+    def test_srv6_stats(self, mock_run_command):
+        runner = CliRunner()
+        result = runner.invoke(show.cli.commands['srv6'].commands['stats'], ['--verbose'])
+        print(result.exit_code)
+        print(result.output)
+        assert result.exit_code == 0
+        mock_run_command.assert_called_once_with(['srv6stat'], display_cmd=True)
+
+    @patch('utilities_common.cli.run_command')
+    def test_srv6_stats_with_sid(self, mock_run_command):
+        runner = CliRunner()
+        result = runner.invoke(show.cli.commands['srv6'].commands['stats'], ['1000:2:30::/48', '--verbose'])
+        print(result.exit_code)
+        print(result.output)
+        assert result.exit_code == 0
+        mock_run_command.assert_called_once_with(['srv6stat', '-s', '1000:2:30::/48'], display_cmd=True)
+
+    def teardown(self):
+        print('TEAR DOWN')

tests/srv6stat_test.py

@@ -0,0 +1,111 @@
+import os
+import sys
+from io import StringIO
+from unittest import mock
+
+from utilities_common.general import load_module_from_source
+from .mock_tables import dbconnector
+
+test_path = os.path.dirname(os.path.abspath(__file__))
+modules_path = os.path.dirname(test_path)
+scripts_path = os.path.join(modules_path, "scripts")
+sys.path.insert(0, modules_path)
+
+srv6stat_path = os.path.join(scripts_path, 'srv6stat')
+srv6stat = load_module_from_source('srv6stat', srv6stat_path)
+
+
+# srv6stat
+default_output = """\
+MySID             Packets    Bytes
+--------------  ---------  -------
+1000:2:30::/48        100   102400
+2000:2:30::/48        200   204800
+"""
+
+specific_sid_output = """\
+MySID             Packets    Bytes
+--------------  ---------  -------
+1000:2:30::/48        100   102400
+"""
+# srv6stat -c
+clear_output = ''
+
+# srv6stat after clear
+after_clear_output = """\
+MySID             Packets    Bytes
+--------------  ---------  -------
+1000:2:30::/48          0        0
+2000:2:30::/48          0        0
+"""
+
+update_after_clear_output = """\
+MySID             Packets    Bytes
+--------------  ---------  -------
+1000:2:30::/48        200     2000
+2000:2:30::/48        300     3000
+"""
+
+
+class SRv6StatRunner():
+    def __init__(self, delete_cache_on_start=True, clear=None, delete=None, sid=None):
+        self.setup(delete_cache_on_start)
+        self.result = self.run_srv6stat(clear=clear, delete=delete, sid=sid)
+
+    def get_result(self):
+        return self.result
+
+    def setup(self, delete_cache_on_start):
+        if delete_cache_on_start:
+            self.run_srv6stat(delete=True)
+
+    def run_srv6stat(self, clear=None, delete=None, sid=None):
+        old_stdout = sys.stdout
+        result = StringIO()
+        sys.stdout = result
+        with mock.patch.object(srv6stat.argparse.ArgumentParser,
+                               'parse_args',
+                               return_value=srv6stat.argparse.Namespace(clear=clear, delete=delete, sid=sid)):
+            srv6stat.main()
+        sys.stdout = old_stdout
+        return result.getvalue()
+
+
+def test_show():
+    result = SRv6StatRunner().get_result()
+    assert result == default_output
+
+
+def test_show_specific_sid():
+    result = SRv6StatRunner(sid='1000:2:30::/48').get_result()
+    assert result == specific_sid_output
+
+
+def test_clear():
+    result = SRv6StatRunner(clear=True).get_result()
+    assert result == clear_output
+
+    result = SRv6StatRunner(delete_cache_on_start=False).get_result()
+    assert result == after_clear_output
+
+
+def test_delete_cache():
+    SRv6StatRunner(clear=True)
+    SRv6StatRunner(delete=True)
+    result = SRv6StatRunner().get_result()
+    assert result == default_output
+
+
+def test_clear_and_populate_counters_db():
+    SRv6StatRunner(clear=True)
+    db = dbconnector.SonicV2Connector()
+    db.connect(db.COUNTERS_DB)
+    db.set(db.COUNTERS_DB, srv6stat.SRv6Stat.SRV6_COUNTERS_MAP, '1000:2:30::/48', 'oid:0x17000000001000')
+    db.set(db.COUNTERS_DB, srv6stat.SRv6Stat.SRV6_COUNTERS_MAP, '2000:2:30::/48', 'oid:0x17000000002000')
+    db.set(db.COUNTERS_DB, 'COUNTERS:oid:0x17000000001000', srv6stat.SRv6Stat.COUNTER_PACKETS, '300')
+    db.set(db.COUNTERS_DB, 'COUNTERS:oid:0x17000000001000', srv6stat.SRv6Stat.COUNTER_BYTES, '104400')
+    db.set(db.COUNTERS_DB, 'COUNTERS:oid:0x17000000002000', srv6stat.SRv6Stat.COUNTER_PACKETS, '500')
+    db.set(db.COUNTERS_DB, 'COUNTERS:oid:0x17000000002000', srv6stat.SRv6Stat.COUNTER_BYTES, '207800')
+    with mock.patch('utilities_common.srv6stat.SonicV2Connector', return_value=db):
+        result = SRv6StatRunner(delete_cache_on_start=False).get_result()
+        assert result == update_after_clear_output