BGP suppress fib pending script

tests/bgp/bgp_helpers.py

@@ -4,6 +4,7 @@
 import json
 import pytest
 import yaml
+import random
 import logging
 import requests
 from natsort import natsorted
@@ -45,6 +46,13 @@
 ALLOW_LIST_PREFIX_JSON_FILE = '/tmp/allow_list.json'
 DROP_COMMUNITY = ''
 DEFAULT_ACTION = ''
+ANNOUNCE = 'announce'
+DEFAULT = "default"
+IP_VER = 4
+QUEUED = "queued"
+ACTION_IN = "in"
+ACTION_NOT_IN = "not"
+ACTION_STOP = "stop"
 
 
 def apply_bgp_config(duthost, template_name):
@@ -514,3 +522,210 @@ def get_default_action():
     Since the value of this constant has been changed in the helper, it cannot be directly imported
     """
     return DEFAULT_ACTION
+
+
+def restart_bgp_session(duthost):
+    """
+    Restart bgp session
+    """
+    logging.info("Restart all BGP sessions")
+    duthost.shell('vtysh -c "clear bgp *"')
+
+
+def get_ptf_recv_port(duthost, vm_name, tbinfo):
+    """
+    Get ptf receive port
+    """
+    port = duthost.shell("show lldp table | grep -w {} | awk '{{print $1}}'".format(vm_name))['stdout']
+    mg_facts = duthost.get_extended_minigraph_facts(tbinfo)
+    return mg_facts['minigraph_ptf_indices'][port]
+
+
+def get_eth_port(duthost, tbinfo):
+    """
+    Get ethernet port that connects to T0 VM
+    """
+    mg_facts = duthost.get_extended_minigraph_facts(tbinfo)
+    t0_vm = [vm_name for vm_name in mg_facts['minigraph_devices'].keys() if vm_name.endswith('T0')][0]
+    port = duthost.shell("show ip interface | grep -w {} | awk '{{print $1}}'".format(t0_vm))['stdout']
+    return port
+
+
+def get_vm_offset(duthost, nbrhosts, tbinfo):
+    """
+    Get port offset of exabgp and ptf receive port
+    """
+    logging.info("get_vm_offset ---------")
+    vm_name = random.choice([vm_name for vm_name in nbrhosts.keys() if vm_name.endswith('T0')])
+    ptf_recv_port = get_ptf_recv_port(duthost, vm_name, tbinfo)
+    port_offset = tbinfo['topo']['properties']['topology']['VMs'][vm_name]['vm_offset']
+    logging.info("vm_offset of {} is: {}".format(vm_name, port_offset))
+    return port_offset, ptf_recv_port
+
+
+def get_exabgp_port(duthost, nbrhosts, tbinfo, exabgp_base_port):
+    """
+    Get exabgp port and ptf receive port
+    """
+    port_offset, ptf_recv_port = get_vm_offset(duthost, nbrhosts, tbinfo)
+    return exabgp_base_port + port_offset, ptf_recv_port
+
+
+def get_vm_name(tbinfo, vm_level='T2'):
+    """
+    Get vm name, default return value would be T2 VM name
+    """
+    for vm in tbinfo['topo']['properties']['topology']['VMs'].keys():
+        if vm[-2:] == vm_level:
+            return vm
+
+
+def get_t2_ptf_intfs(mg_facts):
+    """
+    Get ptf interface list that connect with T2 VMs
+    """
+    t2_ethernets = []
+    for k, v in mg_facts["minigraph_neighbors"].items():
+        if v['name'][-2:] == 'T2':
+            t2_ethernets.append(k)
+
+    ptf_interfaces = []
+    for port in t2_ethernets:
+        ptf_interfaces.append(mg_facts['minigraph_ptf_indices'][port])
+    return ptf_interfaces
+
+
+def get_bgp_neighbor_ip(duthost, vm_name, vrf=DEFAULT):
+    """
+    Get ipv4 and ipv6 bgp neighbor ip addresses
+    """
+    if vrf == DEFAULT:
+        cmd_v4 = "show ip interface | grep -w {} | awk '{{print $5}}'"
+        cmd_v6 = "show ipv6 interface | grep -w {} | awk '{{print $5}}'"
+        bgp_neighbor_ip = duthost.shell(cmd_v4.format(vm_name))['stdout']
+        bgp_neighbor_ipv6 = duthost.shell(cmd_v6.format(vm_name))['stdout']
+    else:
+        cmd_v4 = "show ip interface | grep -w {} | awk '{{print $7}}' | sed 's/)//g'"
+        cmd_v6 = "show ipv6 interface | grep -w {} | awk '{{print $7}}' | sed 's/)//g'"
+        bgp_neighbor_ip = duthost.shell(cmd_v4.format(vm_name))['stdout'][1:-1]
+        bgp_neighbor_ipv6 = duthost.shell(cmd_v6.format(vm_name))['stdout'][1:-1]
+    logging.info("BGP neighbor of {} is {}".format(vm_name, bgp_neighbor_ip))
+    logging.info("IPv6 BGP neighbor of {} is {}".format(vm_name, bgp_neighbor_ipv6))
+
+    return bgp_neighbor_ip, bgp_neighbor_ipv6
+
+
+def get_vrf_route_json(duthost, route, vrf=DEFAULT, ip_ver=IP_VER):
+    """
+    Get output of 'show ip route vrf xxx xxx json' or 'show ipv6 route vrf xxx xxx json'
+    """
+    if ip_ver == IP_VER:
+        logging.info('Execute command - vtysh -c "show ip route vrf {} {} json"'.format(vrf, route))
+        out = json.loads(duthost.shell('vtysh -c "show ip route vrf {} {} json"'.
+                                       format(vrf, route), verbose=False)['stdout'])
+    else:
+        logging.info('Execute command - vtysh -c "show ipv6 route vrf {} {} json"'.format(vrf, route))
+        out = json.loads(duthost.shell('vtysh -c "show ipv6 route vrf {} {} json"'.
+                                       format(vrf, route), verbose=False)['stdout'])
+
+    logging.info('Command output:\n {}'.format(out))
+    return out
+
+
+def check_route_status(duthost, route, check_field, vrf=DEFAULT, ip_ver=IP_VER, expect_status=True):
+    """
+    Get 'offloaded' or 'queu' value of specific route
+    """
+    out = get_vrf_route_json(duthost, route, vrf, ip_ver)
+    check_field_status = out[route][0].get(check_field, None)
+    if check_field_status:
+        logging.info("Route:{} - {} status:{} - expect status:{}"
+                     .format(route, check_field, check_field_status, expect_status))
+        return True is expect_status
+    else:
+        logging.info("No {} value found in route:{}".format(check_field, out))
+        return False is expect_status
+
+
+def check_route_install_status(duthost, route, vrf=DEFAULT, ip_ver=IP_VER, check_point=QUEUED, action=ACTION_IN):
+    """
+    Verify route install status
+    """
+    if check_point == QUEUED:
+        if action == ACTION_IN:
+            pytest_assert(wait_until(60, 2, 0, check_route_status, duthost, route, check_point, vrf, ip_ver),
+                          "Vrf:{} - route:{} is not in {} state".format(vrf, route, check_point))
+        else:
+            pytest_assert(wait_until(60, 2, 0, check_route_status, duthost, route, check_point, vrf, ip_ver, False),
+                          "Vrf:{} - route:{} is in {} state".format(vrf, route, check_point))
+    else:
+        if action == ACTION_IN:
+            pytest_assert(wait_until(60, 2, 0, check_route_status, duthost, route, check_point, vrf, ip_ver),
+                          "Vrf:{} - route:{} is not installed into FIB".format(vrf, route))
+        else:
+            pytest_assert(wait_until(60, 2, 0, check_route_status, duthost, route, check_point, vrf, ip_ver, False),
+                          "Vrf:{} - route:{} is installed into FIB".format(vrf, route))
+
+
+def check_propagate_route(duthost, route, bgp_neighbor, vrf=DEFAULT, ip_ver=IP_VER, action=ACTION_IN):
+    """
+    Check whether ipv4 or ipv6 route is advertised to T2 VM
+    """
+    if ip_ver == IP_VER:
+        logging.info('Execute command - vtysh -c "show ip bgp vrf {} neighbors {} advertised-routes"'
+                     .format(vrf, bgp_neighbor))
+        out = duthost.shell('vtysh -c "show ip bgp vrf {} neighbors {} advertised-routes"'.format(vrf, bgp_neighbor),
+                            verbose=False)['stdout']
+    else:
+        logging.info('Execute command - vtysh -c "show ip bgp vrf {} ipv6 neighbors {} advertised-routes"'
+                     .format(vrf, bgp_neighbor))
+        out = duthost.shell('vtysh -c "show ip bgp vrf {} ipv6 neighbors {} advertised-routes"'.
+                            format(vrf, bgp_neighbor), verbose=False)['stdout']
+    logging.debug('Command output:\n {}'.format(out))
+
+    if action == ACTION_IN:
+        if route in out:
+            logging.info("Route:{} found - action:{}".format(route, action))
+            return True
+        else:
+            logging.info("Route:{} not found - action:{}".format(route, action))
+            return False
+    else:
+        if route in out:
+            logging.info("Route:{} found - action:{}".format(route, action))
+            return False
+        else:
+            logging.info("Route:{} not found - action:{}".format(route, action))
+            return True
+
+
+def validate_route_propagate_status(duthost, route, bgp_neighbor, vrf=DEFAULT, ip_ver=IP_VER, exist=True):
+    """
+    Verify ipv4 or ipv6 route propagate status
+    :param duthost: duthost fixture
+    :param route: ipv4 or ipv6 route
+    :param bgp_neighbor: ipv4 or ipv6 bgp neighbor address
+    :param vrf: vrf name
+    :param ip_ver: ip version number
+    :param exist: route expected status
+    """
+    if exist:
+        pytest_assert(wait_until(30, 2, 0, check_propagate_route, duthost, route, bgp_neighbor, vrf, ip_ver),
+                      "Vrf:{} - route:{} is not propagated to {}".format(vrf, route, bgp_neighbor))
+    else:
+        pytest_assert(wait_until(30, 2, 0, check_propagate_route, duthost, route, bgp_neighbor, vrf, ip_ver,
+                                 ACTION_NOT_IN),
+                      "Vrf:{} - route:{} is propagated to {}".format(vrf, route, bgp_neighbor))
+
+
+def operate_orchagent(duthost, action=ACTION_STOP):
+    """
+    Stop or Continue orchagent process
+    """
+    if action == ACTION_STOP:
+        logging.info('Suspend orchagent process to simulate a delay')
+        cmd = 'sudo kill -SIGSTOP $(pidof orchagent)'
+    else:
+        logging.info('Recover orchagent process')
+        cmd = 'sudo kill -SIGCONT $(pidof orchagent)'
+    duthost.shell(cmd)

tests/bgp/conftest.py

@@ -596,3 +596,52 @@ def bgpmon_setup_teardown(ptfhost, duthosts, enum_rand_one_per_hwsku_frontend_ho
     # Remove the route to DUT loopback IP  and the interface router mac
     ptfhost.shell("ip route del %s" % dut_lo_addr + "/32")
     ptfhost.shell("ip neigh flush to %s nud permanent" % dut_lo_addr)
+
+
+def pytest_addoption(parser):
+    """
+    Adds options to pytest that are used by bgp suppress fib pending test
+    """
+
+    parser.addoption(
+        "--bgp_suppress_fib_pending",
+        action="store_true",
+        dest="bgp_suppress_fib_pending",
+        default=False,
+        help="enable bgp suppress fib pending function, by default it will not enable bgp suppress fib pending function"
+    )
+    parser.addoption(
+        "--bgp_suppress_fib_reboot_type",
+        action="store",
+        dest="bgp_suppress_fib_reboot_type",
+        type=str,
+        choices=["reload", "fast", "warm", "cold", "random"],
+        default="reload",
+        help="reboot type such as reload, fast, warm, cold, random"
+    )
+
+
+@pytest.fixture(scope="module", autouse=True)
+def config_bgp_suppress_fib(duthosts, rand_one_dut_hostname, request):
+    """
+    Enable or disable bgp suppress-fib-pending function
+    """
+    duthost = duthosts[rand_one_dut_hostname]
+    config = request.config.getoption("--bgp_suppress_fib_pending")
+    logger.info("--bgp_suppress_fib_pending:{}".format(config))
+
+    if config:
+        logger.info("Check if bgp suppress fib pending is supported")
+        res = duthost.command("show suppress-fib-pending", module_ignore_errors=True)
+        if res['rc'] != 0:
+            pytest.skip('BGP suppress fib pending function is not supported')
+        logger.info('Enable BGP suppress fib pending function')
+        duthost.shell('sudo config suppress-fib-pending enabled')
+        duthost.shell('sudo config save -y')
+
+    yield
+
+    if config:
+        logger.info('Disable BGP suppress fib pending function')
+        duthost.shell('sudo config suppress-fib-pending disabled')
+        duthost.shell('sudo config save -y')