espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-09-08 18:20:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

[nexus] add test 5.1.10 Parent Selection - Superior Link Quality (#12382)

Browse Source 
Adds a new Nexus test case for 'Parent Selection - Superior Link Quality'
(5.1.10) as specified in the test specification.

Summary of changes:
- Implemented Nexus test 5.1.10:
    - Added test_5_1_10.cpp: Sets up a Leader, Router_1, Router_2, and
      Router_3 (DUT) topology. Uses AddRssIn to configure Router_1 with
      superior link quality (LQ3) and Router_2/Leader with LQ2 relative
      to the DUT. Verifies that the DUT selects Router_1 as its parent
      during attachment.
    - Added verify_5_1_10.py: PCAP verification script for test 5.1.10,
      ensuring that the MLE Parent Request contains the mandatory TLVs
      and that the Child ID Request is correctly sent to the superior
      link-quality router (Router_1).
- Updated build and execution scripts:
    - Modified CMakeLists.txt to build the new 5.1.10 test executable.
    - Updated run_nexus_tests.sh to include 5.1.10 in the default test
      list.
This commit is contained in:
Jonathan Hui
2026-02-06 13:14:35 -08:00
committed by GitHub
parent 6f045ef8ab
commit 9a5527ddd8
4 changed files with 366 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/nexus/CMakeLists.txt
+1
View File
@@ -122,6 +122,7 @@ ot_nexus_test(5_1_6)
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(border_agent)
ot_nexus_test(border_agent_tracker)
ot_nexus_test(discover_scan)
tests/nexus/run_nexus_tests.sh
+1
View File
@@ -57,6 +57,7 @@ DEFAULT_TESTS=(
"5_1_7"
"5_1_8"
"5_1_9"
"5_1_10"
)
# Use provided arguments or the default test list
tests/nexus/test_5_1_10.cpp
+215
View File
@@ -0,0 +1,215 @@
/*
* 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 <stdio.h>
#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 DUT to send Parent Request and receive Parent Responses.
*/
static constexpr uint32_t kParentSelectionTime = 10 * 1000;
/**
* Time to advance for the network to stabilize after routers have attached.
*/
static constexpr uint32_t kStabilizationTime = 10 * 1000;
/**
* RSSI value to enable a link quality of 2 (medium).
* Link margin > 10 dB gives link quality 2.
* Noise floor is -100 dBm.
*/
static constexpr int8_t kRssiLinkQuality2 = -85;
void Test5_1_10(void)
{
/**
* 5.1.10 Attaching to a Router with better link quality
*
* 5.1.10.1 Topology
* - Leader
* - Router_1
* - Router_2
* - Router_3 (DUT)
*
* 5.1.10.2 Purpose & Description
* The purpose of this test case is to validate that the DUT will choose a router with better link quality as its
* parent.
*
* Spec Reference | V1.1 Section | V1.3.0 Section
* -----------------|--------------|---------------
* Parent Selection | 4.7.2 | 4.5.2
*/
Core nexus;
Node &leader = nexus.CreateNode();
Node &router1 = nexus.CreateNode();
Node &router2 = nexus.CreateNode();
Node &dut = nexus.CreateNode();
leader.SetName("LEADER");
router1.SetName("ROUTER_1");
router2.SetName("ROUTER_2");
dut.SetName("DUT");
nexus.AdvanceTime(0);
Instance::SetLogLevel(kLogLevelInfo);
Log("---------------------------------------------------------------------------------------");
Log("Step 1: Leader, Router_1, Router_2");
/**
* Step 1: Leader, Router_1, Router_2
* - Description: Setup the topology without the DUT. Verify all are sending MLE Advertisements.
* - Pass Criteria: N/A
*/
/** Use AllowList feature to restrict the topology. */
leader.AllowList(router1);
leader.AllowList(router2);
router1.AllowList(leader);
router1.AllowList(router2);
router2.AllowList(leader);
router2.AllowList(router1);
leader.Form();
nexus.AdvanceTime(kFormNetworkTime);
VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());
router1.Join(leader);
router2.Join(leader);
nexus.AdvanceTime(kAttachToRouterTime);
VerifyOrQuit(router1.Get<Mle::Mle>().IsRouter());
VerifyOrQuit(router2.Get<Mle::Mle>().IsRouter());
nexus.AdvanceTime(kStabilizationTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 2: Test Harness");
/**
* Step 2: Test Harness
* - Description: Harness configures the RSSI between Router_2 & Router_3 (DUT) to enable a link quality of 2
* (medium).
* - Pass Criteria: N/A
*/
/** Restricted topology for DUT. */
dut.AllowList(router1);
dut.AllowList(router2);
router1.AllowList(dut);
router2.AllowList(dut);
IgnoreError(dut.Get<Mac::Filter>().AddRssIn(router2.Get<Mac::Mac>().GetExtAddress(), kRssiLinkQuality2));
IgnoreError(router2.Get<Mac::Filter>().AddRssIn(dut.Get<Mac::Mac>().GetExtAddress(), kRssiLinkQuality2));
Log("---------------------------------------------------------------------------------------");
Log("Step 3: Router_3 (DUT)");
/**
* Step 3: Router_3 (DUT)
* - Description: Automatically begins attach process by sending a multicast 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:
* - Mode TLV
* - Challenge TLV
* - Scan Mask TLV = 0x80 (active Routers)
* - Version TLV
*/
dut.Get<Mle::Mle>().SetRouterEligible(false);
dut.Join(leader);
/**
* Step 4: Router_1, Router_2
* - Description: Each devices automatically responds to DUT with MLE Parent Response.
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kParentSelectionTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 5: Router_3 (DUT)");
/**
* Step 5: Router_3 (DUT)
* - Description: Automatically sends MLE Child ID Request to Router_1 due to better link quality.
* - Pass Criteria:
* - The DUT MUST unicast MLE Child ID Request to Router_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(kStabilizationTime);
VerifyOrQuit(dut.Get<Mle::Mle>().IsAttached());
VerifyOrQuit(dut.Get<Mle::Mle>().IsChild());
VerifyOrQuit(dut.Get<Mle::Mle>().GetParent().GetExtAddress() == router1.Get<Mac::Mac>().GetExtAddress());
nexus.SaveTestInfo("test_5_1_10.json");
}
} // namespace Nexus
} // namespace ot
int main(void)
{
ot::Nexus::Test5_1_10();
printf("All tests passed\n");
return 0;
}
tests/nexus/verify_5_1_10.py
+149
View File
@@ -0,0 +1,149 @@
#!/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.10 Parent Selection - Superior Link Quality
#
# 5.1.10.1 Topology
# - Leader
# - Router_1
# - Router_2
# - Router_3 (DUT)
#
# 5.1.10.2 Purpose & Description
# The purpose of this test case is to verify that the DUT selects a parent with superior link quality.
#
# 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']
ROUTER_1 = pv.vars['ROUTER_1']
ROUTER_2 = pv.vars['ROUTER_2']
DUT = pv.vars['DUT']
# Step 1: Leader, Router_1, Router_2
# - Description: Setup the topology without the DUT. Verify all are sending MLE Advertisements.
# - Pass Criteria: N/A
print("Step 1: Leader, Router_1, Router_2")
pkts.copy().filter_mle_cmd(consts.MLE_ADVERTISEMENT).filter_wpan_src64(LEADER).must_next()
pkts.copy().filter_mle_cmd(consts.MLE_ADVERTISEMENT).filter_wpan_src64(ROUTER_1).must_next()
pkts.copy().filter_mle_cmd(consts.MLE_ADVERTISEMENT).filter_wpan_src64(ROUTER_2).must_next()
# Step 2: Test Harness
# - Description: Set RSSI of Router_2 at the DUT to -85dBm (Link Quality 2).
# - Pass Criteria: N/A
print("Step 2: Test Harness")
# Step 3: Router_3 (DUT)
# - Description: DUT begins attaching to the network.
# - Pass Criteria:
# - MLE Parent Request:
# - IP Destination: Link-Local All Routers Multicast Address (FF02::2)
# - Hop Limit: 255
# - TLVs:
# - Mode TLV
# - Challenge TLV
# - Scan Mask TLV (Router bit = 1, REED bit = 0)
# - Version TLV
print("Step 3: Router_3 (DUT)")
pkts.filter_mle_cmd(consts.MLE_PARENT_REQUEST).\
filter_LLARMA().\
filter_wpan_src64(DUT).\
filter(lambda p: {
consts.MODE_TLV,
consts.CHALLENGE_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_1, Router_2
# - Description: Leader, Router_1, and Router_2 each send MLE Parent Response.
# - Pass Criteria: N/A
print("Step 4: Router_1, Router_2")
# Verify that we see parent responses from expected nodes.
pkts.copy().filter_mle_cmd(consts.MLE_PARENT_RESPONSE).filter_wpan_src64(ROUTER_1).must_next()
pkts.copy().filter_mle_cmd(consts.MLE_PARENT_RESPONSE).filter_wpan_src64(ROUTER_2).must_next()
# Step 5: Router_3 (DUT)
# - Description: DUT sends Child ID Request to Router_1.
# - Pass Criteria:
# - MLE Child ID Request:
# - IP Destination: Link-Local address of Router_1
# - Hop Limit: 255
# - TLVs:
# - Mode TLV
# - Response TLV
# - Timeout TLV
# - TLV Request TLV
# - Version TLV
# - Link-layer Frame Counter TLV
# - Exclude Address Registration TLV
print("Step 5: Router_3 (DUT)")
pkt = pkts.filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\
filter_wpan_src64(DUT).\
filter_wpan_dst64(ROUTER_1).\
filter(lambda p: {
consts.MODE_TLV,
consts.RESPONSE_TLV,
consts.TIMEOUT_TLV,
consts.TLV_REQUEST_TLV,
consts.VERSION_TLV,
consts.LINK_LAYER_FRAME_COUNTER_TLV,
consts.ADDRESS16_TLV,
consts.NETWORK_DATA_TLV
} <= set(p.mle.tlv.type) and\
p.ipv6.hlim == 255 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)