topotests: test IGMP/MLD group/source limits

Add new topology for testing IGMP/MLD group/source limiting and more features
in the future.

Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>

5 files changed, 486 insertions, 0 deletions

diff --git a/tests/topotests/multicast_features/__init__.py b/tests/topotests/multicast_features/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/tests/topotests/multicast_features/__init__.py
diff --git a/tests/topotests/multicast_features/r1/frr.conf b/tests/topotests/multicast_features/r1/frr.conf
new file mode 100644
index 0000000000..bd1cc4103c
--- /dev/null
+++ b/tests/topotests/multicast_features/r1/frr.conf
@@ -0,0 +1,48 @@
+log commands
+!
+interface r1-eth0
+ ip address 192.168.1.1/24
+ ip pim
+ ipv6 address 2001:db8:1::1/64
+ ipv6 pim
+!
+interface r1-eth1
+ ip address 192.168.2.1/24
+ ip pim
+ ipv6 address 2001:db8:2::1/64
+ ipv6 pim
+!
+interface r1-eth2
+ ip address 192.168.100.1/24
+ ip igmp
+ ip pim passive
+ ipv6 address 2001:db8:ffff::1/128
+ ipv6 mld
+ ipv6 pim passive
+!
+interface lo
+ ip address 10.254.254.1/32
+ ip pim
+ ip pim use-source 10.254.254.1
+!
+router bgp 65100
+ no bgp ebgp-requires-policy
+ no bgp network import-check
+ neighbor 192.168.1.2 remote-as 65200
+ neighbor 192.168.2.2 remote-as 65300
+ !
+ address-family ipv4 unicast
+  redistribute connected
+ exit-address-family
+ address-family ipv6 unicast
+  redistribute connected
+  neighbor 192.168.1.2 activate
+  neighbor 192.168.2.2 activate
+ exit-address-family
+!
+router pim
+ rp 10.254.254.1
+!
+router pim6
+ rp 2001:db8:ffff::1
+!
\ No newline at end of file
diff --git a/tests/topotests/multicast_features/r2/frr.conf b/tests/topotests/multicast_features/r2/frr.conf
new file mode 100644
index 0000000000..f647b93ca3
--- /dev/null
+++ b/tests/topotests/multicast_features/r2/frr.conf
@@ -0,0 +1,37 @@
+log commands
+!
+interface r2-eth0
+ ip address 192.168.1.2/24
+ ip pim
+ ipv6 address 2001:db8:1::2/64
+ ipv6 pim
+!
+interface r2-eth1
+ ip address 192.168.101.1/24
+ ip igmp
+ ip pim passive
+!
+interface lo
+ ip address 10.254.254.2/32
+ ipv6 address 2001:db8:ffff::2/128
+ ipv6 pim passive
+!
+router bgp 65200
+ no bgp ebgp-requires-policy
+ no bgp network import-check
+ neighbor 192.168.1.1 remote-as 65100
+ !
+ address-family ipv4 unicast
+  redistribute connected
+ exit-address-family
+ address-family ipv6 unicast
+  redistribute connected
+  neighbor 192.168.1.1 activate
+ exit-address-family
+!
+router pim
+ rp 10.254.254.2
+!
+router pim6
+ rp 2001:db8:ffff::2
+!
\ No newline at end of file
diff --git a/tests/topotests/multicast_features/r3/frr.conf b/tests/topotests/multicast_features/r3/frr.conf
new file mode 100644
index 0000000000..2ac00c8798
--- /dev/null
+++ b/tests/topotests/multicast_features/r3/frr.conf
@@ -0,0 +1,34 @@
+log commands
+!
+interface r3-eth0
+ ip address 192.168.2.2/24
+ ip pim
+ ipv6 address 2001:db8:2::2/64
+ ipv6 pim
+!
+interface lo
+ ip address 10.254.254.3/32
+ ip pim
+ ip pim use-source 10.254.254.3
+ ipv6 address 2001:db8:ffff::3/128
+ ipv6 pim passive
+!
+router bgp 65300
+ no bgp ebgp-requires-policy
+ no bgp network import-check
+ neighbor 192.168.2.1 remote-as 65100
+ !
+ address-family ipv4 unicast
+  redistribute connected
+ exit-address-family
+ address-family ipv6 unicast
+  redistribute connected
+  neighbor 192.168.2.1 activate
+ exit-address-family
+!
+router pim
+ rp 10.254.254.1
+!
+router pim6
+ rp 2001:db8:ffff::1
+!
\ No newline at end of file
diff --git a/tests/topotests/multicast_features/test_multicast_features.py b/tests/topotests/multicast_features/test_multicast_features.py
new file mode 100644
index 0000000000..9c1f4af99f
--- /dev/null
+++ b/tests/topotests/multicast_features/test_multicast_features.py
@@ -0,0 +1,367 @@
+#!/usr/bin/env python
+# SPDX-License-Identifier: ISC
+
+#
+# test_multicast_features.py
+# Part of NetDEF Topology Tests
+#
+# Copyright (c) 2025 by
+# Network Device Education Foundation, Inc. ("NetDEF")
+#
+
+"""
+test_multicast_features.py: Test the FRR PIM multicast features.
+"""
+
+import os
+import sys
+import json
+from functools import partial
+import re
+import pytest
+
+# Save the Current Working Directory to find configuration files.
+CWD = os.path.dirname(os.path.realpath(__file__))
+sys.path.append(os.path.join(CWD, "../"))
+
+# pylint: disable=C0413
+# Import topogen and topotest helpers
+from lib import topotest
+
+# Required to instantiate the topology builder class.
+from lib.topogen import Topogen, TopoRouter, get_topogen
+from lib.topolog import logger
+
+from lib.pim import McastTesterHelper
+
+pytestmark = [pytest.mark.bgpd, pytest.mark.pimd]
+
+app_helper = McastTesterHelper()
+
+
+def build_topo(tgen):
+    """
+    +----+     +----+     +----+     +----+
+    | h1 | <-> | r1 | <-> | r2 | <-> | h2 |
+    +----+     +----+     +----+     +----+
+                 ^
+                 |
+                 v
+               +----+
+               | r3 |
+               +----+
+    """
+
+    # Create 3 routers
+    for routern in range(1, 4):
+        tgen.add_router(f"r{routern}")
+
+    # R1 interface eth0 and R2 interface eth0
+    switch = tgen.add_switch("s1")
+    switch.add_link(tgen.gears["r1"])
+    switch.add_link(tgen.gears["r2"])
+
+    # R1 interface eth1
+    switch = tgen.add_switch("s2")
+    switch.add_link(tgen.gears["r1"])
+    switch.add_link(tgen.gears["r3"])
+
+    # R1 interface eth2
+    switch = tgen.add_switch("s3")
+    tgen.add_host("h1", "192.168.100.100/24", "via 192.168.100.1")
+    switch.add_link(tgen.gears["r1"])
+    switch.add_link(tgen.gears["h1"])
+
+    # R2 interface eth1
+    switch = tgen.add_switch("s4")
+    tgen.add_host("h2", "192.168.101.100/24", "via 192.168.101.1")
+    switch.add_link(tgen.gears["r2"])
+    switch.add_link(tgen.gears["h2"])
+
+
+def setup_module(mod):
+    "Sets up the pytest environment"
+    tgen = Topogen(build_topo, mod.__name__)
+    tgen.start_topology()
+
+    router_list = tgen.routers()
+    for _, router in router_list.items():
+        router.load_frr_config(os.path.join(CWD, f"{router.name}/frr.conf"))
+
+    # Initialize all routers.
+    tgen.start_router()
+
+    app_helper.init(tgen)
+
+
+def teardown_module():
+    "Teardown the pytest environment"
+    tgen = get_topogen()
+    app_helper.cleanup()
+    tgen.stop_topology()
+
+
+def test_bgp_convergence():
+    "Wait for BGP protocol convergence"
+    tgen = get_topogen()
+    if tgen.routers_have_failure():
+        pytest.skip(tgen.errors)
+
+    logger.info("waiting for protocols to converge")
+
+    def expect_loopback_route(router, iptype, route, proto):
+        "Wait until route is present on RIB for protocol."
+        logger.info(f"waiting route {route} in {router}")
+        test_func = partial(
+            topotest.router_json_cmp,
+            tgen.gears[router],
+            f"show {iptype} route json",
+            {route: [{"protocol": proto}]},
+        )
+        _, result = topotest.run_and_expect(test_func, None, count=130, wait=1)
+        assertmsg = '"{}" convergence failure'.format(router)
+        assert result is None, assertmsg
+
+    # Wait for R1
+    expect_loopback_route("r1", "ip", "10.254.254.2/32", "bgp")
+    expect_loopback_route("r1", "ip", "10.254.254.3/32", "bgp")
+    expect_loopback_route("r1", "ipv6", "2001:db8:ffff::2/128", "bgp")
+    expect_loopback_route("r1", "ipv6", "2001:db8:ffff::3/128", "bgp")
+
+    # Wait for R2
+    expect_loopback_route("r2", "ip", "10.254.254.1/32", "bgp")
+    expect_loopback_route("r2", "ip", "10.254.254.3/32", "bgp")
+    expect_loopback_route("r2", "ipv6", "2001:db8:ffff::1/128", "bgp")
+    expect_loopback_route("r2", "ipv6", "2001:db8:ffff::3/128", "bgp")
+
+    # Wait for R3
+    expect_loopback_route("r3", "ip", "10.254.254.1/32", "bgp")
+    expect_loopback_route("r3", "ip", "10.254.254.2/32", "bgp")
+    expect_loopback_route("r3", "ipv6", "2001:db8:ffff::1/128", "bgp")
+    expect_loopback_route("r3", "ipv6", "2001:db8:ffff::2/128", "bgp")
+
+
+def test_pim_convergence():
+    "Wait for PIM peers find each other."
+    tgen = get_topogen()
+    if tgen.routers_have_failure():
+        pytest.skip(tgen.errors)
+
+    def expect_pim_peer(router, iptype, interface, peer):
+        "Wait until peer is present."
+        logger.info(f"waiting peer {peer} in {router}")
+        expected = {interface: {peer: {"upTime": "*"}}}
+
+        test_func = partial(
+            topotest.router_json_cmp,
+            tgen.gears[router],
+            f"show {iptype} pim neighbor json",
+            expected,
+        )
+        _, result = topotest.run_and_expect(test_func, None, count=40, wait=2)
+        assertmsg = f'"{router}" convergence failure'
+        assert result is None, assertmsg
+
+    expect_pim_peer("r1", "ip", "r1-eth0", "192.168.1.2")
+    expect_pim_peer("r2", "ip", "r2-eth0", "192.168.1.1")
+    expect_pim_peer("r1", "ip", "r1-eth1", "192.168.2.2")
+
+    #
+    # IPv6 part
+    #
+    out = tgen.gears["r1"].vtysh_cmd("show interface r1-eth0 json", True)
+    r1_r2_link_address = out["r1-eth0"]["ipAddresses"][1]["address"].split('/')[0]
+    out = tgen.gears["r1"].vtysh_cmd("show interface r1-eth1 json", True)
+    r1_r3_link_address = out["r1-eth1"]["ipAddresses"][1]["address"].split('/')[0]
+    out = tgen.gears["r2"].vtysh_cmd("show interface r2-eth0 json", True)
+    r2_link_address = out["r2-eth0"]["ipAddresses"][1]["address"].split('/')[0]
+    out = tgen.gears["r3"].vtysh_cmd("show interface r3-eth0 json", True)
+    r3_link_address = out["r3-eth0"]["ipAddresses"][1]["address"].split('/')[0]
+
+    expect_pim_peer("r1", "ipv6", "r1-eth0", r2_link_address)
+    expect_pim_peer("r2", "ipv6", "r2-eth0", r1_r2_link_address)
+    expect_pim_peer("r1", "ipv6", "r1-eth1", r3_link_address)
+
+
+def test_igmp_group_limit():
+    "Test IGMP group limits."
+    tgen = get_topogen()
+    if tgen.routers_have_failure():
+        pytest.skip(tgen.errors)
+
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         ip igmp max-groups 4
+    """)
+    app_helper.run("h1", ["224.0.100.1", "h1-eth0"])
+    app_helper.run("h1", ["224.0.100.2", "h1-eth0"])
+    app_helper.run("h1", ["224.0.100.3", "h1-eth0"])
+    app_helper.run("h1", ["224.0.100.4", "h1-eth0"])
+    app_helper.run("h1", ["224.0.100.5", "h1-eth0"])
+    app_helper.run("h1", ["224.0.100.6", "h1-eth0"])
+
+    def expect_igmp_group_count():
+        igmp_groups = tgen.gears["r1"].vtysh_cmd("show ip igmp groups json", isjson=True)
+        try:
+            return len(igmp_groups["r1-eth2"]["groups"])
+        except KeyError:
+            return 0
+
+    topotest.run_and_expect(expect_igmp_group_count, 4, count=10, wait=2)
+
+    # Cleanup
+    app_helper.stop_host("h1")
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         no ip igmp max-groups 4
+        exit
+        clear ip igmp interfaces
+    """)
+
+
+def test_igmp_group_source_limit():
+    "Test IGMP source limits."
+    tgen = get_topogen()
+    if tgen.routers_have_failure():
+        pytest.skip(tgen.errors)
+
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         ip igmp max-sources 4
+        exit
+    """)
+
+    app_helper.run("h1", ["--source=192.168.100.10", "232.0.101.10", "h1-eth0"])
+    app_helper.run("h1", ["--source=192.168.100.11", "232.0.101.10", "h1-eth0"])
+    app_helper.run("h1", ["--source=192.168.100.12", "232.0.101.10", "h1-eth0"])
+    app_helper.run("h1", ["--source=192.168.100.13", "232.0.101.10", "h1-eth0"])
+    app_helper.run("h1", ["--source=192.168.100.14", "232.0.101.10", "h1-eth0"])
+    app_helper.run("h1", ["--source=192.168.100.15", "232.0.101.10", "h1-eth0"])
+    app_helper.run("h1", ["--source=192.168.100.16", "232.0.101.10", "h1-eth0"])
+
+    def expect_igmp_group_source_count():
+        igmp_sources = tgen.gears["r1"].vtysh_cmd("show ip igmp sources json", isjson=True)
+        try:
+            return len(igmp_sources["r1-eth2"]["232.0.101.10"]["sources"])
+        except KeyError:
+            return 0
+
+    topotest.run_and_expect(expect_igmp_group_source_count, 4, count=10, wait=2)
+
+    # Cleanup
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         no ip igmp max-sources 4
+        exit
+        clear ip igmp interfaces
+    """)
+    app_helper.stop_host("h1")
+
+
+def test_mld_group_limit():
+    "Test MLD group limits."
+    tgen = get_topogen()
+    if tgen.routers_have_failure():
+        pytest.skip(tgen.errors)
+
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         ipv6 mld max-groups 14
+    """)
+    app_helper.run("h1", ["FF05::100", "h1-eth0"])
+    app_helper.run("h1", ["FF05::101", "h1-eth0"])
+    app_helper.run("h1", ["FF05::102", "h1-eth0"])
+    app_helper.run("h1", ["FF05::103", "h1-eth0"])
+    app_helper.run("h1", ["FF05::104", "h1-eth0"])
+    app_helper.run("h1", ["FF05::105", "h1-eth0"])
+    app_helper.run("h1", ["FF05::106", "h1-eth0"])
+    app_helper.run("h1", ["FF05::107", "h1-eth0"])
+    app_helper.run("h1", ["FF05::108", "h1-eth0"])
+    app_helper.run("h1", ["FF05::109", "h1-eth0"])
+    app_helper.run("h1", ["FF05::110", "h1-eth0"])
+    app_helper.run("h1", ["FF05::111", "h1-eth0"])
+    app_helper.run("h1", ["FF05::112", "h1-eth0"])
+    app_helper.run("h1", ["FF05::113", "h1-eth0"])
+    app_helper.run("h1", ["FF05::114", "h1-eth0"])
+    app_helper.run("h1", ["FF05::115", "h1-eth0"])
+
+    def expect_mld_group_count():
+        mld_groups = tgen.gears["r1"].vtysh_cmd("show ipv6 mld groups json", isjson=True)
+        try:
+            return len(mld_groups["r1-eth2"]["groups"])
+        except KeyError:
+            return 0
+
+
+    topotest.run_and_expect(expect_mld_group_count, 14, count=10, wait=2)
+
+
+    # Cleanup
+    app_helper.stop_host("h1")
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         no ipv6 mld max-groups 4
+        exit
+        clear ipv6 mld interfaces
+    """)
+
+
+def test_mld_group_source_limit():
+    "Test MLD source limits."
+    tgen = get_topogen()
+    if tgen.routers_have_failure():
+        pytest.skip(tgen.errors)
+
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         ipv6 mld max-sources 4
+        exit
+    """)
+
+    app_helper.run("h1", ["--source=2001:db8:1::100", "FF35::100", "h1-eth0"])
+    app_helper.run("h1", ["--source=2001:db8:1::101", "FF35::100", "h1-eth0"])
+    app_helper.run("h1", ["--source=2001:db8:1::102", "FF35::100", "h1-eth0"])
+    app_helper.run("h1", ["--source=2001:db8:1::103", "FF35::100", "h1-eth0"])
+    app_helper.run("h1", ["--source=2001:db8:1::104", "FF35::100", "h1-eth0"])
+    app_helper.run("h1", ["--source=2001:db8:1::105", "FF35::100", "h1-eth0"])
+    app_helper.run("h1", ["--source=2001:db8:1::106", "FF35::100", "h1-eth0"])
+
+    def expect_mld_source_group_count():
+        mld_sources = tgen.gears["r1"].vtysh_cmd("show ipv6 mld joins json", isjson=True)
+        try:
+            return len(mld_sources["default"]["r1-eth2"]["ff35::100"].keys())
+        except KeyError:
+            return 0
+
+    topotest.run_and_expect(expect_mld_source_group_count, 4, count=10, wait=2)
+
+    # Cleanup
+    tgen.gears["r1"].vtysh_cmd("""
+        configure terminal
+        interface r1-eth2
+         no ipv6 mld max-sources 4
+        exit
+        clear ipv6 mld interfaces
+    """)
+    app_helper.stop_host("h1")
+
+
+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))