From baa3df86b42b1ee711ea476fc22010f0d1b10a4d Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Tue, 10 Feb 2026 20:34:40 -0600 Subject: [PATCH] =?UTF-8?q?[nexus]=20add=20test=20case=205.2.5=20Address?= =?UTF-8?q?=20Query=20=E2=80=93=20REED=20(#12396)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit adds a new Nexus test case 5.2.5 which validates that a Router Eligible End Device (REED) correctly generates Address Notification messages in response to Address Query messages. The test implementation includes: - test_5_2_5.cpp: Sets up a 16-router topology using AllowList constraints and executes the test procedure. - verify_5_2_5.py: Verifies the resulting pcap to ensure correct Address Notification format (Target EID, RLOC16, and ML-EID TLVs) and Echo Reply sequence. Summary of changes: - Added tests/nexus/test_5_2_5.cpp and tests/nexus/verify_5_2_5.py. - Updated tests/nexus/CMakeLists.txt to include the new test. - Updated tests/nexus/run_nexus_tests.sh to add 5_2_5 to default tests. - Enabled OPENTHREAD_CONFIG_DHCP6_CLIENT_ENABLE and OPENTHREAD_CONFIG_DHCP6_SERVER_ENABLE in tests/nexus/openthread-core-nexus-config.h to support DHCPv6 prefixes used in the test. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/openthread-core-nexus-config.h | 2 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_5_2_5.cpp | 321 +++++++++++++++++++++ tests/nexus/verify_5_2_5.py | 159 ++++++++++ 5 files changed, 484 insertions(+) create mode 100644 tests/nexus/test_5_2_5.cpp create mode 100644 tests/nexus/verify_5_2_5.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 20e6122ba..08096787f 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -132,6 +132,7 @@ ot_nexus_test(5_1_13 "cert;nexus") ot_nexus_test(5_2_1 "cert;nexus") ot_nexus_test(5_2_3 "cert;nexus") ot_nexus_test(5_2_4 "cert;nexus") +ot_nexus_test(5_2_5 "cert;nexus") # Misc tests ot_nexus_test(border_admitter "core;nexus") diff --git a/tests/nexus/openthread-core-nexus-config.h b/tests/nexus/openthread-core-nexus-config.h index 754d6113b..fcc2b42d5 100644 --- a/tests/nexus/openthread-core-nexus-config.h +++ b/tests/nexus/openthread-core-nexus-config.h @@ -64,6 +64,8 @@ #define OPENTHREAD_CONFIG_COMMISSIONER_MAX_JOINER_ENTRIES 4 #define OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE 1 #define OPENTHREAD_CONFIG_DELAY_AWARE_QUEUE_MANAGEMENT_ENABLE 1 +#define OPENTHREAD_CONFIG_DHCP6_CLIENT_ENABLE 1 +#define OPENTHREAD_CONFIG_DHCP6_SERVER_ENABLE 1 #define OPENTHREAD_CONFIG_DIAG_ENABLE 0 #define OPENTHREAD_CONFIG_DNS_CLIENT_ENABLE 1 #define OPENTHREAD_CONFIG_DNS_DSO_ENABLE 0 diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index 038f94539..69c473dbf 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -64,6 +64,7 @@ DEFAULT_TESTS=( "5_2_1" "5_2_3" "5_2_4" + "5_2_5" ) # Use provided arguments or the default test list diff --git a/tests/nexus/test_5_2_5.cpp b/tests/nexus/test_5_2_5.cpp new file mode 100644 index 000000000..7a06dcd2f --- /dev/null +++ b/tests/nexus/test_5_2_5.cpp @@ -0,0 +1,321 @@ +/* + * 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 +#include + +#include "platform/nexus_core.hpp" +#include "platform/nexus_node.hpp" +#include "thread/network_data_local.hpp" +#include "thread/network_data_notifier.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. + */ +static constexpr uint32_t kAttachToRouterTime = 200 * 1000; + +/** + * Time to advance for a node to join as a child. + */ +static constexpr uint32_t kAttachAsChildTime = 5 * 1000; + +/** + * Time to wait for ICMPv6 Echo response. + */ +static constexpr uint32_t kEchoResponseTime = 5000; + +/** + * Number of routers in the topology. + */ +static constexpr uint16_t kRouterCount = 14; + +static Ip6::Address GetUnicastAddress(Node &aNode, const char *aPrefixString) +{ + Ip6::Prefix prefix; + Ip6::Address address; + bool found = false; + + SuccessOrQuit(prefix.FromString(aPrefixString)); + + for (const Ip6::Netif::UnicastAddress &addr : aNode.Get().GetUnicastAddresses()) + { + if (addr.GetAddress().MatchesPrefix(prefix)) + { + address = addr.GetAddress(); + found = true; + break; + } + } + + VerifyOrQuit(found, "did not get unicast address with prefix"); + + return address; +} + +void Test5_2_5(void) +{ + /** + * 5.2.5 Address Query - REED + * + * 5.2.5.1 Topology + * - Build a topology that has a total of 16 active routers, including the Leader, with no communication + * constraints. + * - The Leader is configured as a DHCPv6 server for prefix 2001:: + * - The Border Router is configured as a SLAAC server for prefix 2002:: + * - Each router numbered 1 through 14 have a link to leader + * - MED_1 has a link to the leader + * - Border Router has a link to the leader + * - REED_1 has a link to router 1 + * + * 5.2.5.2 Purpose & Description + * The purpose of this test case is to validate that the DUT is able to generate Address Notification messages in + * response to Address Query messages. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * ---------------|--------------|--------------- + * Address Query | 5.4.2 | 5.4.2 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node *routers[kRouterCount]; + for (uint16_t i = 0; i < kRouterCount; i++) + { + routers[i] = &nexus.CreateNode(); + } + Node &br = nexus.CreateNode(); + Node &med1 = nexus.CreateNode(); + Node &reed1 = nexus.CreateNode(); + + leader.SetName("LEADER"); + for (uint16_t i = 0; i < kRouterCount; i++) + { + char name[16]; + snprintf(name, sizeof(name), "ROUTER_%u", i + 1); + routers[i]->SetName(name); + } + br.SetName("BR"); + med1.SetName("MED_1"); + reed1.SetName("REED_1"); + + nexus.AdvanceTime(0); + Instance::SetLogLevel(kLogLevelNote); + + /** + * Use AllowList feature to restrict the topology. + */ + for (uint16_t i = 0; i < kRouterCount; i++) + { + leader.AllowList(*routers[i]); + routers[i]->AllowList(leader); + } + + leader.AllowList(br); + br.AllowList(leader); + + leader.AllowList(med1); + med1.AllowList(leader); + + routers[0]->AllowList(reed1); + reed1.AllowList(*routers[0]); + + Log("Step 1: Configure the Leader to be a DHCPv6 Border Router for prefix 2001::"); + + /** + * Step 1: Leader + * - Description: Configure the Leader to be a DHCPv6 Border Router for prefix 2001:: + * - Pass Criteria: N/A + */ + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + { + NetworkData::OnMeshPrefixConfig config; + config.Clear(); + SuccessOrQuit(config.GetPrefix().FromString("2001::/64")); + config.mOnMesh = true; + config.mDefaultRoute = true; + config.mStable = true; + config.mDhcp = true; + SuccessOrQuit(leader.Get().AddOnMeshPrefix(config)); + leader.Get().HandleServerDataUpdated(); + } + + Log("Step 2: Attach the Border_Router to the network and configure the below On-Mesh Prefix"); + + /** + * Step 2: Border_Router + * - Description: Attach the Border_Router to the network and configure the below On-Mesh Prefix: + * - Prefix 1: P_Prefix=2002::/64 P_stable=1 P_default=1 P_slaac=1 P_on_mesh=1 P_preferred=1 + * - Pass Criteria: N/A + */ + br.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(br.Get().IsRouter()); + + { + NetworkData::OnMeshPrefixConfig config; + config.Clear(); + SuccessOrQuit(config.GetPrefix().FromString("2002::/64")); + config.mOnMesh = true; + config.mDefaultRoute = true; + config.mStable = true; + config.mSlaac = true; + config.mPreferred = true; + SuccessOrQuit(br.Get().AddOnMeshPrefix(config)); + br.Get().HandleServerDataUpdated(); + } + + Log("Step 3: Ensure topology is formed correctly without the DUT."); + + /** + * Step 3: All + * - Description: Ensure topology is formed correctly without the DUT. + * - Pass Criteria: N/A + */ + for (uint16_t i = 0; i < kRouterCount; i++) + { + routers[i]->Join(leader); + } + nexus.AdvanceTime(kAttachToRouterTime); + + med1.Join(leader, Node::kAsMed); + nexus.AdvanceTime(kAttachAsChildTime); + + for (uint16_t i = 0; i < kRouterCount; i++) + { + VerifyOrQuit(routers[i]->Get().IsRouter()); + } + VerifyOrQuit(br.Get().IsRouter()); + VerifyOrQuit(med1.Get().IsChild()); + + Log("Step 4: Cause the DUT to attach to Router_1 (2-hops from the leader)."); + + /** + * Step 4: REED_1 (DUT) + * - Description: Cause the DUT to attach to Router_1 (2-hops from the leader). + * - Pass Criteria: + * - The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request. + * - If the DUT sends Address Solicit Request, the test fails. + */ + reed1.Join(*routers[0]); + nexus.AdvanceTime(kAttachAsChildTime); + VerifyOrQuit(reed1.Get().IsChild()); + + /** + * Wait some time to ensure it doesn't try to become a router. + */ + nexus.AdvanceTime(20 * 1000); + VerifyOrQuit(reed1.Get().IsChild()); + VerifyOrQuit(!reed1.Get().IsRouter()); + + Log("Step 5: Harness enables a link between the DUT and BR to create a one-way link."); + + /** + * Step 5: REED_1 (DUT), Border Router + * - Description: Harness enables a link between the DUT and BR to create a one-way link. + * - Pass Criteria: N/A + */ + reed1.AllowList(br); + + Log("Step 6: MED_1 sends ICMPv6 Echo Request to the DUT (REED_1) using ML-EID."); + + /** + * Step 6: MED_1 + * - Description: Harness instructs device to send an ICMPv6 Echo Request to the DUT (REED_1) using ML-EID. + * - Pass Criteria: + * - The DUT MUST send a properly formatted Address Notification message: + * - CoAP Request URI-PATH: CON POST coap://[
]:MM/a/an + * - CoAP Payload: + * - Target EID TLV + * - RLOC16 TLV + * - ML-EID TLV + * - The IPv6 Source address MUST be the RLOC of the originator (DUT). + * - The IPv6 Destination address MUST be the RLOC of the destination. + * - The DUT MUST send an ICMPv6 Echo Reply. + */ + nexus.SendAndVerifyEchoRequest(med1, reed1.Get().GetMeshLocalEid(), 0, 64, kEchoResponseTime); + + Log("Step 7: MED_1 sends ICMPv6 Echo Request to REED_1 (DUT) using 2001:: EID."); + + /** + * Step 7: MED_1 + * - Description: Harness instructs the device to send an ICMPv6 Echo Request to REED_1 (DUT) using 2001:: EID. + * - Pass Criteria: + * - The DUT MUST send a properly formatted Address Notification message: + * - CoAP Request URI-PATH: CON POST coap://[
]:MM/a/an + * - CoAP Payload: + * - Target EID TLV + * - RLOC16 TLV + * - ML-EID TLV + * - The IPv6 Source address MUST be the RLOC of the originator. + * - The IPv6 Destination address MUST be the RLOC of the destination. + * - The DUT MUST send an ICMPv6 Echo Reply. + */ + nexus.SendAndVerifyEchoRequest(med1, GetUnicastAddress(reed1, "2001::/64"), 0, 64, kEchoResponseTime); + + Log("Step 8: MED_1 sends ICMPv6 Echo Request to REED_1 (DUT) using 2002:: EID."); + + /** + * Step 8: MED_1 + * - Description: Harness instructs the device to send an ICMPv6 Echo Request to REED_1 (DUT) using 2002:: EID. + * - Pass Criteria: + * - The DUT MUST send a properly formatted Address Notification message: + * - CoAP Request URI-PATH: CON POST coap://[
]:MM/a/an + * - CoAP Payload: + * - Target EID TLV + * - RLOC16 TLV + * - ML-EID TLV + * - The IPv6 Source address MUST be the RLOC of the originator. + * - The IPv6 Destination address MUST be the RLOC of the destination. + * - The DUT MUST send an ICMPv6 Echo Reply. + */ + nexus.SendAndVerifyEchoRequest(med1, GetUnicastAddress(reed1, "2002::/64"), 0, 64, kEchoResponseTime); + + nexus.SaveTestInfo("test_5_2_5.json"); +} + +} // namespace Nexus +} // namespace ot + +int main(void) +{ + ot::Nexus::Test5_2_5(); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_5_2_5.py b/tests/nexus/verify_5_2_5.py new file mode 100644 index 000000000..36762b295 --- /dev/null +++ b/tests/nexus/verify_5_2_5.py @@ -0,0 +1,159 @@ +#!/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): + # 5.2.5 Address Query - REED + # + # 5.2.5.1 Topology + # - Build a topology that has a total of 16 active routers, including the Leader, with no communication + # constraints. + # - The Leader is configured as a DHCPv6 server for prefix 2001:: + # - The Border Router is configured as a SLAAC server for prefix 2002:: + # - Each router numbered 1 through 14 have a link to leader + # - MED_1 has a link to the leader + # - Border Router has a link to the leader + # - REED_1 has a link to router 1 + # + # 5.2.5.2 Purpose & Description + # The purpose of this test case is to validate that the DUT is able to generate Address Notification messages + # in response to Address Query messages. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # ---------------|--------------|--------------- + # Address Query | 5.4.2 | 5.4.2 + + pkts = pv.pkts + pv.summary.show() + + REED_1 = pv.vars['REED_1'] + REED_1_RLOC = pv.vars['REED_1_RLOC'] + LEADER_RLOC = pv.vars['LEADER_RLOC'] + + def verify_address_notification(): + pkts.filter_ipv6_src_dst(REED_1_RLOC, LEADER_RLOC).\ + filter_coap_request(consts.ADDR_NTF_URI).\ + filter(lambda p: { + consts.NL_TARGET_EID_TLV, + consts.NL_RLOC16_TLV, + consts.NL_ML_EID_TLV + } <= set(p.coap.tlv.type)).\ + must_next() + pkts.filter_ping_reply().\ + must_next() + + # Step 1: Leader + # - Description: Configure the Leader to be a DHCPv6 Border Router for prefix 2001:: + # - Pass Criteria: N/A + print("Step 1: Configure the Leader to be a DHCPv6 Border Router for prefix 2001::") + + # Step 2: Border_Router + # - Description: Attach the Border_Router to the network and configure the below On-Mesh Prefix: + # - Prefix 1: P_Prefix=2002::/64 P_stable=1 P_default=1 P_slaac=1 P_on_mesh=1 P_preferred=1 + # - Pass Criteria: N/A + print("Step 2: Attach the Border_Router to the network and configure the below On-Mesh Prefix") + + # Step 3: All + # - Description: Ensure topology is formed correctly without the DUT. + # - Pass Criteria: N/A + print("Step 3: Ensure topology is formed correctly without the DUT.") + + # Step 4: REED_1 (DUT) + # - Description: Cause the DUT to attach to Router_1 (2-hops from the leader). + # - Pass Criteria: + # - The DUT MUST NOT attempt to become an active router by sending an Address Solicit Request. + # - If the DUT sends Address Solicit Request, the test fails. + print("Step 4: Cause the DUT to attach to Router_1 (2-hops from the leader).") + pkts.filter_wpan_src64(REED_1).\ + filter_coap_request(consts.ADDR_SOL_URI).\ + must_not_next() + + # Step 5: REED_1 (DUT), Border Router + # - Description: Harness enables a link between the DUT and BR to create a one-way link. + # - Pass Criteria: N/A + print("Step 5: Harness enables a link between the DUT and BR to create a one-way link.") + + # Step 6: MED_1 + # - Description: Harness instructs device to send an ICMPv6 Echo Request to the DUT (REED_1) using ML-EID. + # - Pass Criteria: + # - The DUT MUST send a properly formatted Address Notification message: + # - CoAP Request URI-PATH: CON POST coap://[
]:MM/a/an + # - CoAP Payload: + # - Target EID TLV + # - RLOC16 TLV + # - ML-EID TLV + # - The IPv6 Source address MUST be the RLOC of the originator (DUT). + # - The IPv6 Destination address MUST be the RLOC of the destination. + # - The DUT MUST send an ICMPv6 Echo Reply. + print("Step 6: MED_1 sends ICMPv6 Echo Request to the DUT (REED_1) using ML-EID.") + verify_address_notification() + + # Step 7: MED_1 + # - Description: Harness instructs the device to send an ICMPv6 Echo Request to REED_1 (DUT) using 2001:: EID. + # - Pass Criteria: + # - The DUT MUST send a properly formatted Address Notification message: + # - CoAP Request URI-PATH: CON POST coap://[
]:MM/a/an + # - CoAP Payload: + # - Target EID TLV + # - RLOC16 TLV + # - ML-EID TLV + # - The IPv6 Source address MUST be the RLOC of the originator. + # - The IPv6 Destination address MUST be the RLOC of the destination. + # - The DUT MUST send an ICMPv6 Echo Reply. + print("Step 7: MED_1 sends ICMPv6 Echo Request to REED_1 (DUT) using 2001:: EID.") + verify_address_notification() + + # Step 8: MED_1 + # - Description: Harness instructs the device to send an ICMPv6 Echo Request to REED_1 (DUT) using 2002:: EID. + # - Pass Criteria: + # - The DUT MUST send a properly formatted Address Notification message: + # - CoAP Request URI-PATH: CON POST coap://[
]:MM/a/an + # - CoAP Payload: + # - Target EID TLV + # - RLOC16 TLV + # - ML-EID TLV + # - The IPv6 Source address MUST be the RLOC of the originator. + # - The IPv6 Destination address MUST be the RLOC of the destination. + # - The DUT MUST send an ICMPv6 Echo Reply. + print("Step 8: MED_1 sends ICMPv6 Echo Request to REED_1 (DUT) using 2002:: EID.") + verify_address_notification() + + +if __name__ == '__main__': + verify_utils.run_main(verify)