Pr json support queue and priority-group watermark and persistent-watermark (sonic-net#3875)

What I did
Added json output supoort for

admin@sonic:~$ show queue watermark unicast --help
Usage: show queue watermark unicast [OPTIONS]

  Show user WM for unicast queues

Options:
  -j, --json      Display1 output in JSON format  [default: False]
  -?, -h, --help  Show this message and exit.
admin@sonic:~$ show queue watermark multicast --help
Usage: show queue watermark multicast [OPTIONS]

  Show user WM for multicast queues

Options:
  -j, --json      Display1 output in JSON format  [default: False]
  -?, -h, --help  Show this message and exit.

Author: vikumarks

scripts/watermarkstat

@@ -81,13 +81,13 @@ class WatermarkstatWrapper(object):
         self.db = None
 
     @multi_asic_util.run_on_multi_asic
-    def run(self, clear, persistent, wm_type):
+    def run(self, clear, persistent, wm_type, json_output):
         watermarkstat = Watermarkstat(self.db, self.multi_asic.current_namespace)
         if clear:
             watermarkstat.send_clear_notification(("PERSISTENT" if persistent else "USER", wm_type.upper()))
         else:
             table_prefix = PERSISTENT_TABLE_PREFIX if persistent else USER_TABLE_PREFIX
-            watermarkstat.print_all_stat(table_prefix, wm_type)
+            watermarkstat.print_all_stat(table_prefix, wm_type, json_output)
 
 
 class Watermarkstat(object):
@@ -283,8 +283,9 @@ class Watermarkstat(object):
                 fields[pos] = str(int(counter_data))
         return fields
 
-    def print_all_stat(self, table_prefix, key):
+    def print_all_stat(self, table_prefix, key, json_output):
         table = []
+        json_result = []
         type = self.watermark_types[key]
         if key in ['buffer_pool', 'headroom_pool']:
             self.header_list = type['header']
@@ -298,6 +299,7 @@ class Watermarkstat(object):
                 if data is None:
                     data = STATUS_NA
                 table.append((buf_pool, data))
+                json_result.append({buf_pool:data})
         else:
             self.build_header(type, key)
             # Get stat for each port
@@ -309,10 +311,14 @@ class Watermarkstat(object):
                 row_data.append(port)
                 row_data.extend(data)
                 table.append(tuple(row_data))
-
-        namespace_str = f" (Namespace {self.namespace})" if multi_asic.is_multi_asic() else ''
-        print(type["message"] + namespace_str)
-        print(tabulate(table, self.header_list, tablefmt='simple', stralign='right'))
+                json_result.append(dict(zip(self.header_list, [port]+data)))
+        
+        if json_output:
+            print(json.dumps(json_result, indent=4))
+        else:
+            namespace_str = f" (Namespace {self.namespace})" if multi_asic.is_multi_asic() else ''
+            print(type["message"] + namespace_str)
+            print(tabulate(table, self.header_list, tablefmt='simple', stralign='right'))
 
     def send_clear_notification(self, data):
         msg = json.dumps(data, separators=(',', ':'))
@@ -324,8 +330,9 @@ class Watermarkstat(object):
 @click.option('-p', '--persistent', is_flag=True, help='Do the operations on the persistent watermark')
 @click.option('-t', '--type', 'wm_type', type=click.Choice(['pg_headroom', 'pg_shared', 'q_shared_uni', 'q_shared_multi', 'buffer_pool', 'headroom_pool', 'q_shared_all']), help='The type of watermark', required=True)
 @click.option('-n', '--namespace', type=click.Choice(multi_asic.get_namespace_list()), help='Namespace name or skip for all', default=None)
+@click.option('--json','-j','json_output', is_flag=True, default=False, show_default=True, help="Display output in JSON format")
 @click.version_option(version='1.0')
-def main(clear, persistent, wm_type, namespace):
+def main(clear, persistent, wm_type, namespace, json_output=False):
     """
        Display the watermark counters
 
@@ -347,7 +354,7 @@ def main(clear, persistent, wm_type, namespace):
     """
 
     namespace_context = WatermarkstatWrapper(namespace)
-    namespace_context.run(clear, persistent, wm_type)
+    namespace_context.run(clear, persistent, wm_type, json_output)
     sys.exit(0)
 
 if __name__ == "__main__":

show/main.py

@@ -842,11 +842,14 @@ def watermark():
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def wm_q_uni(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def wm_q_uni(namespace, json_output):
     """Show user WM for unicast queues"""
     command = ['watermarkstat', '-t', 'q_shared_uni']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 # 'multicast' subcommand ("show queue watermarks multicast")
@@ -859,11 +862,14 @@ def wm_q_uni(namespace):
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def wm_q_multi(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def wm_q_multi(namespace, json_output):
     """Show user WM for multicast queues"""
     command = ['watermarkstat', '-t', 'q_shared_multi']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 # 'all' subcommand ("show queue watermarks all")
@@ -876,11 +882,14 @@ def wm_q_multi(namespace):
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def wm_q_all(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def wm_q_all(namespace, json_output):
     """Show user WM for all queues"""
     command = ['watermarkstat', '-t', 'q_shared_all']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 #
@@ -902,11 +911,14 @@ def persistent_watermark():
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def pwm_q_uni(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def pwm_q_uni(namespace, json_output):
     """Show persistent WM for unicast queues"""
     command = ['watermarkstat', '-p', '-t', 'q_shared_uni']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 # 'multicast' subcommand ("show queue persistent-watermarks multicast")
@@ -919,11 +931,14 @@ def pwm_q_uni(namespace):
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def pwm_q_multi(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def pwm_q_multi(namespace, json_output):
     """Show persistent WM for multicast queues"""
     command = ['watermarkstat', '-p', '-t', 'q_shared_multi']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 # 'all' subcommand ("show queue persistent-watermarks all")
@@ -936,11 +951,14 @@ def pwm_q_multi(namespace):
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def pwm_q_all(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def pwm_q_all(namespace, json_output):
     """Show persistent WM for all queues"""
     command = ['watermarkstat', '-p', '-t', 'q_shared_all']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 #
@@ -965,11 +983,14 @@ def watermark():
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def wm_pg_headroom(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def wm_pg_headroom(namespace, json_output):
     """Show user headroom WM for pg"""
     command = ['watermarkstat', '-t', 'pg_headroom']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 @watermark.command('shared')
@@ -981,11 +1002,14 @@ def wm_pg_headroom(namespace):
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def wm_pg_shared(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def wm_pg_shared(namespace, json_output):
     """Show user shared WM for pg"""
     command = ['watermarkstat', '-t', 'pg_shared']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 @priority_group.group()
@@ -1016,11 +1040,14 @@ def persistent_watermark():
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def pwm_pg_headroom(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def pwm_pg_headroom(namespace, json_output):
     """Show persistent headroom WM for pg"""
     command = ['watermarkstat', '-p', '-t', 'pg_headroom']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 
@@ -1033,11 +1060,14 @@ def pwm_pg_headroom(namespace):
               show_default=True,
               help='Namespace name or all',
               callback=multi_asic_util.multi_asic_namespace_validation_callback)
-def pwm_pg_shared(namespace):
+@click.option('--json', '-j', 'json_output', is_flag=True, default=False, show_default=True, help="Display JSON output")
+def pwm_pg_shared(namespace, json_output):
     """Show persistent shared WM for pg"""
     command = ['watermarkstat', '-p', '-t', 'pg_shared']
     if namespace is not None:
         command += ['-n', str(namespace)]
+    if json_output:
+        command += ["-j"]
     run_command(command)
 
 

tests/watermarkstat_test.py

@@ -31,21 +31,36 @@ def setup_class(cls):
     def test_show_pg_shared_wm(self):
         self.executor(testData['show_pg_wm_shared'])
 
+    def test_show_pg_shared_wm_json(self):
+        self.executor(testData['show_pg_wm_shared_json'])
+
     def test_show_pg_headroom_wm(self):
         self.executor(testData['show_pg_wm_hdrm'])
 
+    def test_show_pg_headroom_wm_json(self):
+        self.executor(testData['show_pg_wm_hdrm_json'])
+
     def test_show_queue_unicast_wm(self):
         self.executor(testData['show_q_wm_unicast'])
 
+    def test_show_queue_unicast_wm_json(self):
+        self.executor(testData['show_q_wm_unicast_json'])
+
     def test_show_queue_multicast_wm(self):
         self.executor(testData['show_q_wm_multicast'])
 
+    def test_show_queue_multicast_wm_json(self):
+        self.executor(testData['show_q_wm_multicast_json'])
+
     def test_show_queue_multicast_wm_neg(self, q_multicast_wm_neg):
         self.executor(testData['show_q_wm_multicast_neg'])
 
     def test_show_queue_all_wm(self):
         self.executor(testData['show_q_wm_all'])
 
+    def test_show_queue_all_wm_json(self):
+        self.executor(testData['show_q_wm_all_json'])
+
     def test_show_buffer_pool_wm(self):
         self.executor(testData['show_buffer_pool_wm'])
 
@@ -55,18 +70,33 @@ def test_show_headroom_pool_wm(self):
     def test_show_pg_shared_peristent_wm(self):
         self.executor(testData['show_pg_pwm_shared'])
 
+    def test_show_pg_shared_peristent_wm_json(self):
+        self.executor(testData['show_pg_pwm_shared_json'])
+
     def test_show_pg_headroom_persistent_wm(self):
         self.executor(testData['show_pg_pwm_hdrm'])
 
+    def test_show_pg_headroom_persistent_wm_json(self):
+        self.executor(testData['show_pg_pwm_hdrm_json'])
+
     def test_show_queue_unicast_persistent_wm(self):
         self.executor(testData['show_q_pwm_unicast'])
 
+    def test_show_queue_unicast_persistent_wm_json(self):
+        self.executor(testData['show_q_pwm_unicast_json'])
+
     def test_show_queue_multicast_persistent_wm(self):
         self.executor(testData['show_q_pwm_multicast'])
 
+    def test_show_queue_multicast_persistent_wm_json(self):
+        self.executor(testData['show_q_pwm_multicast_json'])
+
     def test_show_queue_all_persistent_wm(self):
         self.executor(testData['show_q_pwm_all'])
 
+    def test_show_queue_all_persistent_wm_json(self):
+        self.executor(testData['show_q_pwm_all_json'])
+
     def test_show_buffer_pool_persistent_wm(self):
         self.executor(testData['show_buffer_pool_pwm'])