Fix: Workarround for too long interface names
[osm/vim-emu.git] / src / emuvim / api / openstack / compute.py
1 from mininet.link import Link
2
3 from resources import *
4 from docker import DockerClient
5 import logging
6 import threading
7 import uuid
8 import time
9 import ip_handler as IP
10
11
12 LOG = logging.getLogger("api.openstack.compute")
13
14
15 class HeatApiStackInvalidException(Exception):
16 """
17 Exception thrown when a submitted stack is invalid.
18 """
19
20 def __init__(self, value):
21 self.value = value
22
23 def __str__(self):
24 return repr(self.value)
25
26
27 class OpenstackCompute(object):
28 """
29 This class is a datacenter specific compute object that tracks all containers that are running in a datacenter,
30 as well as networks and configured ports.
31 It has some stack dependet logic and can check if a received stack is valid.
32
33 It also handles start and stop of containers.
34 """
35
36 def __init__(self):
37 self.dc = None
38 self.stacks = dict()
39 self.computeUnits = dict()
40 self.routers = dict()
41 self.flavors = dict()
42 self._images = dict()
43 self.nets = dict()
44 self.ports = dict()
45 self.port_pairs = dict()
46 self.port_pair_groups = dict()
47 self.flow_classifiers = dict()
48 self.port_chains = dict()
49 self.compute_nets = dict()
50 self.dcli = DockerClient(base_url='unix://var/run/docker.sock')
51
52 @property
53 def images(self):
54 """
55 Updates the known images. Asks the docker daemon for a list of all known images and returns
56 the new dictionary.
57
58 :return: Returns the new image dictionary.
59 :rtype: ``dict``
60 """
61 for image in self.dcli.images.list():
62 if len(image.tags) > 0:
63 for t in image.tags:
64 t = t.replace(":latest", "") # only use short tag names for OSM compatibility
65 if t not in self._images:
66 self._images[t] = Image(t)
67 return self._images
68
69 def add_stack(self, stack):
70 """
71 Adds a new stack to the compute node.
72
73 :param stack: Stack dictionary.
74 :type stack: :class:`heat.resources.stack`
75 """
76 if not self.check_stack(stack):
77 self.clean_broken_stack(stack)
78 raise HeatApiStackInvalidException("Stack did not pass validity checks")
79 self.stacks[stack.id] = stack
80
81 def clean_broken_stack(self, stack):
82 for port in stack.ports.values():
83 if port.id in self.ports:
84 del self.ports[port.id]
85 for server in stack.servers.values():
86 if server.id in self.computeUnits:
87 del self.computeUnits[server.id]
88 for net in stack.nets.values():
89 if net.id in self.nets:
90 del self.nets[net.id]
91
92 def check_stack(self, stack):
93 """
94 Checks all dependencies of all servers, ports and routers and their most important parameters.
95
96 :param stack: A reference of the stack that should be checked.
97 :type stack: :class:`heat.resources.stack`
98 :return: * *True*: If the stack is completely fine.
99 * *False*: Else
100 :rtype: ``bool``
101 """
102 everything_ok = True
103 for server in stack.servers.values():
104 for port_name in server.port_names:
105 if port_name not in stack.ports:
106 LOG.warning("Server %s of stack %s has a port named %s that is not known." %
107 (server.name, stack.stack_name, port_name))
108 everything_ok = False
109 if server.image is None:
110 LOG.warning("Server %s holds no image." % (server.name))
111 everything_ok = False
112 if server.command is None:
113 LOG.warning("Server %s holds no command." % (server.name))
114 everything_ok = False
115 for port in stack.ports.values():
116 if port.net_name not in stack.nets:
117 LOG.warning("Port %s of stack %s has a network named %s that is not known." %
118 (port.name, stack.stack_name, port.net_name))
119 everything_ok = False
120 if port.intf_name is None:
121 LOG.warning("Port %s has no interface name." % (port.name))
122 everything_ok = False
123 if port.ip_address is None:
124 LOG.warning("Port %s has no IP address." % (port.name))
125 everything_ok = False
126 for router in stack.routers.values():
127 for subnet_name in router.subnet_names:
128 found = False
129 for net in stack.nets.values():
130 if net.subnet_name == subnet_name:
131 found = True
132 break
133 if not found:
134 LOG.warning("Router %s of stack %s has a network named %s that is not known." %
135 (router.name, stack.stack_name, subnet_name))
136 everything_ok = False
137 return everything_ok
138
139 def add_flavor(self, name, cpu, memory, memory_unit, storage, storage_unit):
140 """
141 Adds a flavor to the stack.
142
143 :param name: Specifies the name of the flavor.
144 :type name: ``str``
145 :param cpu:
146 :type cpu: ``str``
147 :param memory:
148 :type memory: ``str``
149 :param memory_unit:
150 :type memory_unit: ``str``
151 :param storage:
152 :type storage: ``str``
153 :param storage_unit:
154 :type storage_unit: ``str``
155 """
156 flavor = InstanceFlavor(name, cpu, memory, memory_unit, storage, storage_unit)
157 self.flavors[flavor.name] = flavor
158 return flavor
159
160 def deploy_stack(self, stackid):
161 """
162 Deploys the stack and starts the emulation.
163
164 :param stackid: An UUID str of the stack
165 :type stackid: ``str``
166 :return: * *False*: If the Datacenter is None
167 * *True*: Else
168 :rtype: ``bool``
169 """
170 if self.dc is None:
171 return False
172
173 stack = self.stacks[stackid]
174 self.update_compute_dicts(stack)
175
176 # Create the networks first
177 for server in stack.servers.values():
178 self._start_compute(server)
179 return True
180
181 def delete_stack(self, stack_id):
182 """
183 Delete a stack and all its components.
184
185 :param stack_id: An UUID str of the stack
186 :type stack_id: ``str``
187 :return: * *False*: If the Datacenter is None
188 * *True*: Else
189 :rtype: ``bool``
190 """
191 if self.dc is None:
192 return False
193
194 # Stop all servers and their links of this stack
195 for server in self.stacks[stack_id].servers.values():
196 self.stop_compute(server)
197 self.delete_server(server)
198 for net in self.stacks[stack_id].nets.values():
199 self.delete_network(net.id)
200 for port in self.stacks[stack_id].ports.values():
201 self.delete_port(port.id)
202
203 del self.stacks[stack_id]
204 return True
205
206 def update_stack(self, old_stack_id, new_stack):
207 """
208 Determines differences within the old and the new stack and deletes, create or changes only parts that
209 differ between the two stacks.
210
211 :param old_stack_id: The ID of the old stack.
212 :type old_stack_id: ``str``
213 :param new_stack: A reference of the new stack.
214 :type new_stack: :class:`heat.resources.stack`
215 :return: * *True*: if the old stack could be updated to the new stack without any error.
216 * *False*: else
217 :rtype: ``bool``
218 """
219 LOG.debug("updating stack {} with new_stack {}".format(old_stack_id, new_stack))
220 if old_stack_id not in self.stacks:
221 return False
222 old_stack = self.stacks[old_stack_id]
223
224 # Update Stack IDs
225 for server in old_stack.servers.values():
226 if server.name in new_stack.servers:
227 new_stack.servers[server.name].id = server.id
228 for net in old_stack.nets.values():
229 if net.name in new_stack.nets:
230 new_stack.nets[net.name].id = net.id
231 for subnet in new_stack.nets.values():
232 if subnet.subnet_name == net.subnet_name:
233 subnet.subnet_id = net.subnet_id
234 break
235 for port in old_stack.ports.values():
236 if port.name in new_stack.ports:
237 new_stack.ports[port.name].id = port.id
238 for router in old_stack.routers.values():
239 if router.name in new_stack.routers:
240 new_stack.routers[router.name].id = router.id
241
242 # Update the compute dicts to now contain the new_stack components
243 self.update_compute_dicts(new_stack)
244
245 self.update_ip_addresses(old_stack, new_stack)
246
247 # Update all interface names - after each port has the correct UUID!!
248 for port in new_stack.ports.values():
249 port.create_intf_name()
250
251 if not self.check_stack(new_stack):
252 return False
253
254 # Remove unnecessary networks
255 for net in old_stack.nets.values():
256 if not net.name in new_stack.nets:
257 self.delete_network(net.id)
258
259 # Remove all unnecessary servers
260 for server in old_stack.servers.values():
261 if server.name in new_stack.servers:
262 if not server.compare_attributes(new_stack.servers[server.name]):
263 self.stop_compute(server)
264 else:
265 # Delete unused and changed links
266 for port_name in server.port_names:
267 if port_name in old_stack.ports and port_name in new_stack.ports:
268 if not old_stack.ports.get(port_name) == new_stack.ports.get(port_name):
269 my_links = self.dc.net.links
270 for link in my_links:
271 if str(link.intf1) == old_stack.ports[port_name].intf_name and \
272 str(link.intf1.ip) == \
273 old_stack.ports[port_name].ip_address.split('/')[0]:
274 self._remove_link(server.name, link)
275
276 # Add changed link
277 self._add_link(server.name,
278 new_stack.ports[port_name].ip_address,
279 new_stack.ports[port_name].intf_name,
280 new_stack.ports[port_name].net_name)
281 break
282 else:
283 my_links = self.dc.net.links
284 for link in my_links:
285 if str(link.intf1) == old_stack.ports[port_name].intf_name and \
286 str(link.intf1.ip) == old_stack.ports[port_name].ip_address.split('/')[0]:
287 self._remove_link(server.name, link)
288 break
289
290 # Create new links
291 for port_name in new_stack.servers[server.name].port_names:
292 if port_name not in server.port_names:
293 self._add_link(server.name,
294 new_stack.ports[port_name].ip_address,
295 new_stack.ports[port_name].intf_name,
296 new_stack.ports[port_name].net_name)
297 else:
298 self.stop_compute(server)
299
300 # Start all new servers
301 for server in new_stack.servers.values():
302 if server.name not in self.dc.containers:
303 self._start_compute(server)
304 else:
305 server.emulator_compute = self.dc.containers.get(server.name)
306
307 del self.stacks[old_stack_id]
308 self.stacks[new_stack.id] = new_stack
309 return True
310
311 def update_ip_addresses(self, old_stack, new_stack):
312 """
313 Updates the subnet and the port IP addresses - which should always be in this order!
314
315 :param old_stack: The currently running stack
316 :type old_stack: :class:`heat.resources.stack`
317 :param new_stack: The new created stack
318 :type new_stack: :class:`heat.resources.stack`
319 """
320 self.update_subnet_cidr(old_stack, new_stack)
321 self.update_port_addresses(old_stack, new_stack)
322
323 def update_port_addresses(self, old_stack, new_stack):
324 """
325 Updates the port IP addresses. First resets all issued addresses. Then get all IP addresses from the old
326 stack and sets them to the same ports in the new stack. Finally all new or changed instances will get new
327 IP addresses.
328
329 :param old_stack: The currently running stack
330 :type old_stack: :class:`heat.resources.stack`
331 :param new_stack: The new created stack
332 :type new_stack: :class:`heat.resources.stack`
333 """
334 for net in new_stack.nets.values():
335 net.reset_issued_ip_addresses()
336
337 for old_port in old_stack.ports.values():
338 for port in new_stack.ports.values():
339 if port.compare_attributes(old_port):
340 for net in new_stack.nets.values():
341 if net.name == port.net_name:
342 if net.assign_ip_address(old_port.ip_address, port.name):
343 port.ip_address = old_port.ip_address
344 port.mac_address = old_port.mac_address
345 else:
346 port.ip_address = net.get_new_ip_address(port.name)
347
348 for port in new_stack.ports.values():
349 for net in new_stack.nets.values():
350 if port.net_name == net.name and not net.is_my_ip(port.ip_address, port.name):
351 port.ip_address = net.get_new_ip_address(port.name)
352
353 def update_subnet_cidr(self, old_stack, new_stack):
354 """
355 Updates the subnet IP addresses. If the new stack contains subnets from the old stack it will take those
356 IP addresses. Otherwise it will create new IP addresses for the subnet.
357
358 :param old_stack: The currently running stack
359 :type old_stack: :class:`heat.resources.stack`
360 :param new_stack: The new created stack
361 :type new_stack: :class:`heat.resources.stack`
362 """
363 for old_subnet in old_stack.nets.values():
364 IP.free_cidr(old_subnet.get_cidr(), old_subnet.subnet_id)
365
366 for subnet in new_stack.nets.values():
367 subnet.clear_cidr()
368 for old_subnet in old_stack.nets.values():
369 if subnet.subnet_name == old_subnet.subnet_name:
370 if IP.assign_cidr(old_subnet.get_cidr(), subnet.subnet_id):
371 subnet.set_cidr(old_subnet.get_cidr())
372
373 for subnet in new_stack.nets.values():
374 if IP.is_cidr_issued(subnet.get_cidr()):
375 continue
376
377 cird = IP.get_new_cidr(subnet.subnet_id)
378 subnet.set_cidr(cird)
379 return
380
381 def update_compute_dicts(self, stack):
382 """
383 Update and add all stack components tho the compute dictionaries.
384
385 :param stack: A stack reference, to get all required components.
386 :type stack: :class:`heat.resources.stack`
387 """
388 for server in stack.servers.values():
389 self.computeUnits[server.id] = server
390 if isinstance(server.flavor, dict):
391 self.add_flavor(server.flavor['flavorName'],
392 server.flavor['vcpu'],
393 server.flavor['ram'], 'MB',
394 server.flavor['storage'], 'GB')
395 server.flavor = server.flavor['flavorName']
396 for router in stack.routers.values():
397 self.routers[router.id] = router
398 for net in stack.nets.values():
399 self.nets[net.id] = net
400 for port in stack.ports.values():
401 self.ports[port.id] = port
402
403 def _start_compute(self, server):
404 """
405 Starts a new compute object (docker container) inside the emulator.
406 Should only be called by stack modifications and not directly.
407
408 :param server: Specifies the compute resource.
409 :type server: :class:`heat.resources.server`
410 """
411 LOG.debug("Starting new compute resources %s" % server.name)
412 network = list()
413
414 for port_name in server.port_names:
415 network_dict = dict()
416 port = self.find_port_by_name_or_id(port_name)
417 if port is not None:
418 network_dict['id'] = port.intf_name
419 network_dict['ip'] = port.ip_address
420 network_dict[network_dict['id']] = self.find_network_by_name_or_id(port.net_name).name
421 network.append(network_dict)
422
423 self.compute_nets[server.name] = network
424 LOG.debug(network)
425 c = self.dc.startCompute(server.name, image=server.image, command=server.command,
426 network=network, flavor_name=server.flavor,
427 properties=server.properties)
428 server.emulator_compute = c
429
430 for intf in c.intfs.values():
431 for port_name in server.port_names:
432 port = self.find_port_by_name_or_id(port_name)
433 if port is not None:
434 if intf.name == port.intf_name:
435 # wait up to one second for the intf to come up
436 self.timeout_sleep(intf.isUp, 1)
437 if port.mac_address is not None:
438 intf.setMAC(port.mac_address)
439 else:
440 port.mac_address = intf.MAC()
441
442 # Start the real emulator command now as specified in the dockerfile
443 # ENV SON_EMU_CMD
444 config = c.dcinfo.get("Config", dict())
445 env = config.get("Env", list())
446 for env_var in env:
447 if "SON_EMU_CMD=" in env_var:
448 cmd = str(env_var.split("=")[1])
449 server.son_emu_command = cmd
450 # execute command in new thread to ensure that GK is not blocked by VNF
451 t = threading.Thread(target=c.cmdPrint, args=(cmd,))
452 t.daemon = True
453 t.start()
454
455 def stop_compute(self, server):
456 """
457 Determines which links should be removed before removing the server itself.
458
459 :param server: The server that should be removed
460 :type server: ``heat.resources.server``
461 """
462 LOG.debug("Stopping container %s with full name %s" % (server.name, server.full_name))
463 link_names = list()
464 for port_name in server.port_names:
465 link_names.append(self.find_port_by_name_or_id(port_name).intf_name)
466 my_links = self.dc.net.links
467 for link in my_links:
468 if str(link.intf1) in link_names:
469 # Remove all self created links that connect the server to the main switch
470 self._remove_link(server.name, link)
471
472 # Stop the server and the remaining connection to the datacenter switch
473 self.dc.stopCompute(server.name)
474 # Only now delete all its ports and the server itself
475 for port_name in server.port_names:
476 self.delete_port(port_name)
477 self.delete_server(server)
478
479 def find_server_by_name_or_id(self, name_or_id):
480 """
481 Tries to find the server by ID and if this does not succeed then tries to find it via name.
482
483 :param name_or_id: UUID or name of the server.
484 :type name_or_id: ``str``
485 :return: Returns the server reference if it was found or None
486 :rtype: :class:`heat.resources.server`
487 """
488 if name_or_id in self.computeUnits:
489 return self.computeUnits[name_or_id]
490
491 if self._shorten_server_name(name_or_id) in self.computeUnits:
492 return self.computeUnits[name_or_id]
493
494 for server in self.computeUnits.values():
495 if server.name == name_or_id or server.template_name == name_or_id or server.full_name == name_or_id:
496 return server
497 if (server.name == self._shorten_server_name(name_or_id)
498 or server.template_name == self._shorten_server_name(name_or_id)
499 or server.full_name == self._shorten_server_name(name_or_id)):
500 return server
501 return None
502
503 def create_server(self, name, stack_operation=False):
504 """
505 Creates a server with the specified name. Raises an exception when a server with the given name already
506 exists!
507
508 :param name: Name of the new server.
509 :type name: ``str``
510 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
511 :type stack_operation: ``bool``
512 :return: Returns the created server.
513 :rtype: :class:`heat.resources.server`
514 """
515 if self.find_server_by_name_or_id(name) is not None and not stack_operation:
516 raise Exception("Server with name %s already exists." % name)
517 safe_name = self._shorten_server_name(name)
518 server = Server(safe_name)
519 server.id = str(uuid.uuid4())
520 if not stack_operation:
521 self.computeUnits[server.id] = server
522 return server
523
524 def _shorten_server_name(self, name, char_limit=9):
525 """
526 Docker does not like too long instance names.
527 This function provides a shorter name if needed
528 """
529 # this is a ugly fix, but we cannot do better for now (interface names are to long)
530 if len(name) > char_limit:
531 LOG.info("Long server name: {}".format(name))
532 # construct a short name
533 name = name.replace("_vnf", "")
534 p = name.split("_")
535 if len(p) > 0:
536 name = p[len(p)-1]
537 name = name[-char_limit:].strip("-_ .")
538 LOG.info("Short server name: {}".format(name))
539 return name
540
541
542 def delete_server(self, server):
543 """
544 Deletes the given server from the stack dictionary and the computeUnits dictionary.
545
546 :param server: Reference of the server that should be deleted.
547 :type server: :class:`heat.resources.server`
548 :return: * *False*: If the server name is not in the correct format ('datacentername_stackname_servername') \
549 or when no stack with the correct stackname was found.
550 * *True*: Else
551 :rtype: ``bool``
552 """
553 if server is None:
554 return False
555 name_parts = server.name.split('_')
556 if len(name_parts) < 3:
557 return False
558
559 for stack in self.stacks.values():
560 if stack.stack_name == name_parts[1]:
561 stack.servers.pop(server.id, None)
562 if self.computeUnits.pop(server.id, None) is None:
563 return False
564 return True
565
566 def find_network_by_name_or_id(self, name_or_id):
567 """
568 Tries to find the network by ID and if this does not succeed then tries to find it via name.
569
570 :param name_or_id: UUID or name of the network.
571 :type name_or_id: ``str``
572 :return: Returns the network reference if it was found or None
573 :rtype: :class:`heat.resources.net`
574 """
575 if name_or_id in self.nets:
576 return self.nets[name_or_id]
577 for net in self.nets.values():
578 if net.name == name_or_id:
579 return net
580
581 return None
582
583 def create_network(self, name, stack_operation=False):
584 """
585 Creates a new network with the given name. Raises an exception when a network with the given name already
586 exists!
587
588 :param name: Name of the new network.
589 :type name: ``str``
590 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
591 :type stack_operation: ``bool``
592 :return: :class:`heat.resources.net`
593 """
594 LOG.debug("Creating network with name %s" % name)
595 if self.find_network_by_name_or_id(name) is not None and not stack_operation:
596 LOG.warning("Creating network with name %s failed, as it already exists" % name)
597 raise Exception("Network with name %s already exists." % name)
598 network = Net(name)
599 network.id = str(uuid.uuid4())
600 if not stack_operation:
601 self.nets[network.id] = network
602 return network
603
604 def delete_network(self, name_or_id):
605 """
606 Deletes the given network.
607
608 :param name_or_id: Name or UUID of the network.
609 :type name_or_id: ``str``
610 """
611 net = self.find_network_by_name_or_id(name_or_id)
612 if net is None:
613 raise Exception("Network with name or id %s does not exists." % name_or_id)
614
615 for stack in self.stacks.values():
616 stack.nets.pop(net.name, None)
617
618 self.nets.pop(net.id, None)
619
620 def create_port(self, name, stack_operation=False):
621 """
622 Creates a new port with the given name. Raises an exception when a port with the given name already
623 exists!
624
625 :param name: Name of the new port.
626 :type name: ``str``
627 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
628 :type stack_operation: ``bool``
629 :return: Returns the created port.
630 :rtype: :class:`heat.resources.port`
631 """
632 port = self.find_port_by_name_or_id(name)
633 if port is not None and not stack_operation:
634 LOG.warning("Creating port with name %s failed, as it already exists" % name)
635 raise Exception("Port with name %s already exists." % name)
636 LOG.debug("Creating port with name %s" % name)
637 port = Port(name)
638 if not stack_operation:
639 self.ports[port.id] = port
640 port.create_intf_name()
641 return port
642
643 def find_port_by_name_or_id(self, name_or_id):
644 """
645 Tries to find the port by ID and if this does not succeed then tries to find it via name.
646
647 :param name_or_id: UUID or name of the network.
648 :type name_or_id: ``str``
649 :return: Returns the port reference if it was found or None
650 :rtype: :class:`heat.resources.port`
651 """
652 if name_or_id in self.ports:
653 return self.ports[name_or_id]
654 for port in self.ports.values():
655 if port.name == name_or_id or port.template_name == name_or_id:
656 return port
657
658 return None
659
660 def delete_port(self, name_or_id):
661 """
662 Deletes the given port. Raises an exception when the port was not found!
663
664 :param name_or_id: UUID or name of the port.
665 :type name_or_id: ``str``
666 """
667 port = self.find_port_by_name_or_id(name_or_id)
668 if port is None:
669 raise Exception("Port with name or id %s does not exists." % name_or_id)
670
671 my_links = self.dc.net.links
672 for link in my_links:
673 if str(link.intf1) == port.intf_name and \
674 str(link.intf1.ip) == port.ip_address.split('/')[0]:
675 self._remove_link(link.intf1.node.name, link)
676 break
677
678 self.ports.pop(port.id, None)
679 for stack in self.stacks.values():
680 stack.ports.pop(port.name, None)
681
682 def create_port_pair(self, name, stack_operation=False):
683 """
684 Creates a new port pair with the given name. Raises an exception when a port pair with the given name already
685 exists!
686
687 :param name: Name of the new port pair.
688 :type name: ``str``
689 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
690 :type stack_operation: ``bool``
691 :return: Returns the created port pair.
692 :rtype: :class:`openstack.resources.port_pair`
693 """
694 port_pair = self.find_port_pair_by_name_or_id(name)
695 if port_pair is not None and not stack_operation:
696 logging.warning("Creating port pair with name %s failed, as it already exists" % name)
697 raise Exception("Port pair with name %s already exists." % name)
698 logging.debug("Creating port pair with name %s" % name)
699 port_pair = PortPair(name)
700 if not stack_operation:
701 self.port_pairs[port_pair.id] = port_pair
702 return port_pair
703
704 def find_port_pair_by_name_or_id(self, name_or_id):
705 """
706 Tries to find the port pair by ID and if this does not succeed then tries to find it via name.
707
708 :param name_or_id: UUID or name of the port pair.
709 :type name_or_id: ``str``
710 :return: Returns the port pair reference if it was found or None
711 :rtype: :class:`openstack.resources.port_pair`
712 """
713 if name_or_id in self.port_pairs:
714 return self.port_pairs[name_or_id]
715 for port_pair in self.port_pairs.values():
716 if port_pair.name == name_or_id:
717 return port_pair
718
719 return None
720
721 def delete_port_pair(self, name_or_id):
722 """
723 Deletes the given port pair. Raises an exception when the port pair was not found!
724
725 :param name_or_id: UUID or name of the port pair.
726 :type name_or_id: ``str``
727 """
728 port_pair = self.find_port_pair_by_name_or_id(name_or_id)
729 if port_pair is None:
730 raise Exception("Port pair with name or id %s does not exists." % name_or_id)
731
732 self.port_pairs.pop(port_pair.id, None)
733
734 def create_port_pair_group(self, name, stack_operation=False):
735 """
736 Creates a new port pair group with the given name. Raises an exception when a port pair group
737 with the given name already exists!
738
739 :param name: Name of the new port pair group.
740 :type name: ``str``
741 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
742 :type stack_operation: ``bool``
743 :return: Returns the created port pair group .
744 :rtype: :class:`openstack.resources.port_pair_group`
745 """
746 port_pair_group = self.find_port_pair_group_by_name_or_id(name)
747 if port_pair_group is not None and not stack_operation:
748 logging.warning("Creating port pair group with name %s failed, as it already exists" % name)
749 raise Exception("Port pair group with name %s already exists." % name)
750 logging.debug("Creating port pair group with name %s" % name)
751 port_pair_group = PortPairGroup(name)
752 if not stack_operation:
753 self.port_pair_groups[port_pair_group.id] = port_pair_group
754 return port_pair_group
755
756 def find_port_pair_group_by_name_or_id(self, name_or_id):
757 """
758 Tries to find the port pair group by ID and if this does not succeed then tries to find it via name.
759
760 :param name_or_id: UUID or name of the port pair group.
761 :type name_or_id: ``str``
762 :return: Returns the port pair group reference if it was found or None
763 :rtype: :class:`openstack.resources.port_pair_group`
764 """
765 if name_or_id in self.port_pair_groups:
766 return self.port_pair_groups[name_or_id]
767 for port_pair_group in self.port_pair_groups.values():
768 if port_pair_group.name == name_or_id:
769 return port_pair_group
770
771 return None
772
773 def delete_port_pair_group(self, name_or_id):
774 """
775 Deletes the given port pair group. Raises an exception when the port pair group was not found!
776
777 :param name_or_id: UUID or name of the port pair group.
778 :type name_or_id: ``str``
779 """
780 port_pair_group = self.find_port_pair_group_by_name_or_id(name_or_id)
781 if port_pair_group is None:
782 raise Exception("Port pair with name or id %s does not exists." % name_or_id)
783
784 self.port_pair_groups.pop(port_pair_group.id, None)
785
786 def create_port_chain(self, name, stack_operation=False):
787 """
788 Creates a new port chain with the given name. Raises an exception when a port chain with the given name already
789 exists!
790
791 :param name: Name of the new port chain
792 :type name: ``str``
793 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
794 :type stack_operation: ``bool``
795 :return: Returns the created port chain.
796 :rtype: :class:`openstack.resources.port_chain.PortChain`
797 """
798 port_chain = self.find_port_chain_by_name_or_id(name)
799 if port_chain is not None and not stack_operation:
800 logging.warning("Creating port chain with name %s failed, as it already exists" % name)
801 raise Exception("Port chain with name %s already exists." % name)
802 logging.debug("Creating port chain with name %s" % name)
803 port_chain = PortChain(name)
804 if not stack_operation:
805 self.port_chains[port_chain.id] = port_chain
806 return port_chain
807
808 def find_port_chain_by_name_or_id(self, name_or_id):
809 """
810 Tries to find the port chain by ID and if this does not succeed then tries to find it via name.
811
812 :param name_or_id: UUID or name of the port chain.
813 :type name_or_id: ``str``
814 :return: Returns the port chain reference if it was found or None
815 :rtype: :class:`openstack.resources.port_chain.PortChain`
816 """
817 if name_or_id in self.port_chains:
818 return self.port_chains[name_or_id]
819 for port_chain in self.port_chains.values():
820 if port_chain.name == name_or_id:
821 return port_chain
822 return None
823
824 def delete_port_chain(self, name_or_id):
825 """
826 Deletes the given port chain. Raises an exception when the port chain was not found!
827
828 :param name_or_id: UUID or name of the port chain.
829 :type name_or_id: ``str``
830 """
831 port_chain = self.find_port_chain_by_name_or_id(name_or_id)
832 port_chain.uninstall(self)
833 if port_chain is None:
834 raise Exception("Port chain with name or id %s does not exists." % name_or_id)
835
836 self.port_chains.pop(port_chain.id, None)
837
838 def create_flow_classifier(self, name, stack_operation=False):
839 """
840 Creates a new flow classifier with the given name. Raises an exception when a flow classifier with the given name already
841 exists!
842
843 :param name: Name of the new flow classifier.
844 :type name: ``str``
845 :param stack_operation: Allows the heat parser to create modules without adapting the current emulation.
846 :type stack_operation: ``bool``
847 :return: Returns the created flow classifier.
848 :rtype: :class:`openstack.resources.flow_classifier`
849 """
850 flow_classifier = self.find_flow_classifier_by_name_or_id(name)
851 if flow_classifier is not None and not stack_operation:
852 logging.warning("Creating flow classifier with name %s failed, as it already exists" % name)
853 raise Exception("Flow classifier with name %s already exists." % name)
854 logging.debug("Creating flow classifier with name %s" % name)
855 flow_classifier = FlowClassifier(name)
856 if not stack_operation:
857 self.flow_classifiers[flow_classifier.id] = flow_classifier
858 return flow_classifier
859
860 def find_flow_classifier_by_name_or_id(self, name_or_id):
861 """
862 Tries to find the flow classifier by ID and if this does not succeed then tries to find it via name.
863
864 :param name_or_id: UUID or name of the flow classifier.
865 :type name_or_id: ``str``
866 :return: Returns the flow classifier reference if it was found or None
867 :rtype: :class:`openstack.resources.flow_classifier`
868 """
869 if name_or_id in self.flow_classifiers:
870 return self.flow_classifiers[name_or_id]
871 for flow_classifier in self.flow_classifiers.values():
872 if flow_classifier.name == name_or_id:
873 return flow_classifier
874
875 return None
876
877 def delete_flow_classifier(self, name_or_id):
878 """
879 Deletes the given flow classifier. Raises an exception when the flow classifier was not found!
880
881 :param name_or_id: UUID or name of the flow classifier.
882 :type name_or_id: ``str``
883 """
884 flow_classifier = self.find_flow_classifier_by_name_or_id(name_or_id)
885 if flow_classifier is None:
886 raise Exception("Flow classifier with name or id %s does not exists." % name_or_id)
887
888 self.flow_classifiers.pop(flow_classifier.id, None)
889
890 def _add_link(self, node_name, ip_address, link_name, net_name):
891 """
892 Adds a new link between datacenter switch and the node with the given name.
893
894 :param node_name: Name of the required node.
895 :type node_name: ``str``
896 :param ip_address: IP-Address of the node.
897 :type ip_address: ``str``
898 :param link_name: Link name.
899 :type link_name: ``str``
900 :param net_name: Network name.
901 :type net_name: ``str``
902 """
903 node = self.dc.net.get(node_name)
904 params = {'params1': {'ip': ip_address,
905 'id': link_name,
906 link_name: net_name},
907 'intfName1': link_name,
908 'cls': Link}
909 link = self.dc.net.addLink(node, self.dc.switch, **params)
910 OpenstackCompute.timeout_sleep(link.intf1.isUp, 1)
911
912 def _remove_link(self, server_name, link):
913 """
914 Removes a link between server and datacenter switch.
915
916 :param server_name: Specifies the server where the link starts.
917 :type server_name: ``str``
918 :param link: A reference of the link which should be removed.
919 :type link: :class:`mininet.link`
920 """
921 self.dc.switch.detach(link.intf2)
922 del self.dc.switch.intfs[self.dc.switch.ports[link.intf2]]
923 del self.dc.switch.ports[link.intf2]
924 del self.dc.switch.nameToIntf[link.intf2.name]
925 self.dc.net.removeLink(link=link)
926 for intf_key in self.dc.net[server_name].intfs.keys():
927 if self.dc.net[server_name].intfs[intf_key].link == link:
928 self.dc.net[server_name].intfs[intf_key].delete()
929 del self.dc.net[server_name].intfs[intf_key]
930
931 @staticmethod
932 def timeout_sleep(function, max_sleep):
933 """
934 This function will execute a function all 0.1 seconds until it successfully returns.
935 Will return after `max_sleep` seconds if not successful.
936
937 :param function: The function to execute. Should return true if done.
938 :type function: ``function``
939 :param max_sleep: Max seconds to sleep. 1 equals 1 second.
940 :type max_sleep: ``float``
941 """
942 current_time = time.time()
943 stop_time = current_time + max_sleep
944 while not function() and current_time < stop_time:
945 current_time = time.time()
946 time.sleep(0.1)