[thread-cert] refactor case 5.3.9 using pktverify (#5823)

This commit is contained in:
Jing Ma
2020-12-02 12:01:58 -08:00
committed by GitHub
parent d218dfcb35
commit 141208b9d3
@@ -32,42 +32,75 @@ import unittest
import command
import config
import copy
import ipv6
import thread_cert
from pktverify.consts import WIRESHARK_OVERRIDE_PREFS, ADDR_QRY_URI, ADDR_NTF_URI, NL_ML_EID_TLV, NL_RLOC16_TLV, NL_TARGET_EID_TLV
from pktverify.packet_verifier import PacketVerifier
from pktverify.bytes import Bytes
LEADER = 1
ROUTER1 = 2
DUT_ROUTER2 = 3
ROUTER3 = 4
SED1 = 5
PREFIX_1 = '2001::/64'
GUA_1_START = '2001'
PREFIX_2 = '2002::/64'
# Test Purpose and Description:
# -----------------------------
# The purpose of this test case is to validate that the DUT is able to generate
# Address Query and Address Notification messages properly.
# The Leader is configured as a Border Router with DHCPv6 server for prefixes
# 2001:: & 2002::
#
# Test Topology:
# -------------
# Router_1 - Leader
# / \
# Router_3 Router_2(DUT)
# |
# SED
#
# DUT Types:
# ----------
# Router
class Cert_5_3_09_AddressQuery(thread_cert.TestCase):
USE_MESSAGE_FACTORY = False
TOPOLOGY = {
LEADER: {
'name': 'LEADER',
'mode': 'rdn',
'panid': 0xface,
'allowlist': [ROUTER1, DUT_ROUTER2, ROUTER3]
},
ROUTER1: {
'name': 'ROUTER_1',
'mode': 'rdn',
'panid': 0xface,
'router_selection_jitter': 1,
'allowlist': [LEADER]
},
DUT_ROUTER2: {
'name': 'ROUTER_2',
'mode': 'rdn',
'panid': 0xface,
'router_selection_jitter': 1,
'allowlist': [LEADER, SED1]
},
ROUTER3: {
'name': 'ROUTER_3',
'mode': 'rdn',
'panid': 0xface,
'router_selection_jitter': 1,
'allowlist': [LEADER]
},
SED1: {
'name': 'SED',
'is_mtd': True,
'mode': '-',
'panid': 0xface,
@@ -76,22 +109,22 @@ class Cert_5_3_09_AddressQuery(thread_cert.TestCase):
},
}
# override wireshark preferences with case needed parameters
CASE_WIRESHARK_PREFS = copy.deepcopy(WIRESHARK_OVERRIDE_PREFS)
CASE_WIRESHARK_PREFS['6lowpan.context1'] = PREFIX_1
CASE_WIRESHARK_PREFS['6lowpan.context2'] = PREFIX_2
def test(self):
# 1 & 2 ALL: Build and verify the topology
self.nodes[LEADER].start()
self.simulator.go(5)
self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
# Configure the LEADER to be a DHCPv6 Border Router for prefixes 2001::
# & 2002::
self.nodes[LEADER].add_prefix('2001::/64', 'pdros')
self.nodes[LEADER].add_prefix('2002::/64', 'pdro')
# Configure the LEADER to be a DHCPv6 Border Router for prefixes
self.nodes[LEADER].add_prefix(PREFIX_1, 'pdros')
self.nodes[LEADER].add_prefix(PREFIX_2, 'pdro')
self.nodes[LEADER].register_netdata()
# Set lowpan context of sniffer
self.simulator.set_lowpan_context(1, '2001::/64')
self.simulator.set_lowpan_context(2, '2002::/64')
self.nodes[ROUTER1].start()
self.simulator.go(5)
self.assertEqual(self.nodes[ROUTER1].get_state(), 'router')
@@ -108,85 +141,195 @@ class Cert_5_3_09_AddressQuery(thread_cert.TestCase):
self.simulator.go(5)
self.assertEqual(self.nodes[SED1].get_state(), 'child')
self.collect_rlocs()
self.collect_rloc16s()
self.collect_ipaddrs()
# 3 SED1: The SED1 sends an ICMPv6 Echo Request to ROUTER3 using GUA
# 2001:: address
router3_addr = self.nodes[ROUTER3].get_addr("2001::/64")
# PREFIX_1 address
router3_addr = self.nodes[ROUTER3].get_addr(PREFIX_1)
self.assertTrue(router3_addr is not None)
self.assertTrue(self.nodes[SED1].ping(router3_addr))
# Verify DUT_ROUTER2 sent an Address Query Request
dut_router2_messages = self.simulator.get_messages_sent_by(DUT_ROUTER2)
msg = dut_router2_messages.next_coap_message('0.02', '/a/aq')
msg.assertSentToDestinationAddress(config.REALM_LOCAL_ALL_ROUTERS_ADDRESS)
command.check_address_query(
msg,
self.nodes[DUT_ROUTER2],
config.REALM_LOCAL_ALL_ROUTERS_ADDRESS,
)
# Verify the DUT_ROUTER2 forwarded the ICMPv6 Echo Request to ROUTER3
msg = dut_router2_messages.get_icmp_message(ipv6.ICMP_ECHO_REQUEST)
assert (msg is not None), "Error: The DUT_ROUTER2 didn't forward ICMPv6 Echo Request to ROUTER3"
msg.assertSentToNode(self.nodes[ROUTER3])
# 4 ROUTER1: ROUTER1 sends an ICMPv6 Echo Request to the SED1 using GUA
# 2001:: address
sed1_addr = self.nodes[SED1].get_addr("2001::/64")
# PREFIX_1 address
sed1_addr = self.nodes[SED1].get_addr(PREFIX_1)
self.assertTrue(sed1_addr is not None)
self.assertTrue(self.nodes[ROUTER1].ping(sed1_addr))
# Wait for sniffer got all Address Notification messages
self.simulator.go(1)
# Verify DUT_ROUTER2 sent an Address Notification message
dut_router2_messages = self.simulator.get_messages_sent_by(DUT_ROUTER2)
msg = dut_router2_messages.next_coap_message('0.02', '/a/an')
command.check_address_notification(msg, self.nodes[DUT_ROUTER2], self.nodes[ROUTER1])
# 5 SED1: SED1 sends an ICMPv6 Echo Request to the ROUTER3 using GUA
# 2001:: address
# PREFIX_1 address
self.assertTrue(self.nodes[SED1].ping(router3_addr))
# Wait for sniffer got the ICMPv6 Echo Reply
self.simulator.go(1)
# Verify DUT_ROUTER2 didn't generate Address Query Request
dut_router2_messages = self.simulator.get_messages_sent_by(DUT_ROUTER2)
dut_router2_messages_temp = copy.deepcopy(dut_router2_messages)
msg = dut_router2_messages.next_coap_message('0.02', '/a/aq', False)
assert (msg is None), "Error: The DUT_ROUTER2 sent an unexpected Address Query Request"
# Verify DUT_ROUTER2 forwarded the ICMPv6 Echo Reply to SED1
msg = dut_router2_messages_temp.get_icmp_message(ipv6.ICMP_ECHO_RESPONSE)
assert (msg is not None), "Error: The DUT_ROUTER2 didn't forward ICMPv6 Echo Reply to SED1"
msg.assertSentToNode(self.nodes[SED1])
# 6 DUT_ROUTER2: Power off ROUTER3 and wait 580s to alow LEADER to
# expire its Router ID
self.nodes[ROUTER3].stop()
self.simulator.go(580)
# The SED1 sends an ICMPv6 Echo Request to ROUTER3 GUA 2001:: address
# The SED1 sends an ICMPv6 Echo Request to ROUTER3 GUA PREFIX_1 address
self.assertFalse(self.nodes[SED1].ping(router3_addr))
# Verify DUT_ROUTER2 sent an Address Query Request
dut_router2_messages = self.simulator.get_messages_sent_by(DUT_ROUTER2)
msg = dut_router2_messages.next_coap_message('0.02', '/a/aq')
msg.assertSentToDestinationAddress(config.REALM_LOCAL_ALL_ROUTERS_ADDRESS)
self.simulator.go(1)
# 7 SED1: Power off SED1 and wait to allow DUT_ROUTER2 to timeout the
# child
self.nodes[SED1].stop()
self.simulator.go(5)
self.simulator.go(3)
self.simulator.go(config.DEFAULT_CHILD_TIMEOUT)
# ROUTER1 sends two ICMPv6 Echo Requests to SED1 GUA 2001:: address
# ROUTER1 sends two ICMPv6 Echo Requests to SED1 GUA PREFIX_1 address
self.assertFalse(self.nodes[ROUTER1].ping(sed1_addr))
self.assertFalse(self.nodes[ROUTER1].ping(sed1_addr))
# Verify DUT_ROUTER2 didn't generate an Address Notification message
dut_router2_messages = self.simulator.get_messages_sent_by(DUT_ROUTER2)
msg = dut_router2_messages.next_coap_message('0.02', '/a/an', False)
assert (msg is None), "Error: The DUT_ROUTER2 sent an unexpected Address Notification message"
def verify(self, pv):
pkts = pv.pkts
pv.summary.show()
LEADER = pv.vars['LEADER']
ROUTER_1 = pv.vars['ROUTER_1']
ROUTER_1_RLOC = pv.vars['ROUTER_1_RLOC']
ROUTER_2 = pv.vars['ROUTER_2']
ROUTER_2_RLOC = pv.vars['ROUTER_2_RLOC']
ROUTER_2_RLOC16 = pv.vars['ROUTER_2_RLOC16']
ROUTER_3 = pv.vars['ROUTER_3']
SED = pv.vars['SED']
SED_RLOC16 = pv.vars['SED_RLOC16']
MM = pv.vars['MM_PORT']
GUA1 = {}
for node in ('ROUTER_1', 'ROUTER_3', 'SED'):
for addr in pv.vars['%s_IPADDRS' % node]:
if addr.startswith(Bytes(GUA_1_START)):
GUA1[node] = addr
# Step 1: Build the topology as described
for i in range(1, 4):
pv.verify_attached('ROUTER_%d' % i, 'LEADER')
pv.verify_attached('SED', 'ROUTER_2', 'MTD')
# Step 2: SED sends an ICMPv6 Echo Request to Router_3 using GUA 2001::
# address
# The DUT MUST generate an Address Query Request on SEDs behalf
# to find each nodes RLOC.
# The Address Query Request MUST be sent to the Realm-Local
# All-Routers address (FF03::2)
# CoAP URI-Path
# - NON POST coap://<FF03::2>
# CoAP Payload
# - Target EID TLV
# The DUT MUST receive and process the incoming Address Query
# Response and forward the ICMPv6 Echo Reply packet to SED
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(SED).\
filter_ipv6_dst(GUA1['ROUTER_3']).\
must_next()
pkts.filter_wpan_src64(ROUTER_2).\
filter_RLARMA().\
filter_coap_request(ADDR_QRY_URI, port=MM).\
filter(lambda p: p.thread_address.tlv.target_eid == GUA1['ROUTER_3']).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(ROUTER_3).\
filter_ipv6_dst(GUA1['SED']).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(ROUTER_2).\
filter_wpan_dst16(SED_RLOC16).\
must_next()
# Step 3: Router_1 sends an ICMPv6 Echo Request to SED using GUA 2001::
# addresss
# The DUT MUST respond to the Address Query Request with a properly
# formatted Address Notification Message:
# CoAP URI-Path
# - CON POST coap://[<Address Query Source>]:MM/a/an
# CoAP Payload
# - ML-EID TLV
# - RLOC16 TLV
# - Target EID TLV
# The IPv6 Source address MUST be the RLOC of the originator
# The IPv6 Destination address MUST be the RLOC of the destination
pkts.filter_wpan_src64(ROUTER_1).\
filter_RLARMA().\
filter_coap_request(ADDR_QRY_URI, port=MM).\
filter(lambda p: p.thread_address.tlv.target_eid == GUA1['SED']).\
must_next()
pkts.filter_ipv6_src_dst(ROUTER_2_RLOC, ROUTER_1_RLOC).\
filter_coap_request(ADDR_NTF_URI, port=MM).\
filter(lambda p: {
NL_ML_EID_TLV,
NL_RLOC16_TLV,
NL_TARGET_EID_TLV
} <= set(p.coap.tlv.type) and\
p.thread_address.tlv.target_eid == GUA1['SED'] and\
p.thread_address.tlv.rloc16 == ROUTER_2_RLOC16
).\
must_next()
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(ROUTER_1).\
filter_ipv6_dst(GUA1['SED']).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(SED).\
filter_ipv6_dst(GUA1['ROUTER_1']).\
must_next()
# Step 5: SED sends an ICMPv6 Echo Request to Router_3 using GUA 2001::
# address
# The DUT MUST not send an Address Query as Router_3 address should
# be cached.
# The DUT MUST forward the ICMPv6 Echo Reply to SED
_pkt = pkts.filter_ping_request().\
filter_wpan_src64(SED).\
filter_ipv6_dst(GUA1['ROUTER_3']).\
must_next()
lstart = pkts.index
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(ROUTER_3).\
filter_ipv6_dst(GUA1['SED']).\
must_next()
pkts.filter_ping_reply(identifier=_pkt.icmpv6.echo.identifier).\
filter_wpan_src64(ROUTER_2).\
filter_wpan_dst16(SED_RLOC16).\
must_next()
lend = pkts.index
pkts.range(lstart, lend).filter_wpan_src64(ROUTER_2).\
filter_RLARMA().\
filter_coap_request(ADDR_QRY_URI, port=MM).\
must_not_next()
# Step 6: SED sends an ICMPv6 Echo Request to Router_3 using GUA 2001::
# address
# The DUT MUST update its address cache and remove all entries
# based on Router_3s Router ID.
# The DUT MUST send an Address Query to discover Router_3s RLOC address.
pkts.filter_ping_request().\
filter_wpan_src64(SED).\
filter_ipv6_dst(GUA1['ROUTER_3']).\
must_next()
pkts.filter_wpan_src64(ROUTER_2).\
filter_RLARMA().\
filter_coap_request(ADDR_QRY_URI, port=MM).\
filter(lambda p: p.thread_address.tlv.target_eid == GUA1['ROUTER_3']).\
must_next()
# Step 7: Router_1 sends two ICMPv6 Echo Requests to SED using GUA 2001::
# address
# The DUT MUST NOT respond with an Address Notification message
pkts.filter_wpan_src64(ROUTER_2).\
filter_ipv6_dst(ROUTER_1_RLOC).\
filter_coap_request(ADDR_NTF_URI, port=MM).\
must_not_next()
pkts.filter_ping_request().\
filter_wpan_src64(ROUTER_1).\
filter_ipv6_dst(GUA1['SED']).\
must_next()
if __name__ == '__main__':