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

[nexus] add test 6.1.3 Attaching to a Router with better connectivity (#12478)

Browse Source 
This commit adds a new Nexus test case for 'Attaching to a Router
with better connectivity' (6.1.3) as specified in the test
specification.

Summary of changes:
- Implemented Nexus test 6.1.3:
    - Added tests/nexus/test_6_1_3.cpp: Sets up a topology with a
      Leader, three Routers (Router 1, 2, 3), and a DUT (ED/SED).
      Configures the AllowList so that Router 3 has better
      connectivity than Router 2. Executes the test sequence for
      both Topology A (End Device) and Topology B (Sleepy End
      Device). Sets log level to note. Refactored 'main' to reduce
      code duplication.
    - Added tests/nexus/verify_6_1_3.py: PCAP verification script.
      Validates that the DUT sends a MLE Parent Request to the
      All-Routers multicast address with required TLVs, and
      subsequently sends a unicast MLE Child ID Request to Router 3
      due to better connectivity. Also verifies ICMPv6 Echo
      Request/Reply between Router 3 and the DUT.
- Updated build and execution scripts:
    - Modified tests/nexus/CMakeLists.txt to build the new test.
    - Updated tests/nexus/run_nexus_tests.sh to include 6_1_3 in the
      default test list and added expansion logic for A/B topologies.
- Code cleanup and review fixes:
    - Refactored 'main' in test_6_1_3.cpp to improve topology and
      JSON filename handling.
    - Removed redundant include of 'mac/data_poll_sender.hpp'.
    - Fixed code style issues identified by 'make-pretty'.
This commit is contained in:
Jonathan Hui
2026-02-17 21:45:36 -06:00
committed by GitHub
parent 6c7c0dae42
commit 6962c90cad
4 changed files with 454 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/nexus/CMakeLists.txt
+1
View File
@@ -161,6 +161,7 @@ ot_nexus_test(5_8_2 "cert;nexus")
ot_nexus_test(5_8_3 "cert;nexus")
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_2_1 "cert;nexus")
# Misc tests
tests/nexus/run_nexus_tests.sh
+10 -9
View File
@@ -93,6 +93,8 @@ DEFAULT_TESTS=(
"6_1_1_B"
"6_1_2_A"
"6_1_2_B"
"6_1_3_A"
"6_1_3_B"
"6_2_1_A"
"6_2_1_B"
)
@@ -185,15 +187,14 @@ run_test()
expanded_tests=()
for t in "${TESTS_TO_RUN[@]}"; do
if [[ $t == "6_1_1" ]]; then
expanded_tests+=("6_1_1_A" "6_1_1_B")
elif [[ $t == "6_1_2" ]]; then
expanded_tests+=("6_1_2_A" "6_1_2_B")
elif [[ $t == "6_2_1" ]]; then
expanded_tests+=("6_2_1_A" "6_2_1_B")
else
expanded_tests+=("$t")
fi
case "$t" in
6_1_1 | 6_1_2 | 6_1_3 | 6_2_1)
expanded_tests+=("${t}_A" "${t}_B")
;;
*)
expanded_tests+=("$t")
;;
esac
done
for t in "${expanded_tests[@]}"; do
tests/nexus/test_6_1_3.cpp
+283
View File
@@ -0,0 +1,283 @@
/*
* 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 <string.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;
/**
* Data poll period for SED, in milliseconds.
*/
static constexpr uint32_t kPollPeriod = 500;
enum Topology
{
kTopologyA,
kTopologyB,
};
void RunTest6_1_3(Topology aTopology, const char *aJsonFile)
{
/**
* 6.1.3 Attaching to a Router with better connectivity
*
* 6.1.3.1 Topology
* - Ensure link quality between all nodes is set to 3.
* - Leader
* - Router_1
* - Router_2
* - Router_3
* - DUT as ED_1 (Topology A) or SED_1 (Topology B)
*
* 6.1.3.2 Purpose & Description
* The purpose of this test case is to verify that the DUT chooses to attach to a Router with better
* connectivity.
*
* Spec Reference | V1.1 Section | V1.3.0 Section
* ----------------------|--------------|---------------
* Attaching to a Parent | 4.7.1 | 4.5.1
*/
Core nexus;
Node &leader = nexus.CreateNode();
Node &router1 = nexus.CreateNode();
Node &router2 = nexus.CreateNode();
Node &router3 = nexus.CreateNode();
Node &dut = nexus.CreateNode();
leader.SetName("LEADER");
router1.SetName("ROUTER_1");
router2.SetName("ROUTER_2");
router3.SetName("ROUTER_3");
if (aTopology == kTopologyA)
{
dut.SetName("ED_1");
}
else
{
dut.SetName("SED_1");
}
nexus.AdvanceTime(0);
Instance::SetLogLevel(kLogLevelNote);
Log("---------------------------------------------------------------------------------------");
if (aTopology == kTopologyA)
{
Log("Topology A: ED_1 (DUT)");
}
else
{
Log("Topology B: SED_1 (DUT)");
}
Log("---------------------------------------------------------------------------------------");
Log("Step 1: Leader, Router_1, _2, _3");
/**
* Step 1: Leader, Router_1, _2, _3
* - 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(router2);
leader.AllowList(router3);
router1.AllowList(leader);
router1.AllowList(router3);
router2.AllowList(leader);
router2.AllowList(dut);
router3.AllowList(leader);
router3.AllowList(router1);
router3.AllowList(dut);
dut.AllowList(router2);
dut.AllowList(router3);
leader.Form();
nexus.AdvanceTime(kFormNetworkTime);
VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());
router1.Join(leader);
router2.Join(leader);
router3.Join(leader);
nexus.AdvanceTime(kAttachToRouterTime);
VerifyOrQuit(router1.Get<Mle::Mle>().IsRouter());
VerifyOrQuit(router2.Get<Mle::Mle>().IsRouter());
VerifyOrQuit(router3.Get<Mle::Mle>().IsRouter());
nexus.AdvanceTime(kStabilizationTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 2: ED_1 / SED_1 (DUT)");
/**
* Step 2: 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
*/
if (aTopology == kTopologyA)
{
dut.Join(leader, Node::kAsMed);
}
else
{
dut.Join(leader, Node::kAsSed);
SuccessOrQuit(dut.Get<DataPollSender>().SetExternalPollPeriod(kPollPeriod));
}
Log("---------------------------------------------------------------------------------------");
Log("Step 3: Router_2, Router_3");
/**
* Step 3: Router_2, Router_3
* - Description: Automatically responds with MLE Parent Response.
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kParentSelectionTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 4: ED_1 / SED_1 (DUT)");
/**
* Step 4: ED_1 / SED_1 (DUT)
* - Description: Automatically sends MLE Child ID Request to Router_3 due to better connectivity.
* - Pass Criteria:
* - The DUT MUST unicast MLE Child ID Request to Router_3.
* - 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(dut.Get<Mle::Mle>().IsChild());
VerifyOrQuit(dut.Get<Mle::Mle>().GetParent().GetExtAddress() == router3.Get<Mac::Mac>().GetExtAddress());
Log("---------------------------------------------------------------------------------------");
Log("Step 5: Router_3");
/**
* Step 5: Router_3
* - Description: Harness verifies connectivity by instructing device to send an ICMPv6 Echo Request to the
* DUT link local address.
* - Pass Criteria:
* - The DUT MUST respond with ICMPv6 Echo Reply.
*/
nexus.SendAndVerifyEchoRequest(router3, dut.Get<Mle::Mle>().GetLinkLocalAddress());
nexus.SaveTestInfo(aJsonFile);
}
} // namespace Nexus
} // namespace ot
int main(int argc, char *argv[])
{
if (argc < 2)
{
ot::Nexus::RunTest6_1_3(ot::Nexus::kTopologyA, "test_6_1_3_A.json");
ot::Nexus::RunTest6_1_3(ot::Nexus::kTopologyB, "test_6_1_3_B.json");
}
else
{
ot::Nexus::Topology topology;
const char *defaultJsonFile;
if (strcmp(argv[1], "A") == 0)
{
topology = ot::Nexus::kTopologyA;
defaultJsonFile = "test_6_1_3_A.json";
}
else if (strcmp(argv[1], "B") == 0)
{
topology = ot::Nexus::kTopologyB;
defaultJsonFile = "test_6_1_3_B.json";
}
else
{
fprintf(stderr, "Error: Invalid topology '%s'. Must be 'A' or 'B'.\n", argv[1]);
return 1;
}
ot::Nexus::RunTest6_1_3(topology, (argc > 2) ? argv[2] : defaultJsonFile);
}
printf("All tests passed\n");
return 0;
}
tests/nexus/verify_6_1_3.py
+160
View File
@@ -0,0 +1,160 @@
#!/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
def verify(pv):
# 6.1.3 Attaching to a Router with better connectivity
#
# 6.1.3.1 Topology
# - Ensure link quality between all nodes is set to 3.
# - Leader
# - Router_1
# - Router_2
# - Router_3
# - DUT as ED_1 (Topology A) or SED_1 (Topology B)
#
# 6.1.3.2 Purpose & Description
# The purpose of this test case is to verify that the DUT chooses to attach to a Router with better
# connectivity.
#
# Spec Reference | V1.1 Section | V1.3.0 Section
# ----------------------|--------------|---------------
# Attaching to a Parent | 4.7.1 | 4.5.1
pkts = pv.pkts
pv.summary.show()
LEADER = pv.vars['LEADER']
ROUTER_1 = pv.vars['ROUTER_1']
ROUTER_2 = pv.vars['ROUTER_2']
ROUTER_3 = pv.vars['ROUTER_3']
DUT = pv.vars.get('ED_1') or pv.vars.get('SED_1')
# Step 1: Leader, Router_1, _2, _3
# - Description: Setup the topology without the DUT. Ensure all routers and leader are sending MLE
# advertisements.
# - Pass Criteria: N/A
print("Step 1: Leader, Router_1, _2, _3")
for node in [LEADER, ROUTER_1, ROUTER_2, ROUTER_3]:
pkts.copy().\
filter_wpan_src64(node).\
filter_mle_cmd(consts.MLE_ADVERTISEMENT).\
must_next()
# Step 2: 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 2: ED_1 / SED_1 (DUT)")
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 3: Router_2, Router_3
# - Description: Automatically responds with MLE Parent Response.
# - Pass Criteria: N/A
print("Step 3: Router_2, Router_3")
for router in [ROUTER_2, ROUTER_3]:
pkts.copy().\
filter_wpan_src64(router).\
filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\
must_next()
# Step 4: ED_1 / SED_1 (DUT)
# - Description: Automatically sends MLE Child ID Request to Router_3 due to better connectivity.
# - Pass Criteria:
# - The DUT MUST unicast MLE Child ID Request to Router_3.
# - 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 4: ED_1 / SED_1 (DUT)")
pkts.filter_wpan_src64(DUT).\
filter_wpan_dst64(ROUTER_3).\
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 5: Router_3
# - Description: Harness verifies connectivity by instructing 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 5: Router_3")
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(ROUTER_3).\
filter_wpan_dst64(DUT).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(DUT).\
filter_wpan_dst64(ROUTER_3).\
must_next()
if __name__ == '__main__':
verify_utils.run_main(verify)