sonic-utilities: Create SONiC ISIS show commands

* Update show/main.py Include "isis" as a cli group option for show commands
* Create show/isis_frr.py Add "isis" as a cli group option for show commands and add support for "show isis neighbors", "show isis database", "show isis hostname", and "show isis interface"

Signed-off-by: [email protected]

Author: cchoate54

show/isis_frr.py

@@ -0,0 +1,119 @@
+import click
+
+import utilities_common.bgp_util as bgp_util
+import utilities_common.cli as clicommon
+from natsort import natsorted
+from swsscommon.swsscommon import ConfigDBConnector
+
+
+###############################################################################
+#
+# 'show isis' cli stanza
+#
+############################################################################### 
+
+def get_interfaces():
+    """Get list of interfaces 
+    """
+    tables = ['LOOPBACK_INTERFACE', 'PORT', 'PORTCHANNEL']
+    data = []
+
+    config_db = ConfigDBConnector()
+    config_db.connect()
+
+    for table_name in tables:
+        interface_list = list(config_db.get_table(table_name).keys())
+        interface_list = [x for x in interface_list if isinstance(x, str)]
+        data += natsorted(interface_list)
+    return data
+
+INTERFACE_LIST = get_interfaces()
+
+def invalid_arg(input:str):
+    if input == '?':
+        ctx = click.get_current_context()
+        ctx.fail('The argument: "{}" is invalid. Try "-?".'.format(input))
+
+@click.group(cls=clicommon.AliasedGroup, name="isis")
+def isis():
+    """Show ISIS (Intermediate System to Intermediate System) information"""
+    pass
+
+
+# 'neighbors' subcommand ("show isis neighbors")
+@isis.command()
+@click.argument('system_id', required=False)
+@click.option('--verbose', is_flag=True, help="Enable verbose output")
+def neighbors(system_id, verbose):
+    """Show ISIS neighbors"""
+
+    command = 'show isis neighbor'
+    if system_id is not None:
+        invalid_arg(system_id)
+        command += ' {}'.format(system_id)
+    elif verbose:
+        command += ' detail'
+
+    output = ""
+    output += bgp_util.run_bgp_show_command(command)
+
+    click.echo(output.rstrip('\n'))
+
+# 'database' subcommand ("show isis database")
+@isis.command()
+@click.argument('lsp_id', required=False)
+@click.option('--verbose', is_flag=True, help="Enable verbose output")
+def database(lsp_id, verbose):
+    """Show ISIS database"""
+
+    command = 'show isis database'
+    if verbose:
+        command += ' detail'
+    if lsp_id is not None:
+        invalid_arg(lsp_id)
+        command += ' {0}'.format(lsp_id)
+
+    output = ""
+    output += bgp_util.run_bgp_show_command(command)
+
+    click.echo(output.rstrip('\n'))
+
+# 'hostname' subcommand ("show isis hostname")
+@isis.command()
+def hostname():
+    """Show ISIS hostname"""
+
+    command = 'show isis hostname'
+
+    output = ""
+    output += bgp_util.run_bgp_show_command(command)
+
+    click.echo(output.rstrip('\n'))
+
+# 'interface' subcommand ("show isis interface")
+@isis.command()
+@click.argument('interface',
+                metavar='[INTERFACE]',
+                type=click.Choice(
+                    INTERFACE_LIST),
+                required=False)
+@click.option('--verbose', is_flag=True, help="Enable verbose output")
+@click.option('--display', is_flag=True, help=f"Display available [INTERFACE] options:\n{INTERFACE_LIST}")
+def interface(interface, verbose, display):
+    """Show ISIS interface"""
+
+    if display:
+        d = f"[INTERFACE] options: {INTERFACE_LIST}"
+        click.echo(d)
+
+    command = 'show isis interface'
+
+    if interface is not None:
+        command += ' {0}'.format(interface)
+    elif verbose:
+        command += ' detail'
+
+    output = ""
+    output += bgp_util.run_bgp_show_command(command)
+
+    click.echo(output.rstrip('\n'))

show/main.py

@@ -48,6 +48,7 @@
 from . import flow_counters
 from . import gearbox
 from . import interfaces
+from . import isis_frr
 from . import kdump
 from . import kube
 from . import muxcable
@@ -276,6 +277,7 @@ def cli(ctx):
 cli.add_command(flow_counters.flowcnt_trap)
 cli.add_command(kdump.kdump)
 cli.add_command(interfaces.interfaces)
+cli.add_command(isis_frr.isis)
 cli.add_command(kdump.kdump)
 cli.add_command(kube.kubernetes)
 cli.add_command(muxcable.muxcable)

tests/conftest.py

@@ -18,6 +18,12 @@
     mock_show_bgp_network_single_asic,
     mock_show_bgp_network_multi_asic
     )
+from .isis_frr_input.isis_frr_test_vector import(
+    mock_show_isis_neighbors,
+    mock_show_isis_database,
+    mock_show_isis_hostname,
+    mock_show_isis_interface
+    )
 from . import config_int_ip_common
 import utilities_common.constants as constants
 import config.main as config
@@ -367,3 +373,35 @@ def mock_restart_dhcp_relay_service():
     yield
 
     config.vlan.dhcp_relay_util.handle_restart_dhcp_relay_service = origin_func
+
+@pytest.fixture
+def setup_single_isis_instance(request):
+    import utilities_common.bgp_util as bgp_util
+
+    _old_run_bgp_command = bgp_util.run_bgp_command
+
+    if request.param.startswith('isis_neighbor') or \
+            request.param.startswith('isis_neighbor'):
+        bgp_util.run_bgp_command = mock.MagicMock(
+            return_value=mock_show_isis_neighbors(request))
+    elif request.param.startswith('isis_database') or \
+            request.param.startswith('isis_database'):
+        bgp_util.run_bgp_command = mock.MagicMock(
+            return_value=mock_show_isis_database(request))     
+    elif request.param.startswith('isis_hostname') or \
+            request.param.startswith('isis_hostname'):
+        bgp_util.run_bgp_command = mock.MagicMock(
+            return_value=mock_show_isis_hostname(request))
+    elif request.param.startswith('isis_interface') or \
+            request.param.startswith('isis_interface'):
+        bgp_util.run_bgp_command = mock.MagicMock(
+            return_value=mock_show_isis_interface(request))       
+    yield
+
+    bgp_util.run_bgp_command = _old_run_bgp_command
+
+
+@pytest.fixture
+def setup_isis_commands():
+    import show.main as show
+    return show