mirror of
https://github.com/espressif/openthread.git
synced 2026-08-13 22:27:47 +00:00
[nexus] add test 6.1.5 Attaching with Better Link Quality (#12486)
This commit adds a new Nexus test case for 'Attaching to a Router with
Better Link Quality' (6.1.5) as specified in the test specification.
Summary of changes:
- Added tests/nexus/test_6_1_5.cpp:
- Implements test 6.1.5 using direct method calls from the core.
- Sets up a topology with a Leader, one Router, and one REED.
- Uses AllowList to configure connectivity as specified.
- Adjusts RSSI between DUT and REED to ensure lower link quality.
- Sets log level to note and includes 1-line log output for each
test step.
- Avoids magic numbers by using descriptive constants.
- Added tests/nexus/verify_6_1_5.py:
- PCAP verification script for test 6.1.5.
- Validates MLE Parent Request and Child ID Request TLVs.
- Verifies that the DUT selects Router 1 (better link quality) as
its parent.
- Confirms ICMPv6 Echo connectivity between Router 1 and the DUT.
- Follows one-condition-per-line style for verification logic.
- Updated build and execution scripts:
- Modified tests/nexus/CMakeLists.txt to include nexus_6_1_5.
- Updated tests/nexus/run_nexus_tests.sh to add 6_1_5 to the
default test list.
This commit is contained in:
Jonathan Hui
@@ -165,6 +165,7 @@ ot_nexus_test(6_1_1 "cert;nexus")
|
||||
ot_nexus_test(6_1_2 "cert;nexus")
|
||||
ot_nexus_test(6_1_3 "cert;nexus")
|
||||
ot_nexus_test(6_1_4 "cert;nexus")
|
||||
ot_nexus_test(6_1_5 "cert;nexus")
|
||||
ot_nexus_test(6_2_1 "cert;nexus")
|
||||
ot_nexus_test(6_2_2 "cert;nexus")
|
||||
ot_nexus_test(6_3_1 "cert;nexus")
|
||||
|
||||
@@ -98,6 +98,7 @@ DEFAULT_TESTS=(
|
||||
"6_1_3_A"
|
||||
"6_1_3_B"
|
||||
"6_1_4"
|
||||
"6_1_5"
|
||||
"6_2_1_A"
|
||||
"6_2_1_B"
|
||||
"6_2_2"
|
||||
|
||||
@@ -0,0 +1,247 @@
|
||||
/*
|
||||
* 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 "mac/data_poll_sender.hpp"
|
||||
#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;
|
||||
|
||||
/**
|
||||
* ICMPv6 Echo Request identifier.
|
||||
*/
|
||||
static constexpr uint16_t kEchoIdentifier = 0x1234;
|
||||
|
||||
/**
|
||||
* Data poll period for SED, in milliseconds.
|
||||
*/
|
||||
static constexpr uint32_t kPollPeriod = 500;
|
||||
|
||||
/**
|
||||
* Time to advance at the start of the test.
|
||||
*/
|
||||
static constexpr uint32_t kStartTime = 0;
|
||||
|
||||
void Test6_1_5(void)
|
||||
{
|
||||
/**
|
||||
* 6.1.5 Attaching to a Router with Better Link Quality
|
||||
*
|
||||
* 6.1.5.1 Topology
|
||||
* - Topology A: DUT as End Device (ED_1)
|
||||
* - Topology B: DUT as Sleepy End Device (SED_1)
|
||||
* - Leader
|
||||
* - Router_1
|
||||
* - Router_2
|
||||
*
|
||||
* 6.1.5.2 Purpose & Description
|
||||
* The purpose of this test case is to validate that the DUT will choose a router with better link quality as a
|
||||
* 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 &reed2 = nexus.CreateNode();
|
||||
Node &sed1 = nexus.CreateNode();
|
||||
|
||||
leader.SetName("LEADER");
|
||||
router1.SetName("ROUTER_1");
|
||||
reed2.SetName("ROUTER_2");
|
||||
sed1.SetName("SED_1");
|
||||
|
||||
nexus.AdvanceTime(kStartTime);
|
||||
|
||||
Instance::SetLogLevel(kLogLevelNote);
|
||||
|
||||
Log("---------------------------------------------------------------------------------------");
|
||||
Log("Step 1: Setup the topology without the DUT. Ensure all routers and leader are sending MLE advertisements.");
|
||||
|
||||
/**
|
||||
* Step 1: All
|
||||
* - Description: Setup the topology without the DUT. Ensure all routers and leader are sending MLE
|
||||
* advertisements.
|
||||
* - Pass Criteria: N/A
|
||||
*/
|
||||
|
||||
/** Use AllowList feature to restrict the topology. */
|
||||
leader.AllowList(router1);
|
||||
leader.AllowList(reed2);
|
||||
|
||||
router1.AllowList(leader);
|
||||
reed2.AllowList(leader);
|
||||
|
||||
leader.Form();
|
||||
nexus.AdvanceTime(kFormNetworkTime);
|
||||
VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());
|
||||
|
||||
router1.Join(leader);
|
||||
reed2.Join(leader);
|
||||
nexus.AdvanceTime(kAttachToRouterTime);
|
||||
|
||||
VerifyOrQuit(router1.Get<Mle::Mle>().IsRouter());
|
||||
// REED_2 can be either Router or End Device depending on the network state, but it should be attached.
|
||||
VerifyOrQuit(reed2.Get<Mle::Mle>().IsAttached());
|
||||
|
||||
nexus.AdvanceTime(kStabilizationTime);
|
||||
|
||||
Log("---------------------------------------------------------------------------------------");
|
||||
Log("Step 2: Harness configures the device to broadcast a link quality of 2 (medium).");
|
||||
|
||||
/**
|
||||
* Step 2: Router_2
|
||||
* - Description: Harness configures the device to broadcast a link quality of 2 (medium).
|
||||
* - Pass Criteria: N/A
|
||||
*/
|
||||
|
||||
/** Restricted topology for DUT. */
|
||||
sed1.AllowList(router1);
|
||||
sed1.AllowList(reed2);
|
||||
|
||||
router1.AllowList(sed1);
|
||||
reed2.AllowList(sed1);
|
||||
|
||||
IgnoreError(sed1.Get<Mac::Filter>().AddRssIn(reed2.Get<Mac::Mac>().GetExtAddress(), kRssiLinkQuality2));
|
||||
IgnoreError(reed2.Get<Mac::Filter>().AddRssIn(sed1.Get<Mac::Mac>().GetExtAddress(), kRssiLinkQuality2));
|
||||
|
||||
Log("---------------------------------------------------------------------------------------");
|
||||
Log("Step 3: Automatically begins attach process by sending a multicast MLE Parent Request.");
|
||||
|
||||
/**
|
||||
* Step 3: ED_1 / SED_1 (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 Parent Request:
|
||||
* - Challenge TLV
|
||||
* - Mode TLV
|
||||
* - Scan Mask TLV = 0x80 (active Routers)
|
||||
* - Version TLV
|
||||
*/
|
||||
|
||||
sed1.Join(leader, Node::kAsSed);
|
||||
SuccessOrQuit(sed1.Get<DataPollSender>().SetExternalPollPeriod(kPollPeriod));
|
||||
|
||||
Log("---------------------------------------------------------------------------------------");
|
||||
Log("Step 4: Both devices automatically send MLE Parent Response.");
|
||||
|
||||
/**
|
||||
* Step 4: Router_1, Router_2
|
||||
* - Description: Both devices automatically send MLE Parent Response.
|
||||
* - Pass Criteria: N/A
|
||||
*/
|
||||
|
||||
nexus.AdvanceTime(kParentSelectionTime);
|
||||
|
||||
Log("---------------------------------------------------------------------------------------");
|
||||
Log("Step 5: Automatically sends MLE Child ID Request to Router_1 due to better link quality.");
|
||||
|
||||
/**
|
||||
* Step 5: ED_1 / SED_1 (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.
|
||||
* - The following TLVs MUST be present in the Child ID Request:
|
||||
* - Address Registration TLV
|
||||
* - Link-layer Frame Counter TLV
|
||||
* - Mode TLV
|
||||
* - Response TLV
|
||||
* - Timeout TLV
|
||||
* - TLV Request TLV
|
||||
* - Version TLV
|
||||
* - MLE Frame Counter TLV (optional)
|
||||
*/
|
||||
|
||||
nexus.AdvanceTime(kStabilizationTime);
|
||||
|
||||
VerifyOrQuit(sed1.Get<Mle::Mle>().IsAttached());
|
||||
VerifyOrQuit(sed1.Get<Mle::Mle>().IsChild());
|
||||
VerifyOrQuit(sed1.Get<Mle::Mle>().GetParent().GetExtAddress() == router1.Get<Mac::Mac>().GetExtAddress());
|
||||
|
||||
Log("---------------------------------------------------------------------------------------");
|
||||
Log("Step 6: Harness verifies connectivity by instructing the device to send an ICMPv6 Echo Request to the DUT.");
|
||||
|
||||
/**
|
||||
* Step 6: Router_1
|
||||
* - Description: Harness verifies connectivity by instructing the device to send an ICMPv6 Echo Request to the
|
||||
* DUT link local address.
|
||||
* - Pass Criteria:
|
||||
* - The DUT MUST respond with ICMPv6 Echo Reply.
|
||||
*/
|
||||
|
||||
router1.SendEchoRequest(sed1.Get<Mle::Mle>().GetLinkLocalAddress(), kEchoIdentifier);
|
||||
nexus.AdvanceTime(kStabilizationTime);
|
||||
|
||||
nexus.SaveTestInfo("test_6_1_5.json");
|
||||
}
|
||||
|
||||
} // namespace Nexus
|
||||
} // namespace ot
|
||||
|
||||
int main(void)
|
||||
{
|
||||
ot::Nexus::Test6_1_5();
|
||||
printf("All tests passed\n");
|
||||
return 0;
|
||||
}
|
||||
@@ -0,0 +1,154 @@
|
||||
#!/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
|
||||
|
||||
# ICMPv6 Echo Request identifier.
|
||||
ECHO_IDENTIFIER = 0x1234
|
||||
|
||||
|
||||
def verify(pv):
|
||||
# 6.1.5 Attaching to a Router with Better Link Quality
|
||||
#
|
||||
# 6.1.5.1 Topology
|
||||
# - Topology A: DUT as End Device (ED_1)
|
||||
# - Topology B: DUT as Sleepy End Device (SED_1)
|
||||
# - Leader
|
||||
# - Router_1
|
||||
# - Router_2
|
||||
#
|
||||
# 6.1.5.2 Purpose & Description
|
||||
# The purpose of this test case is to validate that the DUT will choose a router with better link quality as a
|
||||
# parent.
|
||||
#
|
||||
# Spec Reference | V1.1 Section | V1.3.0 Section
|
||||
# -----------------|--------------|---------------
|
||||
# Parent Selection | 4.7.2 | 4.5.2
|
||||
|
||||
pkts = pv.pkts
|
||||
pv.summary.show()
|
||||
|
||||
ROUTER_1 = pv.vars['ROUTER_1']
|
||||
SED_1 = pv.vars['SED_1']
|
||||
|
||||
# Step 1: All
|
||||
# - Description: Setup the topology without the DUT. Ensure all routers and leader are sending MLE advertisements.
|
||||
# - Pass Criteria: N/A
|
||||
print("Step 1: Setup the topology without the DUT. Ensure all routers and leader are sending MLE advertisements.")
|
||||
|
||||
# Step 2: Router_2
|
||||
# - Description: Harness configures the device to broadcast a link quality of 2 (medium).
|
||||
# - Pass Criteria: N/A
|
||||
print("Step 2: Harness configures the device to broadcast a link quality of 2 (medium).")
|
||||
|
||||
# Step 3: ED_1 / SED_1 (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 Parent Request:
|
||||
# - Challenge TLV
|
||||
# - Mode TLV
|
||||
# - Scan Mask TLV = 0x80 (active Routers)
|
||||
# - Version TLV
|
||||
print("Step 3: Automatically begins attach process by sending a multicast MLE Parent Request.")
|
||||
pkts.filter_wpan_src64(SED_1).\
|
||||
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)).\
|
||||
filter(lambda p: p.ipv6.hlim == 255).\
|
||||
filter(lambda p: p.mle.tlv.scan_mask.r == 1).\
|
||||
filter(lambda p: p.mle.tlv.scan_mask.e == 0).\
|
||||
must_next()
|
||||
|
||||
# Step 4: Router_1, Router_2
|
||||
# - Description: Both devices automatically send MLE Parent Response.
|
||||
# - Pass Criteria: N/A
|
||||
print("Step 4: Both devices automatically send MLE Parent Response.")
|
||||
|
||||
# Step 5: ED_1 / SED_1 (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.
|
||||
# - The following TLVs MUST be present in the Child ID Request:
|
||||
# - Address Registration TLV
|
||||
# - Link-layer Frame Counter TLV
|
||||
# - Mode TLV
|
||||
# - Response TLV
|
||||
# - Timeout TLV
|
||||
# - TLV Request TLV
|
||||
# - Version TLV
|
||||
# - MLE Frame Counter TLV (optional)
|
||||
print("Step 5: Automatically sends MLE Child ID Request to Router_1 due to better link quality.")
|
||||
pkts.filter_wpan_src64(SED_1).\
|
||||
filter_wpan_dst64(ROUTER_1).\
|
||||
filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\
|
||||
filter(lambda p: {
|
||||
consts.ADDRESS_REGISTRATION_TLV,
|
||||
consts.LINK_LAYER_FRAME_COUNTER_TLV,
|
||||
consts.MODE_TLV,
|
||||
consts.RESPONSE_TLV,
|
||||
consts.TIMEOUT_TLV,
|
||||
consts.TLV_REQUEST_TLV,
|
||||
consts.VERSION_TLV
|
||||
} <= set(p.mle.tlv.type)).\
|
||||
must_next()
|
||||
|
||||
# Step 6: Router_1
|
||||
# - Description: Harness verifies connectivity by instructing the device to send an ICMPv6 Echo Request to the DUT
|
||||
# link local address.
|
||||
# - Pass Criteria:
|
||||
# - The DUT MUST respond with ICMPv6 Echo Reply.
|
||||
print("Step 6: Harness verifies connectivity by instructing the device to send an ICMPv6 Echo Request to the DUT.")
|
||||
_pkt = pkts.filter_ping_request().\
|
||||
filter_wpan_src64(ROUTER_1).\
|
||||
filter_wpan_dst64(SED_1).\
|
||||
filter(lambda p: p.icmpv6.echo.identifier == ECHO_IDENTIFIER).\
|
||||
must_next()
|
||||
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
|
||||
filter_wpan_src64(SED_1).\
|
||||
filter_wpan_dst64(ROUTER_1).\
|
||||
must_next()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
verify_utils.run_main(verify)
|
||||
Reference in New Issue
Block a user