From 8d793aeb12936c8f359b540756ef0f1c8d0539cb Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Sun, 15 Feb 2026 22:00:15 -0600 Subject: [PATCH] [nexus] add test 5.5.5 Split and Merge with REED (#12448) This commit adds a new Nexus test case for 'Split and Merge with REED' (5.5.5) as specified in the Thread Test Specification. The test demonstrates that a REED will upgrade to a Router when it becomes a necessary parent for an isolated Router after its previous neighbor (Router 3) is removed from the network. Summary of changes: - tests/nexus/test_5_5_5.cpp: C++ test execution script. - Sets up a topology with 16 active routers total. - Uses AllowList to specify exact links between nodes. - Powerdowns Router 3 to isolate Router 1. - Verifies REED 1 (DUT) upgrades to router and Router 1 reattaches. - Includes 1-line log outputs for each test step. - Uses mesh-local EID for ICMP Echo connectivity verification. - tests/nexus/verify_5_5_5.py: Python PCAP verification script. - Verifies all MLE messages and CoAP Address Solicit Request. - Ensures proper TLVs are present in MLE and CoAP messages. - Tracks ICMPv6 Echo Request/Reply hop-by-hop through the DUT. - Follows "one condition per line" style for better readability. - tests/nexus/CMakeLists.txt: Added the new test to the build system. - tests/nexus/run_nexus_tests.sh: Added 5_5_5 to the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_5_5.cpp | 278 +++++++++++++++++++++++++++++++++ tests/nexus/verify_5_5_5.py | 214 +++++++++++++++++++++++++ 4 files changed, 494 insertions(+) create mode 100644 tests/nexus/test_5_5_5.cpp create mode 100644 tests/nexus/verify_5_5_5.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index c734c32c8..7c7ce3bf7 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -153,6 +153,7 @@ ot_nexus_test(5_5_2 "cert;nexus") ot_nexus_test(5_5_3 "cert;nexus") ot_nexus_test(5_5_4_1 "cert;nexus") ot_nexus_test(5_5_4_2 "cert;nexus") +ot_nexus_test(5_5_5 "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 a4dbafa60..ffd77fd47 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -83,6 +83,7 @@ DEFAULT_TESTS=( "5_5_3" "5_5_4_1" "5_5_4_2" + "5_5_5" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_5_5.cpp b/tests/nexus/test_5_5_5.cpp new file mode 100644 index 000000000..5b598d641 --- /dev/null +++ b/tests/nexus/test_5_5_5.cpp @@ -0,0 +1,278 @@ +/* + * 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 = 13 * 1000; + +/** + * Time to advance for a node to join as a child and upgrade to a router, in milliseconds. + */ +static constexpr uint32_t kAttachToRouterTime = 200 * 1000; + +/** + * Time to advance for an isolated router to detect isolation and re-attach, in milliseconds. + */ +static constexpr uint32_t kReattachTime = 120 * 1000; + +/** + * Time to advance for a node to join as a child. + */ +static constexpr uint32_t kAttachAsChildTime = 10 * 1000; + +/** + * Time to advance for the network to stabilize after routers have attached. + */ +static constexpr uint32_t kStabilizationTime = 60 * 1000; + +/** + * Timeout for ICMP Echo response, in milliseconds. + */ +static constexpr uint32_t kPingTimeout = 5000; + +void Test5_5_5(void) +{ + /** + * 5.5.5 Split and Merge with REED + * + * 5.5.5.1 Topology + * - Test topology has a total of 16 active routers, including the Leader. Router_1 is restricted only to + * communicate with Router_3 and the DUT. + * + * 5.5.5.2 Purpose & Description + * The purpose of this test case is to show that the DUT will upgrade to a Router when Router_3 is eliminated. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * ---------------------------|--------------|--------------- + * Thread Network Partitions | 5.16 | 5.16 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node *r[16]; + + for (uint16_t i = 1; i <= 15; i++) + { + r[i] = &nexus.CreateNode(); + r[i]->SetName("ROUTER", i); + } + + Node &dut = nexus.CreateNode(); + + leader.SetName("LEADER"); + dut.SetName("REED", 1); + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: All"); + + /** + * Step 1: All + * - Description: Ensure topology is formed correctly without the DUT. + * - Pass Criteria: N/A + */ + + /** Configure AllowList for specific links. */ + for (uint16_t i = 2; i <= 15; i++) + { + leader.AllowList(*r[i]); + r[i]->AllowList(leader); + } + + r[1]->AllowList(*r[3]); + r[3]->AllowList(*r[1]); + + /** DUT links. */ + dut.AllowList(*r[2]); + r[2]->AllowList(dut); + + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + for (uint16_t i = 2; i <= 15; i++) + { + r[i]->Join(leader); + } + nexus.AdvanceTime(kAttachToRouterTime); + + r[1]->Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + + VerifyOrQuit(r[1]->Get().IsRouter()); + VerifyOrQuit(r[2]->Get().IsRouter()); + VerifyOrQuit(r[3]->Get().IsRouter()); + + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: REED_1 (DUT)"); + + /** + * Step 2: REED_1 (DUT) + * - Description: The DUT is added to the topology. Harness filters are set to limit the DUT to attach to Router_2. + * - Pass Criteria: The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request. + */ + SuccessOrQuit(dut.Get().SetRouterEligible(false)); + dut.Join(leader); + nexus.AdvanceTime(kAttachAsChildTime); + + VerifyOrQuit(dut.Get().IsChild()); + VerifyOrQuit(dut.Get().GetParent().GetExtAddress() == r[2]->Get().GetExtAddress()); + + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: Router_3"); + + /** + * Step 3: Router_3 + * - Description: Harness instructs the device to powerdown – removing it from the network. + * - Pass Criteria: N/A + */ + r[3]->Reset(); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: Router_1"); + + /** + * Step 4: Router_1 + * - Description: Automatically attempt to re-attach to the partition by sending multicast Parent Requests to the + * Routers and REEDs address. + * - Pass Criteria: N/A + */ + SuccessOrQuit(dut.Get().SetRouterEligible(true)); + dut.AllowList(*r[1]); + r[1]->AllowList(dut); + nexus.AdvanceTime(kReattachTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 5: REED_1 (DUT)"); + + /** + * Step 5: REED_1 (DUT) + * - Description: Automatically sends MLE Parent Response to Router_1. + * - Pass Criteria: + * - The DUT MUST send MLE Parent response to Router_1. + * - The MLE Parent Response to Router_1 MUST be properly formatted. + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 6: Router_1"); + + /** + * Step 6: Router_1 + * - Description: Automatically sends MLE Child ID Request to the DUT. + * - Pass Criteria: N/A + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 7: REED_1 (DUT)"); + + /** + * Step 7: REED_1 (DUT) + * - Description: Automatically sends an Address Solicit Request to Leader, receives a short address and becomes a + * router. + * - Pass Criteria: + * - The Address Solicit Request MUST be properly formatted: + * - CoAP Request URI: coap://[]:MM/a/as + * - CoAP Payload: + * - MAC Extended Address TLV + * - Status TLV + * - RLOC16 TLV (optional) + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 8: REED_1 (DUT)"); + + /** + * Step 8: REED_1 (DUT) + * - Description: Automatically (optionally) sends multicast Link Request. + * - Pass Criteria: + * - The DUT MAY send a multicast Link Request Message. + * - If sent, the following TLVs MUST be present in the Multicast Link Request Message: + * - Challenge TLV + * - Leader Data TLV + * - TLV Request TLV: Link Margin + * - Source Address TLV + * - Version TLV + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 9: REED_1 (DUT)"); + + /** + * Step 9: REED_1 (DUT) + * - Description: Automatically sends Child ID Response to Router_1. + * - Pass Criteria: + * - The DUT MUST send MLE Child ID Response to Router_1. + * - The Child ID Response MUST be properly formatted. + */ + nexus.AdvanceTime(kStabilizationTime); + + VerifyOrQuit(dut.Get().IsRouter()); + VerifyOrQuit(r[1]->Get().IsChild()); + VerifyOrQuit(r[1]->Get().GetParent().GetExtAddress() == dut.Get().GetExtAddress()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 10: Router_1"); + + /** + * Step 10: Router_1 + * - Description: Harness instructs the device to send an ICMPv6 Echo Request to the Leader. + * - Pass Criteria: + * - The DUT MUST route the ICMPv6 Echo request to the Leader. + * - The DUT MUST route the ICMPv6 Echo reply back to Router_1. + */ + nexus.SendAndVerifyEchoRequest(*r[1], leader.Get().GetMeshLocalEid(), 0, 64, kPingTimeout); + + nexus.SaveTestInfo("test_5_5_5.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_5_5(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_5_5.py b/tests/nexus/verify_5_5_5.py new file mode 100644 index 000000000..5cc18190f --- /dev/null +++ b/tests/nexus/verify_5_5_5.py @@ -0,0 +1,214 @@ +#!/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 import consts + + +def verify(pv): + # 5.5.5 Split and Merge with REED + # + # 5.5.5.1 Topology + # - Test topology has a total of 16 active routers, including the Leader. Router_1 is restricted only to + # communicate with Router_3 and the DUT. + # + # 5.5.5.2 Purpose & Description + # The purpose of this test case is to show that the DUT will upgrade to a Router when Router_3 is eliminated. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # ---------------------------|--------------|--------------- + # Thread Network Partitions | 5.16 | 5.16 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + ROUTER_1 = pv.vars['ROUTER_1'] + ROUTER_2 = pv.vars['ROUTER_2'] + REED_1 = pv.vars['REED_1'] + + # Step 1: All + # - Description: Ensure topology is formed correctly without the DUT. + # - Pass Criteria: N/A + print("Step 1: All") + + # Step 2: REED_1 (DUT) + # - Description: The DUT is added to the topology. Harness filters are set to limit the DUT to attach to Router_2. + # - Pass Criteria: The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request. + print("Step 2: REED_1 (DUT)") + pkts.filter_wpan_src64(REED_1).\ + filter_wpan_dst64(ROUTER_2).\ + filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\ + must_next() + step2_end = pkts.index + + # Step 3: Router_3 + # - Description: Harness instructs the device to powerdown – removing it from the network. + # - Pass Criteria: N/A + print("Step 3: Router_3") + + # Step 4: Router_1 + # - Description: Automatically attempt to re-attach to the partition by sending multicast Parent Requests to the + # Routers and REEDs address. + # - Pass Criteria: N/A + print("Step 4: Router_1") + step4_start = pkts.index + pkts.filter_wpan_src64(ROUTER_1).\ + filter_LLARMA().\ + filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + must_next() + + # Step 2 (verify): The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request. + pkts.range(step2_end, step4_start).\ + filter_wpan_src64(REED_1).\ + filter_coap_request(consts.ADDR_SOL_URI).\ + must_not_next() + + # Step 5: REED_1 (DUT) + # - Description: Automatically sends MLE Parent Response to Router_1. + # - Pass Criteria: + # - The DUT MUST send MLE Parent response to Router_1. + # - The MLE Parent Response to Router_1 MUST be properly formatted. + print("Step 5: REED_1 (DUT)") + pkts.filter_wpan_src64(REED_1).\ + filter_wpan_dst64(ROUTER_1).\ + filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.CONNECTIVITY_TLV, + consts.LEADER_DATA_TLV, + consts.LINK_LAYER_FRAME_COUNTER_TLV, + consts.LINK_MARGIN_TLV, + consts.RESPONSE_TLV, + consts.SOURCE_ADDRESS_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type)).\ + must_next() + + # Step 6: Router_1 + # - Description: Automatically sends MLE Child ID Request to the DUT. + # - Pass Criteria: N/A + print("Step 6: Router_1") + pkts.filter_wpan_src64(ROUTER_1).\ + filter_wpan_dst64(REED_1).\ + filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\ + must_next() + + # Step 7: REED_1 (DUT) + # - Description: Automatically sends an Address Solicit Request to Leader, receives a short address and becomes a + # router. + # - Pass Criteria: + # - The Address Solicit Request MUST be properly formatted: + # - CoAP Request URI: coap://[]:MM/a/as + # - CoAP Payload: + # - MAC Extended Address TLV + # - Status TLV + # - RLOC16 TLV (optional) + print("Step 7: REED_1 (DUT)") + pkts.filter_wpan_src64(REED_1).\ + filter_coap_request(consts.ADDR_SOL_URI).\ + filter(lambda p: { + consts.NL_MAC_EXTENDED_ADDRESS_TLV, + consts.NL_STATUS_TLV + } <= set(p.coap.tlv.type)).\ + must_next() + + # Step 8: REED_1 (DUT) + # - Description: Automatically (optionally) sends multicast Link Request. + # - Pass Criteria: + # - The DUT MAY send a multicast Link Request Message. + # - If sent, the following TLVs MUST be present in the Multicast Link Request Message: + # - Challenge TLV + # - Leader Data TLV + # - TLV Request TLV: Link Margin + # - Source Address TLV + # - Version TLV + print("Step 8: REED_1 (DUT)") + link_req = pkts.filter_wpan_src64(REED_1).\ + filter_LLANMA().\ + filter_mle_cmd(consts.MLE_LINK_REQUEST).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.LEADER_DATA_TLV, + consts.TLV_REQUEST_TLV, + consts.SOURCE_ADDRESS_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type)).\ + next() + + # Step 9: REED_1 (DUT) + # - Description: Automatically sends Child ID Response to Router_1. + # - Pass Criteria: + # - The DUT MUST send MLE Child ID Response to Router_1. + # - The Child ID Response MUST be properly formatted. + print("Step 9: REED_1 (DUT)") + pkts.filter_wpan_src64(REED_1).\ + filter_wpan_dst64(ROUTER_1).\ + filter_mle_cmd(consts.MLE_CHILD_ID_RESPONSE).\ + filter(lambda p: { + consts.ADDRESS16_TLV, + consts.LEADER_DATA_TLV, + consts.NETWORK_DATA_TLV, + consts.SOURCE_ADDRESS_TLV + } <= set(p.mle.tlv.type)).\ + must_next() + + # Step 10: Router_1 + # - Description: Harness instructs the device to send an ICMPv6 Echo Request to the Leader. + # - Pass Criteria: + # - The DUT MUST route the ICMPv6 Echo request to the Leader. + # - The DUT MUST route the ICMPv6 Echo reply back to Router_1. + ROUTER_1_RLOC16 = pv.vars['ROUTER_1_RLOC16'] + ROUTER_2_RLOC16 = pv.vars['ROUTER_2_RLOC16'] + REED_1_RLOC16 = pv.vars['REED_1_RLOC16'] + + print("Step 10: Router_1") + _pkt = pkts.filter_ping_request().\ + filter_wpan_src64(ROUTER_1).\ + filter_wpan_dst16(REED_1_RLOC16).\ + must_next() + pkts.filter_ping_request().\ + filter_wpan_src64(REED_1).\ + filter_wpan_dst16(ROUTER_2_RLOC16).\ + must_next() + pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\ + filter_wpan_src64(REED_1).\ + filter_wpan_dst16(ROUTER_1_RLOC16).\ + must_next() + + +if __name__ == '__main__': + verify_utils.run_main(verify)