espressif/openthread
1
0
Fork 0
mirror of https://github.com/espressif/openthread.git synced 2026-08-06 18:57:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

[nexus] add test 9.2.15 Attaching with different Pending Dataset (#12555)

Browse Source 
This commit adds Nexus test case 9.2.15 which verifies the
synchronization of a Pending Operational Dataset between an attaching
Router and an existing Router.

Implementation details:
- tests/nexus/test_9_2_15.cpp: Implemented the test procedure using
  direct core method calls. Sets node connectivity via AllowList and
  log level to note. Implements power-down simulation by stopping MLE
  and bringing down the network interface. Extracted MGMT_PENDING_SET
  logic into a SendPendingSet helper function for better maintainability.
- tests/nexus/verify_9_2_15.py: Implemented robust verification logic
  to validate end-to-end CoAP MGMT_PENDING_SET and MGMT_ACTIVE_GET
  messages, along with MLE Parent Request/Response and Child ID
  Request/Response exchanges.
- tests/nexus/CMakeLists.txt: Added nexus_9_2_15 target to the build
  configuration.
- tests/nexus/run_nexus_tests.sh: Added 9_2_15 to the default test list.
This commit is contained in:
Jonathan Hui
2026-02-25 14:37:53 -06:00
committed by GitHub
parent 272e9a738f
commit 201042d5d4
4 changed files with 987 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/nexus/CMakeLists.txt
+1
View File
@@ -206,6 +206,7 @@ ot_nexus_test(9_2_8 "cert;nexus")
ot_nexus_test(9_2_10 "cert;nexus")
ot_nexus_test(9_2_11 "cert;nexus")
ot_nexus_test(9_2_14 "cert;nexus")
ot_nexus_test(9_2_15 "cert;nexus")
# Misc tests
ot_nexus_test(border_admitter "core;nexus")
tests/nexus/run_nexus_tests.sh
+1
View File
@@ -142,6 +142,7 @@ DEFAULT_TESTS=(
"9_2_10"
"9_2_11"
"9_2_14"
"9_2_15"
)
# Use provided arguments or the default test list
tests/nexus/test_9_2_15.cpp
+581
View File
@@ -0,0 +1,581 @@
/*
* 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 <stdio.h>
#include <string.h>
#include "meshcop/commissioner.hpp"
#include "meshcop/dataset.hpp"
#include "platform/nexus_core.hpp"
#include "platform/nexus_node.hpp"
#include "thread/mle.hpp"
#include "thread/thread_netif.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 a network, in milliseconds.
*/
static constexpr uint32_t kJoinTime = 10 * 1000;
/**
* Time to advance for a node to upgrade to a router, in milliseconds.
*/
static constexpr uint32_t kRouterUpgradeTime = 200 * 1000;
/**
* Time to advance for a commissioner to become active, in milliseconds.
*/
static constexpr uint32_t kPetitionTime = 5 * 1000;
/**
* Time to wait for a response, in milliseconds.
*/
static constexpr uint32_t kResponseTime = 5000;
/**
* Active Timestamp for Step 3.
*/
static constexpr uint64_t kActiveTimestampStep3 = 70;
/**
* Pending Timestamp for Step 3.
*/
static constexpr uint64_t kPendingTimestampStep3 = 10;
/**
* Mesh Local Prefix for Step 3.
*/
static const char kMeshLocalPrefixStep3[] = "fd00:0db9::";
/**
* Delay Timer for Step 3.
*/
static constexpr uint32_t kDelayTimerStep3 = 600 * 1000;
/**
* Active Timestamp for Step 11.
*/
static constexpr uint64_t kActiveTimestampStep11 = 80;
/**
* Pending Timestamp for Step 11.
*/
static constexpr uint64_t kPendingTimestampStep11 = 20;
/**
* Mesh Local Prefix for Step 11.
*/
static const char kMeshLocalPrefixStep11[] = "fd00:0db7::";
/**
* Delay Timer for Step 11.
*/
static constexpr uint32_t kDelayTimerStep11 = 200 * 1000;
/**
* Pan ID for Step 11.
*/
static constexpr uint16_t kPanIdStep11 = 0xabcd;
/**
* Wait time for Step 9.
*/
static constexpr uint32_t kWaitTimeStep9 = 120 * 1000;
/**
* Power down time for Step 10.
*/
static constexpr uint32_t kPowerDownTimeStep10 = 200 * 1000;
/**
* Wait time for Step 18.
*/
static constexpr uint32_t kWaitTimeStep18 = 200 * 1000;
/**
* Time to wait for ICMPv6 Echo response, in milliseconds.
*/
static constexpr uint32_t kEchoTimeout = 5000;
void SendPendingSet(Node &aCommissioner,
uint16_t aSessionId,
uint64_t aActiveTimestamp,
uint64_t aPendingTimestamp,
const char *aMeshLocalPrefix,
uint32_t aDelayTimer,
const uint16_t *aPanId = nullptr)
{
Tmf::Agent &agent = aCommissioner.Get<Tmf::Agent>();
Coap::Message *message = agent.NewPriorityConfirmablePostMessage(kUriPendingSet);
VerifyOrQuit(message != nullptr);
SuccessOrQuit(Tlv::Append<MeshCoP::CommissionerSessionIdTlv>(*message, aSessionId));
{
MeshCoP::Timestamp timestamp;
timestamp.SetSeconds(aActiveTimestamp);
timestamp.SetTicks(0);
SuccessOrQuit(Tlv::Append<MeshCoP::ActiveTimestampTlv>(*message, timestamp));
}
{
MeshCoP::Timestamp timestamp;
timestamp.SetSeconds(aPendingTimestamp);
timestamp.SetTicks(0);
SuccessOrQuit(Tlv::Append<MeshCoP::PendingTimestampTlv>(*message, timestamp));
}
{
Ip6::Address address;
SuccessOrQuit(address.FromString(aMeshLocalPrefix));
SuccessOrQuit(Tlv::Append<MeshCoP::MeshLocalPrefixTlv>(*message, address.GetPrefix()));
}
SuccessOrQuit(Tlv::Append<MeshCoP::DelayTimerTlv>(*message, aDelayTimer));
if (aPanId != nullptr)
{
SuccessOrQuit(Tlv::Append<MeshCoP::PanIdTlv>(*message, *aPanId));
}
Tmf::MessageInfo messageInfo(aCommissioner.GetInstance());
messageInfo.SetSockAddrToRlocPeerAddrToLeaderAloc();
SuccessOrQuit(agent.SendMessage(*message, messageInfo));
}
void Test9_2_15(void)
{
/**
* 9.2.15 Attaching with different Pending Operational Dataset
*
* 9.2.15.1 Topology
* - Commissioner
* - Leader
* - Router_1
* - Router_2 (DUT)
*
* 9.2.15.2 Purpose & Description
* The purpose of this test case is to verify synchronization of a Pending Operational Dataset between an
* attaching Router and an existing Router.
*
* Spec Reference | V1.1 Section | V1.3.0 Section
* -------------------------|--------------|---------------
* Dissemination of Datasets | 8.4.3 | 8.4.3
*/
Core nexus;
Node &commissioner = nexus.CreateNode();
Node &leader = nexus.CreateNode();
Node &router1 = nexus.CreateNode();
Node &dut = nexus.CreateNode();
commissioner.SetName("COMMISSIONER");
leader.SetName("LEADER");
router1.SetName("ROUTER_1");
dut.SetName("DUT");
nexus.AdvanceTime(0);
Instance::SetLogLevel(kLogLevelNote);
Log("---------------------------------------------------------------------------------------");
Log("Step 1: Commissioner, Leader, Router_1");
/**
* Step 1: Commissioner, Leader, Router_1
* - Description: Setup the topology without the DUT. Ensure topology is formed correctly. Verify Commissioner,
* Leader and Router_1 are sending MLE advertisements.
* - Pass Criteria: N/A
*/
commissioner.AllowList(leader);
leader.AllowList(commissioner);
leader.AllowList(router1);
router1.AllowList(leader);
leader.Form();
nexus.AdvanceTime(kFormNetworkTime);
VerifyOrQuit(leader.Get<Mle::Mle>().IsLeader());
commissioner.Join(leader);
nexus.AdvanceTime(kJoinTime);
VerifyOrQuit(commissioner.Get<Mle::Mle>().IsAttached());
router1.Join(leader);
nexus.AdvanceTime(kRouterUpgradeTime);
VerifyOrQuit(router1.Get<Mle::Mle>().IsRouter());
SuccessOrQuit(commissioner.Get<MeshCoP::Commissioner>().Start(nullptr, nullptr, nullptr));
nexus.AdvanceTime(kPetitionTime);
VerifyOrQuit(commissioner.Get<MeshCoP::Commissioner>().IsActive());
uint16_t sessionId = commissioner.Get<MeshCoP::Commissioner>().GetSessionId();
Log("---------------------------------------------------------------------------------------");
Log("Step 2: Router_2 (DUT)");
/**
* Step 2: Router_2 (DUT)
* - Description: Configuration: Router_2 is configured out-of-band with Network Credentials of existing network.
* - Pass Criteria: N/A
*/
/**
* Link between the following node pairs:
* - Commissioner and Leader
* - Leader and Router 1
* - Router 1 and Router 2
*/
dut.AllowList(router1);
router1.AllowList(dut);
Log("---------------------------------------------------------------------------------------");
Log("Step 3: Commissioner");
/**
* Step 3: Commissioner
* - Description: Harness instructs the Commissioner to send a MGMT_PENDING_SET.req to the Leader Routing or
* Anycast Locator, setting a subset of the Active Operational Dataset:
* - CoAP Request URI: coap://[<L>]:MM/c/ps
* - CoAP Payload:
* - valid Commissioner Session ID TLV
* - new, valid Active Timestamp TLV (70s)
* - new, valid Pending Timestamp TLV (10s)
* - new Network Mesh-Local Prefix TLV value (fd:00:0d:b9:00:00:00:00)
* - Delay Timer TLV: 600s
* - Pass Criteria: N/A
*/
SendPendingSet(commissioner, sessionId, kActiveTimestampStep3, kPendingTimestampStep3, kMeshLocalPrefixStep3,
kDelayTimerStep3);
Log("---------------------------------------------------------------------------------------");
Log("Step 4: Leader");
/**
* Step 4: Leader
* - Description: Automatically sends MGMT_PENDING_SET.rsp to the Commissioner:
* - CoAP Response Code: 2.04 Changed
* - CoAP Payload: State TLV (value = Accept (0x01))
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kResponseTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 5: Router_2 (DUT)");
/**
* Step 5: Router_2 (DUT)
* - Description: 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, including the following TLVs:
* - Challenge TLV
* - Mode TLV
* - Scan Mask TLV (Verify sent to routers only)
* - Version TLV
* - The first MLE Parent Request sent by the DUT MUST NOT be sent to all routers and REEDS.
*/
dut.Join(leader);
Log("---------------------------------------------------------------------------------------");
Log("Step 6: Commissioner, Leader, Router_1");
/**
* Step 6: Commissioner, Leader, Router_1
* - Description: All devices automatically respond by sending MLE Parent Response to Router_2 (DUT).
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kResponseTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 7: Router_2 (DUT)");
/**
* Step 7: Router_2 (DUT)
* - Description: Automatically sends Child ID Request to Router_1.
* - Pass Criteria:
* - The DUT MUST send a MLE Child ID Request to Router_1, including the following TLVs:
* - Link-layer Frame Counter TLV
* - Mode TLV
* - Response TLV
* - Timeout TLV
* - TLV Request TLV
* - Version TLV
* - MLE Frame Counter TLV (optional)
* - The following TLVs MUST NOT be present in the Child ID Request:
* - Address Registration TLV
*/
Log("---------------------------------------------------------------------------------------");
Log("Step 8: Router_1");
/**
* Step 8: Router_1
* - Description: Automatically sends MLE Child ID Response to Router_2 (DUT), including the following TLVs:
* - Active Timestamp TLV
* - Address16 TLV
* - Leader Data TLV
* - Pending Operational Dataset TLV (corresponding to step 3)
* - Pending Timestamp TLV (corresponding to step 3)
* - Source Address TLV
* - Address Registration TLV (optional)
* - Network Data TLV (optional)
* - Route64 TLV (optional)
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kResponseTime);
VerifyOrQuit(dut.Get<Mle::Mle>().IsAttached());
Log("---------------------------------------------------------------------------------------");
Log("Step 9: Test Harness");
/**
* Step 9: Test Harness
* - Description: Wait 120 seconds to allow the DUT to upgrade to a Router.
* - Pass Criteria: N/A (implied)
*/
nexus.AdvanceTime(kWaitTimeStep9);
VerifyOrQuit(dut.Get<Mle::Mle>().IsRouter());
Log("---------------------------------------------------------------------------------------");
Log("Step 10: Router_2 (DUT)");
/**
* Step 10: Router_2 (DUT)
* - Description: Power down DUT for 200 seconds.
* - Pass Criteria: N/A
*/
dut.Get<Mle::Mle>().Stop();
dut.GetInstance().Get<ThreadNetif>().Down();
nexus.AdvanceTime(kPowerDownTimeStep10);
Log("---------------------------------------------------------------------------------------");
Log("Step 11: Commissioner");
/**
* Step 11: Commissioner
* - Description: Harness instructs Commissioner to send a MGMT_PENDING_SET.req to the Leader Routing or Anycast
* Locator setting a subset of the Active Operational Dataset:
* - CoAP Request URI: coap://[<L>]:MM/c/ps
* - CoAP Payload:
* - valid Commissioner Session ID TLV
* - new, valid Active Timestamp TLV (80s)
* - new, valid Pending Timestamp TLV (20s)
* - new value for Network Mesh-Local Prefix TLV (fd:00:0d:b7:00:00:00:00)
* - Delay Timer TLV: 200s
* - new Pan ID TLV (abcd)
* - The Leader Anycast Locator uses the Mesh local prefix with an IID of 0000:00FF:FE00:FC00.
* - Pass Criteria: N/A
*/
SendPendingSet(commissioner, sessionId, kActiveTimestampStep11, kPendingTimestampStep11, kMeshLocalPrefixStep11,
kDelayTimerStep11, &kPanIdStep11);
Log("---------------------------------------------------------------------------------------");
Log("Step 12: Leader");
/**
* Step 12: Leader
* - Description: Automatically sends MGMT_PENDING_SET.rsp to the Commissioner:
* - CoAP Response Code: 2.04 Changed
* - CoAP Payload: State TLV (value = Accept (0x01))
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kResponseTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 13: Router_2 (DUT)");
/**
* Step 13: Router_2 (DUT)
* - Description: Power up after 200 seconds.
* - Pass Criteria: N/A (implied)
*/
dut.GetInstance().Get<ThreadNetif>().Up();
SuccessOrQuit(dut.GetInstance().Get<Mle::Mle>().Start());
Log("---------------------------------------------------------------------------------------");
Log("Step 14: Router_2 (DUT)");
/**
* Step 14: Router_2 (DUT)
* - Description: 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, including the following TLVs:
* - Challenge TLV
* - Mode TLV
* - Scan Mask TLV (Verify sent to routers only)
* - Version TLV
* - The first MLE Parent Request sent by the DUT MUST NOT be sent to all routers and REEDS.
*/
Log("---------------------------------------------------------------------------------------");
Log("Step 15: Commissioner, Leader, Router_1");
/**
* Step 15: Commissioner, Leader, Router_1
* - Description: All devices automatically send MLE Parent Response to Router_2 (DUT).
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kJoinTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 16: Router_2 (DUT)");
/**
* Step 16: Router_2 (DUT)
* - Description: Automatically sends MLE Child ID Request to Router_1.
* - Pass Criteria:
* - The DUT MUST send a MLE Child ID Request to Router_1, including the following TLVs:
* - Active Timestamp TLV
* - Link-layer Frame Counter TLV
* - Mode TLV
* - Response TLV
* - Timeout TLV
* - TLV Request TLV
* - Version TLV
* - MLE Frame Counter TLV (optional)
* - The following TLV MUST NOT be present in the MLE Child ID Request:
* - Address Registration TLV
*/
Log("---------------------------------------------------------------------------------------");
Log("Step 17: Router_1");
/**
* Step 17: Router_1
* - Description: Automatically sends MLE Child ID Response to Router_2, including the following TLVs:
* - Active Timestamp TLV
* - Address16 TLV
* - Leader Data TLV
* - Pending Operational Dataset TLV (corresponding to step 11)
* - Pending Timestamp TLV (corresponding to step 11)
* - Source Address TLV
* - Address Registration TLV (optional)
* - Network Data TLV (optional)
* - Route64 TLV (optional)
* - Pass Criteria: N/A
*/
nexus.AdvanceTime(kJoinTime);
VerifyOrQuit(dut.Get<Mle::Mle>().IsAttached());
Log("---------------------------------------------------------------------------------------");
Log("Step 18: Test Harness");
/**
* Step 18: Test Harness
* - Description: Wait 200 seconds to allow the DUT to upgrade to a Router.
* - Pass Criteria: N/A (implied)
*/
nexus.AdvanceTime(kWaitTimeStep18);
VerifyOrQuit(dut.Get<Mle::Mle>().IsRouter());
Log("---------------------------------------------------------------------------------------");
Log("Step 19: Leader");
/**
* Step 19: Leader
* - Description: Harness instructs Leader to send a MGMT_ACTIVE_GET.req to Router_2 (DUT) to get the Active
* Operational Dataset. (Request entire Active Operational Dataset by not including the Get TLV):
* - CoAP Request URI: coap://[<L>]:MM/c/ag
* - CoAP Payload: <empty>
* - Pass Criteria: N/A
*/
{
Tmf::Agent &agent = leader.Get<Tmf::Agent>();
Coap::Message *message = agent.NewPriorityConfirmablePostMessage(kUriActiveGet);
VerifyOrQuit(message != nullptr);
Tmf::MessageInfo messageInfo(leader.GetInstance());
messageInfo.SetPeerAddr(dut.Get<Mle::Mle>().GetMeshLocalEid());
SuccessOrQuit(agent.SendMessage(*message, messageInfo));
}
Log("---------------------------------------------------------------------------------------");
Log("Step 20: Router_2 (DUT)");
/**
* Step 20: Router_2 (DUT)
* - Description: Automatically sends MGMT_ACTIVE_GET.rsp to the Leader.
* - Pass Criteria:
* - The DUT MUST send a MGMT_ACTIVE_GET.rsp to the Leader:
* - CoAP Response Code: 2.04 Changed
* - CoAP Payload: <entire active operational data set>
* - The PAN ID TLV MUST have a value of abcd.
*/
nexus.AdvanceTime(kResponseTime);
Log("---------------------------------------------------------------------------------------");
Log("Step 21: Commissioner");
/**
* Step 21: Commissioner
* - Description: Harness verifies connectivity by instructing the Commissioner to send an ICMPv6 Echo Request to
* the DUT mesh local address.
* - Pass Criteria: The DUT must respond with an ICMPv6 Echo Reply.
*/
static constexpr uint16_t kEchoPayloadSize = 0;
static constexpr uint8_t kEchoHopLimit = 64;
nexus.SendAndVerifyEchoRequest(commissioner, dut.Get<Mle::Mle>().GetMeshLocalEid(), kEchoPayloadSize, kEchoHopLimit,
kEchoTimeout);
nexus.SaveTestInfo("test_9_2_15.json");
}
} // namespace Nexus
} // namespace ot
int main(void)
{
ot::Nexus::Test9_2_15();
printf("All tests passed\n");
return 0;
}
tests/nexus/verify_9_2_15.py
+404
View File
@@ -0,0 +1,404 @@
#!/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
ACTIVE_TIMESTAMP_STEP3 = 70
PENDING_TIMESTAMP_STEP3 = 10
MESH_LOCAL_PREFIX_STEP3 = 'fd000db900000000'
DELAY_TIMER_STEP3 = 600000
ACTIVE_TIMESTAMP_STEP11 = 80
PENDING_TIMESTAMP_STEP11 = 20
MESH_LOCAL_PREFIX_STEP11 = 'fd000db700000000'
DELAY_TIMER_STEP11 = 200000
PAN_ID_STEP11 = 0xabcd
def verify(pv):
# 9.2.15 Attaching with different Pending Operational Dataset
#
# 9.2.15.1 Topology
# - Commissioner
# - Leader
# - Router_1
# - Router_2 (DUT)
#
# 9.2.15.2 Purpose & Description
# The purpose of this test case is to verify synchronization of a Pending Operational Dataset between an
# attaching Router and an existing Router.
#
# Spec Reference | V1.1 Section | V1.3.0 Section
# -------------------------|--------------|---------------
# Dissemination of Datasets | 8.4.3 | 8.4.3
pkts = pv.pkts
pv.summary.show()
COMMISSIONER = pv.vars['COMMISSIONER']
LEADER = pv.vars['LEADER']
ROUTER1 = pv.vars['ROUTER_1']
DUT = pv.vars['DUT']
# Step 1: Commissioner, Leader, Router_1
# - Description: Setup the topology without the DUT. Ensure topology is formed correctly. Verify Commissioner,
# Leader and Router_1 are sending MLE advertisements.
# - Pass Criteria: N/A
print("Step 1: Setup the topology without the DUT.")
# Step 2: Router_2 (DUT)
# - Description: Configuration: Router_2 is configured out-of-band with Network Credentials of existing network.
# - Pass Criteria: N/A
print("Step 2: Configuration: Router_2 is configured out-of-band.")
# Step 3: Commissioner
# - Description: Harness instructs the Commissioner to send a MGMT_PENDING_SET.req to the Leader Routing or
# Anycast Locator, setting a subset of the Active Operational Dataset:
# - CoAP Request URI: coap://[<L>]:MM/c/ps
# - CoAP Payload:
# - valid Commissioner Session ID TLV
# - new, valid Active Timestamp TLV (70s)
# - new, valid Pending Timestamp TLV (10s)
# - new Network Mesh-Local Prefix TLV value (fd:00:0d:b9:00:00:00:00)
# - Delay Timer TLV: 600s
# - Pass Criteria: N/A
print("Step 3: Commissioner sends a MGMT_PENDING_SET.req to the Leader.")
pkts.filter_coap_request(consts.MGMT_PENDING_SET_URI).\
filter(lambda p: p.ipv6.src in pv.vars['COMMISSIONER_IPADDRS']).\
filter(lambda p: {
consts.NM_COMMISSIONER_SESSION_ID_TLV,
consts.NM_ACTIVE_TIMESTAMP_TLV,
consts.NM_PENDING_TIMESTAMP_TLV,
consts.NM_NETWORK_MESH_LOCAL_PREFIX_TLV,
consts.NM_DELAY_TIMER_TLV
} <= set(p.coap.tlv.type) and\
p.coap.tlv.active_timestamp == ACTIVE_TIMESTAMP_STEP3 and\
p.coap.tlv.pending_timestamp == PENDING_TIMESTAMP_STEP3 and\
p.coap.tlv.mesh_local_prefix == MESH_LOCAL_PREFIX_STEP3 and\
p.coap.tlv.delay_timer == DELAY_TIMER_STEP3).\
must_next()
# Step 4: Leader
# - Description: Automatically sends MGMT_PENDING_SET.rsp to the Commissioner:
# - CoAP Response Code: 2.04 Changed
# - CoAP Payload: State TLV (value = Accept (0x01))
# - Pass Criteria: N/A
print("Step 4: Leader sends MGMT_PENDING_SET.rsp to the Commissioner.")
pkts.filter_coap_ack(consts.MGMT_PENDING_SET_URI).\
filter(lambda p: p.ipv6.dst in pv.vars['COMMISSIONER_IPADDRS']).\
filter(lambda p: p.coap.tlv.state == consts.MESHCOP_ACCEPT).\
must_next()
# Step 5: Router_2 (DUT)
# - Description: 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, including the following TLVs:
# - Challenge TLV
# - Mode TLV
# - Scan Mask TLV (Verify sent to routers only)
# - Version TLV
# - The first MLE Parent Request sent by the DUT MUST NOT be sent to all routers and REEDS.
print("Step 5: Router_2 (DUT) sends a multicast MLE Parent Request.")
pkts.filter_wpan_src64(DUT).\
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()
# Step 6: Commissioner, Leader, Router_1
# - Description: All devices automatically respond by sending MLE Parent Response to Router_2 (DUT).
# - Pass Criteria: N/A
print("Step 6: All devices respond by sending MLE Parent Response to Router_2 (DUT).")
# Step 7: Router_2 (DUT)
# - Description: Automatically sends Child ID Request to Router_1.
# - Pass Criteria:
# - The DUT MUST send a MLE Child ID Request to Router_1, including the following TLVs:
# - Link-layer Frame Counter TLV
# - Mode TLV
# - Response TLV
# - Timeout TLV
# - TLV Request TLV
# - Version TLV
# - MLE Frame Counter TLV (optional)
# - The following TLVs MUST NOT be present in the Child ID Request:
# - Address Registration TLV
print("Step 7: Router_2 (DUT) sends Child ID Request to Router_1.")
_pkt = pkts.filter_wpan_src64(DUT).\
filter_wpan_dst64(ROUTER1).\
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.VERSION_TLV
} <= set(p.mle.tlv.type)).\
must_next()
_pkt.must_not_verify(lambda p: (consts.ADDRESS_REGISTRATION_TLV) in p.mle.tlv.type)
# Step 8: Router_1
# - Description: Automatically sends MLE Child ID Response to Router_2 (DUT), including the following TLVs:
# - Active Timestamp TLV
# - Address16 TLV
# - Leader Data TLV
# - Pending Operational Dataset TLV (corresponding to step 3)
# - Pending Timestamp TLV (corresponding to step 3)
# - Source Address TLV
# - Address Registration TLV (optional)
# - Network Data TLV (optional)
# - Route64 TLV (optional)
# - Pass Criteria: N/A
print("Step 8: Router_1 sends MLE Child ID Response to Router_2 (DUT).")
pkts.filter_wpan_src64(ROUTER1).\
filter_wpan_dst64(DUT).\
filter_mle_cmd(consts.MLE_CHILD_ID_RESPONSE).\
filter(lambda p: {
consts.ACTIVE_TIMESTAMP_TLV,
consts.ADDRESS16_TLV,
consts.LEADER_DATA_TLV,
consts.PENDING_OPERATION_DATASET_TLV,
consts.PENDING_TIMESTAMP_TLV,
consts.SOURCE_ADDRESS_TLV
} <= set(p.mle.tlv.type)).\
must_next()
# Step 9: Test Harness
# - Description: Wait 120 seconds to allow the DUT to upgrade to a Router.
# - Pass Criteria: N/A (implied)
print("Step 9: Wait 120 seconds to allow the DUT to upgrade to a Router.")
# Step 10: Router_2 (DUT)
# - Description: Power down DUT for 200 seconds.
# - Pass Criteria: N/A
print("Step 10: Power down DUT for 200 seconds.")
# Step 11: Commissioner
# - Description: Harness instructs Commissioner to send a MGMT_PENDING_SET.req to the Leader Routing or Anycast
# Locator setting a subset of the Active Operational Dataset:
# - CoAP Request URI: coap://[<L>]:MM/c/ps
# - CoAP Payload:
# - valid Commissioner Session ID TLV
# - new, valid Active Timestamp TLV (80s)
# - new, valid Pending Timestamp TLV (20s)
# - new value for Network Mesh-Local Prefix TLV (fd:00:0d:b7:00:00:00:00)
# - Delay Timer TLV: 200s
# - new Pan ID TLV (abcd)
# - The Leader Anycast Locator uses the Mesh local prefix with an IID of 0000:00FF:FE00:FC00.
# - Pass Criteria: N/A
print("Step 11: Commissioner sends a MGMT_PENDING_SET.req to the Leader.")
pkts.filter_coap_request(consts.MGMT_PENDING_SET_URI).\
filter(lambda p: p.ipv6.src in pv.vars['COMMISSIONER_IPADDRS']).\
filter(lambda p: {
consts.NM_COMMISSIONER_SESSION_ID_TLV,
consts.NM_ACTIVE_TIMESTAMP_TLV,
consts.NM_PENDING_TIMESTAMP_TLV,
consts.NM_NETWORK_MESH_LOCAL_PREFIX_TLV,
consts.NM_DELAY_TIMER_TLV,
consts.NM_PAN_ID_TLV
} <= set(p.coap.tlv.type) and\
p.coap.tlv.active_timestamp == ACTIVE_TIMESTAMP_STEP11 and\
p.coap.tlv.pending_timestamp == PENDING_TIMESTAMP_STEP11 and\
p.coap.tlv.mesh_local_prefix == MESH_LOCAL_PREFIX_STEP11 and\
p.coap.tlv.delay_timer == DELAY_TIMER_STEP11 and\
p.coap.tlv.pan_id == PAN_ID_STEP11).\
must_next()
# Step 12: Leader
# - Description: Automatically sends MGMT_PENDING_SET.rsp to the Commissioner:
# - CoAP Response Code: 2.04 Changed
# - CoAP Payload: State TLV (value = Accept (0x01))
# - Pass Criteria: N/A
print("Step 12: Leader sends MGMT_PENDING_SET.rsp to the Commissioner.")
pkts.filter_coap_ack(consts.MGMT_PENDING_SET_URI).\
filter(lambda p: p.ipv6.dst in pv.vars['COMMISSIONER_IPADDRS']).\
filter(lambda p: p.coap.tlv.state == consts.MESHCOP_ACCEPT).\
must_next()
# Step 13: Router_2 (DUT)
# - Description: Power up after 200 seconds.
# - Pass Criteria: N/A (implied)
print("Step 13: Power up after 200 seconds.")
# Step 14: Router_2 (DUT)
# - Description: 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, including the following TLVs:
# - Challenge TLV
# - Mode TLV
# - Scan Mask TLV (Verify sent to routers only)
# - Version TLV
# - The first MLE Parent Request sent by the DUT MUST NOT be sent to all routers and REEDS.
print("Step 14: Router_2 (DUT) sends a multicast MLE Parent Request.")
pkts.filter_wpan_src64(DUT).\
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()
# Step 15: Commissioner, Leader, Router_1
# - Description: All devices automatically send MLE Parent Response to Router_2 (DUT).
# - Pass Criteria: N/A
print("Step 15: All devices send MLE Parent Response to Router_2 (DUT).")
# Step 16: Router_2 (DUT)
# - Description: Automatically sends MLE Child ID Request to Router_1.
# - Pass Criteria:
# - The DUT MUST send a MLE Child ID Request to Router_1, including the following TLVs:
# - Active Timestamp TLV
# - Link-layer Frame Counter TLV
# - Mode TLV
# - Response TLV
# - Timeout TLV
# - TLV Request TLV
# - Version TLV
# - MLE Frame Counter TLV (optional)
# - The following TLV MUST NOT be present in the MLE Child ID Request:
# - Address Registration TLV
print("Step 16: Router_2 (DUT) sends MLE Child ID Request to Router_1.")
_pkt = pkts.filter_wpan_src64(DUT).\
filter_wpan_dst64(ROUTER1).\
filter_mle_cmd(consts.MLE_CHILD_ID_REQUEST).\
filter(lambda p: {
consts.ACTIVE_TIMESTAMP_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()
_pkt.must_not_verify(lambda p: (consts.ADDRESS_REGISTRATION_TLV) in p.mle.tlv.type)
# Step 17: Router_1
# - Description: Automatically sends MLE Child ID Response to Router_2, including the following TLVs:
# - Active Timestamp TLV
# - Address16 TLV
# - Leader Data TLV
# - Pending Operational Dataset TLV (corresponding to step 11)
# - Pending Timestamp TLV (corresponding to step 11)
# - Source Address TLV
# - Address Registration TLV (optional)
# - Network Data TLV (optional)
# - Route64 TLV (optional)
# - Pass Criteria: N/A
print("Step 17: Router_1 sends MLE Child ID Response to Router_2.")
pkts.filter_wpan_src64(ROUTER1).\
filter_wpan_dst64(DUT).\
filter_mle_cmd(consts.MLE_CHILD_ID_RESPONSE).\
filter(lambda p: {
consts.ACTIVE_TIMESTAMP_TLV,
consts.ADDRESS16_TLV,
consts.LEADER_DATA_TLV,
consts.PENDING_OPERATION_DATASET_TLV,
consts.PENDING_TIMESTAMP_TLV,
consts.SOURCE_ADDRESS_TLV
} <= set(p.mle.tlv.type)).\
must_next()
# Step 18: Test Harness
# - Description: Wait 200 seconds to allow the DUT to upgrade to a Router.
# - Pass Criteria: N/A (implied)
print("Step 18: Wait 200 seconds to allow the DUT to upgrade to a Router.")
# Step 19: Leader
# - Description: Harness instructs Leader to send a MGMT_ACTIVE_GET.req to Router_2 (DUT) to get the Active
# Operational Dataset. (Request entire Active Operational Dataset by not including the Get TLV):
# - CoAP Request URI: coap://[<L>]:MM/c/ag
# - CoAP Payload: <empty>
# - Pass Criteria: N/A
print("Step 19: Leader sends a MGMT_ACTIVE_GET.req to Router_2 (DUT).")
pkts.filter_coap_request(consts.MGMT_ACTIVE_GET_URI).\
filter(lambda p: p.ipv6.src in pv.vars['LEADER_IPADDRS'] and\
p.ipv6.dst in pv.vars['DUT_IPADDRS']).\
must_next()
# Step 20: Router_2 (DUT)
# - Description: Automatically sends MGMT_ACTIVE_GET.rsp to the Leader.
# - Pass Criteria:
# - The DUT MUST send a MGMT_ACTIVE_GET.rsp to the Leader:
# - CoAP Response Code: 2.04 Changed
# - CoAP Payload: <entire active operational data set>
# - The PAN ID TLV MUST have a value of abcd.
print("Step 20: Router_2 (DUT) sends MGMT_ACTIVE_GET.rsp to the Leader.")
pkts.filter_coap_ack(consts.MGMT_ACTIVE_GET_URI).\
filter(lambda p: p.ipv6.src in pv.vars['DUT_IPADDRS'] and\
p.ipv6.dst in pv.vars['LEADER_IPADDRS']).\
filter(lambda p: {
consts.NM_PAN_ID_TLV
} <= set(p.coap.tlv.type) and\
p.coap.tlv.pan_id == PAN_ID_STEP11).\
must_next()
# Step 21: Commissioner
# - Description: Harness verifies connectivity by instructing the Commissioner to send an ICMPv6 Echo Request to
# the DUT mesh local address.
# - Pass Criteria: The DUT must respond with an ICMPv6 Echo Reply.
print("Step 21: Commissioner sends an ICMPv6 Echo Request to the DUT.")
_pkt = pkts.filter_ping_request().\
filter(lambda p: p.ipv6.src in pv.vars['COMMISSIONER_IPADDRS'] and\
p.ipv6.dst in pv.vars['DUT_IPADDRS']).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter(lambda p: p.ipv6.src in pv.vars['DUT_IPADDRS'] and\
p.ipv6.dst in pv.vars['COMMISSIONER_IPADDRS']).\
must_next()
if __name__ == '__main__':
verify_utils.run_main(verify)