From 3d5b59b6f12bf1729447b2b42a5f768c7daf3335 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Fri, 13 Feb 2026 09:18:10 -0600 Subject: [PATCH] [nexus] add test 5.5.1 Leader Reboot < timeout (#12431) This commit adds a new Nexus test case for 'Leader Reboot < timeout' (5.5.1) as specified in the Thread Test Specification. The test demonstrates that when a Leader reboots for a period shorter than the leader timeout, it successfully reattaches to the network and remains the Leader without causing partition changes. Summary of changes: - tests/nexus/test_5_5_1.cpp: C++ test execution script. - Sets up a topology with a Leader and a Router. - Reboots the Leader for 80 seconds (less than the 120s timeout). - Uses direct method calls and block comments. - Includes 1-line log outputs for each test step. - tests/nexus/verify_5_5_1.py: Python PCAP verification script. - Verifies MLE Advertisements and correct TLVs. - Ensures Leader stops advertisements during reboot. - Validates multicast Link Request formatting after reboot. - Confirms no Parent Request is sent by the Leader. - Verifies ICMPv6 connectivity after reattachment. - tests/nexus/CMakeLists.txt: Added the new test to the build system. - tests/nexus/run_nexus_tests.sh: Added 5_5_1 to the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_5_1.cpp | 220 +++++++++++++++++++++++++++++++++ tests/nexus/verify_5_5_1.py | 208 +++++++++++++++++++++++++++++++ 4 files changed, 430 insertions(+) create mode 100644 tests/nexus/test_5_5_1.cpp create mode 100644 tests/nexus/verify_5_5_1.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index c9eb4c09f..019ac7b14 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -148,6 +148,7 @@ ot_nexus_test(5_3_8 "cert;nexus") ot_nexus_test(5_3_9 "cert;nexus") ot_nexus_test(5_3_10 "cert;nexus") ot_nexus_test(5_3_11 "cert;nexus") +ot_nexus_test(5_5_1 "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 394684e56..7ae5d0716 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -78,6 +78,7 @@ DEFAULT_TESTS=( "5_3_9" "5_3_10" "5_3_11" + "5_5_1" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_5_1.cpp b/tests/nexus/test_5_5_1.cpp new file mode 100644 index 000000000..7579f6e31 --- /dev/null +++ b/tests/nexus/test_5_5_1.cpp @@ -0,0 +1,220 @@ +/* + * 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 the network to stabilize after routers have attached. + */ +static constexpr uint32_t kStabilizationTime = 10 * 1000; + +/** + * Leader reboot time in milliseconds. + * Must be less than Leader Timeout value (default 120 seconds). + */ +static constexpr uint32_t kLeaderRebootTime = 80 * 1000; + +/** + * Time to advance after Leader reset to allow it to synchronize. + */ +static constexpr uint32_t kSynchronizationTime = 10 * 1000; + +void Test5_5_1(void) +{ + /** + * 5.5.1 Leader Reboot < timeout + * + * 5.5.1.1 Topology + * - Leader + * - Router_1 + * + * 5.5.1.2 Purpose & Description + * The purpose of this test case is to show that when the Leader is rebooted for a time period shorter than the + * leader timeout, it does not trigger network partitioning and remains the leader when it reattaches to the + * network. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * --------------------|--------------|--------------- + * Losing Connectivity | 5.16.1 | 5.16.1 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node &router1 = nexus.CreateNode(); + + leader.SetName("LEADER"); + router1.SetName("ROUTER_1"); + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: All"); + + /** + * Step 1: All + * - Description: Ensure topology is formed correctly. + * - Pass Criteria: N/A + */ + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + router1.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(router1.Get().IsRouter()); + + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: Leader, Router_1"); + + /** + * Step 2: Leader, Router_1 + * - Description: Transmit MLE advertisements. + * - Pass Criteria: + * - The devices MUST send properly formatted MLE Advertisements. + * - Advertisements MUST be sent with an IP Hop Limit of 255 to the Link-Local All Nodes multicast address + * (FF02::1). + * - The following TLVs MUST be present in MLE Advertisements: + * - Leader Data TLV + * - Route64 TLV + * - Source Address TLV + * - Non-DUT device: Harness instructs device to send a ICMPv6 Echo Request to the DUT to help differentiate + * between Link Requests sent before and after reset. + */ + nexus.AdvanceTime(kStabilizationTime); + nexus.SendAndVerifyEchoRequest(router1, leader.Get().GetLinkLocalAddress()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: Leader"); + + /** + * Step 3: Leader + * - Description: Reset Leader. + * - If DUT=Leader and testing is manual, this is a UI pop-up box interaction. + * - Allowed Leader reboot time is 125 seconds (must be greater than Leader Timeout value [default 120 seconds]). + * - Pass Criteria: + * - For DUT = Leader: The Leader MUST stop sending MLE advertisements. + * - The Leader reboot time MUST be less than Leader Timeout value (default 120 seconds). + */ + leader.Reset(); + nexus.AdvanceTime(kLeaderRebootTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: Leader"); + + /** + * Step 4: Leader + * - Description: Automatically performs Synchronization after Reset, sends Link Request. + * - Pass Criteria: + * - For DUT = Leader: The Leader MUST send a multicast Link Request. + * - The following TLVs MUST be present in the Link Request: + * - Challenge TLV + * - TLV Request TLV: Address16 TLV, Route64 TLV + * - Version TLV + */ + leader.Get().Up(); + SuccessOrQuit(leader.Get().Start()); + nexus.AdvanceTime(kSynchronizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 5: Router_1"); + + /** + * Step 5: Router_1 + * - Description: Automatically responds with a Link Accept. + * - Pass Criteria: + * - For DUT = Router: Router_1 MUST reply with a Link Accept. + * - The following TLVs MUST be present in the Link Accept: + * - Address16 TLV + * - Leader Data TLV + * - Link-Layer Frame Counter TLV + * - Response TLV + * - Route64 TLV + * - Source Address TLV + * - Version TLV + * - MLE Frame Counter TLV (optional) + * - Challenge TLV (situational - MUST be included if the response is an Accept and Request message) + */ + nexus.AdvanceTime(kStabilizationTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 6: Leader"); + + /** + * Step 6: Leader + * - Description: Does NOT send a Parent Request. + * - Pass Criteria: + * - For DUT = Leader: The Leader MUST NOT send a Parent Request after it is re-enabled. + */ + nexus.AdvanceTime(kStabilizationTime); + VerifyOrQuit(leader.Get().IsLeader()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 7: All"); + + /** + * Step 7: All + * - Description: Harness verifies connectivity by sending an ICMPv6 Echo Request to the Router_1 link local + * address. + * - Pass Criteria: + * - For DUT = Router: Router_1 MUST respond with an ICMPv6 Echo Reply. + */ + nexus.SendAndVerifyEchoRequest(leader, router1.Get().GetLinkLocalAddress()); + + nexus.SaveTestInfo("test_5_5_1.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_5_1(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_5_1.py b/tests/nexus/verify_5_5_1.py new file mode 100644 index 000000000..fdad1b896 --- /dev/null +++ b/tests/nexus/verify_5_5_1.py @@ -0,0 +1,208 @@ +#!/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.5.1 Leader Reboot < timeout + # + # 5.5.1.1 Topology + # - Leader + # - Router_1 + # + # 5.5.1.2 Purpose & Description + # The purpose of this test case is to show that when the Leader is rebooted for a time period shorter than the + # leader timeout, it does not trigger network partitioning and remains the leader when it reattaches to the + # network. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # --------------------|--------------|--------------- + # Losing Connectivity | 5.16.1 | 5.16.1 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + ROUTER_1 = pv.vars['ROUTER_1'] + + # Step 1: All + # - Description: Ensure topology is formed correctly. + # - Pass Criteria: N/A + print("Step 1: All") + + # Step 2: Leader, Router_1 + # - Description: Transmit MLE advertisements. + # - Pass Criteria: + # - The devices MUST send properly formatted MLE Advertisements. + # - Advertisements MUST be sent with an IP Hop Limit of 255 to the Link-Local All Nodes multicast address + # (FF02::1). + # - The following TLVs MUST be present in MLE Advertisements: + # - Leader Data TLV + # - Route64 TLV + # - Source Address TLV + # - Non-DUT device: Harness instructs device to send a ICMPv6 Echo Request to the DUT to help differentiate + # between Link Requests sent before and after reset. + print("Step 2: Leader, Router_1") + pkts.filter_wpan_src64(LEADER).\ + filter_LLANMA().\ + filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter(lambda p: { + consts.LEADER_DATA_TLV, + consts.ROUTE64_TLV, + consts.SOURCE_ADDRESS_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255).\ + must_next() + + pkts.filter_wpan_src64(ROUTER_1).\ + filter_LLANMA().\ + filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter(lambda p: { + consts.LEADER_DATA_TLV, + consts.ROUTE64_TLV, + consts.SOURCE_ADDRESS_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255).\ + must_next() + + pkts.filter_ping_request().\ + filter_wpan_src64(ROUTER_1).\ + filter_wpan_dst64(LEADER).\ + must_next() + lstart = pkts.index + + # Step 3: Leader + # - Description: Reset Leader. + # - If DUT=Leader and testing is manual, this is a UI pop-up box interaction. + # - Allowed Leader reboot time is 125 seconds (must be greater than Leader Timeout value [default 120 seconds]). + # - Pass Criteria: + # - For DUT = Leader: The Leader MUST stop sending MLE advertisements. + # - The Leader reboot time MUST be less than Leader Timeout value (default 120 seconds). + print("Step 3: Leader") + + # Step 4: Leader + # - Description: Automatically performs Synchronization after Reset, sends Link Request. + # - Pass Criteria: + # - For DUT = Leader: The Leader MUST send a multicast Link Request. + # - The following TLVs MUST be present in the Link Request: + # - Challenge TLV + # - TLV Request TLV: Address16 TLV, Route64 TLV + # - Version TLV + print("Step 4: Leader") + pkts.filter_wpan_src64(LEADER).\ + filter_LLARMA().\ + filter_mle_cmd(consts.MLE_LINK_REQUEST).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.TLV_REQUEST_TLV, + consts.VERSION_TLV, + consts.ADDRESS16_TLV, + consts.ROUTE64_TLV + } <= set(p.mle.tlv.type) and\ + p.mle.tlv.addr16 is nullField and\ + p.mle.tlv.route64.id_mask is nullField).\ + must_next() + lend = pkts.index + + # Step 3 (verify): Leader MUST stop sending MLE advertisements. + pkts.range(lstart, lend).\ + filter_wpan_src64(LEADER).\ + filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + must_not_next() + + # Step 5: Router_1 + # - Description: Automatically responds with a Link Accept. + # - Pass Criteria: + # - For DUT = Router: Router_1 MUST reply with a Link Accept. + # - The following TLVs MUST be present in the Link Accept: + # - Address16 TLV + # - Leader Data TLV + # - Link-Layer Frame Counter TLV + # - Response TLV + # - Route64 TLV + # - Source Address TLV + # - Version TLV + # - MLE Frame Counter TLV (optional) + # - Challenge TLV (situational - MUST be included if the response is an Accept and Request message) + print("Step 5: Router_1") + _pkt = pkts.filter_wpan_src64(ROUTER_1).\ + filter_wpan_dst64(LEADER).\ + filter_mle_cmd2(consts.MLE_LINK_ACCEPT, consts.MLE_LINK_ACCEPT_AND_REQUEST).\ + filter(lambda p: { + 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 is not nullField and\ + p.mle.tlv.route64.id_mask is not nullField).\ + must_next() + if _pkt.mle.cmd == consts.MLE_LINK_ACCEPT_AND_REQUEST: + _pkt.must_verify(lambda p: {consts.CHALLENGE_TLV} <= set(p.mle.tlv.type)) + + # Step 7 (prepare): ICMPv6 Echo Request to Router_1 + print("Step 7: All") + _pkt = pkts.filter_ping_request().\ + filter_wpan_src64(LEADER).\ + filter_wpan_dst64(ROUTER_1).\ + must_next() + lconnect = pkts.index + + # Step 7 (verify): Router_1 MUST respond with an ICMPv6 Echo Reply + pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\ + filter_wpan_src64(ROUTER_1).\ + filter_wpan_dst64(LEADER).\ + must_next() + + # Step 6: Leader + # - Description: Does NOT send a Parent Request. + # - Pass Criteria: + # - For DUT = Leader: The Leader MUST NOT send a Parent Request after it is re-enabled. + print("Step 6: Leader") + pkts.range(lend, lconnect).\ + filter_wpan_src64(LEADER).\ + filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + must_not_next() + + +if __name__ == '__main__': + verify_utils.run_main(verify)