From dd19659ab30d939982de5683a1acb0a16bb173f6 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Wed, 11 Feb 2026 00:15:04 -0600 Subject: [PATCH] [nexus] add test 5.2.7 REED Synchronization (#12400) Adds a new Nexus test case for 'REED Synchronization' (5.2.7) as specified in the test specification. The test validates the REED's Synchronization procedure after attaching to a network with multiple Routers. A REED must process incoming Advertisements and perform a one-way frame-counter synchronization with at least 3 neighboring Routers. Summary of changes: - Implemented Nexus test 5.2.7: - Added test_5_2_7.cpp: Sets up a topology with 16 active routers (Leader + 15 Routers) and adds a REED last. Verifies the REED joins and remains a child. - Added verify_5_2_7.py: PCAP verification script for test 5.2.7, ensuring the REED sends Link Requests and receives Link Accepts from at least three distinct neighbors with mandatory TLVs. - Updated build and execution scripts: - Modified CMakeLists.txt to build the new 5.2.7 test executable. - Updated run_nexus_tests.sh to include 5.2.7 in the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_2_7.cpp | 224 +++++++++++++++++++++++++++++++++ tests/nexus/verify_5_2_7.py | 148 ++++++++++++++++++++++ 4 files changed, 374 insertions(+) create mode 100644 tests/nexus/test_5_2_7.cpp create mode 100644 tests/nexus/verify_5_2_7.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 64fb607f2..68288e1e5 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -134,6 +134,7 @@ ot_nexus_test(5_2_3 "cert;nexus") ot_nexus_test(5_2_4 "cert;nexus") ot_nexus_test(5_2_5 "cert;nexus") ot_nexus_test(5_2_6 "cert;nexus") +ot_nexus_test(5_2_7 "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 7fb9d36ee..106dd24ac 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -66,6 +66,7 @@ DEFAULT_TESTS=( "5_2_4" "5_2_5" "5_2_6" + "5_2_7" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_2_7.cpp b/tests/nexus/test_5_2_7.cpp new file mode 100644 index 000000000..75ef300bd --- /dev/null +++ b/tests/nexus/test_5_2_7.cpp @@ -0,0 +1,224 @@ +/* + * 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 + +#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. + */ +static constexpr uint32_t kFormNetworkTime = 13 * 1000; + +/** + * Time to advance for a node to join as a child and upgrade to a router. + * This duration accounts for MLE attach process and ROUTER_SELECTION_JITTER. + */ +static constexpr uint32_t kAttachToRouterTime = 200 * 1000; + +/** + * Time to advance for a node to join as a child. + */ +static constexpr uint32_t kAttachToChildTime = 10 * 1000; + +/** + * Time interval for advancing time in a loop. + */ +static constexpr uint32_t kOneSecond = 1000; + +/** + * Delay between node joins to ensure stability. + */ +static constexpr uint32_t kJoinDelay = 10 * 1000; + +/** + * Number of active routers in the topology. + */ +static constexpr uint16_t kNumRouters = 16; + +void Test5_2_7(void) +{ + /** + * 5.2.7 REED Synchronization + * + * 5.2.7.1 Topology + * - Topology A + * - Topology B + * - Build a topology that has a total of 16 active routers, including the Leader, with no communication + * constraints. + * + * 5.2.7.2 Purpose & Description + * The purpose of this test case is to validate the REED’s Synchronization procedure after attaching to a network + * with multiple Routers. A REED MUST process incoming Advertisements and perform a one-way frame-counter + * synchronization with at least 3 neighboring Routers. When Router receives unicast MLE Link Request from REED, + * it replies with MLE Link Accept. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * -----------------------------------|--------------|--------------- + * REED and FED Synchronization | 4.7.7.4 | 4.7.1.4 + */ + + Core nexus; + Node *routers[kNumRouters]; + + for (uint16_t i = 0; i < kNumRouters; i++) + { + routers[i] = &nexus.CreateNode(); + if (i == 0) + { + routers[i]->SetName("LEADER"); + } + else + { + routers[i]->SetName("ROUTER", i); + } + } + + Node &reed1 = nexus.CreateNode(); + reed1.SetName("REED_1"); + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: All"); + + /** + * Step 1: All + * - Description: Topology formation + * - The REED device is added last + * - If DUT=REED + * - the DUT may attach to any router + * - If DUT=Router + * - the REED is not allowed to attach to the DUT + * - the REED is limited to 2 neighbors, including the DUT + * - Pass Criteria: N/A + */ + routers[0]->Form(); + nexus.AdvanceTime(kFormNetworkTime); + + for (uint16_t i = 1; i < kNumRouters; i++) + { + routers[i]->Join(*routers[0]); + nexus.AdvanceTime(kJoinDelay); + } + + for (uint32_t time = 0; time < kAttachToRouterTime; time += kOneSecond) + { + nexus.AdvanceTime(kOneSecond); + bool allRouters = true; + for (uint16_t i = 0; i < kNumRouters; i++) + { + if (!routers[i]->Get().IsRouterOrLeader()) + { + allRouters = false; + break; + } + } + if (allRouters) + { + break; + } + } + + for (uint16_t i = 0; i < kNumRouters; i++) + { + if (!routers[i]->Get().IsRouterOrLeader()) + { + Log("Node %u (name %s) is NOT a router, role %s", i, routers[i]->GetName(), + Mle::RoleToString(routers[i]->Get().GetRole())); + } + VerifyOrQuit(routers[i]->Get().IsRouterOrLeader()); + } + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: REED_1"); + + /** + * Step 2: REED_1 + * - Description: Automatically joins the topology + * - Pass Criteria: + * - For DUT = REED: The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request + */ + reed1.Join(*routers[0]); + nexus.AdvanceTime(kAttachToChildTime); + VerifyOrQuit(reed1.Get().IsChild()); + VerifyOrQuit(!reed1.Get().IsRouterOrLeader()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: REED_1"); + + /** + * Step 3: REED_1 + * - Description: Automatically sends Link Request to neighboring Routers + * - Pass Criteria: + * - For DUT = REED: The DUT MUST send a unicast Link Request to at least three neighbors + * - The following TLVs MUST be present in the Link Request: + * - Challenge TLV + * - Leader Data TLV + * - Source Address TLV + * - Version TLV + */ + nexus.AdvanceTime(kAttachToChildTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: Router_1"); + + /** + * Step 4: Router_1 + * - Description: Automatically sends Link Accept to REED_1 + * - Pass Criteria: + * - For DUT = Router: The DUT MUST send Link Accept to the REED; the DUT MUST NOT send a Link Accept And Request + * message. + * - The following TLVs MUST be present in the Link Accept message: + * - Link-layer Frame Counter TLV + * - Source Address TLV + * - Response TLV + * - Version TLV + * - MLE Frame Counter TLV (optional) + */ + nexus.AdvanceTime(kAttachToChildTime); + + nexus.SaveTestInfo("test_5_2_7.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_2_7(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_2_7.py b/tests/nexus/verify_5_2_7.py new file mode 100644 index 000000000..665a34899 --- /dev/null +++ b/tests/nexus/verify_5_2_7.py @@ -0,0 +1,148 @@ +#!/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 + +import verify_utils +from pktverify import consts + + +def verify(pv): + # 5.2.7 REED Synchronization + # + # 5.2.7.1 Topology + # - Topology A + # - Topology B + # - Build a topology that has a total of 16 active routers, including the Leader, with no communication + # constraints. + # + # 5.2.7.2 Purpose & Description + # The purpose of this test case is to validate the REED’s Synchronization procedure after attaching to a network + # with multiple Routers. A REED MUST process incoming Advertisements and perform a one-way frame-counter + # synchronization with at least 3 neighboring Routers. When Router receives unicast MLE Link Request from REED, + # it replies with MLE Link Accept. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # -----------------------------------|--------------|--------------- + # REED and FED Synchronization | 4.7.7.4 | 4.7.1.4 + + pkts = pv.pkts + pv.summary.show() + + REED_1 = pv.vars['REED_1'] + K_MIN_NEIGHBORS = 3 + + def verify_unique_neighbor_count(pkt_stream, addr_attr, min_count, error_msg_prefix): + neighbors = set() + while True: + pkt = pkt_stream.next() + if pkt is None: + break + + neighbors.add(getattr(pkt.wpan, addr_attr)) + if len(neighbors) >= min_count: + break + + if len(neighbors) < min_count: + raise Exception("%s only %d neighbors, expected at least %d" % + (error_msg_prefix, len(neighbors), min_count)) + + # Step 1: All + # - Description: Topology formation + # - The REED device is added last + # - If DUT=REED + # - the DUT may attach to any router + # - If DUT=Router + # - the REED is not allowed to attach to the DUT + # - the REED is limited to 2 neighbors, including the DUT + # - Pass Criteria: N/A + print("Step 1: All") + + # Step 2: REED_1 + # - Description: Automatically joins the topology + # - Pass Criteria: + # - For DUT = REED: The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request + print("Step 2: REED_1") + pkts.filter_wpan_src64(REED_1).\ + filter_coap_request(consts.ADDR_SOL_URI).\ + must_not_next() + + # Step 3: REED_1 + # - Description: Automatically sends Link Request to neighboring Routers + # - Pass Criteria: + # - For DUT = REED: The DUT MUST send a unicast Link Request to at least three neighbors + # - The following TLVs MUST be present in the Link Request: + # - Challenge TLV + # - Leader Data TLV + # - Source Address TLV + # - Version TLV + print("Step 3: REED_1") + link_requests = pkts.filter_wpan_src64(REED_1).\ + filter_mle_cmd(consts.MLE_LINK_REQUEST).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.LEADER_DATA_TLV, + consts.SOURCE_ADDRESS_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type)) + + verify_unique_neighbor_count(link_requests, 'dst64', K_MIN_NEIGHBORS, "REED_1 sent Link Requests to") + + # Step 4: Router_1 + # - Description: Automatically sends Link Accept to REED_1 + # - Pass Criteria: + # - For DUT = Router: The DUT MUST send Link Accept to the REED; the DUT MUST NOT send a Link Accept And Request + # message. + # - The following TLVs MUST be present in the Link Accept message: + # - Link-layer Frame Counter TLV + # - Source Address TLV + # - Response TLV + # - Version TLV + # - MLE Frame Counter TLV (optional) + print("Step 4: Router_1") + link_accepts = pkts.filter_wpan_dst64(REED_1).\ + filter_mle_cmd(consts.MLE_LINK_ACCEPT).\ + filter(lambda p: { + consts.LINK_LAYER_FRAME_COUNTER_TLV, + consts.SOURCE_ADDRESS_TLV, + consts.RESPONSE_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type)) + + verify_unique_neighbor_count(link_accepts, 'src64', K_MIN_NEIGHBORS, "REED_1 received Link Accepts from") + + # Verify that no router sends a Link Accept and Request + pkts.filter_wpan_dst64(REED_1).\ + filter_mle_cmd(consts.MLE_LINK_ACCEPT_AND_REQUEST).\ + must_not_next() + + +if __name__ == '__main__': + verify_utils.run_main(verify)