[debug][undebug] Rework of CLI for BGP (sonic-net#583)

* Changed debug command for FRR

* Update undebug

* Add ipv6 support to generate_dump

debug/main.py

@@ -5,128 +5,287 @@
 import os
 import subprocess
 from click_default_group import DefaultGroup
-
-try:
-    import ConfigParser as configparser
-except ImportError:
-    import configparser
-
-
-# This is from the aliases example:
-# https://github.com/pallets/click/blob/57c6f09611fc47ca80db0bd010f05998b3c0aa95/examples/aliases/aliases.py
-class Config(object):
-    """Object to hold CLI config"""
-
-    def __init__(self):
-        self.path = os.getcwd()
-        self.aliases = {}
-
-    def read_config(self, filename):
-        parser = configparser.RawConfigParser()
-        parser.read([filename])
-        try:
-            self.aliases.update(parser.items('aliases'))
-        except configparser.NoSectionError:
-            pass
-
-
-# Global Config object
-_config = None
-
-
-# This aliased group has been modified from click examples to inherit from DefaultGroup instead of click.Group.
-# DefaultFroup is a superclass of click.Group which calls a default subcommand instead of showing
-# a help message if no subcommand is passed
-class AliasedGroup(DefaultGroup):
-    """This subclass of a DefaultGroup supports looking up aliases in a config
-    file and with a bit of magic.
-    """
-
-    def get_command(self, ctx, cmd_name):
-        global _config
-
-        # If we haven't instantiated our global config, do it now and load current config
-        if _config is None:
-            _config = Config()
-
-            # Load our config file
-            cfg_file = os.path.join(os.path.dirname(__file__), 'aliases.ini')
-            _config.read_config(cfg_file)
-
-        # Try to get builtin commands as normal
-        rv = click.Group.get_command(self, ctx, cmd_name)
-        if rv is not None:
-            return rv
-
-        # No builtin found. Look up an explicit command alias in the config
-        if cmd_name in _config.aliases:
-            actual_cmd = _config.aliases[cmd_name]
-            return click.Group.get_command(self, ctx, actual_cmd)
-
-        # Alternative option: if we did not find an explicit alias we
-        # allow automatic abbreviation of the command.  "status" for
-        # instance will match "st".  We only allow that however if
-        # there is only one command.
-        matches = [x for x in self.list_commands(ctx)
-                   if x.lower().startswith(cmd_name.lower())]
-        if not matches:
-            # No command name matched. Issue Default command.
-            ctx.arg0 = cmd_name
-            cmd_name = self.default_cmd_name
-            return DefaultGroup.get_command(self, ctx, cmd_name)
-        elif len(matches) == 1:
-            return DefaultGroup.get_command(self, ctx, matches[0])
-        ctx.fail('Too many matches: %s' % ', '.join(sorted(matches)))
-
+from pprint import pprint
 
 def run_command(command, pager=False):
-    if pager is True:
-        click.echo(click.style("Command: ", fg='cyan') + click.style(command, fg='green'))
-        p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
-        click.echo_via_pager(p.stdout.read())
+    click.echo(click.style("Command: ", fg='cyan') + click.style(command, fg='green'))
+    p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
+    output = p.stdout.read()
+    if pager:
+        click.echo_via_pager(output)
     else:
-        click.echo(click.style("Command: ", fg='cyan') + click.style(command, fg='green'))
-        p = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
-        click.echo(p.stdout.read())
+        click.echo(output)
 
 
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help', '-?'])
-
-
 #
 # 'cli' group (root group) ###
 #
 
-@click.group(cls=AliasedGroup, context_settings=CONTEXT_SETTINGS)
+@click.group(cls=click.Group, context_settings=CONTEXT_SETTINGS, invoke_without_command=True)
 def cli():
     """SONiC command line - 'debug' command"""
     pass
 
-#
-# 'bgp' group ###
-#
 
-@cli.group(cls=AliasedGroup, default_if_no_args=True)
-def bgp():
-    """debug bgp on """
-    pass
+p = subprocess.check_output(["sudo vtysh -c 'show version'"], shell=True)
+if 'FRRouting' in p:
+    #
+    # 'bgp' group for FRR ###
+    #
+    @cli.group()
+    def bgp():
+        """debug bgp group """
+        pass
+
+    @bgp.command()
+    def allow_martians():
+        """BGP allow martian next hops"""
+        command = 'sudo vtysh -c "debug bgp allow-martians"'
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('additional', type=click.Choice(['segment']), required=False)
+    def as4(additional):
+        """BGP AS4 actions"""
+        command = 'sudo vtysh -c "debug bgp as4'
+        if additional is not None:
+            command += " segment"
+        command += '"'
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('prefix', required=True)
+    def bestpath(prefix):
+        """BGP bestpath"""
+        command = 'sudo vtysh -c "debug bgp bestpath %s"' % prefix
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('prefix_or_iface', required=False)
+    def keepalives(prefix_or_iface):
+        """BGP Neighbor Keepalives"""
+        command = 'sudo vtysh -c "debug bgp keepalives'
+        if prefix_or_iface is not None:
+            command += " " + prefix_or_iface
+        command += '"'
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('prefix_or_iface', required=False)
+    def neighbor_events(prefix_or_iface):
+        """BGP Neighbor Events"""
+        command = 'sudo vtysh -c "debug bgp neighbor-events'
+        if prefix_or_iface is not None:
+            command += " " + prefix_or_iface
+        command += '"'
+        run_command(command)
+
+    @bgp.command()
+    def nht():
+        """BGP nexthop tracking events"""
+        command = 'sudo vtysh -c "debug bgp nht"'
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('additional', type=click.Choice(['error']), required=False)
+    def pbr(additional):
+        """BGP policy based routing"""
+        command = 'sudo vtysh -c "debug bgp pbr'
+        if additional is not None:
+            command += " error"
+        command += '"'
+        run_command(command)
+
+    @bgp.command()
+    def update_groups():
+        """BGP update-groups"""
+        command = 'sudo vtysh -c "debug bgp update-groups"'
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('direction', type=click.Choice(['in', 'out', 'prefix']), required=False)
+    @click.argument('prefix', required=False)
+    def updates(direction, prefix):
+        """BGP updates"""
+        command = 'sudo vtysh -c "debug bgp updates'
+        if direction is not None:
+            command += " " + direction
+        if prefix is not None:
+            command += " " + prefix
+        command += '"'
+        run_command(command)
+
+    @bgp.command()
+    @click.argument('prefix', required=False)
+    def zebra(prefix):
+        """BGP Zebra messages"""
+        command = 'sudo vtysh -c "debug bgp zebra'
+        if prefix is not None:
+            command += " prefix " + prefix
+        command += '"'
+        run_command(command)
+
+    #
+    # 'zebra' group for FRR ###
+    #
+    @cli.group()
+    def zebra():
+        """debug zebra group"""
+        pass
+
+    @zebra.command()
+    @click.argument('detailed', type=click.Choice(['detailed']), required=False)
+    def dplane(detailed):
+        """Debug zebra dataplane events"""
+        command = 'sudo vtysh -c "debug zebra dplane'
+        if detailed is not None:
+            command += " detailed"
+        command += '"'
+        run_command(command)
+
+    @zebra.command()
+    def events():
+        """Debug option set for zebra events"""
+        command = 'sudo vtysh -c "debug zebra events"'
+        run_command(command)
+
+    @zebra.command()
+    def fpm():
+        """Debug zebra FPM events"""
+        command = 'sudo vtysh -c "debug zebra fpm"'
+        run_command(command)
+
+    @zebra.command()
+    def kernel():
+        """Debug option set for zebra between kernel interface"""
+        command = 'sudo vtysh -c "debug zebra kernel"'
+        run_command(command)
+
+    @zebra.command()
+    def nht():
+        """Debug option set for zebra next hop tracking"""
+        command = 'sudo vtysh -c "debug zebra nht"'
+        run_command(command)
+
+    @zebra.command()
+    def packet():
+        """Debug option set for zebra packet"""
+        command = 'sudo vtysh -c "debug zebra packet"'
+        run_command(command)
+
+    @zebra.command()
+    @click.argument('detailed', type=click.Choice(['detailed']), required=False)
+    def rib(detailed):
+        """Debug RIB events"""
+        command = 'sudo vtysh -c "debug zebra rib'
+        if detailed is not None:
+            command += " detailed"
+        command += '"'
+        run_command(command)
+
+    @zebra.command()
+    def vxlan():
+        """Debug option set for zebra VxLAN (EVPN)"""
+        command = 'sudo vtysh -c "debug zebra vxlan"'
+        run_command(command)
+
+else:
+    #
+    # 'bgp' group for quagga ###
+    #
+    @cli.group(cls=DefaultGroup, default_if_no_args=True)
+    #@cli.group()
+    def bgp():
+        """debug bgp on """
+        pass
+
+    @bgp.command(default=True)
+    def default():
+        """debug bgp"""
+        command = 'sudo vtysh -c "debug bgp"'
+        run_command(command)
+
+    @bgp.command()
+    def events():
+        """debug bgp events on"""
+        command = 'sudo vtysh -c "debug bgp events"'
+        run_command(command)
+
+    @bgp.command()
+    def updates():
+        """debug bgp updates on"""
+        command = 'sudo vtysh -c "debug bgp updates"'
+        run_command(command)
+
+    @bgp.command()
+    def as4():
+        """debug bgp as4 actions on"""
+        command = 'sudo vtysh -c "debug bgp as4"'
+        run_command(command)
+
+    @bgp.command()
+    def filters():
+        """debug bgp filters on"""
+        command = 'sudo vtysh -c "debug bgp filters"'
+        run_command(command)
+
+    @bgp.command()
+    def fsm():
+        """debug bgp finite state machine on"""
+        command = 'sudo vtysh -c "debug bgp fsm"'
+        run_command(command)
+
+    @bgp.command()
+    def keepalives():
+        """debug bgp keepalives on"""
+        command = 'sudo vtysh -c "debug bgp keepalives"'
+        run_command(command)
+
+    @bgp.command()
+    def zebra():
+        """debug bgp zebra messages on"""
+        command = 'sudo vtysh -c "debug bgp zebra"'
+        run_command(command)
+
+    #
+    # 'zebra' group for quagga ###
+    #
+    @cli.group()
+    def zebra():
+        """debug zebra group"""
+        pass
+
+    @zebra.command()
+    def events():
+        """debug option set for zebra events"""
+        command = 'sudo vtysh -c "debug zebra events"'
+        run_command(command)
+
+    @zebra.command()
+    def fpm():
+        """debug zebra FPM events"""
+        command = 'sudo vtysh -c "debug zebra fpm"'
+        run_command(command)
+
+    @zebra.command()
+    def kernel():
+        """debug option set for zebra between kernel interface"""
+        command = 'sudo vtysh -c "debug zebra kernel"'
+        run_command(command)
+
+    @zebra.command()
+    def packet():
+        """debug option set for zebra packet"""
+        command = 'sudo vtysh -c "debug zebra packet"'
+        run_command(command)
+
+    @zebra.command()
+    def rib():
+        """debug RIB events"""
+        command = 'sudo vtysh -c "debug zebra rib"'
+        run_command(command)
 
-@bgp.command(default=True)
-def default():
-    command = 'sudo vtysh -c "debug bgp"'
-    run_command(command)
-
-@bgp.command()
-def events():
-    """debug bgp events on """
-    command = 'sudo vtysh -c "debug bgp events"'
-    run_command(command)
-
-@bgp.command()
-def updates():
-    """debug bgp events on """
-    command = 'sudo vtysh -c "debug bgp updates"'
-    run_command(command)
 
 if __name__ == '__main__':
     cli()