blob: 0da95cd01c72c8a99f2221186b5b8acbdf13ac26 [file] [log] [blame]
#!/usr/bin/env python3
#
# Copyright (c) 2016, 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 unittest
import mle
import thread_cert
from pktverify.consts import MLE_ADVERTISEMENT, MLE_PARENT_REQUEST, MLE_PARENT_RESPONSE, MLE_CHILD_ID_REQUEST, SOURCE_ADDRESS_TLV, MODE_TLV, TIMEOUT_TLV, CHALLENGE_TLV, RESPONSE_TLV, LINK_LAYER_FRAME_COUNTER_TLV, ADDRESS16_TLV, LEADER_DATA_TLV, NETWORK_DATA_TLV, TLV_REQUEST_TLV, SCAN_MASK_TLV, CONNECTIVITY_TLV, LINK_MARGIN_TLV, VERSION_TLV, ADDRESS_REGISTRATION_TLV
from pktverify.packet_verifier import PacketVerifier
from pktverify.null_field import nullField
LEADER = 1
REED = 2
ROUTER2 = 3
ROUTER1 = 4
# Test Purpose and Description:
# -----------------------------
# The purpose of this test case is to validate that DUT will
# attach to a REED with the highest link quality, when routers
# with the highest link quality are not available.
#
# Test Topology:
# -------------
# Leader
# / \
# Router2 REED1
# \ /(better link_quality)
# Router1[DUT]
#
# DUT Types:
# ----------
# Router
class Cert_5_1_11_REEDAttachLinkQuality(thread_cert.TestCase):
USE_MESSAGE_FACTORY = False
TOPOLOGY = {
LEADER: {
'name': 'LEADER',
'mode': 'rdn',
'allowlist': [REED, ROUTER2]
},
REED: {
'name': 'REED_1',
'mode': 'rdn',
'router_upgrade_threshold': 0,
'allowlist': [LEADER, ROUTER1]
},
ROUTER2: {
'name': 'ROUTER_2',
'mode': 'rdn',
'allowlist': [LEADER, (ROUTER1, -85)]
},
ROUTER1: {
'name': 'ROUTER_1',
'mode': 'rdn',
'allowlist': [REED, ROUTER2]
},
}
def test(self):
self.nodes[LEADER].start()
self.simulator.go(5)
self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
self.nodes[REED].start()
self.simulator.go(5)
self.assertEqual(self.nodes[REED].get_state(), 'child')
self.nodes[ROUTER2].start()
self.simulator.go(5)
self.assertEqual(self.nodes[ROUTER2].get_state(), 'router')
self.nodes[ROUTER1].start()
self.simulator.go(10)
self.assertEqual(self.nodes[ROUTER1].get_state(), 'router')
self.assertEqual(self.nodes[REED].get_state(), 'router')
def verify(self, pv):
pkts = pv.pkts
pv.summary.show()
LEADER = pv.vars['LEADER']
REED_1 = pv.vars['REED_1']
ROUTER_1 = pv.vars['ROUTER_1']
ROUTER_2 = pv.vars['ROUTER_2']
# Step 1: Verify ROUTER_2 and Leader are sending MLE advertisements.
pkts.filter_wpan_src64(LEADER).\
filter_mle_cmd(MLE_ADVERTISEMENT).\
must_next()
pv.verify_attached('ROUTER_2')
# Step 3: The DUT sends a MLE Parent Request with an IP hop limit of
# 255 to the Link-Local All Routers multicast address (FF02::2).
# The following TLVs MUST be present in the MLE Parent Request:
# - Challenge TLV
# - Mode TLV
# - Scan Mask TLV
# If the DUT sends multiple MLE Parent Requests
# - The first one MUST be sent only to all Routers
# - Subsequent ones MAY be sent to all Routers and REEDS
# - Version TLV
# If the first MLE Parent Request was sent to all Routers and
# REEDS, the test fails.
pkts.filter_wpan_src64(ROUTER_1).\
filter_LLARMA().\
filter_mle_cmd(MLE_PARENT_REQUEST).\
filter(lambda p: {
CHALLENGE_TLV,
MODE_TLV,
SCAN_MASK_TLV,
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 5: The DUT MUST send a MLE Parent Request with an IP hop limit of
# 255 to the Link-Local All Routers multicast address (FF02::2).
# The following TLVs MUST be present in the MLE Parent Request:
# - Challenge TLV
# - Mode TLV
# - Scan Mask TLV
# - The Scan Mask TLV MUST be sent to Routers And REEDs
# - Version TLV
#
pkts.filter_wpan_src64(ROUTER_1).\
filter_LLARMA().\
filter_mle_cmd(MLE_PARENT_REQUEST).\
filter(lambda p: {
CHALLENGE_TLV,
MODE_TLV,
SCAN_MASK_TLV,
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: The DUT MUST initiate the attach process with REED_1 by
# sending an MLE Child ID Request; if not, the test fails.
# The following TLVs MUST be present in the MLE Child ID Request:
# - Link-layer Frame Counter TLV
# - Mode TLV
# - Response TLV
# - Timeout TLV
# - TLV Request TLV
# - Address16 TLV
# - Network Data TLV
# - Route64 TLV (optional)
# - Version TLV
# - MLE Frame Counter TLV (optional)
# The following TLV MUST NOT be present in the MLE Child ID Request:
# - Address Registration TLV
_pkt = pkts.filter_wpan_src64(ROUTER_1).\
filter_wpan_dst64(REED_1).\
filter_mle_cmd(MLE_CHILD_ID_REQUEST).\
filter(lambda p: {
LINK_LAYER_FRAME_COUNTER_TLV,
MODE_TLV,
RESPONSE_TLV,
TIMEOUT_TLV,
TLV_REQUEST_TLV,
ADDRESS16_TLV,
NETWORK_DATA_TLV,
VERSION_TLV
} <= set(p.mle.tlv.type) and\
p.mle.tlv.addr16 is nullField and\
p.thread_nwd.tlv.type is nullField
).\
must_next()
_pkt.must_not_verify(lambda p: (ADDRESS_REGISTRATION_TLV) in p.mle.tlv.type)
if __name__ == '__main__':
unittest.main()