[route_check][dualtor] Ignore vlan neighbor route miss (#2888)

What I did
As the subject.
This PR is to leave the vlan neighbor route checking to dualtor_neighbor_check.py script: #2840

Signed-off-by: Longxiang Lyu [email protected]

How I did it
If any misses are found on dualtor, ignore those vlan neighbor misses.

How to verify it
UT and verify on testbed.

Author: lolyu

scripts/route_check.py

@@ -530,6 +530,51 @@ def filter_out_soc_ip_routes(routes):
     return updated_routes
 
 
+def get_vlan_neighbors():
+    """Return a list of VLAN neighbors."""
+    db = swsscommon.DBConnector(APPL_DB_NAME, 0)
+    print_message(syslog.LOG_DEBUG, "APPL DB connected for neighbors")
+    tbl = swsscommon.Table(db, 'NEIGH_TABLE')
+    neigh_entries = tbl.getKeys()
+
+    valid_neighs = []
+    for neigh_entry in neigh_entries:
+        if ':' in neigh_entry:
+            device, prefix = neigh_entry.split(':', 1)
+            if device.startswith("Vlan"):
+                valid_neighs.append(add_prefix_ifnot(prefix.lower()))
+
+    print_message(syslog.LOG_DEBUG, "Vlan neighbors:",  json.dumps(valid_neighs, indent=4))
+    return valid_neighs
+
+
+def filter_out_vlan_neigh_route_miss(rt_appl_miss, rt_asic_miss):
+    """Ignore any route miss for vlan neighbor IPs."""
+
+    def _filter_out_neigh_route(routes, neighs):
+        updated_routes = []
+        ignored_routes = []
+        for route in routes:
+            if route in neighs:
+                ignored_routes.append(route)
+            else:
+                updated_routes.append(route)
+        return updated_routes, ignored_routes
+
+    config_db = swsscommon.ConfigDBConnector()
+    config_db.connect()
+
+    print_message(syslog.LOG_DEBUG, "Ignore vlan neighbor route miss")
+    if is_dualtor(config_db):
+        vlan_neighs = set(get_vlan_neighbors())
+        rt_appl_miss, ignored_rt_appl_miss = _filter_out_neigh_route(rt_appl_miss, vlan_neighs)
+        print_message(syslog.LOG_DEBUG, "Ignored appl route miss:",  json.dumps(ignored_rt_appl_miss, indent=4))
+        rt_asic_miss, ignored_rt_asic_miss = _filter_out_neigh_route(rt_asic_miss, vlan_neighs)
+        print_message(syslog.LOG_DEBUG, "Ignored asic route miss:",  json.dumps(ignored_rt_asic_miss, indent=4))
+
+    return rt_appl_miss, rt_asic_miss
+
+
 def check_routes():
     """
     The heart of this script which runs the checks.
@@ -578,6 +623,11 @@ def check_routes():
     if rt_appl_miss:
         rt_appl_miss = filter_out_voq_neigh_routes(rt_appl_miss)
 
+    # NOTE: On dualtor environment, ignore any route miss for the
+    # neighbors learned from the vlan subnet.
+    if rt_appl_miss or rt_asic_miss:
+        rt_appl_miss, rt_asic_miss = filter_out_vlan_neigh_route_miss(rt_appl_miss, rt_asic_miss)
+
     if rt_appl_miss or rt_asic_miss:
         # Look for subscribe updates for a second
         adds, deletes = get_subscribe_updates(selector, subs)

tests/route_check_test_data.py

@@ -351,4 +351,58 @@
             }
         }
     },
+    "11": {
+        DESCR: "dualtor ignore vlan neighbor route miss case",
+        ARGS: "route_check -i 15",
+        RET: -1,
+        PRE: {
+            CONFIG_DB: {
+                DEVICE_METADATA: {
+                    LOCALHOST: {"subtype": "DualToR"}
+                }
+            },
+            APPL_DB: {
+                ROUTE_TABLE: {
+                    "10.10.196.12/31" : { "ifname": "portchannel0" },
+                    "10.10.196.20/31" : { "ifname": "portchannel0" },
+                    "192.168.0.101/32": { "ifname": "tun0" },
+                    "192.168.0.103/32": { "ifname": "tun0" },
+                },
+                INTF_TABLE: {
+                    "PortChannel1013:90.10.196.24/31": {},
+                    "PortChannel1023:9603:10b0:503:df4::5d/126": {},
+                },
+                NEIGH_TABLE: {
+                    "Vlan1000:192.168.0.100": {},
+                    "Vlan1000:192.168.0.101": {},
+                    "Vlan1000:192.168.0.102": {},
+                    "Vlan1000:192.168.0.103": {},
+                }
+            },
+            ASIC_DB: {
+                RT_ENTRY_TABLE: {
+                    RT_ENTRY_KEY_PREFIX + "20.10.196.12/31" + RT_ENTRY_KEY_SUFFIX: {},
+                    RT_ENTRY_KEY_PREFIX + "20.10.196.20/31" + RT_ENTRY_KEY_SUFFIX: {},
+                    RT_ENTRY_KEY_PREFIX + "20.10.196.24/32" + RT_ENTRY_KEY_SUFFIX: {},
+                    RT_ENTRY_KEY_PREFIX + "192.168.0.101/32" + RT_ENTRY_KEY_SUFFIX: {},
+                    RT_ENTRY_KEY_PREFIX + "192.168.0.102/32" + RT_ENTRY_KEY_SUFFIX: {},
+                }
+            }
+        },
+        RESULT: {
+            "missed_ROUTE_TABLE_routes": [
+                "10.10.196.12/31",
+                "10.10.196.20/31"
+            ],
+            "missed_INTF_TABLE_entries": [
+                "90.10.196.24/32",
+                "9603:10b0:503:df4::5d/128"
+            ],
+            "Unaccounted_ROUTE_ENTRY_TABLE_entries": [
+                "20.10.196.12/31",
+                "20.10.196.20/31",
+                "20.10.196.24/32",
+            ]
+        }
+    },
 }