diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 80b5a34b2..1622ebc32 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_6 "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") diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index 8dcfe6373..9ea6eb7fa 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_6" "6_1_7" "6_2_1_A" "6_2_1_B" @@ -205,7 +206,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_3_1 | 6_3_2 | 6_4_1 | 6_4_2 | 6_5_1 | 6_6_1 | 6_6_2) + 6_1_1 | 6_1_2 | 6_1_3 | 6_1_6 | 6_2_1 | 6_2_2 | 6_3_1 | 6_3_2 | 6_4_1 | 6_4_2 | 6_5_1 | 6_6_1 | 6_6_2) expanded_tests+=("${t}_A" "${t}_B") ;; *) diff --git a/tests/nexus/test_6_1_6.cpp b/tests/nexus/test_6_1_6.cpp new file mode 100644 index 000000000..534191294 --- /dev/null +++ b/tests/nexus/test_6_1_6.cpp @@ -0,0 +1,291 @@ +/* + * 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 "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 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; + +/** + * RSSI value to enable a link quality of 3 (good). + */ +static constexpr int8_t kRssiLinkQuality3 = -70; + +/** + * RSSI value to enable a link quality of 1 (bad). + */ +static constexpr int8_t kRssiLinkQuality1 = -95; + +/** + * The SED poll period, in milliseconds. + */ +static constexpr uint32_t kSedPollPeriod = 1000; + +enum Topology +{ + kTopologyA, + kTopologyB, +}; + +void RunTest6_1_6(Topology aTopology, const char *aJsonFile) +{ + /** + * 6.1.6 Attaching to a REED with Better Link Quality + * + * 6.1.6.1 Topology + * - Topology A: DUT as End Device (ED_1) + * - Topology B: DUT as Sleepy End Device (SED_1) + * - Leader + * - Router_1: Link quality = 1 + * - REED_1: Link quality = 3 + * + * 6.1.6.2 Purpose & Description + * The purpose of this test is to verify that the DUT sends a second Parent Request to the all-routers and + * all-reeds multicast address if it gets a reply from the first Parent Request to the all-routers address + * with a bad link quality. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * -----------------|--------------|--------------- + * Parent Selection | 4.7.2 | 4.5.2 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node &router1 = nexus.CreateNode(); + Node &reed1 = nexus.CreateNode(); + Node &dut = nexus.CreateNode(); + + leader.SetName("LEADER"); + router1.SetName("ROUTER_1"); + reed1.SetName("REED_1"); + + switch (aTopology) + { + case kTopologyA: + dut.SetName("ED_1"); + break; + case kTopologyB: + dut.SetName("SED_1"); + break; + } + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + /** + * Step 1: All + * - Description: Setup the topology without the DUT. Ensure all routers and leader are sending + * MLE advertisements. + * - Pass Criteria: N/A + */ + Log("Step 1: All"); + + leader.AllowList(router1); + leader.AllowList(reed1); + + router1.AllowList(leader); + reed1.AllowList(leader); + + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + router1.Join(leader); + nexus.AdvanceTime(kAttachToRouterTime); + VerifyOrQuit(router1.Get().IsRouter()); + + reed1.Join(leader); + reed1.Get().SetRouterUpgradeThreshold(0); + nexus.AdvanceTime(kStabilizationTime); + VerifyOrQuit(reed1.Get().IsChild()); + + /** + * Step 2: Router_1 + * - Description: Harness configures the device to broadcast a link quality of 1 (bad). + * - Pass Criteria: N/A + */ + Log("Step 2: Router_1"); + + dut.AllowList(router1); + dut.AllowList(reed1); + + router1.AllowList(dut); + reed1.AllowList(dut); + + SuccessOrQuit(dut.Get().AddRssIn(router1.Get().GetExtAddress(), kRssiLinkQuality1)); + SuccessOrQuit(router1.Get().AddRssIn(dut.Get().GetExtAddress(), kRssiLinkQuality1)); + + SuccessOrQuit(dut.Get().AddRssIn(reed1.Get().GetExtAddress(), kRssiLinkQuality3)); + SuccessOrQuit(reed1.Get().AddRssIn(dut.Get().GetExtAddress(), kRssiLinkQuality3)); + + /** + * Step 3: ED_1 / SED_1 (DUT) + * - Description: Automatically begins attach process by sending a multicast MLE Parent Request + * to the All-Routers multicast address with the Scan Mask TLV set for all Routers. + * - 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 (Value = 0x80 (active Routers)) + * - Version TLV + */ + Log("Step 3: ED_1 / SED_1 (DUT)"); + + switch (aTopology) + { + case kTopologyA: + dut.Join(leader, Node::kAsMed); + break; + case kTopologyB: + SuccessOrQuit(dut.Get().SetExternalPollPeriod(kSedPollPeriod)); + dut.Join(leader, Node::kAsSed); + break; + } + + /** + * Step 4: Router_1 + * - Description: Automatically responds with MLE Parent Response. + * - Pass Criteria: N/A + */ + Log("Step 4: Router_1"); + + /** + * Step 5: ED_1 / SED_1 (DUT) + * - Description: Automatically sends another multicast MLE Parent Request to the All-Routers + * multicast with the Scan Mask TLV set for all Routers and REEDs. + * - 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 (Value = 0xC0 (Routers and REEDs)) + * - Version TLV + */ + Log("Step 5: ED_1 / SED_1 (DUT)"); + + nexus.AdvanceTime(kParentSelectionTime); + + /** + * Step 6: REED_1 + * - Description: Automatically responds with MLE Parent Response (in addition to Router_1). + * - Pass Criteria: N/A + */ + Log("Step 6: REED_1"); + + /** + * Step 7: ED_1 / SED_1 (DUT) + * - Description: Automatically sends MLE Child ID Request to REED_1 due to better link quality. + * - Pass Criteria: + * - The DUT MUST unicast MLE Child ID Request to REED_1. + * - 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) + */ + Log("Step 7: ED_1 / SED_1 (DUT)"); + + nexus.AdvanceTime(kStabilizationTime); + + VerifyOrQuit(dut.Get().IsChild()); + VerifyOrQuit(dut.Get().GetParent().GetExtAddress() == reed1.Get().GetExtAddress()); + + nexus.SaveTestInfo(aJsonFile); +} + +} // namespace Nexus +} // namespace ot + +int main(int argc, char *argv[]) +{ + if (argc < 2) + { + ot::Nexus::RunTest6_1_6(ot::Nexus::kTopologyA, "test_6_1_6_A.json"); + ot::Nexus::RunTest6_1_6(ot::Nexus::kTopologyB, "test_6_1_6_B.json"); + } + else + { + ot::Nexus::Topology topology; + const char *defaultJsonFile; + + if (strcmp(argv[1], "A") == 0) + { + topology = ot::Nexus::kTopologyA; + defaultJsonFile = "test_6_1_6_A.json"; + } + else if (strcmp(argv[1], "B") == 0) + { + topology = ot::Nexus::kTopologyB; + defaultJsonFile = "test_6_1_6_B.json"; + } + else + { + fprintf(stderr, "Error: Invalid topology '%s'. Must be 'A' or 'B'.\n", argv[1]); + return 1; + } + + ot::Nexus::RunTest6_1_6(topology, (argc > 2) ? argv[2] : defaultJsonFile); + } + + printf("All tests passed\n"); + return 0; +} diff --git a/tests/nexus/verify_6_1_6.py b/tests/nexus/verify_6_1_6.py new file mode 100644 index 000000000..6a8db4002 --- /dev/null +++ b/tests/nexus/verify_6_1_6.py @@ -0,0 +1,193 @@ +#!/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.6 Attaching to a REED with Better Link Quality + # + # 6.1.6.1 Topology + # - Topology A: DUT as End Device (ED_1) + # - Topology B: DUT as Sleepy End Device (SED_1) + # - Leader + # - Router_1: Link quality = 1 + # - REED_1: Link quality = 3 + # + # 6.1.6.2 Purpose & Description + # The purpose of this test is to verify that the DUT sends a second Parent Request to the all-routers and + # all-reeds multicast address if it gets a reply from the first Parent Request to the all-routers address + # with a bad link quality. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # -----------------|--------------|--------------- + # Parent Selection | 4.7.2 | 4.5.2 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + ROUTER_1 = pv.vars['ROUTER_1'] + REED_1 = pv.vars['REED_1'] + + if 'ED_1' in pv.vars: + dut = pv.vars['ED_1'] + name = 'ED_1' + elif 'SED_1' in pv.vars: + dut = pv.vars['SED_1'] + name = 'SED_1' + else: + raise ValueError("Neither ED_1 nor SED_1 found in topology vars") + + # 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: All") + pkts.copy().\ + filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter_wpan_src64(LEADER).\ + must_next() + pkts.copy().\ + filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + filter_wpan_src64(ROUTER_1).\ + must_next() + + # Step 2: Router_1 + # - Description: Harness configures the device to broadcast a link quality of 1 (bad). + # - Pass Criteria: N/A + print("Step 2: Router_1") + + # Step 3: ED_1 / SED_1 (DUT) + # - Description: Automatically begins attach process by sending a multicast MLE Parent Request + # to the All-Routers multicast address with the Scan Mask TLV set for all Routers. + # - 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 (Value = 0x80 (active Routers)) + # - Version TLV + print(f"Step 3: {name} (DUT)") + pkts.filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + filter_LLARMA().\ + filter_wpan_src64(dut).\ + 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 4: Router_1 + # - Description: Automatically responds with MLE Parent Response. + # - Pass Criteria: N/A + print("Step 4: Router_1") + pkts.filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\ + filter_wpan_src64(ROUTER_1).\ + must_next() + + # Step 5: ED_1 / SED_1 (DUT) + # - Description: Automatically sends another multicast MLE Parent Request to the All-Routers + # multicast with the Scan Mask TLV set for all Routers and REEDs. + # - 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 (Value = 0xC0 (Routers and REEDs)) + # - Version TLV + print(f"Step 5: {name} (DUT)") + pkts.filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + filter_LLARMA().\ + filter_wpan_src64(dut).\ + 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 == 1).\ + must_next() + + # Step 6: REED_1 + # - Description: Automatically responds with MLE Parent Response (in addition to Router_1). + # - Pass Criteria: N/A + print("Step 6: REED_1") + pkts.filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\ + filter_wpan_src64(REED_1).\ + must_next() + + # Step 7: ED_1 / SED_1 (DUT) + # - Description: Automatically sends MLE Child ID Request to REED_1 due to better link quality. + # - Pass Criteria: + # - The DUT MUST unicast MLE Child ID Request to REED_1. + # - 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(f"Step 7: {name} (DUT)") + pkts.filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\ + filter_wpan_src64(dut).\ + filter_wpan_dst64(REED_1).\ + 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() + + +if __name__ == '__main__': + verify_utils.run_main(verify)