tests: add candidate BSR/RP topotest

Signed-off-by: Jafar Al-Gharaibeh <jafar@atcorp.com>

8 files changed, 479 insertions, 0 deletions

diff --git a/tests/topotests/pim_cand_rp_bsr/__init__.py b/tests/topotests/pim_cand_rp_bsr/__init__.py
new file mode 100755
index 0000000000..e69de29bb2
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/__init__.py
diff --git a/tests/topotests/pim_cand_rp_bsr/r1/frr.conf b/tests/topotests/pim_cand_rp_bsr/r1/frr.conf
new file mode 100644
index 0000000000..d0aa3d529f
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/r1/frr.conf
@@ -0,0 +1,25 @@
+!
+hostname r1
+password zebra
+log file /tmp/r1-frr.log
+!
+!debug pim packet
+!debug pim bsm
+!
+ip route 0.0.0.0/0 10.0.0.4
+!
+interface r1-eth0
+ ip address 10.0.0.1/24
+ ip igmp
+ ip pim
+!
+interface r1-eth1
+ ip address 10.0.1.1/24
+ ip igmp
+ ip pim
+!
+router pim
+  bsr candidate-bsr priority 200 source address 10.0.0.1
+!
+ip forwarding
+!
diff --git a/tests/topotests/pim_cand_rp_bsr/r2/frr.conf b/tests/topotests/pim_cand_rp_bsr/r2/frr.conf
new file mode 100644
index 0000000000..741c839f19
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/r2/frr.conf
@@ -0,0 +1,22 @@
+!
+hostname r2
+password zebra
+log file /tmp/r2-frr.log
+!
+ip route 0.0.0.0/0 10.0.0.4
+!
+interface r2-eth0
+ ip address 10.0.0.2/24
+ ip igmp
+ ip pim
+!
+interface r2-eth1
+ ip address 10.0.2.2/24
+ ip igmp
+ ip pim
+!
+router pim
+  bsr candidate-bsr priority 100 source address 10.0.0.2
+!
+ip forwarding
+!
diff --git a/tests/topotests/pim_cand_rp_bsr/r3/frr.conf b/tests/topotests/pim_cand_rp_bsr/r3/frr.conf
new file mode 100644
index 0000000000..bd5c8ce93f
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/r3/frr.conf
@@ -0,0 +1,32 @@
+!
+hostname r3
+password zebra
+log file /tmp/r3-frr.log
+!
+!debug pim packet
+!debug pim bsm
+!
+ip route 0.0.0.0/0 10.0.3.4
+ip route 10.0.6.0/24 10.0.3.6
+!
+interface r3-eth0
+ ip address 10.0.1.3/24
+ ip igmp
+ ip pim
+!
+interface r3-eth1
+ ip address 10.0.3.3/24
+ ip igmp
+ ip pim
+!
+interface r3-eth2
+ ip address 10.0.4.3/24
+ ip igmp
+ ip pim
+!
+router pim
+  bsr candidate-rp group 239.0.0.0/16
+  bsr candidate-rp priority 10 source address 10.0.3.3
+!
+ip forwarding
+!
diff --git a/tests/topotests/pim_cand_rp_bsr/r4/frr.conf b/tests/topotests/pim_cand_rp_bsr/r4/frr.conf
new file mode 100644
index 0000000000..825b227728
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/r4/frr.conf
@@ -0,0 +1,37 @@
+!
+hostname r4
+password zebra
+log file /tmp/r4-frr.log
+!
+ip route 10.0.1.0/24 10.0.0.1
+ip route 10.0.4.0/24 10.0.3.3
+ip route 10.0.6.0/24 10.0.3.6
+!
+interface r4-eth0
+ ip address 10.0.2.4/24
+ ip igmp
+ ip pim
+!
+interface r4-eth1
+ ip address 10.0.3.4/24
+ ip igmp
+ ip pim
+!
+interface r4-eth2
+ ip address 10.0.5.4/24
+ ip igmp
+ ip pim
+!
+interface r4-eth3
+ ip address 10.0.0.4/24
+ ip igmp
+ ip pim
+!
+router pim
+  bsr candidate-rp group 239.0.0.0/24
+  bsr candidate-rp group 239.0.0.0/16
+  bsr candidate-rp group 239.0.0.0/8
+  bsr candidate-rp priority 20 source address 10.0.3.4
+!
+ip forwarding
+!
diff --git a/tests/topotests/pim_cand_rp_bsr/r5/frr.conf b/tests/topotests/pim_cand_rp_bsr/r5/frr.conf
new file mode 100644
index 0000000000..c934717d08
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/r5/frr.conf
@@ -0,0 +1,17 @@
+!
+hostname r5
+password zebra
+log file /tmp/r5-frr.log
+!
+ip route 0.0.0.0/0 10.0.4.3
+!
+interface r5-eth0
+ ip address 10.0.4.5/24
+ ip igmp
+ ip pim
+!
+interface r5-eth1
+ ip address 10.0.6.5/24
+!
+ip forwarding
+!
diff --git a/tests/topotests/pim_cand_rp_bsr/r6/frr.conf b/tests/topotests/pim_cand_rp_bsr/r6/frr.conf
new file mode 100644
index 0000000000..fd9d1eb5c4
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/r6/frr.conf
@@ -0,0 +1,22 @@
+!
+hostname r6
+password zebra
+log file /tmp/r6-frr.log
+!
+ip route 0.0.0.0/0 10.0.6.6
+!
+interface r6-eth0
+ ip address 10.0.5.6/24
+ ip igmp
+ ip pim
+!
+interface r6-eth1
+ ip address 10.0.6.6/24
+!
+interface r6-eth2
+ ip address 10.0.3.6/24
+ ip igmp
+ ip pim
+!
+ip forwarding
+!
diff --git a/tests/topotests/pim_cand_rp_bsr/test_pim_cand_rp_bsr.py b/tests/topotests/pim_cand_rp_bsr/test_pim_cand_rp_bsr.py
new file mode 100644
index 0000000000..ce7bc9dc56
--- /dev/null
+++ b/tests/topotests/pim_cand_rp_bsr/test_pim_cand_rp_bsr.py
@@ -0,0 +1,324 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: ISC
+
+#
+# test_pim_cand_rp_bsr.py
+#
+# Copyright (c) 2024 ATCorp
+# Jafar Al-Gharaibeh
+#
+
+import os
+import sys
+import pytest
+import json
+from functools import partial
+
+# pylint: disable=C0413
+# Import topogen and topotest helpers
+from lib import topotest
+from lib.topogen import Topogen, get_topogen
+from lib.topolog import logger
+from lib.pim import verify_pim_rp_info
+from lib.common_config import step, write_test_header, retry
+
+from time import sleep
+
+"""
+test_pim_cand_rp_bsr.py: Test candidate RP/BSR functionality
+"""
+
+TOPOLOGY = """
+    Candidate RP/BSR functionality
+
+    +---+---+                      +---+---+
+    | C-BSR |     10.0.0.0/24      | C-BSR |
+    +  R1   + <--------+---------> +  R2   |
+    |elected| .1       |        .2 |       |
+    +---+---+          |           +---+---+
+     .1 |              |  10.0.2.0/24  | .2
+        | 10.0.1.0/24  |               |
+     .3 |              +-----|  .4     | .4
+    +---+---+                |---->+---+---+
+    | C-RP  |    10.0.3.0/24       | C-RP  |
+    +  R3   + <--------+---------> +  R4   |
+    | prio  | .3       |        .4 |       |
+    +---+---+          |           +---+---+
+     .3 |              |              | .4
+        |10.0.4.0/24   |   10.0.5.0/24|
+     .5 |              |         .6   | .6
+    +---+---+          +---------->+---+---+
+    |       |                      |       |
+    +  R5   + <------------------> +  R6   |
+    |       | .5                .6 |       |
+    +---+---+     10.0.6.0/24      +---+---+
+"""
+
+# Save the Current Working Directory to find configuration files.
+CWD = os.path.dirname(os.path.realpath(__file__))
+sys.path.append(os.path.join(CWD, "../"))
+
+# Required to instantiate the topology builder class.
+pytestmark = [pytest.mark.pimd]
+
+
+def build_topo(tgen):
+    "Build function"
+
+    # Create 6 routers
+    for rn in range(1, 7):
+        tgen.add_router("r{}".format(rn))
+
+    # Create 7 switches and connect routers
+    sw1 = tgen.add_switch("s1")
+    sw1.add_link(tgen.gears["r1"])
+    sw1.add_link(tgen.gears["r2"])
+
+    sw = tgen.add_switch("s2")
+    sw.add_link(tgen.gears["r1"])
+    sw.add_link(tgen.gears["r3"])
+
+    sw = tgen.add_switch("s3")
+    sw.add_link(tgen.gears["r2"])
+    sw.add_link(tgen.gears["r4"])
+
+    sw3 = tgen.add_switch("s4")
+    sw3.add_link(tgen.gears["r3"])
+    sw3.add_link(tgen.gears["r4"])
+
+    sw = tgen.add_switch("s5")
+    sw.add_link(tgen.gears["r3"])
+    sw.add_link(tgen.gears["r5"])
+
+    sw = tgen.add_switch("s6")
+    sw.add_link(tgen.gears["r4"])
+    sw.add_link(tgen.gears["r6"])
+
+    sw = tgen.add_switch("s7")
+    sw.add_link(tgen.gears["r5"])
+    sw.add_link(tgen.gears["r6"])
+
+    # make the diagnoal connections
+    sw1.add_link(tgen.gears["r4"])
+    sw3.add_link(tgen.gears["r6"])
+
+def setup_module(mod):
+    logger.info("PIM Candidate RP/BSR:\n {}".format(TOPOLOGY))
+
+    tgen = Topogen(build_topo, mod.__name__)
+    tgen.start_topology()
+
+    router_list = tgen.routers()
+    for rname, router in router_list.items():
+        logger.info("Loading router %s" % rname)
+        router.load_frr_config(os.path.join(CWD, "{}/frr.conf".format(rname)))
+
+    # Initialize all routers.
+    tgen.start_router()
+    for router in router_list.values():
+        if router.has_version("<", "4.0"):
+            tgen.set_error("unsupported version")
+
+
+def teardown_module(mod):
+    "Teardown the pytest environment"
+    tgen = get_topogen()
+    tgen.stop_topology()
+
+def test_pim_bsr_election_r1(request):
+    "Test PIM BSR Election"
+    tgen = get_topogen()
+    tc_name = request.node.name
+    write_test_header(tc_name)
+
+    if tgen.routers_have_failure():
+        pytest.skip("skipped because of router(s) failure")
+
+    r2 = tgen.gears["r2"]
+    # r1 should be the BSR winner because it has higher priority
+    expected = {
+        "bsr":"10.0.0.1",
+        "priority":200,
+        "state":"ACCEPT_PREFERRED",
+    }
+
+    test_func = partial(
+        topotest.router_json_cmp, r2, "show ip pim bsr json", expected
+    )
+    _, result = topotest.run_and_expect(test_func, None, count=60, wait=1)
+
+    assertmsg = "r2: r1 was not elected, bsr election mismatch"
+    assert result is None, assertmsg
+
+def test_pim_bsr_cand_bsr_r1(request):
+    "Test PIM BSR candidate BSR"
+    tgen = get_topogen()
+    tc_name = request.node.name
+    write_test_header(tc_name)
+
+    if tgen.routers_have_failure():
+        pytest.skip("skipped because of router(s) failure")
+
+    r2 = tgen.gears["r2"]
+
+    # r2 is a candidate bsr with low priority: elected = False
+    expected = {
+        "address": "10.0.0.2",
+        "priority": 100,
+        "elected": False
+    }
+    test_func = partial(
+        topotest.router_json_cmp, r2, "show ip pim bsr candidate-bsr json", expected
+    )
+    _, result = topotest.run_and_expect(test_func, None, count=60, wait=1)
+
+    assertmsg = "r2: candidate bsr mismatch "
+    assert result is None, assertmsg
+
+def test_pim_bsr_cand_rp(request):
+    "Test PIM BSR candidate RP"
+    tgen = get_topogen()
+    tc_name = request.node.name
+    write_test_header(tc_name)
+
+    if tgen.routers_have_failure():
+        pytest.skip("skipped because of router(s) failure")
+
+    r3 = tgen.gears["r3"]
+
+    # r3 is a candidate rp
+    expected = {
+        "address":"10.0.3.3",
+        "priority":10
+    }
+    test_func = partial(
+        topotest.router_json_cmp, r3, "show ip pim bsr candidate-rp json", expected
+    )
+    _, result = topotest.run_and_expect(test_func, None, count=60, wait=1)
+
+    assertmsg = "r3: bsr candidate rp mismatch"
+    assert result is None, assertmsg
+
+
+def test_pim_bsr_rp_info(request):
+    "Test RP info state"
+    tgen = get_topogen()
+    tc_name = request.node.name
+    write_test_header(tc_name)
+
+    if tgen.routers_have_failure():
+        pytest.skip("skipped because of router(s) failure")
+
+    # At this point, all nodes, including r5 should have synced the RP state
+    step("Verify rp-info on r5 from BSR")
+    result = verify_pim_rp_info(tgen, None, "r5", "239.0.0.0/16", None, "10.0.3.3",
+                                "BSR", False, "ipv4", True, retry_timeout = 90)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+    result = verify_pim_rp_info(tgen, None, "r5", "239.0.0.0/8", None, "10.0.3.4",
+                                "BSR", False, "ipv4", True,  retry_timeout = 30)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+    result = verify_pim_rp_info(tgen, None, "r5", "239.0.0.0/24", None, "10.0.3.4",
+                                "BSR", False, "ipv4", True,  retry_timeout = 30)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+    step("Verify rp-info on the BSR node itself r1")
+    result = verify_pim_rp_info(tgen, None, "r1", "239.0.0.0/16", None, "10.0.3.3",
+                                "BSR", False, "ipv4", True, retry_timeout = 10)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+    result = verify_pim_rp_info(tgen, None, "r1", "239.0.0.0/8", None, "10.0.3.4",
+                                "BSR", False, "ipv4", True,  retry_timeout = 10)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+    result = verify_pim_rp_info(tgen, None, "r1", "239.0.0.0/24", None, "10.0.3.4",
+                                "BSR", False, "ipv4", True,  retry_timeout = 10)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+
+def test_pim_bsr_election_fallback_r2(request):
+    "Test PIM BSR Election Backup"
+    tgen = get_topogen()
+    tc_name = request.node.name
+    write_test_header(tc_name)
+
+    if tgen.routers_have_failure():
+        pytest.skip("skipped because of router(s) failure")
+
+    step("Take r1 out from BSR candidates")
+    r1 = tgen.gears["r1"]
+    r1.vtysh_cmd(
+        """
+        configure
+          router pim
+            no bsr candidate-bsr priority 200 source address 10.0.0.1
+        """)
+
+    step("Verify r1 is no longer a BSR candidate")
+    expected = {}
+
+    test_func = partial(
+        topotest.router_json_cmp, r1, "show ip pim bsr candidate-bsr json", expected
+    )
+    _, result = topotest.run_and_expect(test_func, None, count=10, wait=1)
+
+    assertmsg = "r1: failed to remove bsr candidate configuration"
+    assert result is None, assertmsg
+
+    r2 = tgen.gears["r2"]
+    # We should fall back to r2 as the BSR
+    expected = {
+        "bsr":"10.0.0.2",
+        "priority":100,
+        "state":"BSR_ELECTED",
+    }
+
+    step("Verify that we fallback to r2 as the new BSR")
+
+    test_func = partial(
+        topotest.router_json_cmp, r2, "show ip pim bsr json", expected
+    )
+    _, result = topotest.run_and_expect(test_func, None, count=180, wait=1)
+
+    assertmsg = "r2: failed to fallback to r2 as a BSR"
+    assert result is None, assertmsg
+
+
+def test_pim_bsr_rp_info_fallback(request):
+    "Test RP info state on r5"
+    tgen = get_topogen()
+    tc_name = request.node.name
+    write_test_header(tc_name)
+
+    if tgen.routers_have_failure():
+        pytest.skip("skipped because of router(s) failure")
+
+    step("Take r3 out from RP candidates for group 239.0.0.0/16")
+    r3 = tgen.gears["r3"]
+    r3.vtysh_cmd(
+        """
+        configure
+          router pim
+            no bsr candidate-rp group 239.0.0.0/16
+        """)
+
+    step("Verify falling back to r4 as the new RP for 239.0.0.0/16")
+
+    result = verify_pim_rp_info(tgen, None, "r5", "239.0.0.0/16", None, "10.0.3.4",
+                                "BSR", False, "ipv4", True, retry_timeout = 30)
+    assert result is True, "Testcase {} :Failed \n Error: {}".format(tc_name, result)
+
+
+def test_memory_leak():
+    "Run the memory leak test and report results."
+    tgen = get_topogen()
+    if not tgen.is_memleak_enabled():
+        pytest.skip("Memory leak test/report is disabled")
+
+    tgen.report_memory_leaks()
+
+
+if __name__ == "__main__":
+    args = ["-s"] + sys.argv[1:]
+    sys.exit(pytest.main(args))