Implement waiting for BGP routes to go down.

tests/arp/test_neighbor_mac_noptf.py

@@ -2,6 +2,7 @@
 import pytest
 import time
 
+from tests.common.utilities import wait_until
 from tests.common.helpers.assertions import pytest_assert
 from tests.common.config_reload import config_reload
 
@@ -10,7 +11,11 @@
 pytestmark = [
     pytest.mark.topology('any')
 ]
+
 REDIS_NEIGH_ENTRY_MAC_ATTR ="SAI_NEIGHBOR_ENTRY_ATTR_DST_MAC_ADDRESS"
+ROUTE_TABLE_NAME = 'ASIC_STATE:SAI_OBJECT_TYPE_ROUTE_ENTRY'
+DEFAULT_ROUTE_NUM = 2
+
 class TestNeighborMacNoPtf:
     """
         Test handling of neighbor MAC in SONiC switch
@@ -25,6 +30,21 @@ class TestNeighborMacNoPtf:
         6: {"intfIp": "fe00::1/64", "NeighborIp": "fe00::2"},
     }	
 
+    def count_routes(self, host, prefix):
+        # Counts routes in ASIC_DB with a given prefix
+        num = host.shell(
+                'sonic-db-cli ASIC_DB eval "return #redis.call(\'keys\', \'{}:{{\\"dest\\":\\"{}*\')" 0'.format(ROUTE_TABLE_NAME, prefix),
+                module_ignore_errors=True, verbose=True)['stdout']
+        return int(num)
+
+    def _check_no_bgp_routes(self, duthost):
+        # Checks that there are no routes installed by BGP in ASIC_DB by filtering out all local routes installed on testbeds
+        localv6 = self.count_routes(duthost, "fc") + self.count_routes(duthost, "fe")
+        localv4 = self.count_routes(duthost, "10.") + self.count_routes(duthost, "192.168.0.")
+        allroutes = self.count_routes(duthost, "")
+        bgproutes = allroutes - localv6 - localv4 - DEFAULT_ROUTE_NUM
+
+        return bgproutes == 0
 
     @pytest.fixture(scope="module", autouse=True)
     def setupDutConfig(self, duthosts, enum_rand_one_per_hwsku_frontend_hostname):
@@ -39,7 +59,9 @@ def setupDutConfig(self, duthosts, enum_rand_one_per_hwsku_frontend_hostname):
         """
         duthost = duthosts[enum_rand_one_per_hwsku_frontend_hostname]
         duthost.command("sudo config bgp shutdown all")
-        time.sleep(120)
+        if not wait_until(120, 2.0, self._check_no_bgp_routes, duthost):
+            pytest.fail('BGP Shutdown Timeout: BGP route removal exceeded 120 seconds.')
+
         yield
 
         logger.info("Reload Config DB")