espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-19 00:49:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

[nexus] add test 5.1.6 Leader removes Router ID (#12374)

Browse Source 
Adds a new Nexus test case for 'Leader removes Router ID' (5.1.6) as
specified in the test specification.

Summary of changes:
- Implemented Nexus test 5.1.6:
    - Added test_5_1_6.cpp: Sets up a Leader and Router_1 (DUT) topology.
      Verifies that when the Leader de-allocates a Router ID, the DUT
      automatically re-attaches.
    - Added verify_5_1_6.py: PCAP verification script for test 5.1.6,
      ensuring that MLE Parent Request, MLE Child ID Request, and
      Address Solicit Request messages follow the specification.
- Updated build and execution scripts:
    - Modified CMakeLists.txt to build the new 5.1.6 test executable.
    - Updated run_nexus_tests.sh to include 5.1.6 in the default test list.
This commit is contained in:
Jonathan Hui
2026-02-05 21:57:46 -08:00
committed by GitHub
parent a393e510cd
commit c815ca4ca3
4 changed files with 377 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/nexus/CMakeLists.txt
+1
View File
@@ -118,6 +118,7 @@ ot_nexus_test(5_1_2)
ot_nexus_test(5_1_3)
ot_nexus_test(5_1_4)
ot_nexus_test(5_1_5)
ot_nexus_test(5_1_6)
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
@@ -53,6 +53,7 @@ DEFAULT_TESTS=(
"5_1_3"
"5_1_4"
"5_1_5"
"5_1_6"
)
# Use provided arguments or the default test list
tests/nexus/test_5_1_6.cpp
+207
View File
@@ -0,0 +1,207 @@
/*
* 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 <stdarg.h>
#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.
*/
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 wait for ICMPv6 Echo Response.
*/
static constexpr uint32_t kEchoResponseTime = 1000;
/**
* ICMPv6 Echo Request identifier.
*/
static constexpr uint16_t kEchoIdentifier = 0x1234;
/**
* ICMPv6 Hop Limit.
*/
static constexpr uint8_t kHopLimit = 64;
static void HandleEchoReply(void *aContext,
otMessage *aMessage,
const otMessageInfo *aMessageInfo,
const otIcmp6Header *aIcmpHeader)
{
OT_UNUSED_VARIABLE(aMessage);
OT_UNUSED_VARIABLE(aMessageInfo);
if (aIcmpHeader->mType == OT_ICMP6_TYPE_ECHO_REPLY)
{
*static_cast<bool *>(aContext) = true;
}
}
static void SendAndVerifyEchoRequest(Core &aNexus, Node &aSender, Node &aReceiver, bool &aReceivedEchoReply)
{
Message *message = aSender.Get<Ip6::Icmp>().NewMessage();
Ip6::MessageInfo messageInfo;
VerifyOrQuit(message != nullptr);
messageInfo.SetPeerAddr(aReceiver.Get<Mle::Mle>().GetLinkLocalAddress());
messageInfo.SetHopLimit(kHopLimit);
aReceivedEchoReply = false;
SuccessOrQuit(aSender.Get<Ip6::Icmp>().SendEchoRequest(*message, messageInfo, kEchoIdentifier));
aNexus.AdvanceTime(kEchoResponseTime);
VerifyOrQuit(aReceivedEchoReply, "Echo Reply not received");
}
void Test5_1_6(void)
{
/**
* 5.1.6 Leader removes Router ID
*
* 5.1.6.1 Topology
* - Leader
* - Router_1 (DUT)
*
* 5.1.6.2 Purpose & Description
* The purpose of this test case is to verify that when the Leader de-allocates a Router ID, the DUT, as a
* router, re-attaches.
*
* Spec Reference | V1.1 Section | V1.3.0 Section
* ---------------------------------------------|--------------|---------------
* Router ID Management / Router ID Assignment | 5.16.1 | 5.16.1
*/
Core nexus;
Node &leader = nexus.CreateNode();
Node &router = nexus.CreateNode();
leader.SetName("LEADER");
router.SetName("ROUTER");
// Use AllowList feature to restrict the topology
leader.AllowList(router);
router.AllowList(leader);
nexus.AdvanceTime(0);
Instance::SetLogLevel(kLogLevelInfo);
Log("---------------------------------------------------------------------------------------");
Log("Step 0: Verify topology is formed correctly");
/**
* Step 0: All
* - Description: Verify topology is formed correctly
* - Pass Criteria: N/A
*/
leader.Form();
nexus.AdvanceTime(kFormNetworkTime);
VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());
router.Join(leader);
nexus.AdvanceTime(kAttachToRouterTime);
VerifyOrQuit(router.Get<Mle::Mle>().IsRouter());
Log("---------------------------------------------------------------------------------------");
Log("Step 1: Harness instructs the Leader to send a ' helper ping' (ICMPv6 Echo Request) to the DUT");
/**
* Step 1: Leader
* - Description: Harness instructs the Leader to send a ' helper ping' (ICMPv6 Echo Request) to the DUT
* - Pass Criteria:
* - The DUT MUST respond with an ICMPv6 Echo Reply
*/
bool leaderReceivedEchoReply = false;
Ip6::Icmp::Handler leaderIcmpHandler(HandleEchoReply, &leaderReceivedEchoReply);
SuccessOrQuit(leader.Get<Ip6::Icmp>().RegisterHandler(leaderIcmpHandler));
SendAndVerifyEchoRequest(nexus, leader, router, leaderReceivedEchoReply);
Log("---------------------------------------------------------------------------------------");
Log("Step 2: Harness instructs the Leader to remove the Router ID of Router_1 (the DUT)");
/**
* Step 2: Leader
* - Description: Harness instructs the Leader to remove the Router ID of Router_1 (the DUT)
* - Pass Criteria: N/A
*/
uint8_t routerId = Mle::RouterIdFromRloc16(router.Get<Mle::Mle>().GetRloc16());
SuccessOrQuit(leader.Get<RouterTable>().Release(routerId));
Log("---------------------------------------------------------------------------------------");
Log("Step 3: Automatically re-attaches once it recognizes its Router ID has been removed.");
/**
* Step 3: Router_1 (DUT)
* - Description: Automatically re-attaches once it recognizes its Router ID has been removed.
* - Pass Criteria:
* - The DUT MUST send a properly formatted MLE Parent Request, MLE Child ID Request, and Address Solicit
* Request messages to the Leader. (See 5.1.1 for formatting)
*/
nexus.AdvanceTime(kAttachToRouterTime);
VerifyOrQuit(router.Get<Mle::Mle>().IsRouter());
Log("---------------------------------------------------------------------------------------");
Log("Step 4: Harness verifies connectivity by instructing the Leader to send an ICMPv6 Echo Request to the DUT");
/**
* Step 4: Leader
* - Description: Harness verifies connectivity by instructing the Leader to send an ICMPv6 Echo Request to
* the DUT
* - Pass Criteria:
* - The DUT MUST respond with an ICMPv6 Echo Reply
*/
SendAndVerifyEchoRequest(nexus, leader, router, leaderReceivedEchoReply);
nexus.SaveTestInfo("test_5_1_6.json");
}
} // namespace Nexus
} // namespace ot
int main(void)
{
ot::Nexus::Test5_1_6();
printf("All tests passed\n");
return 0;
}
tests/nexus/verify_5_1_6.py
Executable
+168
View File
@@ -0,0 +1,168 @@
#!/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.6 Leader removes Router ID
#
# 5.1.6.1 Topology
# - Leader
# - Router_1 (DUT)
#
# 5.1.6.2 Purpose & Description
# The purpose of this test case is to verify that when the Leader de-allocates a Router ID, the DUT, as a
# router, re-attaches.
#
# Spec Reference | V1.1 Section | V1.3.0 Section
# ---------------------------------------------|--------------|---------------
# Router ID Management / Router ID Assignment | 5.16.1 | 5.16.1
pkts = pv.pkts
pv.summary.show()
LEADER = pv.vars['LEADER']
LEADER_RLOC16 = pv.vars['LEADER_RLOC16']
ROUTER = pv.vars['ROUTER']
# Step 0: All
# - Description: Verify topology is formed correctly
# - Pass Criteria: N/A
print("Step 0: Verify topology is formed correctly")
pv.verify_attached('ROUTER')
pkts.copy().filter_wpan_src64(LEADER).\
filter_coap_ack(consts.ADDR_SOL_URI).\
filter(lambda p: {
consts.NL_STATUS_TLV,
consts.NL_RLOC16_TLV,
consts.NL_ROUTER_MASK_TLV
} <= set(p.coap.tlv.type) and\
p.coap.code == consts.COAP_CODE_ACK and\
p.coap.tlv.status == 0
).\
must_next()
# Step 1: Leader
# - Description: Harness instructs the Leader to send a ' helper ping' (ICMPv6 Echo Request) to the DUT
# - Pass Criteria:
# - The DUT MUST respond with an ICMPv6 Echo Reply
print("Step 1: Leader sends a ' helper ping' (ICMPv6 Echo Request) to the DUT")
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(LEADER).\
filter_wpan_dst64(ROUTER).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(ROUTER).\
filter_wpan_dst64(LEADER).\
must_next()
# Step 2: Leader
# - Description: Harness instructs the Leader to remove the Router ID of Router_1 (the DUT)
# - Pass Criteria: N/A
print("Step 2: Leader removes the Router ID of Router_1 (the DUT)")
# Step 3: Router_1 (DUT)
# - Description: Automatically re-attaches once it recognizes its Router ID has been removed.
# - Pass Criteria:
# - The DUT MUST send a properly formatted MLE Parent Request, MLE Child ID Request, and Address Solicit
# Request messages to the Leader. (See 5.1.1 for formatting)
print("Step 3: Router_1 (DUT) automatically re-attaches")
# MLE Parent Request
pkts.filter_wpan_src64(ROUTER).\
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()
# MLE Child ID Request
_pkt = pkts.filter_wpan_src64(ROUTER).\
filter_wpan_dst64(LEADER).\
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.ADDRESS16_TLV,
consts.NETWORK_DATA_TLV,
consts.VERSION_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)
# Address Solicit Request
pkts.filter_wpan_src64(ROUTER).\
filter_wpan_dst16(LEADER_RLOC16).\
filter_coap_request(consts.ADDR_SOL_URI).\
filter(lambda p: {
consts.NL_MAC_EXTENDED_ADDRESS_TLV,
consts.NL_STATUS_TLV
} <= set(p.coap.tlv.type)
).\
must_next()
# Step 4: Leader
# - Description: Harness verifies connectivity by instructing the Leader to send an ICMPv6 Echo Request to the DUT
# - Pass Criteria:
# - The DUT MUST respond with an ICMPv6 Echo Reply
print("Step 4: Leader sends an ICMPv6 Echo Request to the DUT")
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(LEADER).\
filter_wpan_dst64(ROUTER).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(ROUTER).\
filter_wpan_dst64(LEADER).\
must_next()
if __name__ == '__main__':
verify_utils.run_main(verify)