xref: /aosp_15_r20/external/openthread/tests/toranj/cli/test-022-netdata-full.py (revision cfb92d1480a9e65faed56933e9c12405f45898b4)
1#!/usr/bin/env python3
2#
3#  Copyright (c) 2023, 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
32import time
33
34# -----------------------------------------------------------------------------------------------------------------------
35# Test description: Validate mechanism to detect when Network Data gets full and related callback.
36#
37
38test_name = __file__[:-3] if __file__.endswith('.py') else __file__
39print('-' * 120)
40print('Starting \'{}\''.format(test_name))
41
42# -----------------------------------------------------------------------------------------------------------------------
43# Creating `cli.Node` instances
44
45speedup = 40
46cli.Node.set_time_speedup_factor(speedup)
47
48leader = cli.Node()
49r1 = cli.Node()
50r2 = cli.Node()
51r3 = cli.Node()
52
53# -----------------------------------------------------------------------------------------------------------------------
54# Form topology
55
56leader.form('netdata-full')
57r1.join(leader)
58r2.join(r1)
59r3.join(r1)
60
61verify(leader.get_state() == 'leader')
62verify(r1.get_state() == 'router')
63verify(r2.get_state() == 'router')
64verify(r2.get_state() == 'router')
65
66# -----------------------------------------------------------------------------------------------------------------------
67# Test Implementation
68
69verify(leader.get_netdata_full() == 'no')
70verify(r1.get_netdata_full() == 'no')
71verify(r2.get_netdata_full() == 'no')
72verify(r3.get_netdata_full() == 'no')
73
74# Add 7 routes from `r1` to netdata and make sure they are all
75# successfully registered with leader.
76
77r1.add_route('fd00:1:0:1::/64', 's', 'med')
78r1.add_route('fd00:1:0:2::/64', 's', 'med')
79r1.add_route('fd00:1:0:3::/64', 's', 'med')
80r1.add_route('fd00:1:0:4::/64', 's', 'med')
81r1.add_route('fd00:1:0:5::/64', 's', 'med')
82r1.add_route('fd00:1:0:6::/64', 's', 'med')
83r1.add_route('fd00:1:0:7::/64', 's', 'med')
84r1.register_netdata()
85
86
87def check_netdata_after_r1():
88    netdata = leader.get_netdata()
89    verify(len(netdata['routes']) == 7)
90
91
92verify_within(check_netdata_after_r1, 5)
93
94verify(leader.get_netdata_full() == 'no')
95verify(r1.get_netdata_full() == 'no')
96verify(r2.get_netdata_full() == 'no')
97verify(r3.get_netdata_full() == 'no')
98
99prev_len = int(leader.get_netdata_length())
100
101# Now add 7 new routes from `r2` to netdata and make sure they are all
102# successfully registered with leader.
103
104r2.add_route('fd00:2:0:1::/64', 's', 'med')
105r2.add_route('fd00:2:0:2::/64', 's', 'med')
106r2.add_route('fd00:2:0:3::/64', 's', 'med')
107r2.add_route('fd00:2:0:4::/64', 's', 'med')
108r2.add_route('fd00:2:0:5::/64', 's', 'med')
109r2.add_route('fd00:2:0:6::/64', 's', 'med')
110r2.add_route('fd00:2:0:7::/64', 's', 'med')
111r2.register_netdata()
112
113
114def check_netdata_after_r2():
115    netdata = leader.get_netdata()
116    verify(len(netdata['routes']) == 14)
117
118
119verify_within(check_netdata_after_r2, 5)
120
121verify(leader.get_netdata_full() == 'no')
122verify(r1.get_netdata_full() == 'no')
123verify(r2.get_netdata_full() == 'no')
124verify(r3.get_netdata_full() == 'no')
125
126verify(int(leader.get_netdata_length()) > prev_len)
127
128# Try adding 3 routes from `r3`, this should cause netdata to go
129# over its size limit. Make sure that both `r3` and `leader`
130# detect that
131
132r3.add_route('fd00:3:0:1::/64', 's', 'med')
133r3.add_route('fd00:3:0:2::/64', 's', 'med')
134r3.add_route('fd00:3:0:3::/64', 's', 'med')
135r3.register_netdata()
136
137
138def check_netdata_after_r3():
139    verify(leader.get_netdata_full() == 'yes')
140    verify(r1.get_netdata_full() == 'no')
141    verify(r2.get_netdata_full() == 'no')
142    verify(r3.get_netdata_full() == 'yes')
143
144
145verify_within(check_netdata_after_r3, 5)
146
147r3.remove_prefix('fd00:3:0:1::/64')
148r3.remove_prefix('fd00:3:0:2::/64')
149r3.remove_prefix('fd00:3:0:3::/64')
150r3.register_netdata()
151
152leader.reset_netdata_full()
153r3.reset_netdata_full()
154
155
156def check_netdata_after_remove_on_r3():
157    verify(leader.get_netdata_full() == 'no')
158    verify(r1.get_netdata_full() == 'no')
159    verify(r2.get_netdata_full() == 'no')
160    verify(r3.get_netdata_full() == 'no')
161
162
163verify_within(check_netdata_after_remove_on_r3, 5)
164
165r2.add_route('fd00:2:0:8::/64', 's', 'med')
166r2.add_route('fd00:2:0:9::/64', 's', 'med')
167r2.register_netdata()
168
169
170def check_netdata_after_more_routes_on_r2():
171    verify(leader.get_netdata_full() == 'yes')
172    verify(r1.get_netdata_full() == 'no')
173    verify(r2.get_netdata_full() == 'yes')
174    verify(r3.get_netdata_full() == 'no')
175
176
177verify_within(check_netdata_after_more_routes_on_r2, 5)
178
179# -----------------------------------------------------------------------------------------------------------------------
180# Test finished
181
182cli.Node.finalize_all_nodes()
183
184print('\'{}\' passed.'.format(test_name))
185