From 7ca1991764afae1bbc4c1de17ea55881db531efd Mon Sep 17 00:00:00 2001 From: Jonathan Hui Date: Thu, 19 Feb 2026 17:01:02 -0600 Subject: [PATCH] [nexus] add test 6.1.7 End Device Synchronization (#12495) This commit adds a new Nexus test case for 'End Device Synchronization' (6.1.7) as specified in the test specification. Summary of changes: - Implemented Nexus test 6.1.7: - Added tests/nexus/test_6_1_7.cpp: Implements the test execution for DUT as a Full End Device (FED). The test verifies that the DUT automatically sends Link Requests to neighboring routers after attaching to the Leader. The test uses direct method calls, sets log level to note, and uses AllowList for connectivity. - Added tests/nexus/verify_6_1_7.py: PCAP verification script. Validates the MLE Child ID Request to the Leader and subsequent unicast Link Requests to Router 1, 2, and 3, ensuring they contain all required TLVs. Also verifies receipt of Link Accepts from the routers. - 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_7 in the default test list. --- tests/nexus/CMakeLists.txt | 1 + tests/nexus/run_nexus_tests.sh | 1 + tests/nexus/test_6_1_7.cpp | 193 +++++++++++++++++++++++++++++++++ tests/nexus/verify_6_1_7.py | 124 +++++++++++++++++++++ 4 files changed, 319 insertions(+) create mode 100644 tests/nexus/test_6_1_7.cpp create mode 100644 tests/nexus/verify_6_1_7.py diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index cd88413fe..3be1a95e7 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -167,6 +167,7 @@ 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_1_7 "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") diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index 1af813a96..a96e84fc0 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -100,6 +100,7 @@ DEFAULT_TESTS=( "6_1_3_B" "6_1_4" "6_1_5" + "6_1_7" "6_2_1_A" "6_2_1_B" "6_2_2" diff --git a/tests/nexus/test_6_1_7.cpp b/tests/nexus/test_6_1_7.cpp new file mode 100644 index 000000000..b9136371e --- /dev/null +++ b/tests/nexus/test_6_1_7.cpp @@ -0,0 +1,193 @@ +/* + * 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 "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 the leader, in milliseconds. + */ +static constexpr uint32_t kAttachToLeaderTime = 20 * 1000; + +/** + * Time to advance for the DUT to send Link Requests to neighboring routers. + */ +static constexpr uint32_t kLinkRequestTime = 60 * 1000; + +void RunTest6_1_7(const char *aJsonFile) +{ + /** + * 6.1.7 End Device Synchronization + * + * 6.1.7.1 Topology + * - DUT as Full End Device (FED) + * - Leader + * - Router_1 + * - Router_2 + * - Router_3 + * + * 6.1.7.2 Purpose & Description + * The purpose of this test case is to validate End Device Synchronization on the DUT. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * ------------------------------|--------------|--------------- + * REED and FED Synchronization | 4.7.7.4 | 4.7.1.4 + */ + + 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"); + dut.SetName("DUT"); + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: All"); + + /** + * Step 1: All + * - Description: Setup the topology without the DUT. Ensure all routers and the Leader are sending MLE + * advertisements. + * - Pass Criteria: N/A + */ + + /** Use AllowList feature to specify links between nodes. */ + leader.AllowList(router1); + leader.AllowList(router2); + + router1.AllowList(leader); + router1.AllowList(router3); + + router2.AllowList(leader); + router2.AllowList(router3); + + router3.AllowList(router1); + router3.AllowList(router2); + + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + + router1.Join(leader); + router2.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + + router3.Join(router1); + nexus.AdvanceTime(kAttachToRouterTime); + + VerifyOrQuit(leader.Get().IsLeader()); + VerifyOrQuit(router1.Get().IsRouter()); + VerifyOrQuit(router2.Get().IsRouter()); + VerifyOrQuit(router3.Get().IsRouter()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: FED (DUT)"); + + /** + * Step 2: FED (DUT) + * - Description: Automatically attaches to the Leader. + * - Pass Criteria: + * - The DUT MUST unicast MLE Child ID Request to the Leader. + */ + dut.AllowList(leader); + leader.AllowList(dut); + + dut.Join(leader, Node::kAsFed); + nexus.AdvanceTime(kAttachToLeaderTime); + VerifyOrQuit(dut.Get().IsChild()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: FED (DUT)"); + + /** + * Step 3: FED (DUT) + * - Description: Automatically sends Link Requests to Router_1, Router_2 & Router_3. + * - Pass Criteria: + * - The DUT MUST unicast Link Requests to each Router which contains the following TLVs: + * - Challenge TLV + * - Leader Data TLV + * - Source Address TLV + * - Version TLV + */ + dut.AllowList(router1); + dut.AllowList(router2); + dut.AllowList(router3); + + router1.AllowList(dut); + router2.AllowList(dut); + router3.AllowList(dut); + + nexus.AdvanceTime(kLinkRequestTime); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: Router_1, Router_2, Router_3"); + + /** + * Step 4: Router_1, Router_2, Router_3 + * - Description: Automatically send Link Accept to the DUT. + * - Pass Criteria: N/A + */ + nexus.AdvanceTime(kLinkRequestTime); + + nexus.SaveTestInfo(aJsonFile); +} + +} // namespace Nexus +} // namespace ot + +int main(int argc, char *argv[]) +{ + ot::Nexus::RunTest6_1_7((argc > 2) ? argv[2] : "test_6_1_7.json"); + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_6_1_7.py b/tests/nexus/verify_6_1_7.py new file mode 100644 index 000000000..0ea8e4a4a --- /dev/null +++ b/tests/nexus/verify_6_1_7.py @@ -0,0 +1,124 @@ +#!/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.7 End Device Synchronization + # + # 6.1.7.1 Topology + # DUT as Full End Device (FED) + # Leader + # Router_1 + # Router_2 + # Router_3 + # + # 6.1.7.2 Purpose & Description + # The purpose of this test case is to validate End Device Synchronization on the DUT. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # ------------------------------|--------------|--------------- + # REED and FED Synchronization | 4.7.7.4 | 4.7.1.4 + + 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['DUT'] + + # Step 1: All + # - Description: Setup the topology without the DUT. Ensure all routers and the Leader are sending MLE + # advertisements. + # - Pass Criteria: N/A + print("Step 1: All") + + # Step 2: FED (DUT) + # - Description: Automatically attaches to the Leader. + # - Pass Criteria: + # - The DUT MUST unicast MLE Child ID Request to the Leader. + print("Step 2: FED (DUT)") + pkts.filter_wpan_src64(DUT).\ + filter_wpan_dst64(LEADER).\ + filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\ + must_next() + + # Step 3: FED (DUT) + # - Description: Automatically sends Link Requests to Router_1, Router_2 & Router_3. + # - Pass Criteria: + # - The DUT MUST unicast Link Requests to each Router which contains the following TLVs: + # - Challenge TLV + # - Leader Data TLV + # - Source Address TLV + # - Version TLV + print("Step 3: FED (DUT)") + step3_start_pkts = pkts.copy() + max_idx = pkts.index + for router in [ROUTER_1, ROUTER_2, ROUTER_3]: + f = step3_start_pkts.copy().\ + filter_wpan_src64(DUT).\ + filter_wpan_dst64(router).\ + filter_mle_cmd(consts.MLE_LINK_REQUEST).\ + filter(lambda p: { + consts.CHALLENGE_TLV, + consts.LEADER_DATA_TLV, + consts.SOURCE_ADDRESS_TLV, + consts.VERSION_TLV + } <= set(p.mle.tlv.type)) + f.must_next() + max_idx = max(max_idx, f.index) + + # Step 4: Router_1, Router_2, Router_3 + # - Description: Automatically send Link Accept to the DUT. + # - Pass Criteria: N/A + print("Step 4: Router_1, Router_2, Router_3") + for router in [ROUTER_1, ROUTER_2, ROUTER_3]: + f = step3_start_pkts.copy().\ + filter_wpan_src64(router).\ + filter_wpan_dst64(DUT).\ + filter(lambda p: p.mle.cmd in [consts.MLE_LINK_ACCEPT, consts.MLE_LINK_ACCEPT_AND_REQUEST]) + f.must_next() + max_idx = max(max_idx, f.index) + + pkts.index = max_idx + + +if __name__ == '__main__': + verify_utils.run_main(verify)