xref: /aosp_15_r20/external/openthread/tests/toranj/cli/test-003-join.py (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1#!/usr/bin/env python3
2#
3#  Copyright (c) 2021, The OpenThread Authors.
4#  All rights reserved.
5#
6#  Redistribution and use in source and binary forms, with or without
7#  modification, are permitted provided that the following conditions are met:
8#  1. Redistributions of source code must retain the above copyright
9#     notice, this list of conditions and the following disclaimer.
10#  2. Redistributions in binary form must reproduce the above copyright
11#     notice, this list of conditions and the following disclaimer in the
12#     documentation and/or other materials provided with the distribution.
13#  3. Neither the name of the copyright holder nor the
14#     names of its contributors may be used to endorse or promote products
15#     derived from this software without specific prior written permission.
16#
17#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27#  POSSIBILITY OF SUCH DAMAGE.
28
29from cli import verify
30from cli import verify_within
31import cli
32
33# -----------------------------------------------------------------------------------------------------------------------
34# Test description: joining (as router, end-device, sleepy) - two node network
35
36test_name = __file__[:-3] if __file__.endswith('.py') else __file__
37print('-' * 120)
38print('Starting \'{}\''.format(test_name))
39
40# -----------------------------------------------------------------------------------------------------------------------
41# Creating `cli.Nodes` instances
42
43speedup = 10
44cli.Node.set_time_speedup_factor(speedup)
45
46node1 = cli.Node()
47node2 = cli.Node()
48
49# -----------------------------------------------------------------------------------------------------------------------
50# Test implementation
51
52node1.allowlist_node(node2)
53node2.allowlist_node(node1)
54
55node1.form('join-net')
56verify(node1.get_state() == 'leader')
57
58node2.join(node1)
59verify(node2.get_state() == 'router')
60
61node2.interface_down()
62
63node2.join(node1, cli.JOIN_TYPE_END_DEVICE)
64verify(node2.get_state() == 'child')
65verify(node2.get_mode() == 'rn')
66
67node2.interface_down()
68
69node2.join(node1, cli.JOIN_TYPE_SLEEPY_END_DEVICE)
70verify(node2.get_state() == 'child')
71verify(node2.get_mode() == '-')
72
73node2.interface_down()
74
75# Create a poor link between child and parent using MAC fixed RSSI
76# filter and make sure child can still attach.
77
78node1.cli('macfilter rss add * -99')
79node2.cli('macfilter rss add * -99')
80
81node2.join(node1, cli.JOIN_TYPE_END_DEVICE)
82verify(node2.get_state() == 'child')
83verify(node2.get_mode() == 'rn')
84
85verify(len(node1.get_child_table()) == 1)
86
87# -----------------------------------------------------------------------------------------------------------------------
88# Test finished
89
90cli.Node.finalize_all_nodes()
91
92print('\'{}\' passed.'.format(test_name))
93