1#!/usr/bin/env python3
2#
3#  Copyright (c) 2020, 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#
29
30import unittest
31
32from config import ADDRESS_TYPE
33from mle import LinkMetricsSubTlvType, TlvType
34from pktverify import consts
35from pktverify.null_field import nullField
36from pktverify.packet_verifier import PacketVerifier
37
38import config
39import thread_cert
40
41LEADER = 1
42SED_1 = 2
43SSED_1 = 3
44
45SERIES_ID = 1
46SERIES_ID_2 = 2
47POLL_PERIOD = 2000  # 2s
48
49
50class LowPower_7_2_01_ForwardTrackingSeries(thread_cert.TestCase):
51    USE_MESSAGE_FACTORY = False
52    TOPOLOGY = {
53        LEADER: {
54            'version': '1.2',
55            'name': 'LEADER',
56            'mode': 'rdn',
57            'allowlist': [SED_1, SSED_1],
58        },
59        SED_1: {
60            'version': '1.2',
61            'name': 'SED_1',
62            'mode': '-',
63            'allowlist': [LEADER],
64        },
65        SSED_1: {
66            'version': '1.2',
67            'name': 'SSED_1',
68            'mode': '-',
69            'allowlist': [LEADER],
70        }
71    }
72    """All nodes are created with default configurations"""
73
74    def test(self):
75        self.nodes[LEADER].start()
76        self.simulator.go(config.LEADER_STARTUP_DELAY)
77        self.assertEqual(self.nodes[LEADER].get_state(), 'leader')
78
79        self.nodes[SED_1].set_pollperiod(POLL_PERIOD)
80        self.nodes[SED_1].start()
81        self.simulator.go(5)
82        self.assertEqual(self.nodes[SED_1].get_state(), 'child')
83
84        self.nodes[SSED_1].set_csl_period(consts.CSL_DEFAULT_PERIOD)
85        self.nodes[SSED_1].start()
86        self.simulator.go(5)
87        self.assertEqual(self.nodes[SSED_1].get_state(), 'child')
88
89        leader_addr = self.nodes[LEADER].get_ip6_address(ADDRESS_TYPE.LINK_LOCAL)
90
91        # Step 3 - Verify connectivity by instructing each device to send an ICMPv6 Echo Request to the DUT
92        self.assertTrue(self.nodes[SED_1].ping(leader_addr, timeout=POLL_PERIOD / 1000))
93        self.assertTrue(self.nodes[SSED_1].ping(leader_addr))
94        self.simulator.go(5)
95
96        # Step 4 - SED_1 requests a Forward Tracking Series by sending a Link Metrics Management Request
97        # Forward Series Flags = 0x04:
98        # - Bit 2 = 1, MAC Data Request
99        # - Bits 0,1 & 3-7 = 0
100        # Concatenation of Link Metric Type ID Flags = 0x00:
101        # - Item1: (0)(1)(000)(000) = 0x40
102        # -- E = 0
103        # -- L = 1
104        # -- Type/Average Enum = 0 (count)
105        # -- Metrics Enum = 0 (count)
106        self.nodes[SED_1].link_metrics_config_req_forward_tracking_series(leader_addr, SERIES_ID, 'r', 'p', 'async')
107
108        self.simulator.go(5)
109
110        # Step 6 - Configures SED_1 to send MAC Data Request every 2 seconds and wait for 30 seconds
111        self.simulator.go(30)
112
113        # Step 7 - SED_1 sends an MLE Data Request to retrieve aggregated Forward Series Results
114        result = self.nodes[SED_1].link_metrics_request_forward_tracking_series(leader_addr, SERIES_ID)
115        self.assertIn("PDU Counter", result)
116
117        #self.simulator.go(5)
118
119        # Step 9 - SED_1 clears the Forward Tracking Series
120        # Forward Series Flags = 0x00:
121        # - Bits 0-7 = 0
122        # Concatenation of Link Metric Type ID Flags = NULL:
123        self.nodes[SED_1].link_metrics_config_req_forward_tracking_series(leader_addr, SERIES_ID, 'X', '', 'async')
124
125        self.simulator.go(5)
126
127        # Step 16 - SSED_1 requests a Forward Tracking Series by sending a Link Metrics Management Request
128        # Forward Series Flags = 0x02:
129        # - Bit 1 = 1, (all Link Layer Data Frames)
130        # - Bits 0, 2-7 = 0
131        # Concatenation of Link Metric Type ID Flags = 0x0a:
132        # - Item1: (0)(0)(001)(010) = 0x0a
133        # -- E = 0
134        # -- L = 0
135        # -- Type/Average Enum = 1 (Exponential Moving Average)
136        # -- Metrics Enum = 2 (Link Margin)
137        self.nodes[SSED_1].link_metrics_config_req_forward_tracking_series(leader_addr, SERIES_ID_2, 'd', 'm', 'async')
138
139        self.simulator.go(5)
140
141        # Step 18 - SSED_1 sends MAC Data packet every 1 second for 30 seconds
142        # Note: As the api to send MAC Data frame hasn't been implemented, we send MLE Link Probe message here
143        for i in range(30):
144            self.nodes[SSED_1].link_metrics_send_link_probe(leader_addr, SERIES_ID_2, 1)
145            self.simulator.go(1)
146
147        # Step 19 - SSED_1 sends an MLE Data Request to retrieve aggregated Forward Series Results
148        result = self.nodes[SSED_1].link_metrics_request_forward_tracking_series(leader_addr, SERIES_ID_2)
149        self.assertIn("Margin", result)
150
151        # Step 21 - SSED_1 clears the Forward Series Link Metrics
152        # Forward Series Flags = 0x00:
153        # - Bits 0-7 = 0
154        # Concatenation of Link Metric Type ID Flags = NULL
155        self.nodes[SSED_1].link_metrics_config_req_forward_tracking_series(leader_addr, SERIES_ID_2, 'X', '', 'async')
156
157        self.simulator.go(5)
158
159        # Step 23 - SSED_1 sends an MLE Data Request to retrieve aggregated Forward Series Results
160        result = self.nodes[SSED_1].link_metrics_request_forward_tracking_series(leader_addr, SERIES_ID_2)
161        self.assertIn('Status', result)
162        self.assertEqual(result['Status'], 'Series ID not recognized')
163
164    def verify(self, pv):
165        pkts = pv.pkts
166        pv.summary.show()
167        LEADER = pv.vars['LEADER']
168        SED_1 = pv.vars['SED_1']
169        SSED_1 = pv.vars['SSED_1']
170
171        # Step 3 - The DUT MUST send ICMPv6 Echo Responses to both SED1 & SSED1
172        pkts.filter_wpan_src64(LEADER) \
173            .filter_wpan_dst64(SED_1) \
174            .filter_ping_reply() \
175            .must_next()
176        pkts.filter_wpan_src64(LEADER) \
177            .filter_wpan_dst64(SSED_1) \
178            .filter_ping_reply() \
179            .must_next()
180
181        # Step 4 - SED_1 requests a Forward Series Link Metrics by sending a Link Metrics Management Request
182        # Forward Series Flags = 0x04:
183        # - Bit 2 = 1, MAC Data Request
184        # - Bits 0,1 & 3-7 = 0
185        # Concatenation of Link Metric Type ID Flags = 0x40:
186        # - Item1: (0)(1)(000)(000) = 0x40
187        # -- E = 0
188        # -- L = 1
189        # -- Type/Average Enum = 0 (count)
190        # -- Metrics Enum = 0 (count)
191        pkts.filter_wpan_src64(SED_1) \
192            .filter_wpan_dst64(LEADER) \
193            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_REQUEST) \
194            .filter(lambda p: LinkMetricsSubTlvType.FORWARD_PROBING_REGISTRATION in p.mle.tlv.link_sub_tlv) \
195            .filter(lambda p: 4 in p.mle.tlv.link_forward_series)  \
196            .filter(lambda p: consts.LINK_METRICS_TYPE_AVERAGE_ENUM_COUNT in p.mle.tlv.metric_type_id_flags.type) \
197            .filter(lambda p: consts.LINK_METRICS_METRIC_TYPE_ENUM_PDU_COUNT in p.mle.tlv.metric_type_id_flags.metric) \
198            .filter(lambda p: 1 in p.mle.tlv.metric_type_id_flags.l) \
199            .must_next()
200
201        # Step 5 - Leader responds with a Link Metrics Management Response
202        pkts.filter_wpan_src64(LEADER) \
203            .filter_wpan_dst64(SED_1) \
204            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_RESPONSE) \
205            .filter(lambda p: p.mle.tlv.link_status_sub_tlv == consts.LINK_METRICS_STATUS_SUCCESS) \
206            .must_next()
207
208        # Step 8 - Leader responds with an MLE Data Response
209        pkts.filter_wpan_src64(LEADER) \
210            .filter_wpan_dst64(SED_1) \
211            .filter_mle_cmd(consts.MLE_DATA_RESPONSE) \
212            .filter(lambda p: TlvType.LINK_METRICS_REPORT in p.mle.tlv.type) \
213            .filter(lambda p: consts.LINK_METRICS_TYPE_AVERAGE_ENUM_COUNT in p.mle.tlv.metric_type_id_flags.type) \
214            .filter(lambda p: consts.LINK_METRICS_METRIC_TYPE_ENUM_PDU_COUNT in p.mle.tlv.metric_type_id_flags.metric) \
215            .must_next()
216
217        # Step 9 - SED_1 clears the Forward Series Link Metrics
218        # Forward Series Flags = 0x00:
219        # - Bits 0-7 = 0
220        # Concatenation of Link Metric Type ID Flags = NULL:
221        pkts.filter_wpan_src64(SED_1) \
222            .filter_wpan_dst64(LEADER) \
223            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_REQUEST) \
224            .filter(lambda p: LinkMetricsSubTlvType.FORWARD_PROBING_REGISTRATION in p.mle.tlv.link_sub_tlv) \
225            .filter(lambda p: 0 in p.mle.tlv.link_forward_series) \
226            .filter(lambda p: p.mle.tlv.metric_type_id_flags.type is nullField) \
227            .filter(lambda p: p.mle.tlv.metric_type_id_flags.metric is nullField) \
228            .must_next()
229
230        # Step 10 - Leader responds with a Link Metrics Management Response
231        pkts.filter_wpan_src64(LEADER) \
232            .filter_wpan_dst64(SED_1) \
233            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_RESPONSE) \
234            .filter(lambda p: p.mle.tlv.link_status_sub_tlv == consts.LINK_METRICS_STATUS_SUCCESS) \
235            .must_next()
236
237        # Step 16 - SSED_1 requests a Forward Series Link Metrics by sending a Link Metrics Management Request
238        # Forward Series Flags = 0x02:
239        # - Bit 1 = 1, (all Link Layer Data Frames)
240        # - Bits 0, 2-7 = 0
241        # Concatenation of Link Metric Type ID Flags = 0x0a:
242        # - Item1: (0)(0)(001)(010) = 0x0a
243        # -- E = 0
244        # -- L = 0
245        # -- Type/Average Enum = 1 (Exponential Moving Average)
246        # -- Metrics Enum = 2 (Link Margin)
247        pkts.filter_wpan_src64(SSED_1) \
248            .filter_wpan_dst64(LEADER) \
249            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_REQUEST) \
250            .filter(lambda p: LinkMetricsSubTlvType.FORWARD_PROBING_REGISTRATION in p.mle.tlv.link_sub_tlv) \
251            .filter(lambda p: 2 in p.mle.tlv.link_forward_series) \
252            .filter(lambda p: consts.LINK_METRICS_TYPE_AVERAGE_ENUM_EXPONENTIAL in p.mle.tlv.metric_type_id_flags.type) \
253            .filter(lambda p: consts.LINK_METRICS_METRIC_TYPE_ENUM_LINK_MARGIN in p.mle.tlv.metric_type_id_flags.metric) \
254            .must_next()
255
256        # Step 17 - Leader responds with a Link Metrics Management Response
257        pkts.filter_wpan_src64(LEADER) \
258            .filter_wpan_dst64(SSED_1) \
259            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_RESPONSE) \
260            .filter(lambda p: p.mle.tlv.link_status_sub_tlv == consts.LINK_METRICS_STATUS_SUCCESS) \
261            .must_next()
262
263        # Step 19 - SSED_1 sends an MLE Data Request to retrieve aggregated Forward Series results
264        # - TLV Request TLV(Link Metrics Report TLV specified
265        # - Link Metrics Query TLV
266        # -- Link Metrics Query ID Sub-TLV
267        # --- Query ID: (ID set in step 16)
268        # - Verify that the Link Metrics Query Options Sub-TLV is NOT present
269        pkts.filter_wpan_src64(SSED_1) \
270            .filter_wpan_dst64(LEADER) \
271            .filter_mle_cmd(consts.MLE_DATA_REQUEST) \
272            .filter(lambda p: TlvType.LINK_METRICS_QUERY in p.mle.tlv.type) \
273            .filter(lambda p: p.mle.tlv.query_id == SERIES_ID_2) \
274            .must_next()
275
276        # Step 20 - Leader MUST reply to SSED_1 with an MLE Data Response with the following:
277        # - Link Metrics Report TLV
278        # -- Link Metrics Report Sub-TLV
279        # --- Metric Type ID Flags
280        # ---- Type / Average Enum = 1 (Exponential Moving Average)
281        # ---- Metric Enum = 2 (Link Margin)
282        # --- Value (1 bytes)
283        pkts.filter_wpan_src64(LEADER) \
284            .filter_wpan_dst64(SSED_1) \
285            .filter_mle_cmd(consts.MLE_DATA_RESPONSE) \
286            .filter_mle_has_tlv(TlvType.LINK_METRICS_REPORT) \
287            .filter(lambda p: LinkMetricsSubTlvType.LINK_METRICS_REPORT in p.mle.tlv.link_sub_tlv) \
288            .filter(lambda p: consts.LINK_METRICS_TYPE_AVERAGE_ENUM_EXPONENTIAL in p.mle.tlv.metric_type_id_flags.type) \
289            .filter(lambda p: consts.LINK_METRICS_METRIC_TYPE_ENUM_LINK_MARGIN in p.mle.tlv.metric_type_id_flags.metric) \
290            .must_next()
291
292        # Step 21 - SSED_1 clears the Forward Series Link Metrics
293        # Forward Series Flags = 0x00:
294        # - Bits 0-7 = 0
295        # Concatenation of Link Metric Type ID Flags = NULL
296        pkts.filter_wpan_src64(SSED_1) \
297            .filter_wpan_dst64(LEADER) \
298            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_REQUEST) \
299            .filter(lambda p: LinkMetricsSubTlvType.FORWARD_PROBING_REGISTRATION in p.mle.tlv.link_sub_tlv) \
300            .filter(lambda p: 0 in p.mle.tlv.link_forward_series) \
301            .filter(lambda p: p.mle.tlv.metric_type_id_flags.type is nullField) \
302            .filter(lambda p: p.mle.tlv.metric_type_id_flags.metric is nullField) \
303            .must_next()
304
305        # Step 22 - Leader responds with a Link Metrics Management Response
306        pkts.filter_wpan_src64(LEADER) \
307            .filter_wpan_dst64(SSED_1) \
308            .filter_mle_cmd(consts.MLE_LINK_METRICS_MANAGEMENT_RESPONSE) \
309            .filter(lambda p: p.mle.tlv.link_status_sub_tlv == consts.LINK_METRICS_STATUS_SUCCESS) \
310            .must_next()
311
312        # Step 23 - SSED_1 sends an MLE Data Request to retrieve aggregated Forward Series results
313        # - TLV Request TLV(Link Metrics Report TLV specified
314        # - Link Metrics Query TLV
315        # -- Link Metrics Query ID Sub-TLV
316        # --- Query ID: (ID set in step 16)
317        # This is a negative step
318        pkts.filter_wpan_src64(SSED_1) \
319            .filter_wpan_dst64(LEADER) \
320            .filter_mle_cmd(consts.MLE_DATA_REQUEST) \
321            .filter(lambda p: TlvType.LINK_METRICS_QUERY in p.mle.tlv.type) \
322            .filter(lambda p: p.mle.tlv.query_id == SERIES_ID_2) \
323            .must_next()
324
325        # Step 24 - Leader MUST reply to SSED_1 with an MLE Data Response with the following:
326        # - Link Metrics Report TLV
327        # -- Link Metrics Status Sub-TLV
328        # --- Status = 3 (Series ID not recognized)
329        pkts.filter_wpan_src64(LEADER) \
330            .filter_wpan_dst64(SSED_1) \
331            .filter_mle_cmd(consts.MLE_DATA_RESPONSE) \
332            .filter_mle_has_tlv(TlvType.LINK_METRICS_REPORT) \
333            .filter(lambda p: LinkMetricsSubTlvType.LINK_METRICS_STATUS in p.mle.tlv.link_sub_tlv) \
334            .filter(lambda p: p.mle.tlv.link_status_sub_tlv == consts.LINK_METRICS_STATUS_SERIES_ID_NOT_RECOGNIZED) \
335            .must_next()
336
337
338if __name__ == '__main__':
339    unittest.main()
340