diff --git a/tests/nexus/CMakeLists.txt b/tests/nexus/CMakeLists.txt index 73f2a3519..58cd5e438 100644 --- a/tests/nexus/CMakeLists.txt +++ b/tests/nexus/CMakeLists.txt @@ -156,6 +156,7 @@ ot_nexus_test(5_5_4_2 "cert;nexus") ot_nexus_test(5_5_5 "cert;nexus") ot_nexus_test(5_5_7 "cert;nexus") ot_nexus_test(5_8_2 "cert;nexus") +ot_nexus_test(6_1_1 "cert;nexus") # Misc tests ot_nexus_test(border_admitter "core;nexus") diff --git a/tests/nexus/run_nexus_tests.sh b/tests/nexus/run_nexus_tests.sh index e1d226a96..50aab513d 100755 --- a/tests/nexus/run_nexus_tests.sh +++ b/tests/nexus/run_nexus_tests.sh @@ -86,6 +86,8 @@ DEFAULT_TESTS=( "5_5_5" "5_5_7" "5_8_2" + "6_1_1_A" + "6_1_1_B" ) # Use provided arguments or the default test list @@ -99,18 +101,24 @@ failed_tests=() run_test() { - local test_base="$1" + local test_full="$1" # Strip 'nexus_' prefix if present - test_base="${test_base#nexus_}" + test_full="${test_full#nexus_}" + + local test_base="${test_full%_[AB]}" + local topology="" + if [[ $test_full != "$test_base" ]]; then + topology="${test_full##*_}" + fi local test_name="nexus_${test_base}" - local json_file="test_${test_base}.json" - local pcap_file="test_${test_base}.pcap" + local json_file="test_${test_full}.json" + local pcap_file="test_${test_full}.pcap" local verify_script="${REPO_ROOT}/tests/nexus/verify_${test_base}.py" local nexus_bin="${NEXUS_BIN_DIR}/${test_name}" printf "========================================================================================\n" - printf "Running %s...\n" "$test_name" + printf "Running %s...\n" "$test_full" printf "========================================================================================\n" if [[ ! -x $nexus_bin ]]; then @@ -120,7 +128,7 @@ run_test() # Create a temporary directory for test artifacts local work_dir - work_dir=$(mktemp -d "${TEMP_DIR}/nexus_test_${test_base}.XXXXXX") + work_dir=$(mktemp -d "${TEMP_DIR}/nexus_test_${test_full}.XXXXXX") # Run the Nexus C++ test and verification in a subshell to isolate the working directory ( @@ -128,8 +136,8 @@ run_test() # 1. Run the Nexus C++ test export OT_NEXUS_PCAP_FILE="$pcap_file" - if ! "$nexus_bin"; then - printf "C++ test %s FAILED\n" "$test_name" >&2 + if ! "$nexus_bin" "$topology" "$json_file"; then + printf "C++ test %s FAILED\n" "$test_full" >&2 exit 1 fi @@ -143,12 +151,12 @@ run_test() fi if ! python3 "$verify_script" "$json_file"; then - printf "Verification for %s FAILED\n" "$test_name" >&2 + printf "Verification for %s FAILED\n" "$test_full" >&2 exit 1 fi else printf "\n" - printf "No verification script found for %s (%s), skipping verification.\n" "$test_name" "$verify_script" + printf "No verification script found for %s (%s), skipping verification.\n" "$test_full" "$verify_script" fi ) @@ -156,19 +164,28 @@ run_test() if [[ $exit_code -eq 0 ]]; then printf "\n" - printf "%s PASSED\n" "$test_name" + printf "%s PASSED\n" "$test_full" if [[ -d $work_dir && $work_dir == "${TEMP_DIR}/"* ]]; then rm -rf "$work_dir" fi return 0 else printf "\n" - printf "%s FAILED. Artifacts preserved in: %s\n" "$test_name" "$work_dir" >&2 + printf "%s FAILED. Artifacts preserved in: %s\n" "$test_full" "$work_dir" >&2 return 1 fi } +expanded_tests=() for t in "${TESTS_TO_RUN[@]}"; do + if [[ $t == "6_1_1" ]]; then + expanded_tests+=("6_1_1_A" "6_1_1_B") + else + expanded_tests+=("$t") + fi +done + +for t in "${expanded_tests[@]}"; do if ! run_test "$t"; then failed_tests+=("$t") fi diff --git a/tests/nexus/test_6_1_1.cpp b/tests/nexus/test_6_1_1.cpp new file mode 100644 index 000000000..27117e2d3 --- /dev/null +++ b/tests/nexus/test_6_1_1.cpp @@ -0,0 +1,236 @@ +/* + * 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 the DUT to attach to the leader, in milliseconds. + */ +static constexpr uint32_t kAttachTime = 10 * 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 = 500; + +enum Topology +{ + kTopologyA, + kTopologyB, +}; + +void RunTest6_1_1(Topology aTopology, const char *aJsonFile) +{ + /** + * 6.1.1 Attaching to a Router + * + * 6.1.1.1 Topology + * - Topology A: DUT as End Device (ED_1) + * - Topology B: DUT as Sleepy End Device (SED_1) + * - Leader + * + * 6.1.1.2 Purpose & Description + * The purpose of this test case is to validate that the DUT is able to successfully attach to a network. + * + * Spec Reference | V1.1 Section | V1.3.0 Section + * ----------------------|--------------|--------------- + * Attaching to a Parent | 4.7.1 | 4.5.1 + */ + + Core nexus; + + Node &leader = nexus.CreateNode(); + Node &dut = nexus.CreateNode(); + + leader.SetName("LEADER"); + + if (aTopology == kTopologyA) + { + dut.SetName("ED_1"); + } + else + { + dut.SetName("SED_1"); + } + + nexus.AdvanceTime(0); + + Instance::SetLogLevel(kLogLevelNote); + + if (aTopology == kTopologyA) + { + Log("---------------------------------------------------------------------------------------"); + Log("Topology A: ED_1 (DUT)"); + } + else + { + Log("---------------------------------------------------------------------------------------"); + Log("Topology B: SED_1 (DUT)"); + } + + Log("---------------------------------------------------------------------------------------"); + Log("Step 1: Leader"); + + /** + * Step 1: Leader + * - Description: Begin wireless sniffer and ensure the Leader is sending MLE Advertisements. + * - Pass Criteria: N/A + */ + leader.Form(); + nexus.AdvanceTime(kFormNetworkTime); + VerifyOrQuit(leader.Get().IsLeader()); + + Log("---------------------------------------------------------------------------------------"); + Log("Step 2: DUT"); + + /** + * Step 2: ED_1 / SED_1 (DUT) + * - Description: Automatically begins attach process by sending a multicast MLE Parent Request. + * - Pass Criteria: + * - The DUT MUST send a 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 = 0x80 (active Routers) + * - Version TLV + * - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header MUST be set + * to '0x02'. + */ + if (aTopology == kTopologyA) + { + dut.Join(leader, Node::kAsMed); + } + else + { + dut.Join(leader, Node::kAsSed); + SuccessOrQuit(dut.Get().SetExternalPollPeriod(kPollPeriod)); + } + + Log("---------------------------------------------------------------------------------------"); + Log("Step 3: Leader"); + + /** + * Step 3: Leader + * - Description: Automatically responds with a MLE Parent Response. + * - Pass Criteria: N/A + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 4: DUT"); + + /** + * Step 4: ED_1 / SED_1 (DUT) + * - Description: Receives the MLE Parent Response and automatically sends a MLE Child ID Request. + * - Pass Criteria: + * - The DUT MUST send a MLE Child ID Request. + * - 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) + * - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header MUST be set + * to '0x02'. + */ + + Log("---------------------------------------------------------------------------------------"); + Log("Step 5: Leader"); + + /** + * Step 5: Leader + * - Description: Automatically responds with MLE Child ID Response. + * - Pass Criteria: N/A + */ + nexus.AdvanceTime(kAttachTime); + VerifyOrQuit(dut.Get().IsChild()); + + 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 an ICMPv6 Echo Reply. + */ + nexus.SendAndVerifyEchoRequest(leader, dut.Get().GetLinkLocalAddress(), 0, 64, kEchoTimeout); + + nexus.SaveTestInfo(aJsonFile); +} + +} // namespace Nexus +} // namespace ot + +int main(int argc, char *argv[]) +{ + if (argc < 2) + { + // If no argument, run both topologies. + ot::Nexus::RunTest6_1_1(ot::Nexus::kTopologyA, "test_6_1_1_A.json"); + ot::Nexus::RunTest6_1_1(ot::Nexus::kTopologyB, "test_6_1_1_B.json"); + } + else if (strcmp(argv[1], "A") == 0) + { + ot::Nexus::RunTest6_1_1(ot::Nexus::kTopologyA, (argc > 2) ? argv[2] : "test_6_1_1_A.json"); + } + else if (strcmp(argv[1], "B") == 0) + { + ot::Nexus::RunTest6_1_1(ot::Nexus::kTopologyB, (argc > 2) ? argv[2] : "test_6_1_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; +} diff --git a/tests/nexus/verify_6_1_1.py b/tests/nexus/verify_6_1_1.py new file mode 100644 index 000000000..6b6448639 --- /dev/null +++ b/tests/nexus/verify_6_1_1.py @@ -0,0 +1,174 @@ +#!/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.1 Attaching to a Router + # + # 6.1.1.1 Topology + # - Topology A: DUT as End Device (ED_1) + # - Topology B: DUT as Sleepy End Device (SED_1) + # - Leader + # + # 6.1.1.2 Purpose & Description + # The purpose of this test case is to validate that the DUT is able to successfully attach to a network. + # + # Spec Reference | V1.1 Section | V1.3.0 Section + # ----------------------|--------------|--------------- + # Attaching to a Parent | 4.7.1 | 4.5.1 + + pkts = pv.pkts + pv.summary.show() + + LEADER = pv.vars['LEADER'] + + 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: Leader + # - Description: Begin wireless sniffer and ensure the Leader is sending MLE Advertisements. + # - Pass Criteria: N/A + print("Step 1: Begin wireless sniffer and ensure the Leader is sending MLE Advertisements.") + pkts.filter_wpan_src64(LEADER).\ + filter_LLANMA().\ + filter_mle_cmd(consts.MLE_ADVERTISEMENT).\ + must_next() + + # Step 2: ED_1 / SED_1 (DUT) + # - Description: Automatically begins attach process by sending a multicast MLE Parent Request. + # - Pass Criteria: + # - The DUT MUST send a 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 = 0x80 (active Routers) + # - Version TLV + # - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header + # MUST be set to '0x02'. + print(f"Step 2: {name} (DUT) sends a multicast MLE Parent Request.") + + pkts.filter_wpan_src64(dut).\ + filter_LLARMA().\ + filter_mle_cmd(consts.MLE_PARENT_REQUEST).\ + filter(lambda p: p.ipv6.hlim == 255).\ + filter(lambda p: consts.CHALLENGE_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.MODE_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.SCAN_MASK_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.VERSION_TLV in p.mle.tlv.type).\ + filter(lambda p: p.mle.tlv.scan_mask.r == 1).\ + filter(lambda p: p.mle.tlv.scan_mask.e == 0).\ + filter(lambda p: p.wpan.aux_sec.key_id_mode == 2).\ + must_next() + + # Step 3: Leader + # - Description: Automatically responds with a MLE Parent Response. + # - Pass Criteria: N/A + print("Step 3: Leader responds with a MLE Parent Response.") + + pkts.filter_wpan_src64(LEADER).\ + filter_wpan_dst64(dut).\ + filter_mle_cmd(consts.MLE_PARENT_RESPONSE).\ + must_next() + + # Step 4: ED_1 / SED_1 (DUT) + # - Description: Receives the MLE Parent Response and automatically sends a MLE Child ID Request. + # - Pass Criteria: + # - The DUT MUST send a MLE Child ID Request. + # - 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) + # - The Key Identifier Mode of the Security Control field of the MAC frame Auxiliary Security Header + # MUST be set to '0x02'. + print(f"Step 4: {name} (DUT) sends a MLE Child ID Request.") + + pkts.filter_wpan_src64(dut).\ + filter_wpan_dst64(LEADER).\ + filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\ + filter(lambda p: consts.ADDRESS_REGISTRATION_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.LINK_LAYER_FRAME_COUNTER_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.MODE_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.RESPONSE_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.TIMEOUT_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.TLV_REQUEST_TLV in p.mle.tlv.type).\ + filter(lambda p: consts.VERSION_TLV in p.mle.tlv.type).\ + filter(lambda p: p.wpan.aux_sec.key_id_mode == 2).\ + must_next() + + # Step 5: Leader + # - Description: Automatically responds with MLE Child ID Response. + # - Pass Criteria: N/A + print("Step 5: Leader responds with MLE 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 an ICMPv6 Echo Reply. + print("Step 6: Harness verifies connectivity using ICMPv6 Echo Request/Reply.") + + _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)