mirror of
https://github.com/espressif/openthread.git
synced 2026-09-12 12:10:07 +00:00
[toranj] add test-case for router table (#2970)
This commit adds a test-case under `toranj` to verify router table
entries on a network with 4 routers: {r1, r2, r3} forming a loop
with r4 connecting to r3.
This commit is contained in:
Abtin Keshavarzian
committed by
Jonathan Hui
Jonathan Hui
parent
0cea4bc738
commit
f993ba5f89
@@ -133,6 +133,7 @@ run test-016-neighbor-table.py
|
||||
run test-017-parent-reset-child-recovery.py
|
||||
run test-018-child-supervision.py
|
||||
run test-019-inform-previous-parent.py
|
||||
run test-020-router-table.py
|
||||
run test-100-mcu-power-state.py
|
||||
run test-600-channel-manager-properties.py
|
||||
run test-601-channel-manager-channel-change.py
|
||||
|
||||
@@ -0,0 +1,198 @@
|
||||
#!/usr/bin/env python
|
||||
#
|
||||
# Copyright (c) 2018, 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 time
|
||||
import wpan
|
||||
from wpan import verify
|
||||
|
||||
#-----------------------------------------------------------------------------------------------------------------------
|
||||
# Test description: Router table
|
||||
#
|
||||
# Verify router table entries on a network with 4 routers:
|
||||
# {r1, r2, r3} forming a loop with r4 connecting to r3.
|
||||
#
|
||||
|
||||
test_name = __file__[:-3] if __file__.endswith('.py') else __file__
|
||||
print '-' * 120
|
||||
print 'Starting \'{}\''.format(test_name)
|
||||
|
||||
#-----------------------------------------------------------------------------------------------------------------------
|
||||
# Creating `wpan.Nodes` instances
|
||||
|
||||
speedup = 4
|
||||
wpan.Node.set_time_speedup_factor(speedup)
|
||||
|
||||
r1 = wpan.Node()
|
||||
r2 = wpan.Node()
|
||||
r3 = wpan.Node()
|
||||
r4 = wpan.Node()
|
||||
c4 = wpan.Node()
|
||||
|
||||
#-----------------------------------------------------------------------------------------------------------------------
|
||||
# Init all nodes
|
||||
|
||||
wpan.Node.init_all_nodes()
|
||||
|
||||
#-----------------------------------------------------------------------------------------------------------------------
|
||||
# Build network topology
|
||||
#
|
||||
#
|
||||
# r1 ------ r2
|
||||
# \ /
|
||||
# \ /
|
||||
# \ /
|
||||
# r3 _____ r4
|
||||
#
|
||||
#
|
||||
|
||||
r1.form("route-table")
|
||||
|
||||
r1.whitelist_node(r2)
|
||||
r2.whitelist_node(r1)
|
||||
r2.join_node(r1, wpan.JOIN_TYPE_ROUTER)
|
||||
|
||||
r2.whitelist_node(r3)
|
||||
r3.whitelist_node(r2)
|
||||
r3.join_node(r2, wpan.JOIN_TYPE_ROUTER)
|
||||
|
||||
r3.whitelist_node(r1)
|
||||
r1.whitelist_node(r3)
|
||||
|
||||
r3.whitelist_node(r4)
|
||||
r4.whitelist_node(r3)
|
||||
r4.join_node(r3, wpan.JOIN_TYPE_ROUTER)
|
||||
|
||||
# c4 is attached to r4 so that it quickly gets promoted to a router role.
|
||||
c4.whitelist_node(r4)
|
||||
r4.whitelist_node(c4)
|
||||
c4.join_node(r4, wpan.JOIN_TYPE_SLEEPY_END_DEVICE)
|
||||
c4.set(wpan.WPAN_POLL_INTERVAL, '2000')
|
||||
|
||||
#-----------------------------------------------------------------------------------------------------------------------
|
||||
# Test implementation
|
||||
#
|
||||
|
||||
verify(r1.get(wpan.WPAN_NODE_TYPE) == wpan.NODE_TYPE_LEADER)
|
||||
verify(r2.get(wpan.WPAN_NODE_TYPE) == wpan.NODE_TYPE_ROUTER)
|
||||
verify(r3.get(wpan.WPAN_NODE_TYPE) == wpan.NODE_TYPE_ROUTER)
|
||||
verify(r4.get(wpan.WPAN_NODE_TYPE) == wpan.NODE_TYPE_ROUTER)
|
||||
|
||||
r1_id = int(r1.get(wpan.WPAN_THREAD_ROUTER_ID), 0)
|
||||
r2_id = int(r2.get(wpan.WPAN_THREAD_ROUTER_ID), 0)
|
||||
r3_id = int(r3.get(wpan.WPAN_THREAD_ROUTER_ID), 0)
|
||||
r4_id = int(r4.get(wpan.WPAN_THREAD_ROUTER_ID), 0)
|
||||
|
||||
r1_ext_addr = r1.get(wpan.WPAN_EXT_ADDRESS)[1:-1]
|
||||
r2_ext_addr = r2.get(wpan.WPAN_EXT_ADDRESS)[1:-1]
|
||||
r3_ext_addr = r3.get(wpan.WPAN_EXT_ADDRESS)[1:-1]
|
||||
r4_ext_addr = r4.get(wpan.WPAN_EXT_ADDRESS)[1:-1]
|
||||
|
||||
r1_rloc = int(r1.get(wpan.WPAN_THREAD_RLOC16), 16)
|
||||
r2_rloc = int(r2.get(wpan.WPAN_THREAD_RLOC16), 16)
|
||||
r3_rloc = int(r3.get(wpan.WPAN_THREAD_RLOC16), 16)
|
||||
r4_rloc = int(r4.get(wpan.WPAN_THREAD_RLOC16), 16)
|
||||
|
||||
WAIT_TIME = 30 / speedup + 5
|
||||
|
||||
INVALID_ROUTER_ID = 63
|
||||
|
||||
def check_r1_router_table():
|
||||
router_table = wpan.parse_router_table_result(r1.get(wpan.WPAN_THREAD_ROUTER_TABLE))
|
||||
verify(len(router_table) == 4)
|
||||
for entry in router_table:
|
||||
if entry.rloc16 == r1_rloc:
|
||||
pass
|
||||
elif entry.rloc16 == r2_rloc:
|
||||
# r1 should be directly connected to r2.
|
||||
verify(entry.is_link_established())
|
||||
verify(entry.ext_address == r2_ext_addr)
|
||||
elif entry.rloc16 == r3_rloc:
|
||||
# r1 should be directly connected to r3.
|
||||
verify(entry.is_link_established())
|
||||
verify(entry.ext_address == r3_ext_addr)
|
||||
elif entry.rloc16 == r4_rloc:
|
||||
# r1's next hop towards r4 should be through r3.
|
||||
verify(not entry.is_link_established());
|
||||
verify(entry.next_hop == r3_id)
|
||||
else:
|
||||
raise(wpan.VerifyError("unknown entry in the router table of r1"))
|
||||
|
||||
wpan.verify_within(check_r1_router_table, WAIT_TIME)
|
||||
|
||||
def check_r3_router_table():
|
||||
router_table = wpan.parse_router_table_result(r3.get(wpan.WPAN_THREAD_ROUTER_TABLE))
|
||||
verify(len(router_table) == 4)
|
||||
for entry in router_table:
|
||||
if entry.rloc16 == r1_rloc:
|
||||
# r3 should be directly connected to r1.
|
||||
verify(entry.is_link_established())
|
||||
verify(entry.ext_address == r1_ext_addr)
|
||||
elif entry.rloc16 == r2_rloc:
|
||||
# r3 should be directly connected to r2.
|
||||
verify(entry.is_link_established())
|
||||
verify(entry.ext_address == r2_ext_addr)
|
||||
elif entry.rloc16 == r3_rloc:
|
||||
pass
|
||||
elif entry.rloc16 == r4_rloc:
|
||||
# r3 should be directly connected to r4.
|
||||
verify(entry.is_link_established());
|
||||
verify(entry.ext_address == r4_ext_addr)
|
||||
else:
|
||||
raise(wpan.VerifyError("unknown entry in the router table of r3"))
|
||||
|
||||
wpan.verify_within(check_r3_router_table, WAIT_TIME)
|
||||
|
||||
def check_r4_router_table():
|
||||
router_table = wpan.parse_router_table_result(r4.get(wpan.WPAN_THREAD_ROUTER_TABLE))
|
||||
verify(len(router_table) == 4)
|
||||
for entry in router_table:
|
||||
if entry.rloc16 == r1_rloc:
|
||||
# r4's next hop towards r1 should be through r3.
|
||||
verify(not entry.is_link_established())
|
||||
verify(entry.next_hop == r3_id)
|
||||
elif entry.rloc16 == r2_rloc:
|
||||
# r4's next hop towards r2 should be through r3.
|
||||
verify(not entry.is_link_established());
|
||||
verify(entry.next_hop == r3_id)
|
||||
elif entry.rloc16 == r3_rloc:
|
||||
# r4 should be directly connected to r3.
|
||||
verify(entry.is_link_established())
|
||||
verify(entry.ext_address == r3_ext_addr)
|
||||
elif entry.rloc16 == r4_rloc:
|
||||
pass
|
||||
else:
|
||||
raise(wpan.VerifyError("unknown entry in the router table of r4"))
|
||||
|
||||
wpan.verify_within(check_r4_router_table, WAIT_TIME)
|
||||
|
||||
#-----------------------------------------------------------------------------------------------------------------------
|
||||
# Test finished
|
||||
|
||||
wpan.Node.finalize_all_nodes()
|
||||
|
||||
print '\'{}\' passed.'.format(test_name)
|
||||
@@ -1136,3 +1136,61 @@ class NeighborEntry(object):
|
||||
def parse_neighbor_table_result(neighbor_table_list):
|
||||
""" Parses neighbor table list string and returns an array of `NeighborEntry` objects"""
|
||||
return [ NeighborEntry(item) for item in neighbor_table_list.split('\n')[1:-1] ]
|
||||
|
||||
#- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
|
||||
class RouterTableEntry(object):
|
||||
""" This object encapsulates a router table entry"""
|
||||
|
||||
def __init__(self, text):
|
||||
|
||||
# Example of expected text:
|
||||
#
|
||||
# `\t"8A970B3251810826, RLOC16:4000, RouterId:16, NextHop:43, PathCost:1, LQIn:3, LQOut:3, Age:3, LinkEst:yes"`
|
||||
#
|
||||
|
||||
# We get rid of the first two chars `\t"' and last char '"', split the rest using whitespace as separator.
|
||||
# Then remove any ',' at end of items in the list.
|
||||
items = [item[:-1] if item[-1] ==',' else item for item in text[2:-1].split()]
|
||||
|
||||
# First item in the extended address
|
||||
self._ext_address = items[0]
|
||||
|
||||
# Convert the rest into a dictionary by splitting the text using ':' as separator
|
||||
dict = {item.split(':')[0] : item.split(':')[1] for item in items[1:]}
|
||||
|
||||
self._rloc16 = int(dict['RLOC16'], 16)
|
||||
self._router_id = int(dict['RouterId'], 0)
|
||||
self._next_hop = int(dict['NextHop'], 0)
|
||||
self._path_cost = int(dict['PathCost'], 0)
|
||||
self._age = int(dict['Age'], 0)
|
||||
self._le = (dict['LinkEst'] == 'yes')
|
||||
|
||||
@property
|
||||
def ext_address(self):
|
||||
return self._ext_address
|
||||
|
||||
@property
|
||||
def rloc16(self):
|
||||
return self._rloc16
|
||||
|
||||
@property
|
||||
def router_id(self):
|
||||
return self._router_id
|
||||
|
||||
@property
|
||||
def next_hop(self):
|
||||
return self._next_hop
|
||||
|
||||
@property
|
||||
def path_cost(self):
|
||||
return self._path_cost
|
||||
|
||||
def is_link_established(self):
|
||||
return self._le
|
||||
|
||||
def __repr__(self):
|
||||
return 'RouterTableEntry({})'.format(self.__dict__)
|
||||
|
||||
def parse_router_table_result(router_table_list):
|
||||
""" Parses router table list string and returns an array of `RouterTableEntry` objects"""
|
||||
return [ RouterTableEntry(item) for item in router_table_list.split('\n')[1:-1] ]
|
||||
|
||||
Reference in New Issue
Block a user