From af762f1e01b9772efeff4f7f55cf512b253dfd45 Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Fri, 6 Feb 2026 14:51:34 -0800 Subject: [PATCH] [nexus] add test 5.1.11 Attaching to a REED with better link quality (#12383) Adds a new Nexus test case for 'Attaching to a REED with better link quality' (5.1.11) as specified in the test specification. Summary of changes: - Implemented Nexus test 5.1.11: - Added test_5_1_11.cpp: Sets up a topology with Leader, REED_1, Router_2, and Router_1 (DUT). Configures RSSI to ensure REED_1 has a higher link quality than Router_2. Verifies that the DUT attaches to REED_1 as its parent. - Added verify_5_1_11.py: PCAP verification script for test 5.1.11, validating the MLE Parent Request sequence (Routers then REEDs) and the final attachment to REED_1. - Updated build and execution scripts: - Modified CMakeLists.txt to build the new 5.1.11 test executable. - Updated run_nexus_tests.sh to include 5.1.11 in the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_1_11.cpp | 250 +++++++++++++++++++++++++++++++++ tests/nexus/verify_5_1_11.py | 172 +++++++++++++++++++++++ 4 files changed, 424 insertions(+) create mode 100644 tests/nexus/test_5_1_11.cpp create mode 100644 tests/nexus/verify_5_1_11.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index ab61c19ec..03de24c45 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -123,6 +123,7 @@ ot_nexus_test(5_1_7) ot_nexus_test(5_1_8) ot_nexus_test(5_1_9) ot_nexus_test(5_1_10) +ot_nexus_test(5_1_11) 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 d7dcf4a92..a39f32d90 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -58,6 +58,7 @@ DEFAULT_TESTS=( "5_1_8" "5_1_9" "5_1_10" + "5_1_11" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_1_11.cpp b/tests/nexus/test_5_1_11.cpp new file mode 100644 index 000000000..3bb73e519 --- /dev/null +++ b/tests/nexus/test_5_1_11.cpp @@ -0,0 +1,250 @@ +/* + * 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" +#include "thread/link_quality.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 kAttachAsChildTime = 10 * 1000; + +/** + * Default noise floor used for RSSI calculations. + */ +static constexpr int8_t kDefaultNoiseFloor = -100; + +/** + * Typical RSSI for link quality 2. + */ +static const int8_t kRssiQuality2 = GetTypicalRssForLinkQuality(kDefaultNoiseFloor, kLinkQuality2); + +/** + * Typical RSSI for link quality 3. + */ +static const int8_t kRssiQuality3 = GetTypicalRssForLinkQuality(kDefaultNoiseFloor, kLinkQuality3); + +void Test5_1_11(void) +{ + /** + * 5.1.11 Attaching to a REED with better link quality + * + * 5.1.11.1 Topology + * - Leader + * - REED_1 + * - Router_2 + * - Router_1 (DUT) + * + * 5.1.11.2 Purpose & Description + * The purpose of this test case is to validate that DUT will attach to a REED with the highest link quality, + * when routers with the highest link quality are not available. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * -----------------|--------------|--------------- + * Parent Selection | 4.7.2 | 4.5.2 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node &reed1 = nexus.CreateNode(); + Node &router2 = nexus.CreateNode(); + Node &dut = nexus.CreateNode(); + + leader.SetName("LEADER"); + reed1.SetName("REED_1"); + router2.SetName("ROUTER_2"); + dut.SetName("DUT"); + + nexus.AdvanceTime(0); + + /** + * Use AllowList feature to restrict the topology. + */ + + /** + * Leader <-> REED_1 + */ + leader.AllowList(reed1); + reed1.AllowList(leader); + + /** + * Leader <-> Router_2 + */ + leader.AllowList(router2); + router2.AllowList(leader); + + /** + * REED_1 <-> DUT + */ + reed1.AllowList(dut); + dut.AllowList(reed1); + + /** + * Router_2 <-> DUT + */ + router2.AllowList(dut); + dut.AllowList(router2); + + /** + * REED_1 <-> Router_2 (to ensure they can see each other if needed, though not strictly required by topology) + */ + reed1.AllowList(router2); + router2.AllowList(reed1); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: Leader, REED_1, Router_2"); + + /** + * Step 1: Leader, REED_1, Router_2 + * - Description: Setup the topology without the DUT. Verify Leader and Router_2 are sending MLE + * Advertisements. + * - Pass Criteria: N/A + */ + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + reed1.Get().SetRouterUpgradeThreshold(0); + reed1.Join(leader); + nexus.AdvanceTime(kAttachAsChildTime); + VerifyOrQuit(reed1.Get().IsChild()); + + router2.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(router2.Get().IsRouter()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: Test Harness"); + + /** + * Step 2: Test Harness + * - Description: Harness configures the RSSI between Router_2 & Router_1 (DUT) to enable a link quality of 2 + * (medium). + * - Pass Criteria: N/A + */ + dut.Get().AddRssIn(router2.Get().GetExtAddress(), kRssiQuality2); + router2.Get().AddRssIn(dut.Get().GetExtAddress(), kRssiQuality2); + + dut.Get().AddRssIn(reed1.Get().GetExtAddress(), kRssiQuality3); + reed1.Get().AddRssIn(dut.Get().GetExtAddress(), kRssiQuality3); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: Router_1 (DUT)"); + + /** + * Step 3: Router_1 (DUT) + * - Description: Automatically sends a MLE Parent Request. + * - Pass Criteria: + * - The DUT MUST send MLE Parent Request to the Link-Local All-Routers multicast address (FF02::2) with an IP + * Hop Limit of 255. + * - The following TLVs MUST be present in the MLE Parent Request: + * - Challenge TLV + * - Mode TLV + * - Scan Mask TLV = 0x80 (active Routers) + * - Version TLV + */ + dut.Get().SetRouterEligible(false); + dut.Join(leader); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: Router_2"); + + /** + * Step 4: Router_2 + * - Description: Automatically responds to DUT with MLE Parent Response. + * - Pass Criteria: N/A + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 5: Router_1 (DUT)"); + + /** + * Step 5: Router_1 (DUT) + * - Description: Automatically sends another MLE Parent Request - to Routers and REEDs - when it doesn’t see the + * highest link quality in Router_2’s response. + * - Pass Criteria: + * - The DUT MUST send MLE Parent Request with the Scan Mask set to All Routers and REEDs. + * - The following TLVs MUST be present in the MLE Parent Request: + * - Challenge TLV + * - Mode TLV + * - Scan Mask TLV = 0xC0 (Routers and REEDs) + * - Version TLV + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 6: Router_1 (DUT)"); + + /** + * Step 6: Router_1 (DUT) + * - Description: Automatically sends MLE Child ID Request to REED_1 due to its better link quality. + * - Pass Criteria: + * - The DUT MUST unicast MLE Child ID Request to REED_1, including the following TLVs: + * - Link-layer Frame Counter TLV + * - Mode TLV + * - Response TLV + * - Timeout TLV + * - TLV Request TLV + * - Version TLV + * - MLE Frame Counter TLV (optional) + * - The following TLV MUST NOT be present in the Child ID Request: + * - Address Registration TLV + */ + nexus.AdvanceTime(kAttachAsChildTime); + VerifyOrQuit(dut.Get().IsChild()); + VerifyOrQuit(dut.Get().GetParent().GetExtAddress() == reed1.Get().GetExtAddress()); + + nexus.SaveTestInfo("test_5_1_11.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_1_11(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_1_11.py b/tests/nexus/verify_5_1_11.py new file mode 100644 index 000000000..6b9c0f155 --- /dev/null +++ b/tests/nexus/verify_5_1_11.py @@ -0,0 +1,172 @@ +#!/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.11 Attaching to a REED with better link quality + # + # 5.1.11.1 Topology + # - Leader + # - REED_1 + # - Router_2 + # - Router_1 (DUT) + # + # 5.1.11.2 Purpose & Description + # The purpose of this test case is to validate that DUT will attach to a REED with the highest link quality, + # when routers with the highest link quality are not available. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # -----------------|--------------|--------------- + # Parent Selection | 4.7.2 | 4.5.2 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + REED_1 = pv.vars['REED_1'] + ROUTER_2 = pv.vars['ROUTER_2'] + DUT = pv.vars['DUT'] + + # Step 1: Leader, REED_1, Router_2 + # - Description: Setup the topology without the DUT. Verify Leader and Router_2 are sending MLE + # Advertisements. + # - Pass Criteria: N/A + print("Step 1: Leader, REED_1, Router_2") + + # Step 2: Test Harness + # - Description: Harness configures the RSSI between Router_2 & Router_1 (DUT) to enable a link quality of 2 + # (medium). + # - Pass Criteria: N/A + print("Step 2: Test Harness") + + # Step 3: Router_1 (DUT) + # - Description: Automatically sends a MLE Parent Request. + # - Pass Criteria: + # - The DUT MUST send MLE Parent Request to the Link-Local All-Routers multicast address (FF02::2) with an IP + # Hop Limit of 255. + # - The following TLVs MUST be present in the MLE Parent Request: + # - Challenge TLV + # - Mode TLV + # - Scan Mask TLV = 0x80 (active Routers) + # - Version TLV + print("Step 3: Router_1 (DUT) sends MLE Parent Request to active Routers") + pkts.filter_wpan_src64(DUT).\ + filter_LLARMA().\ + filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.MODE_TLV, + consts.SCAN_MASK_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255 and\ + p.mle.tlv.scan_mask.r == 1 and\ + p.mle.tlv.scan_mask.e == 0).\ + must_next() + + # Step 4: Router_2 + # - Description: Automatically responds to DUT with MLE Parent Response. + # - Pass Criteria: N/A + print("Step 4: Router_2 responds with MLE Parent Response") + pkts.filter_wpan_src64(ROUTER_2).\ + filter_wpan_dst64(DUT).\ + filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\ + must_next() + + # Step 5: Router_1 (DUT) + # - Description: Automatically sends another MLE Parent Request - to Routers and REEDs - when it doesn’t see the + # highest link quality in Router_2’s response. + # - Pass Criteria: + # - The DUT MUST send MLE Parent Request with the Scan Mask set to All Routers and REEDs. + # - The following TLVs MUST be present in the MLE Parent Request: + # - Challenge TLV + # - Mode TLV + # - Scan Mask TLV = 0xC0 (Routers and REEDs) + # - Version TLV + print("Step 5: Router_1 (DUT) sends MLE Parent Request to Routers and REEDs") + pkts.filter_wpan_src64(DUT).\ + filter_LLARMA().\ + filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.MODE_TLV, + consts.SCAN_MASK_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type) and\ + p.ipv6.hlim == 255 and\ + p.mle.tlv.scan_mask.r == 1 and\ + p.mle.tlv.scan_mask.e == 1).\ + must_next() + + # Step 6: Router_1 (DUT) + # - Description: Automatically sends MLE Child ID Request to REED_1 due to its better link quality. + # - Pass Criteria: + # - The DUT MUST unicast MLE Child ID Request to REED_1, including the following TLVs: + # - Link-layer Frame Counter TLV + # - Mode TLV + # - Response TLV + # - Timeout TLV + # - TLV Request TLV + # - Version TLV + # - MLE Frame Counter TLV (optional) + # - The following TLV MUST NOT be present in the Child ID Request: + # - Address Registration TLV + print("Step 6: Router_1 (DUT) sends MLE Child ID Request to REED_1") + pkt = pkts.filter_wpan_src64(DUT).\ + filter_wpan_dst64(REED_1).\ + filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\ + filter(lambda p: { + consts.LINK_LAYER_FRAME_COUNTER_TLV, + consts.MODE_TLV, + consts.RESPONSE_TLV, + consts.TIMEOUT_TLV, + consts.TLV_REQUEST_TLV, + consts.VERSION_TLV, + consts.ADDRESS16_TLV, + consts.NETWORK_DATA_TLV + } <= set(p.mle.tlv.type) and\ + p.mle.tlv.addr16 is nullField and\ + p.thread_nwd.tlv.type is nullField).\ + must_next() + pkt.must_not_verify(lambda p: (consts.ADDRESS_REGISTRATION_TLV) in p.mle.tlv.type) + + +if __name__ == '__main__': + verify_utils.run_main(verify)