From 8f980e8ba0af7d17520675c0ffd7d9f8028b4919 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Wed, 18 Mar 2026 10:02:30 -0500 Subject: [PATCH] [nexus] add MATN-TC-23 test case for automatic MLR re-registration (#12713) This commit adds a new Nexus test case MATN-TC-23 to verify that a Thread Device (DUT) automatically re-registers its multicast addresses before the Multicast Listener Registration (MLR) timeout expires. The test simulates a topology with two Border Routers (BR_1 and BR_2) and a Thread Device (TD as DUT). BR_1 acts as the Primary Backbone Router (BBR) and distributes a BBR Dataset with a configured MLR timeout. The TD registers a multicast address and then automatically sends a subsequent MLR.req to renew the registration before the timeout period ends. Implementation details: - Added test_1_2_MATN_TC_23.cpp to execute the simulation using direct method calls and 'note' log level. - Added verify_1_2_MATN_TC_23.py to validate the MLR.req/rsp exchange in the pcap output. - Included the full test specification as inline comments in both files, following strict indentation and formatting rules. - Registered the new test in CMakeLists.txt and run_nexus_tests.sh. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_1_2_MATN_TC_23.cpp | 231 +++++++++++++++++++++++++++ tests/nexus/verify_1_2_MATN_TC_23.py | 147 +++++++++++++++++ 4 files changed, 380 insertions(+) create mode 100644 tests/nexus/test_1_2_MATN_TC_23.cpp create mode 100644 tests/nexus/verify_1_2_MATN_TC_23.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 9899d3af4..f32e24128 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -249,6 +249,7 @@ ot_nexus_test(1_2_MATN_TC_19 "cert;nexus") ot_nexus_test(1_2_MATN_TC_20 "cert;nexus") ot_nexus_test(1_2_MATN_TC_21 "cert;nexus") ot_nexus_test(1_2_MATN_TC_22 "cert;nexus") +ot_nexus_test(1_2_MATN_TC_23 "cert;nexus") # Misc tests ot_nexus_test(border_admitter "core;nexus") diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index dfaf22aa5..7f09b39e5 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -184,6 +184,7 @@ DEFAULT_TESTS=( "1_2_MATN_TC_20" "1_2_MATN_TC_21" "1_2_MATN_TC_22" + "1_2_MATN_TC_23" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_1_2_MATN_TC_23.cpp b/tests/nexus/test_1_2_MATN_TC_23.cpp new file mode 100644 index 000000000..c9919e780 --- /dev/null +++ b/tests/nexus/test_1_2_MATN_TC_23.cpp @@ -0,0 +1,231 @@ +/* + * Copyright (c) 2026, The OpenThread Authors. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. Neither the name of the copyright holder nor the + * names of its contributors may be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + */ + +#include + +#include "platform/nexus_core.hpp" +#include "platform/nexus_node.hpp" + +namespace ot { +namespace Nexus { + +/** + * Time to advance for a node to form a network and become leader, in milliseconds. + */ +static constexpr uint32_t kFormNetworkTime = 10 * 1000; + +/** + * Time to advance for a node to join as a router, in milliseconds. + */ +static constexpr uint32_t kAttachToRouterTime = 200 * 1000; + +/** + * Time to advance for the network to stabilize, in milliseconds. + */ +static constexpr uint32_t kStabilizationTime = 10 * 1000; + +/** + * MLR Timeout Minimum value in seconds. + */ +static constexpr uint32_t kMlrTimeoutMin = 300; + +/** + * MLR Timeout value to use in seconds. + */ +static constexpr uint32_t kMlrTimeout = kMlrTimeoutMin + 30; + +/** + * Multicast address MA1. + */ +static const char kMulticastAddr1[] = "ff04::1234:777a:1"; + +void TestMatnTc23(void) +{ + /** + * 5.10.19 MATN-TC-23: Automatic re-registration by Thread Device + * + * 5.10.19.1 Topology + * - BR_1 + * - BR_2 + * - TD (DUT) + * + * 5.10.19.2 Purpose & Description + * The purpose of this test case is to verify that a Thread Device DUT can re-register its multicast address + * before the MLR timeout expires. See also MATN-TC-05 which tests the BBR function in a similar situation. + * + * Spec Reference | V1.2 Section | V1.3.0 Section + * -----------------|--------------|--------------- + * Multicast | 5.10.19 | 5.10.19 + */ + + Core nexus; + Node &br1 = nexus.CreateNode(); + Node &br2 = nexus.CreateNode(); + Node &td = nexus.CreateNode(); + Ip6::Address ma1; + + br1.SetName("BR_1"); + br2.SetName("BR_2"); + td.SetName("TD"); + + SuccessOrQuit(ma1.FromString(kMulticastAddr1)); + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + /** + * Step 0 + * - Device: N/A + * - Description: Topology formation - BR_1, BR_2, TD (DUT) + * - Pass Criteria: + * - N/A + */ + Log("Step 0: Topology formation - BR_1, BR_2, TD (DUT)"); + + br1.AllowList(br2); + br1.AllowList(td); + br2.AllowList(br1); + br2.AllowList(td); + td.AllowList(br1); + td.AllowList(br2); + + br1.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(br1.Get().IsLeader()); + + br1.Get().Init(1, true); + br1.Get().Init(); + SuccessOrQuit(br1.Get().SetEnabled(true)); + br1.Get().SetEnabled(true); + + br2.Join(br1, Node::kAsFtd); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(br2.Get().IsRouter()); + + br2.Get().Init(1, true); + br2.Get().Init(); + SuccessOrQuit(br2.Get().SetEnabled(true)); + br2.Get().SetEnabled(true); + + td.Join(br1, Node::kAsFtd); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(td.Get().IsRouter()); + + nexus.AdvanceTime(kStabilizationTime); + + VerifyOrQuit(br1.Get().IsPrimary()); + VerifyOrQuit(br2.Get().GetState() == BackboneRouter::Local::kStateSecondary); + + nexus.AddTestVar("MA1", kMulticastAddr1); + { + String<16> timeoutStr; + + timeoutStr.Append("%u", kMlrTimeout); + nexus.AddTestVar("MLR_TIMEOUT", timeoutStr.AsCString()); + } + + /** + * Step 1 + * - Device: BR_1 + * - Description: Harness instructs the device to configure the value of the MLR timeout in the BBR Dataset of + * BR_1 to be (MLR_TIMEOUT_MIN + 30) seconds and distribute the BBR Dataset in network data. Wait until TD + * has received the new network data. + * - Pass Criteria: + * - N/A + */ + Log("Step 1: BR_1 configures MLR timeout and distributes BBR Dataset."); + { + BackboneRouter::Config bbrConfig; + br1.Get().GetConfig(bbrConfig); + bbrConfig.mMlrTimeout = kMlrTimeout; + SuccessOrQuit(br1.Get().SetConfig(bbrConfig)); + SuccessOrQuit(br1.Get().AddService(BackboneRouter::Local::kForceRegistration)); + } + nexus.AdvanceTime(kStabilizationTime); + + /** + * Step 2 + * - Device: TD (DUT) + * - Description: The DUT must be configured to register the multicast address, MA1. This causes the DUT to + * automatically send out MLR.req. + * - Pass Criteria: + * - The DUT MUST unicast an MLR.req CoAP request to BR_1: coap://[]:MM/n/mr + * - Where the payload contains one TLV only with at least one address MA1 inside (there may be more + * addresses): IPv6 Addresses TLV: the MA1 + */ + Log("Step 2: TD (DUT) registers multicast address, MA1."); + SuccessOrQuit(td.Get().SubscribeExternalMulticast(ma1)); + nexus.AdvanceTime(kStabilizationTime); + + /** + * Step 3 + * - Device: BR_1 + * - Description: Automatically responds with MLR.rsp with status ST_MLR_SUCCESS. + * - Pass Criteria: + * - N/A + */ + Log("Step 3: BR_1 responds with MLR.rsp."); + // Handled automatically. + + /** + * Step 4 + * - Device: TD (DUT) + * - Description: Within (MLR_TIMEOUT_MIN + 30) seconds of step 3, the DUT automatically re-registers for + * multicast address, MA1. + * - Pass Criteria: + * - The DUT MUST unicast an MLR.req CoAP request to BR_1: coap://[]:MM/n/mr + * - Where the payload contains one TLV only with at least one address MA inside: IPv6 Addresses TLV: the + * multicast address MA1 + * - The MLR.req CoAP request MUST be sent within (MLR_TIMEOUT_MIN + 30) seconds of step 3 + */ + Log("Step 4: TD (DUT) automatically re-registers for MA1."); + nexus.AdvanceTime(kMlrTimeout * 1000); + + /** + * Step 5 + * - Device: BR_1 + * - Description: Automatically responds with MLR.rsp and status ST_MLR_SUCCESS. + * - Pass Criteria: + * - N/A + */ + Log("Step 5: BR_1 responds with MLR.rsp."); + // Handled automatically. + + nexus.SaveTestInfo("test_1_2_MATN_TC_23.json", &br1); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::TestMatnTc23(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_1_2_MATN_TC_23.py b/tests/nexus/verify_1_2_MATN_TC_23.py new file mode 100644 index 000000000..bdfdfe518 --- /dev/null +++ b/tests/nexus/verify_1_2_MATN_TC_23.py @@ -0,0 +1,147 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2026, The OpenThread Authors. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# 1. Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# 2. Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# 3. Neither the name of the copyright holder nor the +# names of its contributors may be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. +# + +import sys +import os + +# Add the current directory to sys.path to find verify_utils +CUR_DIR = os.path.dirname(os.path.abspath(__file__)) +sys.path.append(CUR_DIR) + +import verify_utils +from pktverify.addrs import Ipv6Addr +from pktverify.bytes import Bytes + +# Status SUCCESS +ST_MLR_SUCCESS = 0 + + +def verify(pv): + # 5.10.19 MATN-TC-23: Automatic re-registration by Thread Device + # + # 5.10.19.1 Topology + # - BR_1 + # - BR_2 + # - TD (DUT) + # + # 5.10.19.2 Purpose & Description + # The purpose of this test case is to verify that a Thread Device DUT can re-register its multicast address + # before the MLR timeout expires. See also MATN-TC-05 which tests the BBR function in a similar situation. + # + # Spec Reference | V1.2 Section | V1.3.0 Section + # -----------------|--------------|--------------- + # Multicast | 5.10.19 | 5.10.19 + + pkts = pv.pkts + pv.summary.show() + + BR_1_RLOC = pv.vars['BR_1_RLOC'] + MA1 = pv.vars['MA1'] + + # Step 0 + # - Device: N/A + # - Description: Topology formation - BR_1, BR_2, TD (DUT) + # - Pass Criteria: + # - N/A + print("Step 0: Topology formation - BR_1, BR_2, TD (DUT)") + + # Step 1 + # - Device: BR_1 + # - Description: Harness instructs the device to configure the value of the MLR timeout in the BBR Dataset of + # BR_1 to be (MLR_TIMEOUT_MIN + 30) seconds and distribute the BBR Dataset in network data. Wait until TD + # has received the new network data. + # - Pass Criteria: + # - N/A + print("Step 1: BR_1 configures MLR timeout and distributes BBR Dataset.") + + # Step 2 + # - Device: TD (DUT) + # - Description: The DUT must be configured to register the multicast address, MA1. This causes the DUT to + # automatically send out MLR.req. + # - Pass Criteria: + # - The DUT MUST unicast an MLR.req CoAP request to BR_1: coap://[]:MM/n/mr + # - Where the payload contains one TLV only with at least one address MA1 inside (there may be more + # addresses): IPv6 Addresses TLV: the MA1 + print("Step 2: TD (DUT) registers multicast address, MA1.") + # MLDv2 and BLMR.ntf checks are intentionally skipped. + req2 = pkts.filter_coap_request('/n/mr').\ + filter(lambda p: p.ipv6.dst == Ipv6Addr(BR_1_RLOC) or \ + p.ipv6.dst == pv.vars['LEADER_ALOC']).\ + filter(lambda p: MA1 in p.coap.tlv.ipv6_address).\ + must_next() + assert len(req2.coap.tlv.type) == 1, f"Expected 1 TLV, but got {len(req2.coap.tlv.type)}" + + # Step 3 + # - Device: BR_1 + # - Description: Automatically responds with MLR.rsp with status ST_MLR_SUCCESS. + # - Pass Criteria: + # - N/A + print("Step 3: BR_1 responds with MLR.rsp.") + rsp3 = pkts.filter_coap_ack('/n/mr').\ + filter(lambda p: p.coap.tlv.status == ST_MLR_SUCCESS).\ + must_next() + + # Step 4 + # - Device: TD (DUT) + # - Description: Within (MLR_TIMEOUT_MIN + 30) seconds of step 3, the DUT automatically re-registers for + # multicast address, MA1. + # - Pass Criteria: + # - The DUT MUST unicast an MLR.req CoAP request to BR_1: coap://[]:MM/n/mr + # - Where the payload contains one TLV only with at least one address MA inside: IPv6 Addresses TLV: the + # multicast address MA1 + # - The MLR.req CoAP request MUST be sent within (MLR_TIMEOUT_MIN + 30) seconds of step 3 + print("Step 4: TD (DUT) automatically re-registers for MA1.") + # MLDv2 and BLMR.ntf checks are intentionally skipped. + req4 = pkts.filter_coap_request('/n/mr').\ + filter(lambda p: p.ipv6.dst == Ipv6Addr(BR_1_RLOC) or \ + p.ipv6.dst == pv.vars['LEADER_ALOC']).\ + filter(lambda p: MA1 in p.coap.tlv.ipv6_address).\ + must_next() + assert len(req4.coap.tlv.type) == 1, f"Expected 1 TLV, but got {len(req4.coap.tlv.type)}" + + # The MLR.req CoAP request MUST be sent within (MLR_TIMEOUT_MIN + 30) seconds of step 3 + # Thread specification recommends sending the re-registration at 7/8 of the timeout. + # We check that the request is sent in the latter half of the timeout window. + MLR_TIMEOUT = float(pv.vars['MLR_TIMEOUT']) + diff = req4.sniff_timestamp - rsp3.sniff_timestamp + assert MLR_TIMEOUT / 4 < diff <= MLR_TIMEOUT, f"MLR re-registration time {diff}s is out of expected range ({MLR_TIMEOUT / 4}s, {MLR_TIMEOUT}s]" + + # Step 5 + # - Device: BR_1 + # - Description: Automatically responds with MLR.rsp and status ST_MLR_SUCCESS. + # - Pass Criteria: + # - N/A + print("Step 5: BR_1 responds with MLR.rsp.") + pkts.filter_coap_ack('/n/mr').\ + filter(lambda p: p.coap.tlv.status == ST_MLR_SUCCESS).\ + must_next() + + +if __name__ == '__main__': + verify_utils.run_main(verify)