#!/usr/bin/env python3 # # Copyright (c) 2022, 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 unittest import config import thread_cert import enum # Test description: # This test verifies that a single NAT64 prefix is published when there are # multiple Border Routers in the same Thread and infrastructure network. # # Topology: # ----------------(eth)-------------------------- # | | | # BR1 (Leader) ---- BR2 HOST # | # ROUTER # BR1 = 1 ROUTER = 2 BR2 = 3 HOST = 4 NAT64_STATE_DISABLED = 'disabled' NAT64_STATE_NOT_RUNNING = 'not_running' NAT64_STATE_IDLE = 'idle' NAT64_STATE_ACTIVE = 'active' class Nat64MultiBorderRouter(thread_cert.TestCase): USE_MESSAGE_FACTORY = False TOPOLOGY = { BR1: { 'name': 'BR1', 'allowlist': [ROUTER, BR2], 'is_otbr': True, 'version': '1.2', }, ROUTER: { 'name': 'Router', 'allowlist': [BR1], 'version': '1.2', }, BR2: { 'name': 'BR2', 'allowlist': [BR1], 'is_otbr': True, 'version': '1.2' }, HOST: { 'name': 'Host', 'is_host': True }, } def test(self): br1 = self.nodes[BR1] router = self.nodes[ROUTER] br2 = self.nodes[BR2] host = self.nodes[HOST] host.start(start_radvd=False) self.simulator.go(5) br1.start() # When feature flag is enabled, NAT64 might be disabled by default. So # ensure NAT64 is enabled here. br1.nat64_set_enabled(True) self.simulator.go(config.LEADER_STARTUP_DELAY) self.assertEqual('leader', br1.get_state()) router.start() self.simulator.go(config.ROUTER_STARTUP_DELAY) self.assertEqual('router', router.get_state()) # # Case 1. BR2 joins the network and it will not add its local nat64 prefix to Network Data. # br2.start() # When feature flag is enabled, NAT64 might be disabled by default. So # ensure NAT64 is enabled here. br2.nat64_set_enabled(True) self.simulator.go(config.BORDER_ROUTER_STARTUP_DELAY) self.assertEqual('router', br2.get_state()) self.simulator.go(10) br1_local_nat64_prefix = br1.get_br_nat64_prefix() br2_local_nat64_prefix = br2.get_br_nat64_prefix() self.assertEqual(len(br1.get_netdata_nat64_routes()), 1) nat64_prefix = br1.get_netdata_nat64_routes()[0] self.assertEqual(nat64_prefix, br1_local_nat64_prefix) self.assertNotEqual(nat64_prefix, br2_local_nat64_prefix) self.assertDictIncludes(br1.nat64_state, { 'PrefixManager': NAT64_STATE_ACTIVE, 'Translator': NAT64_STATE_ACTIVE }) self.assertDictIncludes(br2.nat64_state, { 'PrefixManager': NAT64_STATE_IDLE, 'Translator': NAT64_STATE_NOT_RUNNING }) # # Case 2. Disable NAT64 on BR1. # BR1 withdraws its local prefix and BR2 advertises its local prefix. # br1.nat64_set_enabled(False) self.simulator.go(10) self.assertEqual(len(br1.get_netdata_nat64_routes()), 1) nat64_prefix = br1.get_netdata_nat64_routes()[0] self.assertEqual(br2_local_nat64_prefix, nat64_prefix) self.assertNotEqual(br1_local_nat64_prefix, nat64_prefix) self.assertDictIncludes(br1.nat64_state, { 'PrefixManager': NAT64_STATE_DISABLED, 'Translator': NAT64_STATE_DISABLED }) self.assertDictIncludes(br2.nat64_state, { 'PrefixManager': NAT64_STATE_ACTIVE, 'Translator': NAT64_STATE_ACTIVE }) # # Case 3. Re-enable NAT64 on BR1. # NAT64 prefix in Network Data is still BR2's local prefix. # br1.nat64_set_enabled(True) self.simulator.go(10) self.assertEqual(len(br1.get_netdata_nat64_routes()), 1) nat64_prefix = br1.get_netdata_nat64_routes()[0] self.assertEqual(br2_local_nat64_prefix, nat64_prefix) self.assertNotEqual(br1_local_nat64_prefix, nat64_prefix) self.assertDictIncludes(br1.nat64_state, { 'PrefixManager': NAT64_STATE_IDLE, 'Translator': NAT64_STATE_NOT_RUNNING }) self.assertDictIncludes(br2.nat64_state, { 'PrefixManager': NAT64_STATE_ACTIVE, 'Translator': NAT64_STATE_ACTIVE }) # # Case 4. Disable the routing manager should stop NAT64 prefix manager. # # br2.disable_br() self.simulator.go(10) self.assertEqual(len(br1.get_netdata_nat64_routes()), 1) nat64_prefix = br1.get_netdata_nat64_routes()[0] self.assertEqual(br1_local_nat64_prefix, nat64_prefix) self.assertNotEqual(br2_local_nat64_prefix, nat64_prefix) self.assertDictIncludes(br1.nat64_state, { 'PrefixManager': NAT64_STATE_ACTIVE, 'Translator': NAT64_STATE_ACTIVE }) self.assertDictIncludes(br2.nat64_state, { 'PrefixManager': NAT64_STATE_NOT_RUNNING, 'Translator': NAT64_STATE_NOT_RUNNING }) # # Case 5. Enable the routing manager the BR should start NAT64 prefix manager if the prefix manager is enabled. # # br2.enable_br() self.simulator.go(10) self.assertEqual(len(br1.get_netdata_nat64_routes()), 1) nat64_prefix = br1.get_netdata_nat64_routes()[0] self.assertEqual(br1_local_nat64_prefix, nat64_prefix) self.assertNotEqual(br2_local_nat64_prefix, nat64_prefix) self.assertDictIncludes(br1.nat64_state, { 'PrefixManager': NAT64_STATE_ACTIVE, 'Translator': NAT64_STATE_ACTIVE }) self.assertDictIncludes(br2.nat64_state, { 'PrefixManager': NAT64_STATE_IDLE, 'Translator': NAT64_STATE_NOT_RUNNING }) if __name__ == '__main__': unittest.main()