1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from neutronclient.common.exceptions import NotFound
18 from snaps.openstack.create_network import PortSettings
19 from snaps.openstack.openstack_creator import OpenStackNetworkObject
20 from snaps.openstack.utils import neutron_utils, keystone_utils
22 __author__ = 'spisarski'
24 logger = logging.getLogger('OpenStackNetwork')
27 class OpenStackRouter(OpenStackNetworkObject):
29 Class responsible for managing a router in OpenStack
32 def __init__(self, os_creds, router_settings):
34 Constructor - all parameters are required
35 :param os_creds: The credentials to connect with OpenStack
36 :param router_settings: The settings used to create a router object
37 (must be an instance of the RouterSettings
40 super(self.__class__, self).__init__(os_creds)
42 if not router_settings:
43 raise RouterCreationError('router_settings is required')
45 self.router_settings = router_settings
47 # Attributes instantiated on create()
49 self.__internal_subnets = list()
50 self.__internal_router_interface = None
52 # Dict where the port object is the key and any newly created router
53 # interfaces are the value
58 Loads the existing router.
59 :return: the Router domain object
61 super(self.__class__, self).initialize()
63 self.__router = neutron_utils.get_router(
64 self._neutron, router_settings=self.router_settings)
66 for internal_subnet_name in self.router_settings.internal_subnets:
67 internal_subnet = neutron_utils.get_subnet(
68 self._neutron, subnet_name=internal_subnet_name)
70 self.__internal_subnets.append(internal_subnet)
72 raise RouterCreationError(
73 'Subnet not found with name ' + internal_subnet_name)
75 for port_setting in self.router_settings.port_settings:
76 port = neutron_utils.get_port(
77 self._neutron, port_settings=port_setting)
79 self.__ports.append(port)
85 Responsible for creating the router.
86 :return: the Router domain object
91 self.__router = neutron_utils.create_router(
92 self._neutron, self._os_creds, self.router_settings)
94 for internal_subnet_name in self.router_settings.internal_subnets:
95 internal_subnet = neutron_utils.get_subnet(
96 self._neutron, subnet_name=internal_subnet_name)
98 self.__internal_subnets.append(internal_subnet)
100 logger.debug('Adding router to subnet...')
101 router_intf = neutron_utils.add_interface_router(
102 self._neutron, self.__router,
103 subnet=internal_subnet)
104 self.__internal_router_interface = router_intf
106 raise RouterCreationError(
107 'Subnet not found with name ' + internal_subnet_name)
109 for port_setting in self.router_settings.port_settings:
110 port = neutron_utils.get_port(
111 self._neutron, port_settings=port_setting)
113 'Retrieved port %s for router - %s', port_setting.name,
114 self.router_settings.name)
116 self.__ports.append(port)
119 port = neutron_utils.create_port(
120 self._neutron, self._os_creds, port_setting)
123 'Created port %s for router - %s',
125 self.router_settings.name)
126 self.__ports.append(port)
127 neutron_utils.add_interface_router(self._neutron,
131 raise RouterCreationError(
132 'Error creating port with name - '
139 Removes and deletes all items created in reverse order.
141 for port in self.__ports:
143 'Removing router interface from router %s and port %s',
144 self.router_settings.name, port.name)
146 neutron_utils.remove_interface_router(self._neutron,
147 self.__router, port=port)
150 self.__ports = list()
152 for internal_subnet in self.__internal_subnets:
154 'Removing router interface from router %s and subnet %s',
155 self.router_settings.name, internal_subnet.name)
157 neutron_utils.remove_interface_router(self._neutron,
159 subnet=internal_subnet)
162 self.__internal_subnets = list()
165 logger.info('Removing router ' + self.router_settings.name)
167 neutron_utils.delete_router(self._neutron, self.__router)
172 def get_router(self):
174 Returns the OpenStack router object
179 def get_internal_router_interface(self):
181 Returns the OpenStack internal router interface object
184 return self.__internal_router_interface
187 class RouterCreationError(Exception):
189 Exception to be thrown when an router instance cannot be created
193 class RouterSettings:
195 Class representing a router configuration
198 def __init__(self, **kwargs):
200 Constructor - all parameters are optional
201 :param name: The router name.
202 :param project_name: The name of the project who owns the network. Only
203 administrative users can specify a project ID
204 other than their own. You cannot change this value
205 through authorization policies.
206 :param external_gateway: Name of the external network to which to route
207 :param admin_state_up: The administrative status of the router.
208 True = up / False = down (default True)
209 :param external_fixed_ips: Dictionary containing the IP address
211 :param internal_subnets: List of subnet names to which to connect this
212 router for Floating IP purposes
213 :param port_settings: List of PortSettings objects
216 self.name = kwargs.get('name')
217 self.project_name = kwargs.get('project_name')
218 self.external_gateway = kwargs.get('external_gateway')
220 self.admin_state_up = kwargs.get('admin_state_up')
221 self.enable_snat = kwargs.get('enable_snat')
222 self.external_fixed_ips = kwargs.get('external_fixed_ips')
223 if kwargs.get('internal_subnets'):
224 self.internal_subnets = kwargs['internal_subnets']
226 self.internal_subnets = list()
228 self.port_settings = list()
229 if kwargs.get('interfaces', kwargs.get('port_settings')):
230 interfaces = kwargs.get('interfaces', kwargs.get('port_settings'))
231 for interface in interfaces:
232 if isinstance(interface, PortSettings):
233 self.port_settings.append(interface)
235 self.port_settings.append(
236 PortSettings(**interface['port']))
239 raise RouterSettingsError('Name is required')
241 def dict_for_neutron(self, neutron, os_creds):
243 Returns a dictionary object representing this object.
244 This is meant to be converted into JSON designed for use by the Neutron
247 TODO - expand automated testing to exercise all parameters
248 :param neutron: The neutron client to retrieve external network
249 information if necessary
250 :param os_creds: The OpenStack credentials
251 :return: the dictionary object
257 out['name'] = self.name
258 if self.project_name:
259 keystone = keystone_utils.keystone_client(os_creds)
260 project = keystone_utils.get_project(
261 keystone=keystone, project_name=self.project_name)
264 project_id = project.id
266 out['tenant_id'] = project_id
268 raise RouterSettingsError(
269 'Could not find project ID for project named - ' +
271 if self.admin_state_up is not None:
272 out['admin_state_up'] = self.admin_state_up
273 if self.external_gateway:
274 ext_net = neutron_utils.get_network(
275 neutron, network_name=self.external_gateway)
277 ext_gw['network_id'] = ext_net.id
278 out['external_gateway_info'] = ext_gw
280 raise RouterSettingsError(
281 'Could not find the external network named - ' +
282 self.external_gateway)
284 return {'router': out}
287 class RouterSettingsError(Exception):
289 Exception to be thrown when router settings attributes are incorrect