| 1 |
# Copyright 2023 SysEleven GmbH. |
| 2 |
# |
| 3 |
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 4 |
# not use this file except in compliance with the License. You may obtain |
| 5 |
# a copy of the License at |
| 6 |
# |
| 7 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
# |
| 9 |
# Unless required by applicable law or agreed to in writing, software |
| 10 |
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 11 |
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 12 |
# License for the specific language governing permissions and limitations |
| 13 |
# under the License. |
| 14 |
|
| 15 |
from unittest import mock |
| 16 |
|
| 17 |
from neutron.agent.linux import ip_lib |
| 18 |
from neutron.conf.agent import common as agent_config |
| 19 |
from neutron.conf import common as common_config |
| 20 |
from oslo_config import cfg |
| 21 |
from oslo_utils import uuidutils |
| 22 |
|
| 23 |
from neutron_vpnaas.services.vpn.device_drivers import ovn_ipsec |
| 24 |
from neutron_vpnaas.tests import base |
| 25 |
from neutron_vpnaas.tests.unit.services.vpn.device_drivers import test_ipsec |
| 26 |
|
| 27 |
_uuid = uuidutils.generate_uuid |
| 28 |
|
| 29 |
|
| 30 |
FAKE_PROCESS_ID = "c5b52e50-e678-491e-98dd-34e2676a6f81" |
| 31 |
FAKE_NAMESPACE_NAME = "qvpn-c5b52e50-e678-491e-98dd-34e2676a6f81" |
| 32 |
|
| 33 |
FAKE_GW_PORT_ID = "e95d89fb-1723-4865-876f-a1c8efed4b55" |
| 34 |
FAKE_GW_PORT_INTERFACE_NAME = "vge95d89fb-172" |
| 35 |
FAKE_GW_PORT_IP_ADDRESS = "20.20.20.20" |
| 36 |
FAKE_GW_PORT_MAC_ADDRESS = "11:22:33:44:55:66" |
| 37 |
FAKE_GW_PORT_SUBNET_ID = _uuid() |
| 38 |
FAKE_GW_PORT_SUBNET_INFO = { |
| 39 |
'id': FAKE_GW_PORT_SUBNET_ID, |
| 40 |
'cidr': '20.20.20.0/24', |
| 41 |
'ip_version': 4 |
| 42 |
} |
| 43 |
FAKE_GW_PORT = { |
| 44 |
'id': FAKE_GW_PORT_ID, |
| 45 |
'mac_address': FAKE_GW_PORT_MAC_ADDRESS, |
| 46 |
'fixed_ips': [{ |
| 47 |
'ip_address': FAKE_GW_PORT_IP_ADDRESS, |
| 48 |
'subnet_id': FAKE_GW_PORT_SUBNET_ID |
| 49 |
}] |
| 50 |
} |
| 51 |
FAKE_TRANSIT_PORT_ID = "0eb4bdb3-fe2e-4724-bb04-f84b6a5974f8" |
| 52 |
FAKE_TRANSIT_PORT_INTERFACE_NAME = "vr0eb4bdb3-fe2" |
| 53 |
FAKE_TRANSIT_PORT_MAC_ADDRESS = "22:33:44:55:66:77" |
| 54 |
FAKE_TRANSIT_PORT_IP_ADDRESS = "169.254.0.2" |
| 55 |
FAKE_TRANSIT_PORT_SUBNET_ID = _uuid() |
| 56 |
FAKE_TRANSIT_PORT = { |
| 57 |
'id': FAKE_TRANSIT_PORT_ID, |
| 58 |
'mac_address': FAKE_TRANSIT_PORT_MAC_ADDRESS, |
| 59 |
'fixed_ips': [{ |
| 60 |
'ip_address': FAKE_TRANSIT_PORT_IP_ADDRESS, |
| 61 |
'subnet_id': FAKE_TRANSIT_PORT_SUBNET_ID |
| 62 |
}] |
| 63 |
} |
| 64 |
|
| 65 |
|
| 66 |
def fake_interface_driver(*args, **kwargs): |
| 67 |
driver = mock.Mock() |
| 68 |
driver.DEV_NAME_LEN = 14 |
| 69 |
return driver |
| 70 |
|
| 71 |
|
| 72 |
class TestDeviceManager(base.BaseTestCase): |
| 73 |
def setUp(self): |
| 74 |
super().setUp() |
| 75 |
self.conf = cfg.CONF |
| 76 |
self.conf.register_opts(common_config.core_opts) |
| 77 |
self.conf.register_opts(agent_config.INTERFACE_DRIVER_OPTS) |
| 78 |
self.conf.set_override( |
| 79 |
'interface_driver', |
| 80 |
'neutron_vpnaas.tests.unit.services.vpn.device_drivers' |
| 81 |
'.test_ovn_ipsec.fake_interface_driver') |
| 82 |
self.host = "some-hostname" |
| 83 |
self.plugin = mock.Mock() |
| 84 |
self.plugin.get_subnet_info.return_value = FAKE_GW_PORT_SUBNET_INFO |
| 85 |
self.context = mock.Mock() |
| 86 |
|
| 87 |
def test_names(self): |
| 88 |
mgr = ovn_ipsec.DeviceManager(self.conf, self.host, |
| 89 |
self.plugin, self.context) |
| 90 |
port = {'id': "0df5beb8-4794-4217-acde-e6ce4875a59f"} |
| 91 |
name = mgr.get_interface_name(port, "internal") |
| 92 |
self.assertEqual(name, "vr0df5beb8-479") |
| 93 |
|
| 94 |
name = mgr.get_interface_name(port, "external") |
| 95 |
self.assertEqual(name, "vg0df5beb8-479") |
| 96 |
|
| 97 |
name = mgr.get_namespace_name("0df5beb8-4794-4217-acde-e6ce4875a59f") |
| 98 |
self.assertEqual(name, "qvpn-0df5beb8-4794-4217-acde-e6ce4875a59f") |
| 99 |
|
| 100 |
def test_setup_external(self): |
| 101 |
ext_net_id = _uuid() |
| 102 |
network_details = { |
| 103 |
'gw_port': FAKE_GW_PORT, |
| 104 |
'external_network': { |
| 105 |
'id': ext_net_id |
| 106 |
} |
| 107 |
} |
| 108 |
|
| 109 |
mgr = ovn_ipsec.DeviceManager(self.conf, self.host, |
| 110 |
self.plugin, self.context) |
| 111 |
|
| 112 |
with mock.patch.object(ip_lib, 'ensure_device_is_ready') as dev_ready: |
| 113 |
with mock.patch.object(mgr, 'set_default_route') as set_def_route: |
| 114 |
dev_ready.return_value = False |
| 115 |
|
| 116 |
mgr.setup_external(FAKE_PROCESS_ID, network_details) |
| 117 |
|
| 118 |
dev_ready.assert_called_once() |
| 119 |
self.plugin.get_subnet_info.assert_called_once_with( |
| 120 |
FAKE_GW_PORT_SUBNET_ID |
| 121 |
) |
| 122 |
set_def_route.assert_called_once_with( |
| 123 |
FAKE_NAMESPACE_NAME, |
| 124 |
FAKE_GW_PORT_SUBNET_INFO, |
| 125 |
FAKE_GW_PORT_INTERFACE_NAME |
| 126 |
) |
| 127 |
mgr.driver.init_l3.assert_called_once() |
| 128 |
mgr.driver.plug.assert_called_once() |
| 129 |
|
| 130 |
def test_setup_internal(self): |
| 131 |
network_details = {'transit_port': FAKE_TRANSIT_PORT} |
| 132 |
|
| 133 |
mgr = ovn_ipsec.DeviceManager(self.conf, self.host, |
| 134 |
self.plugin, self.context) |
| 135 |
|
| 136 |
with mock.patch.object(ip_lib, 'ensure_device_is_ready') as dev_ready: |
| 137 |
dev_ready.return_value = False |
| 138 |
|
| 139 |
mgr.setup_internal(FAKE_PROCESS_ID, network_details) |
| 140 |
|
| 141 |
dev_ready.assert_called_once() |
| 142 |
mgr.driver.init_l3.assert_called_once() |
| 143 |
mgr.driver.plug.assert_called_once() |
| 144 |
|
| 145 |
def test_list_routes(self): |
| 146 |
mgr = ovn_ipsec.DeviceManager(self.conf, self.host, |
| 147 |
self.plugin, self.context) |
| 148 |
mock_ipdev = mock.Mock() |
| 149 |
routes = [ |
| 150 |
{'cidr': '192.168.111.0/24', 'via': FAKE_TRANSIT_PORT_IP_ADDRESS} |
| 151 |
] |
| 152 |
with mock.patch.object(ip_lib, 'IPDevice') as ipdev: |
| 153 |
ipdev.return_value = mock_ipdev |
| 154 |
mock_ipdev.route.list_routes.return_value = routes |
| 155 |
returned = mgr.list_routes(FAKE_NAMESPACE_NAME) |
| 156 |
self.assertEqual(returned, routes) |
| 157 |
|
| 158 |
def test_del_static_routes(self): |
| 159 |
mgr = ovn_ipsec.DeviceManager(self.conf, self.host, self.plugin, |
| 160 |
self.context) |
| 161 |
mock_ipdev = mock.Mock() |
| 162 |
routes = [ |
| 163 |
{'cidr': '192.168.111.0/24', 'via': FAKE_TRANSIT_PORT_IP_ADDRESS}, |
| 164 |
{'cidr': '192.168.112.0/24', 'via': FAKE_TRANSIT_PORT_IP_ADDRESS} |
| 165 |
] |
| 166 |
with mock.patch.object(ip_lib, 'IPDevice') as ipdev: |
| 167 |
ipdev.return_value = mock_ipdev |
| 168 |
mock_ipdev.route.list_routes.return_value = routes |
| 169 |
|
| 170 |
mgr.del_static_routes(FAKE_NAMESPACE_NAME) |
| 171 |
|
| 172 |
mock_ipdev.route.delete_route.assert_has_calls([ |
| 173 |
mock.call(routes[0]['cidr'], via=FAKE_TRANSIT_PORT_IP_ADDRESS), |
| 174 |
mock.call(routes[1]['cidr'], via=FAKE_TRANSIT_PORT_IP_ADDRESS), |
| 175 |
], any_order=True) |
| 176 |
|
| 177 |
|
| 178 |
class TestOvnStrongSwanDriver(test_ipsec.IPSecDeviceLegacy): |
| 179 |
|
| 180 |
def setUp(self, driver=ovn_ipsec.OvnStrongSwanDriver, |
| 181 |
ipsec_process=ovn_ipsec.OvnStrongSwanProcess): |
| 182 |
conf = cfg.CONF |
| 183 |
conf.register_opts(common_config.core_opts) |
| 184 |
conf.register_opts(agent_config.INTERFACE_DRIVER_OPTS) |
| 185 |
conf.set_override( |
| 186 |
'interface_driver', |
| 187 |
'neutron_vpnaas.tests.unit.services.vpn.device_drivers' |
| 188 |
'.test_ovn_ipsec.fake_interface_driver') |
| 189 |
|
| 190 |
super().setUp(driver, ipsec_process) |
| 191 |
self.driver.nsmgr = mock.Mock() |
| 192 |
self.driver.nsmgr.exists.return_value = False |
| 193 |
self.driver.devmgr = mock.Mock() |
| 194 |
self.driver.devmgr.get_namespace_name.return_value = \ |
| 195 |
FAKE_NAMESPACE_NAME |
| 196 |
self.driver.devmgr.list_routes.return_value = [] |
| 197 |
self.driver.devmgr.get_existing_process_ids.return_value = [] |
| 198 |
self.driver.agent_rpc.get_vpn_transit_network_details.return_value = { |
| 199 |
'transit_gateway_ip': '192.168.1.1', |
| 200 |
} |
| 201 |
|
| 202 |
def test_ensure_nat_rules(self): |
| 203 |
"""Not applicable for OvnIPsecDriver""" |
| 204 |
pass |
| 205 |
|
| 206 |
def test_get_namespace_for_router(self): |
| 207 |
"""Different for OvnIPsecDriver""" |
| 208 |
namespace = self.driver.get_namespace(FAKE_PROCESS_ID) |
| 209 |
self.assertEqual(FAKE_NAMESPACE_NAME, namespace) |
| 210 |
|
| 211 |
def test_fail_getting_namespace_for_unknown_router(self): |
| 212 |
"""Not applicable for OvnIPsecDriver""" |
| 213 |
pass |
| 214 |
|
| 215 |
def test_create_router(self): |
| 216 |
"""Not applicable for OvnIPsecDriver""" |
| 217 |
pass |
| 218 |
|
| 219 |
def test_destroy_router(self): |
| 220 |
"""Not applicable for OvnIPsecDriver""" |
| 221 |
pass |
| 222 |
|
| 223 |
def test_ensure_nat_rules_with_multiple_local_subnets(self): |
| 224 |
"""Not applicable for OvnIPsecDriver""" |
| 225 |
pass |
| 226 |
|
| 227 |
def _test_ensure_nat_rules(self): |
| 228 |
"""Not applicable for OvnIPsecDriver""" |
| 229 |
pass |
| 230 |
|
| 231 |
def test_stale_cleanup(self): |
| 232 |
process = self.fake_ensure_process(FAKE_PROCESS_ID) |
| 233 |
|
| 234 |
self.driver.devmgr.get_existing_process_ids.return_value = [ |
| 235 |
FAKE_PROCESS_ID] |
| 236 |
|
| 237 |
self.driver.agent_rpc.get_vpn_services_on_host.return_value = [] |
| 238 |
context = mock.Mock() |
| 239 |
with mock.patch.object(self.driver, 'ensure_process') as ensure: |
| 240 |
ensure.return_value = process |
| 241 |
self.driver.sync(context, []) |
| 242 |
process.disable.assert_called() |
| 243 |
|
| 244 |
|
| 245 |
class TestOvnOpenSwanDriver(TestOvnStrongSwanDriver): |
| 246 |
def setUp(self): |
| 247 |
super().setUp(driver=ovn_ipsec.OvnOpenSwanDriver, |
| 248 |
ipsec_process=ovn_ipsec.OvnOpenSwanProcess) |
| 249 |
|
| 250 |
|
| 251 |
class TestOvnLibreSwanDriver(TestOvnStrongSwanDriver): |
| 252 |
def setUp(self): |
| 253 |
super().setUp(driver=ovn_ipsec.OvnLibreSwanDriver, |
| 254 |
ipsec_process=ovn_ipsec.OvnLibreSwanProcess) |