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
29import wpan
30from wpan import verify
31
32# -----------------------------------------------------------------------------------------------------------------------
33# Test description: Test MeshCop Joiner, Commissioner and Joiner-router behavior
34#
35# This test covers Thread commissioning with a commissioner, a joiner-router and
36# joiner device.
37
38test_name = __file__[:-3] if __file__.endswith('.py') else __file__
39print('-' * 120)
40print('Starting \'{}\''.format(test_name))
41
42# -----------------------------------------------------------------------------------------------------------------------
43# Creating `wpan.Nodes` instances
44
45speedup = 4
46wpan.Node.set_time_speedup_factor(speedup)
47
48r1 = wpan.Node()
49r2 = wpan.Node()
50c2 = wpan.Node()
51joiner = wpan.Node()
52
53# -----------------------------------------------------------------------------------------------------------------------
54# Init all nodes
55
56wpan.Node.init_all_nodes()
57
58# -----------------------------------------------------------------------------------------------------------------------
59# Build network topology
60#
61#       r1 ---------- r2
62#   (commissioner)   (joiner-router)
63#                     |
64#                     |
65#                     joiner
66
67r1.form('jr-meshcop')
68
69r1.allowlist_node(r2)
70r2.join_node(r1, wpan.JOIN_TYPE_ROUTER)
71
72c2.join_node(r2, wpan.JOIN_TYPE_END_DEVICE)
73
74# -----------------------------------------------------------------------------------------------------------------------
75# Test implementation
76
77WAIT_TIME = 2  # seconds
78
79verify(r2.get(wpan.WPAN_NODE_TYPE) == wpan.NODE_TYPE_ROUTER)
80
81PSKd = '123456'
82
83joiner_hw_addr = joiner.get(wpan.WPAN_HW_ADDRESS)[1:-1]  # Remove the `[]`
84
85# Start the commissioner and add joiner hw address along with PSKd
86r1.commissioner_start()
87r1.commissioner_add_joiner(joiner_hw_addr, PSKd)
88
89# Start Joiner
90joiner.joiner_join(PSKd)
91
92# Verify that Joiner succeeded
93verify(joiner.get(wpan.WPAN_STATE) == wpan.STATE_COMMISSIONED)
94
95joiner.joiner_attach()
96
97
98def joiner_is_associated():
99    verify(joiner.is_associated())
100
101
102wpan.verify_within(joiner_is_associated, WAIT_TIME)
103
104# -----------------------------------------------------------------------------------------------------------------------
105# Test finished
106
107wpan.Node.finalize_all_nodes()
108
109print('\'{}\' passed.'.format(test_name))
110