espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-16 15:47:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[nexus] add test 6.3.1 Orphan Reattach (#12471)

Browse Source 
This commit adds a new Nexus test case for 'Orphan Reattach' (6.3.1)
as specified in the Thread Test Specification.

The test validates that the DUT (ED or SED) will correctly detach
and re-attach to the Leader after its parent (Router_1) is silently
removed from the network.

Summary of changes:
- tests/nexus/test_6_3_1.cpp: Implements the test logic.
    - Sets up a network with Leader, Router_1, and DUT.
    - Initially attaches DUT to Router_1.
    - Silently stops Router_1 to simulate parent loss.
    - Advances time to allow the DUT to detect the loss and re-attach
      to the Leader.
    - Verifies connectivity via ICMPv6 Echo between Leader and DUT.
- tests/nexus/verify_6_3_1.py: Python PCAP verification script.
    - Validates optional Child Update Request or Data Request
      messages sent during the detachment phase.
    - Exhaustively verifies the MLE attach sequence (Parent Request,
      Parent Response, Child ID Request, Child ID Response) with the
      new parent (Leader).
    - Verifies the final ICMPv6 Echo Request/Reply exchange.
- tests/nexus/CMakeLists.txt: Integrated the new test into the build
  system.
- tests/nexus/run_nexus_tests.sh: Added 6_3_1_A and 6_3_1_B to the
  default test list.
This commit is contained in:
Jonathan Hui
2026-02-18 12:36:41 -06:00
committed by GitHub
parent 4888911cd5
commit ab0c978ab3
4 changed files with 460 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/nexus/CMakeLists.txt
+1
View File
@@ -167,6 +167,7 @@ ot_nexus_test(6_1_3 "cert;nexus")
ot_nexus_test(6_1_4 "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")
ot_nexus_test(6_4_1 "cert;nexus")
# Misc tests
tests/nexus/run_nexus_tests.sh
+3 -1
View File
@@ -101,6 +101,8 @@ DEFAULT_TESTS=(
"6_2_1_A"
"6_2_1_B"
"6_2_2"
"6_3_1_A"
"6_3_1_B"
"6_4_1_A"
"6_4_1_B"
)
@@ -194,7 +196,7 @@ run_test()
expanded_tests=()
for t in "${TESTS_TO_RUN[@]}"; do
case "$t" in
6_1_1 | 6_1_2 | 6_1_3 | 6_2_1 | 6_2_2 | 6_4_1)
6_1_1 | 6_1_2 | 6_1_3 | 6_2_1 | 6_2_2 | 6_3_1 | 6_4_1)
expanded_tests+=("${t}_A" "${t}_B")
;;
*)
tests/nexus/test_6_3_1.cpp
+300
View File
@@ -0,0 +1,300 @@
/*
* 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 "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 attach to a parent, in milliseconds.
*/
static constexpr uint32_t kAttachTime = 20 * 1000;
/**
* Time to wait for ICMPv6 Echo response, in milliseconds.
*/
static constexpr uint32_t kEchoTimeout = 5000;
/**
* Data poll period for SED, in milliseconds.
*/
static constexpr uint32_t kPollPeriod = 1000;
/**
* Child timeout for DUT, in milliseconds.
*/
static constexpr uint32_t kChildTimeout = 4000;
/**
* Time to wait for the DUT to detect its parent is gone, in milliseconds.
*/
static constexpr uint32_t kDetectParentLossTime = 100 * 1000;
/**
* ICMPv6 Echo hop limit.
*/
static constexpr uint8_t kEchoHopLimit = 64;
/**
* ICMPv6 Echo identifier for the nudge ping.
*/
static constexpr uint16_t kNudgeEchoIdentifier = 0x1234;
enum Topology
{
kTopologyA,
kTopologyB,
};
void RunTest6_3_1(Topology aTopology, const char *aJsonFile)
{
/**
* 6.3.1 Orphan Reattach
*
* 6.3.1.1 Topology
* - Topology A: DUT as End Device (ED_1)
* - Topology B: DUT as Sleepy End Device (SED_1)
* - Leader
* - Router_1
*
* 6.3.1.2 Purpose & Description
* The purpose of this test case is to show that the DUT will attach to the Leader once its parent is removed from
* the network.
*
* Spec Reference | V1.1 Section | V1.3.0 Section
* ----------------------|--------------|---------------
* Child Update Messages | 4.7.3 | 4.6.1
*/
Core nexus;
Node &leader = nexus.CreateNode();
Node &router1 = nexus.CreateNode();
Node &dut = nexus.CreateNode();
leader.SetName("LEADER");
router1.SetName("ROUTER_1");
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: All");
/**
* Step 1: All
* - Description: Setup the topology without the DUT. Ensure all routers and leader are sending MLE advertisements.
* - Pass Criteria: N/A
*/
leader.AllowList(router1);
router1.AllowList(leader);
router1.AllowList(dut);
dut.AllowList(router1);
leader.Form();
nexus.AdvanceTime(kFormNetworkTime);
VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());
router1.Join(leader);
nexus.AdvanceTime(kAttachToRouterTime);
VerifyOrQuit(router1.Get<Mle::Mle>().IsRouter());
if (aTopology == kTopologyA)
{
dut.Join(router1, Node::kAsMed);
}
else
{
dut.Join(router1, Node::kAsSed);
SuccessOrQuit(dut.Get<DataPollSender>().SetExternalPollPeriod(kPollPeriod));
}
dut.Get<Mle::Mle>().SetTimeout(kChildTimeout);
nexus.AdvanceTime(kAttachTime);
VerifyOrQuit(dut.Get<Mle::Mle>().IsChild());
VerifyOrQuit(dut.Get<Mle::Mle>().GetParent().GetExtAddress() == router1.Get<Mac::Mac>().GetExtAddress());
Log("---------------------------------------------------------------------------------------");
Log("Step 2: Router_1");
/**
* Step 2: Router_1
* - Description: Harness silently removes Router_1 from the network.
* - Pass Criteria: N/A
*/
router1.Get<Mle::Mle>().Stop();
router1.Get<ThreadNetif>().Down();
if (aTopology == kTopologyA)
{
Log("---------------------------------------------------------------------------------------");
Log("Step 3: ED_1 (DUT) [Topology A only]");
/**
* Step 3: ED_1 (DUT) [Topology A only]
* - Description: Automatically sends MLE Child Update Request keep-alive message(s) to its parent. [Optional]
* The DUT SHOULD send MLE Child Update Requests [FAILED_CHILD_TRANSMISSIONS-1] to its parent (Router_1).
* - Pass Criteria:
* - The following TLVs MUST be included in each MLE Child Update Request:
* - Source Address TLV
* - Leader Data TLV
* - Mode TLV
* - Address Registration TLVs (optional)
*/
/** We advance time to let the periodic keep-alive happen. */
nexus.AdvanceTime(kChildTimeout);
/** Send multiple pings to parent to trigger parent loss detection. */
for (int i = 0; i < 5; i++)
{
dut.SendEchoRequest(router1.Get<Mle::Mle>().GetLinkLocalAddress(), kNudgeEchoIdentifier);
nexus.AdvanceTime(1000);
}
}
else
{
Log("---------------------------------------------------------------------------------------");
Log("Step 4: SED_1 (DUT) [Topology B only]");
/**
* Step 4: SED_1 (DUT) [Topology B only]
* - Description: Automatically sends 802.15.4 Data Request keep-alive message(s) to its parent. [Optional] The
* DUT SHOULD send 802.15.4 Data Request commands [FAILED_CHILD_TRANSMISSIONS-1] to its parent (Router_1).
* - Pass Criteria:
* - The DUT MUST NOT receive an ACK message in response.
*/
}
leader.AllowList(dut);
dut.AllowList(leader);
nexus.AdvanceTime(kDetectParentLossTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 5: ED_1 / SED_1 (DUT)");
/**
* Step 5: ED_1 / SED_1 (DUT)
* - Description: Automatically attaches to the Leader.
* - Pass Criteria:
* - The DUT MUST perform the attach procedure with the Leader (see section 6.1.1 Attaching to a Router).
*/
for (uint32_t i = 0; i < 60; i++)
{
nexus.AdvanceTime(1000);
if (dut.Get<Mle::Mle>().IsAttached() &&
dut.Get<Mle::Mle>().GetParent().GetExtAddress() == leader.Get<Mac::Mac>().GetExtAddress())
{
break;
}
}
VerifyOrQuit(dut.Get<Mle::Mle>().IsAttached());
VerifyOrQuit(dut.Get<Mle::Mle>().GetParent().GetExtAddress() == leader.Get<Mac::Mac>().GetExtAddress());
Log("---------------------------------------------------------------------------------------");
Log("Step 6: Leader");
/**
* Step 6: Leader
* - 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.
*/
nexus.SendAndVerifyEchoRequest(leader, dut.Get<Mle::Mle>().GetLinkLocalAddress(), 0, kEchoHopLimit, kEchoTimeout);
nexus.SaveTestInfo(aJsonFile);
}
} // namespace Nexus
} // namespace ot
int main(int argc, char *argv[])
{
if (argc < 2)
{
ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyA, "test_6_3_1_A.json");
ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyB, "test_6_3_1_B.json");
}
else if (strcmp(argv[1], "A") == 0)
{
ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyA, (argc > 2) ? argv[2] : "test_6_3_1_A.json");
}
else if (strcmp(argv[1], "B") == 0)
{
ot::Nexus::RunTest6_3_1(ot::Nexus::kTopologyB, (argc > 2) ? argv[2] : "test_6_3_1_B.json");
}
else
{
fprintf(stderr, "Error: Invalid topology '%s'. Must be 'A' or 'B'.\n", argv[1]);
return 1;
}
printf("All tests passed\n");
return 0;
}
tests/nexus/verify_6_3_1.py
+156
View File
@@ -0,0 +1,156 @@
#!/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.3.1 Orphan Reattach
#
# 6.3.1.1 Topology
# Topology A: DUT as End Device (ED_1)
# Topology B: DUT as Sleepy End Device (SED_1)
# Leader
# Router_1
#
# 6.3.1.2 Purpose & Description
# The purpose of this test case is to show that the DUT will attach to the Leader once its parent is removed from
# the network.
#
# Spec Reference | V1.1 Section | V1.3.0 Section
# ----------------------|--------------|---------------
# Child Update Messages | 4.7.3 | 4.6.1
pkts = pv.pkts
pv.summary.show()
LEADER = pv.vars['LEADER']
ROUTER_1 = pv.vars['ROUTER_1']
IS_TOPOLOGY_A = 'ED_1' in pv.vars
if IS_TOPOLOGY_A:
DUT = pv.vars['ED_1']
else:
DUT = 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.")
# Step 2: Router_1
# Description: Harness silently removes Router_1 from the network.
# Pass Criteria: N/A
print("Step 2: Harness silently removes Router_1 from the network.")
if IS_TOPOLOGY_A:
# Step 3: ED_1 (DUT) [Topology A only]
# Description: Automatically sends MLE Child Update Request keep-alive message(s) to its parent. [Optional]
# The DUT SHOULD send MLE Child Update Requests [FAILED_CHILD_TRANSMISSIONS-1] to its parent (Router_1).
# Pass Criteria:
# The following TLVs MUST be included in each MLE Child Update Request:
# Source Address TLV
# Leader Data TLV
# Mode TLV
# Address Registration TLVs (optional)
print("Step 3: ED_1 (DUT) sends MLE Child Update Request keep-alive message(s) to its parent. [Optional]")
# We try to find the packet, but don't fail if it's not there as it is optional.
_pkt = pkts.filter_wpan_src64(DUT).\
filter_mle_cmd(consts.MLE_CHILD_UPDATE_REQUEST).\
next()
if _pkt:
_pkt.filter(lambda p: {
consts.SOURCE_ADDRESS_TLV,
consts.LEADER_DATA_TLV,
consts.MODE_TLV
} <= set(p.mle.tlv.type)).\
must_verify()
else:
# Step 4: SED_1 (DUT) [Topology B only]
# Description: Automatically sends 802.15.4 Data Request keep-alive message(s) to its parent. [Optional] The
# DUT SHOULD send 802.15.4 Data Request commands [FAILED_CHILD_TRANSMISSIONS-1] to its parent (Router_1).
# Pass Criteria:
# The DUT MUST NOT receive an ACK message in response.
print("Step 4: SED_1 (DUT) sends 802.15.4 Data Request keep-alive message(s) to its parent. [Optional]")
pkts.filter_wpan_src64(DUT).\
filter(lambda p: p.wpan.cmd == consts.WPAN_DATA_REQUEST).\
next()
# Step 5: ED_1 / SED_1 (DUT)
# Description: Automatically attaches to the Leader.
# Pass Criteria:
# The DUT MUST perform the attach procedure with the Leader (see section 6.1.1 Attaching to a Router).
print("Step 5: Automatically attaches to the Leader.")
# Parent Request
pkts.filter_wpan_src64(DUT).\
filter_LLARMA().\
filter_mle_cmd(consts.MLE_PARENT_REQUEST).\
must_next()
# Parent Response from Leader
pkts.filter_wpan_src64(LEADER).\
filter_wpan_dst64(DUT).\
filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\
must_next()
# Child ID Request
pkts.filter_wpan_src64(DUT).\
filter_wpan_dst64(LEADER).\
filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\
must_next()
# Child ID Response
pkts.filter_wpan_src64(LEADER).\
filter_wpan_dst64(DUT).\
filter_mle_cmd(consts.MLE_CHILD_ID_RESPONSE).\
must_next()
# Step 6: Leader
# 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: Leader verifies connectivity by sending an ICMPv6 Echo Request.")
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(LEADER).\
filter_wpan_dst64(DUT).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(DUT).\
filter_wpan_dst64(LEADER).\
must_next()
if __name__ == '__main__':
verify_utils.run_main(verify)