From 47e9bf7319b9c0ccde45a18b2e9c6414306ff874 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Sat, 7 Feb 2026 17:38:25 -0800 Subject: [PATCH] [nexus] add test 5.1.13 Router Synchronization after Reset (#12385) Adds a new Nexus test case for 'Router Synchronization after Reset' (5.1.13) as specified in the test specification. Summary of changes: - Implemented Nexus test 5.1.13: - test_5_1_13.cpp: Sets up a Leader and Router_1 topology, simulates a router reset, and verifies successful re-synchronization. - verify_5_1_13.py: PCAP verification script for test 5.1.13, ensuring correct MLE advertisements, Link Request/Accept exchange, and proper response timing and TLV validation. - Updated build and execution scripts: - Modified CMakeLists.txt to build the new 5.1.13 test executable. - Updated run_nexus_tests.sh to include 5.1.13 in the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_1_13.cpp | 186 +++++++++++++++++++++++++++++++++ tests/nexus/verify_5_1_13.py | 181 ++++++++++++++++++++++++++++++++ 4 files changed, 369 insertions(+) create mode 100644 tests/nexus/test_5_1_13.cpp create mode 100644 tests/nexus/verify_5_1_13.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 8d14b4063..eadf0b6f0 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -125,6 +125,7 @@ ot_nexus_test(5_1_9) ot_nexus_test(5_1_10) ot_nexus_test(5_1_11) ot_nexus_test(5_1_12) +ot_nexus_test(5_1_13) ot_nexus_test(border_agent) ot_nexus_test(border_agent_tracker) ot_nexus_test(discover_scan) diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index 6d91daec7..b1f9db7a3 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -60,6 +60,7 @@ DEFAULT_TESTS=( "5_1_10" "5_1_11" "5_1_12" + "5_1_13" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_1_13.cpp b/tests/nexus/test_5_1_13.cpp new file mode 100644 index 000000000..f833c50ba --- /dev/null +++ b/tests/nexus/test_5_1_13.cpp @@ -0,0 +1,186 @@ +/* + * 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. + */ +static constexpr uint32_t kFormNetworkTime = 13 * 1000; + +/** + * Time to advance for a node to join as a child and upgrade to a router. + */ +static constexpr uint32_t kAttachToRouterTime = 200 * 1000; + +/** + * Time for nodes to send MLE Advertisements. + */ +static constexpr uint32_t kAdvTime = 32 * 1000; + +/** + * Time to wait for router synchronization. + */ +static constexpr uint32_t kResetSyncTime = 10 * 1000; + +void Test5_1_13(void) +{ + /** + * 5.1.13 Router Synchronization after Reset + * + * 5.1.13.1 Topology + * - Topology A + * - Topology B + * + * 5.1.13.2 Purpose & Description + * The purpose of this test case is to validate that when a router resets, it will synchronize upon returning by + * using the Router Synchronization after Reset procedure. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * -----------------------------------|--------------|--------------- + * Router Synchronization after Reset | 4.7.7.3 | 4.7.1.3 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node &router = nexus.CreateNode(); + + leader.SetName("LEADER"); + router.SetName("ROUTER_1"); + + nexus.AdvanceTime(0); + + // Use AllowList feature to restrict the topology. + leader.AllowList(router); + router.AllowList(leader); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: All"); + + /** + * Step 1: All + * - Description: Verify topology is formed correctly. + * - Pass Criteria: N/A + */ + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + router.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(router.Get().IsRouter()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: Router_1 / Leader"); + + /** + * Step 2: Router_1 / Leader + * - Description: Automatically transmit MLE advertisements. + * - Pass Criteria: + * - Devices MUST send properly formatted MLE Advertisements with an IP Hop Limit of 255 to the Link-Local All + * Nodes multicast address (FF02::1). + * - The following TLVs MUST be present in the Advertisements: + * - Leader Data TLV + * - Route64 TLV + * - Source Address TLV + */ + nexus.AdvanceTime(kAdvTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: Router_1"); + + /** + * Step 3: Router_1 + * - Description: Harness silently resets the device. + * - Pass Criteria: N/A + */ + router.Reset(); + router.AllowList(leader); + router.Get().Up(); + SuccessOrQuit(router.Get().Start()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: Router_1"); + + /** + * Step 4: Router_1 + * - Description: Automatically sends multicast Link Request message. + * - Pass Criteria: + * - For DUT = Router: The Link Request message MUST be sent to the Link-Local All Routers multicast address + * (FF02::2). + * - The following TLVs MUST be present in the Link Request message: + * - Challenge TLV + * - TLV Request TLV + * - Address16 TLV + * - Route64 TLV + * - Version TLV + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 5: Leader"); + + /** + * Step 5: Leader + * - Description: Automatically replies to Router_1 with Link Accept message. + * - Pass Criteria: + * - For DUT = Leader: The following TLVs MUST be present in the Link Accept Message: + * - Address16 TLV + * - Leader Data TLV + * - Link-layer Frame Counter TLV + * - Response TLV + * - Route64 TLV + * - Source Address TLV + * - Version TLV + * - Challenge TLV (situational - MUST be included if the response is an Accept and Request message) + * - MLE Frame Counter TLV (optional) + * - Responses to multicast Link Requests MUST be delayed by a random time of up to MLE_MAX_RESPONSE_DELAY (1 + * second). + */ + nexus.AdvanceTime(kResetSyncTime); + + VerifyOrQuit(router.Get().IsRouter()); + + nexus.SaveTestInfo("test_5_1_13.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_1_13(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_1_13.py b/tests/nexus/verify_5_1_13.py new file mode 100644 index 000000000..02a974818 --- /dev/null +++ b/tests/nexus/verify_5_1_13.py @@ -0,0 +1,181 @@ +#!/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 +from pktverify.null_field import nullField + + +def verify(pv): + # 5.1.13 Router Synchronization after Reset + # + # 5.1.13.1 Topology + # - Topology A + # - Topology B + # + # 5.1.13.2 Purpose & Description + # The purpose of this test case is to validate that when a router resets, it will synchronize upon returning by + # using the Router Synchronization after Reset procedure. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # -----------------------------------|--------------|--------------- + # Router Synchronization after Reset | 4.7.7.3 | 4.7.1.3 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + ROUTER_1 = pv.vars['ROUTER_1'] + + # Step 1: All + # - Description: Verify topology is formed correctly. + # - Pass Criteria: N/A + print("Step 1: All") + + # Step 2: Router_1 / Leader + # - Description: Automatically transmit MLE advertisements. + # - Pass Criteria: + # - Devices MUST send properly formatted MLE Advertisements with an IP Hop Limit of 255 to the Link-Local All + # Nodes multicast address (FF02::1). + # - The following TLVs MUST be present in the Advertisements: + # - Leader Data TLV + # - Route64 TLV + # - Source Address TLV + print("Step 2: Router_1 / Leader") + + # Leader Advertisements + pkts.filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter_LLANMA().\ + filter_wpan_src64(LEADER).\ + filter(lambda p: { + consts.LEADER_DATA_TLV, + consts.ROUTE64_TLV, + consts.SOURCE_ADDRESS_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255 and\ + p.mle.tlv.route64.id_mask is not nullField).\ + must_next() + + # Router_1 Advertisements + pkts.filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter_LLANMA().\ + filter_wpan_src64(ROUTER_1).\ + filter(lambda p: { + consts.LEADER_DATA_TLV, + consts.ROUTE64_TLV, + consts.SOURCE_ADDRESS_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255 and\ + p.mle.tlv.route64.id_mask is not nullField).\ + must_next() + + # Step 3: Router_1 + # - Description: Harness silently resets the device. + # - Pass Criteria: N/A + print("Step 3: Router_1") + + # Step 4: Router_1 + # - Description: Automatically sends multicast Link Request message. + # - Pass Criteria: + # - For DUT = Router: The Link Request message MUST be sent to the Link-Local All Routers multicast address + # (FF02::2). + # - The following TLVs MUST be present in the Link Request message: + # - Challenge TLV + # - TLV Request TLV + # - Address16 TLV + # - Route64 TLV + # - Version TLV + print("Step 4: Router_1") + + # Note: Address16 and Route64 TLVs are requested in TLV Request TLV, and Wireshark dissects their types into + # mle.tlv.type list. We also verify that they are NOT present as top-level TLVs (since the router has reset). + pkt_lq = pkts.filter_mle_cmd(consts.MLE_LINK_REQUEST).\ + filter_LLARMA().\ + filter_wpan_src64(ROUTER_1).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.TLV_REQUEST_TLV, + consts.VERSION_TLV, + consts.ADDRESS16_TLV, + consts.ROUTE64_TLV + } <= set(p.mle.tlv.type)).\ + must_next() + + pkt_lq.must_verify(lambda p: p.mle.tlv.addr16 is nullField and\ + p.mle.tlv.route64.id_mask is nullField) + + # Step 5: Leader + # - Description: Automatically replies to Router_1 with Link Accept message. + # - Pass Criteria: + # - For DUT = Leader: The following TLVs MUST be present in the Link Accept Message: + # - Address16 TLV + # - Leader Data TLV + # - Link-layer Frame Counter TLV + # - Response TLV + # - Route64 TLV + # - Source Address TLV + # - Version TLV + # - Challenge TLV (situational - MUST be included if the response is an Accept and Request message) + # - MLE Frame Counter TLV (optional) + # - Responses to multicast Link Requests MUST be delayed by a random time of up to MLE_MAX_RESPONSE_DELAY (1 + # second). + print("Step 5: Leader") + + ROUTER_1_RLOC16 = pv.vars['ROUTER_1_RLOC16'] + + pkt_la = pkts.filter_mle_cmd2(consts.MLE_LINK_ACCEPT, consts.MLE_LINK_ACCEPT_AND_REQUEST).\ + filter_wpan_src64(LEADER).\ + filter_wpan_dst64(ROUTER_1).\ + filter(lambda p: p.sniff_timestamp - pkt_lq.sniff_timestamp < consts.MLE_MAX_RESPONSE_DELAY + 0.1 and\ + { + consts.ADDRESS16_TLV, + consts.LEADER_DATA_TLV, + consts.LINK_LAYER_FRAME_COUNTER_TLV, + consts.RESPONSE_TLV, + consts.ROUTE64_TLV, + consts.SOURCE_ADDRESS_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type) and\ + p.mle.tlv.addr16 == ROUTER_1_RLOC16 and\ + p.mle.tlv.route64.id_mask is not nullField).\ + must_next() + + if pkt_la.mle.cmd == consts.MLE_LINK_ACCEPT_AND_REQUEST: + pkt_la.must_verify(lambda p: consts.CHALLENGE_TLV in p.mle.tlv.type) + + +if __name__ == '__main__': + verify_utils.run_main(verify)