# Copyright (c) 2013-2017 Barnstormer Softworks, Ltd.
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
from __future__ import absolute_import
import itertools
import sys
import functools
import importlib
from lxml import etree as ET
import six
import geni.rspec
import geni.namespaces as GNS
import geni.urn
# This exception gets thrown if a __ONCEONLY__ extension gets added to a parent
# element more than one time
[docs]
class DuplicateExtensionError(Exception):
def __init__ (self, klass):
super(DuplicateExtensionError, self).__init__()
self.klass = klass
def __str__ (self):
return "Extension (%s) can only be added to a parent object once" % self.klass.__name__
################################################
# Base Request - Must be at top for EXTENSIONS #
################################################
[docs]
class Request(geni.rspec.RSpec):
EXTENSIONS = []
def __init__ (self):
super(Request, self).__init__("request")
self._resources = []
self.tour = None
self._raw_elements = []
self.addNamespace(GNS.REQUEST, None)
self.addNamespace(Namespaces.CLIENT)
self._ext_children = []
for name,ext in Request.EXTENSIONS:
self._wrapext(name,ext)
def _wrapext (self, name, klass):
@functools.wraps(klass.__init__)
def wrap(*args, **kw):
if getattr(klass, "__ONCEONLY__", False):
if any(map(lambda x: isinstance(x,klass),self._ext_children)):
raise DuplicateExtensionError(klass)
instance = klass(*args, **kw)
if getattr(klass, "__WANTPARENT__", False):
instance._parent = self
for ns in getattr(klass, "__NAMESPACES__", []):
self.addNamespace(ns)
self._ext_children.append(instance)
return instance
setattr(self, name, wrap)
[docs]
def addResource (self, rsrc):
for ns in rsrc.namespaces:
self.addNamespace(ns)
self._resources.append(rsrc)
@property
def resources(self):
return self._resources + self._ext_children
[docs]
def addTour (self, tour):
self.addNamespace(Namespaces.EMULAB)
self.addNamespace(Namespaces.JACKS)
self.tour = tour
[docs]
def hasTour (self):
return self.tour is not None
[docs]
def addRawElement (self, elem):
self._raw_elements.append(elem)
[docs]
def writeXML (self, path):
"""Write the current request contents as an XML file that represents an rspec
in the GENIv3 format."""
if path is None:
f = sys.stdout
else:
f = open(path, "w+")
buf = self.toXMLString(True,True)
f.write(buf)
if path is not None:
f.close()
[docs]
def toXMLString (self, pretty_print = False, ucode = False):
"""Return the current request contents as an XML string that represents an rspec
in the GENIv3 format."""
rspec = self.getDOM()
if self.tour:
self.tour._write(rspec)
for resource in self._resources:
resource._write(rspec)
for obj in self._ext_children:
obj._write(rspec)
for elem in self._raw_elements:
rspec.append(elem)
if ucode:
buf = ET.tostring(rspec, pretty_print = pretty_print, encoding="unicode")
else:
buf = ET.tostring(rspec, pretty_print = pretty_print)
return buf
[docs]
class Resource(object):
def __init__ (self):
self.namespaces = []
self._ext_children = []
[docs]
def addNamespace (self, ns):
self.namespaces.append(ns)
def _wrapext (self, name, klass):
@functools.wraps(klass.__init__)
def wrap(*args, **kw):
if getattr(klass, "__ONCEONLY__", False):
if any(map(lambda x: isinstance(x,klass),self._ext_children)):
raise DuplicateExtensionError(klass)
for ns in getattr(klass, "__NAMESPACES__", []):
self.addNamespace(ns)
instance = klass(*args, **kw)
self._ext_children.append(instance)
return instance
setattr(self, name, wrap)
def _write (self, element):
for obj in self._ext_children:
obj._write(element)
return element
[docs]
class NodeType(object):
XEN = "emulab-xen"
DOCKER = "emulab-docker"
RAW = "raw"
VM = "emulab-xen"
[docs]
class Command(object):
def __init__ (self, cmd, data):
self.cmd = cmd
self.data = data
[docs]
def resolve (self):
return self.cmd % self.data
[docs]
class Service(object):
def __init__ (self):
pass
[docs]
class Install(Service):
def __init__ (self, url, path):
super(Install, self).__init__()
self.url = url
self.path = path
def _write (self, element):
ins = ET.SubElement(element, "{%s}install" % (GNS.REQUEST.name))
ins.attrib["url"] = self.url
ins.attrib["install_path"] = self.path
return ins
[docs]
class Execute(Service):
def __init__ (self, shell, command):
super(Execute, self).__init__()
self.shell = shell
self.command = command
def _write (self, element):
exc = ET.SubElement(element, "{%s}execute" % (GNS.REQUEST.name))
exc.attrib["shell"] = self.shell
if isinstance(self.command, Command):
exc.attrib["command"] = self.command.resolve()
else:
exc.attrib["command"] = self.command
return exc
[docs]
class Address(object):
def __init__ (self, atype):
self.type = atype
[docs]
class IPv4Address(Address):
def __init__ (self, address, netmask):
super(IPv4Address, self).__init__("ipv4")
self.address = address
self.netmask = netmask
def _write (self, element):
ip = ET.SubElement(element, "{%s}ip" % (GNS.REQUEST.name))
ip.attrib["address"] = self.address
ip.attrib["netmask"] = self.netmask
ip.attrib["type"] = self.type
return ip
[docs]
class Interface(object):
EXTENSIONS = []
[docs]
class InvalidAddressTypeError(Exception):
def __init__ (self, addr):
super(Interface.InvalidAddressTypeError, self).__init__()
self.addr = addr
def __str__ (self):
return "Type (%s) is invalid for interface addresses." % (type(self.addr))
def __init__ (self, name, node, address = None):
self.client_id = name
self.node = node
self.addresses = []
self.component_id = None
self.bandwidth = None
self.latency = None
self.plr = None
self._ext_children = []
if address:
self.addAddress(address)
for name,ext in Interface.EXTENSIONS:
self._wrapext(name,ext)
def _wrapext (self, name, klass):
@functools.wraps(klass.__init__)
def wrap(*args, **kw):
if getattr(klass, "__ONCEONLY__", False):
if any(map(lambda x: isinstance(x,klass),self._ext_children)):
raise DuplicateExtensionError(klass)
instance = klass(*args, **kw)
if getattr(klass, "__WANTPARENT__", False):
instance._parent = self
for ns in getattr(klass, "__NAMESPACES__", []):
self.addNamespace(ns)
self._ext_children.append(instance)
return instance
setattr(self, name, wrap)
@property
def name (self):
return self.client_id
[docs]
def addAddress (self, address):
if isinstance(address, Address):
self.addresses.append(address)
else:
raise Interface.InvalidAddressTypeError(address)
def _write (self, element):
intf = ET.SubElement(element, "{%s}interface" % (GNS.REQUEST.name))
intf.attrib["client_id"] = self.client_id
if self.component_id:
if isinstance(self.component_id, geni.urn.Base):
intf.attrib["component_id"] = str(self.component_id)
else:
intf.attrib["component_id"] = self.component_id
for addr in self.addresses:
addr._write(intf)
for obj in self._ext_children:
obj._write(intf)
return intf
[docs]
class Link(Resource):
EXTENSIONS = []
LNKID = 0
DEFAULT_BW = -1
DEFAULT_LAT = 0
DEFAULT_PLR = 0.0
def __init__ (self, name = None, ltype = "", members = None):
super(Link, self).__init__()
if name is None:
self.client_id = Link.newLinkID()
else:
self.client_id = name
self.interfaces = []
if members is not None:
for member in members:
if isinstance(member,Interface):
self.addInterface(member)
else:
self.addInterface(member.addInterface())
self.type = ltype
self._mac_learning = True
self._vlan_tagging = None
self._trivial_ok = None
self._link_multiplexing = False
self._best_effort = False
self._ext_children = []
self._raw_elements = []
self._component_managers = []
self.protocol = None
# If you try to set bandwidth higher than a gigabit, PG probably won't like you
self.bandwidth = Link.DEFAULT_BW
self.latency = Link.DEFAULT_LAT
self.plr = Link.DEFAULT_PLR
for name,ext in Link.EXTENSIONS:
self._wrapext(name,ext)
def _wrapext (self, name, klass):
@functools.wraps(klass.__init__)
def wrap(*args, **kw):
if getattr(klass, "__ONCEONLY__", False):
if any(map(lambda x: isinstance(x,klass),self._ext_children)):
raise DuplicateExtensionError(klass)
instance = klass(*args, **kw)
if getattr(klass, "__WANTPARENT__", False):
instance._parent = self
for ns in getattr(klass, "__NAMESPACES__", []):
self.addNamespace(ns)
self._ext_children.append(instance)
return instance
setattr(self, name, wrap)
[docs]
def addRawElement (self, elem):
self._raw_elements.append(elem)
[docs]
@classmethod
def newLinkID (cls):
Link.LNKID += 1
return "link-%d" % (Link.LNKID)
[docs]
def addChild (self, obj):
self._ext_children.append(obj)
[docs]
def addInterface (self, intf):
self.interfaces.append(intf)
[docs]
def addNode (self, node):
interface = node.addInterface()
self.interfaces.append(interface)
return interface
[docs]
def addComponentManager (self, component_manager):
self._component_managers.append(component_manager)
[docs]
def disableMACLearning (self):
self.namespaces.append(Namespaces.VTOP)
self._mac_learning = False
[docs]
def enableVlanTagging (self):
import geni.warnings as GW
import warnings
warnings.warn("Link.enableVlanTagging() is deprecated, please use the Link.vlan_tagging attribute instead.",
GW.GENILibDeprecationWarning, 2)
self.vlan_tagging = True
@property
def vlan_tagging (self):
return self._vlan_tagging
@vlan_tagging.setter
def vlan_tagging (self, val):
self.namespaces.append(Namespaces.EMULAB)
self._vlan_tagging = val
@property
def best_effort (self):
return self._best_effort
@best_effort.setter
def best_effort (self, val):
self.namespaces.append(Namespaces.EMULAB)
self._best_effort = val
@property
def link_multiplexing (self):
return self._link_multiplexing
@link_multiplexing.setter
def link_multiplexing (self, val):
self.namespaces.append(Namespaces.EMULAB)
self._link_multiplexing = val
@property
def trivial_ok (self):
return self._trivial_ok
@trivial_ok.setter
def trivial_ok (self, val):
self.namespaces.append(Namespaces.EMULAB)
self._trivial_ok = val
def _write (self, root):
# pylint: disable=too-many-branches
lnk = ET.SubElement(root, "{%s}link" % (GNS.REQUEST.name))
lnk.attrib["client_id"] = self.client_id
if self.protocol:
lnk.attrib["protocol"] = self.protocol
for intf in self.interfaces:
ir = ET.SubElement(lnk, "{%s}interface_ref" % (GNS.REQUEST.name))
ir.attrib["client_id"] = intf.client_id
if self.type != "":
lt = ET.SubElement(lnk, "{%s}link_type" % (GNS.REQUEST.name))
lt.attrib["name"] = self.type
if not self._mac_learning:
lrnelem = ET.SubElement(lnk, "{%s}link_attribute" % (Namespaces.VTOP.name))
lrnelem.attrib["key"] = "nomac_learning"
lrnelem.attrib["value"] = "yep"
# Do not want to spit out a vlan tagging statement unless explicitly
# set, since the default is no tagging and always spitting that out
# will be bad for regression testing.
if self._vlan_tagging != None:
tagging = ET.SubElement(lnk, "{%s}vlan_tagging" % (Namespaces.EMULAB.name))
if self._vlan_tagging:
tagging.attrib["enabled"] = "true"
else:
tagging.attrib["enabled"] = "false"
if self._best_effort:
tagging = ET.SubElement(lnk, "{%s}best_effort" % (Namespaces.EMULAB.name))
tagging.attrib["enabled"] = "true"
if self._link_multiplexing:
tagging = ET.SubElement(lnk, "{%s}link_multiplexing" % (Namespaces.EMULAB.name))
tagging.attrib["enabled"] = "true"
if self._trivial_ok is not None:
trivial = ET.SubElement(lnk, "{%s}trivial_ok" % (Namespaces.EMULAB.name))
if self._trivial_ok:
trivial.attrib["enabled"] = "true"
else:
trivial.attrib["enabled"] = "false"
# LAN shaping properties are handled by the LAN class below.
if self.type != "lan":
for (intfA,intfB) in itertools.permutations(self.interfaces,2):
bw = intfA.bandwidth if intfA.bandwidth else self.bandwidth
lat = intfA.latency if intfA.latency else self.latency
plr = intfA.plr if intfA.plr else self.plr
self._write_link_prop(lnk, intfB.client_id, intfA.client_id, bw, lat, plr)
for obj in self._ext_children:
obj._write(lnk)
for elem in self._raw_elements:
lnk.append(elem)
for manager in self._component_managers:
cm = ET.SubElement(lnk, "{%s}component_manager" % (GNS.REQUEST.name))
cm.attrib["name"] = manager
return lnk
def _write_link_prop(self, lnk, src, dst, bw, lat, plr):
if bw != Link.DEFAULT_BW or lat != Link.DEFAULT_LAT or \
plr != Link.DEFAULT_PLR:
prop = ET.SubElement(lnk, "{%s}property" % (GNS.REQUEST.name))
prop.attrib["source_id"] = src
prop.attrib["dest_id"] = dst
if bw != Link.DEFAULT_BW:
prop.attrib["capacity"] = str(bw)
if lat != Link.DEFAULT_LAT:
prop.attrib["latency"] = str(lat)
if plr != Link.DEFAULT_PLR:
prop.attrib["packet_loss"] = str(plr)
Request.EXTENSIONS.append(("Link", Link))
[docs]
class LAN(Link):
def __init__ (self, name = None):
super(LAN, self).__init__(name, "lan")
def _write (self, root):
lnk = super(LAN, self)._write(root)
for intf in self.interfaces:
bw = intf.bandwidth if intf.bandwidth else self.bandwidth
lat = intf.latency if intf.latency else self.latency
plr = intf.plr if intf.plr else self.plr
super(LAN, self)._write_link_prop(lnk, intf.client_id, self.client_id, bw, lat, plr)
return lnk
Request.EXTENSIONS.append(("LAN", LAN))
[docs]
class L3GRE(Link):
def __init__ (self, name = None):
super(L3GRE, self).__init__(name, "gre-tunnel")
Request.EXTENSIONS.append(("L3GRE", L3GRE))
[docs]
class L2GRE(Link):
def __init__ (self, name = None):
super(L2GRE, self).__init__(name, "egre-tunnel")
Request.EXTENSIONS.append(("L2GRE", L2GRE))
[docs]
class StitchedLink(Link):
[docs]
class UnknownComponentManagerError(Exception):
def __init__ (self, cid):
super(StitchedLink.UnknownComponentManagerError, self).__init__()
self._cid = cid
def __str__ (self):
return "Interface with client_id %s is not attached to a bound node." % (self._cid)
[docs]
class TooManyInterfacesError(Exception):
def __str__ (self):
return "Stitched Links may not be connected to more than two interfaces"
def __init__ (self, name = None):
super(StitchedLink, self).__init__(name, "")
self.bandwidth = 20000
def _write (self, root):
if len(self.interfaces) > 2:
raise StitchedLink.TooManyInterfacesError()
lnk = super(StitchedLink, self)._write(root)
for intf in self.interfaces:
if intf.node.component_manager_id is None:
raise StitchedLink.UnknownComponentManagerError(intf.client_id)
cm = ET.SubElement(lnk, "{%s}component_manager" % (GNS.REQUEST.name))
cm.attrib["name"] = intf.node.component_manager_id
return lnk
Request.EXTENSIONS.append(("StitchedLink", StitchedLink))
[docs]
class Node(Resource):
"""A basic Node class. Typically you want to instantiate one of its subclasses, such as `RawPC`, `XenVM`, or `DockerContainer`.
Args:
name (str): Your name for this node. This must be unique within a single `Request` object.
ntype (str): The physical or virtual machine type to which this node should be mapped.
component_id (Optional[str]): The `component_id` of the site physical node to which you want to bind this node.
exclusive (Optional[bool]): Request this container on an isolated host used only by your sliver. Defaults to unspecified, allowing the site processing the request rspec to assign resources as it prefers.
Attributes:
client_id (str): Your name for this node. This must be unique within a single `Request` object.
component_id (Optional[str]): The `component_id` of the site physical node to which you want to bind this node.
exclusive (Optional[bool]): Request this container on an isolated host used only by your sliver. Defaults to unspecified, allowing the site processing the request rspec to assign resources as it prefers.
disk_image (Optional[str]): The disk image that should be loaded and run on this node. Should be an image URN.
"""
EXTENSIONS = []
__WANTPARENT__ = True;
def __init__ (self, name, ntype, component_id = None, exclusive = None):
super(Node, self).__init__()
self.client_id = name
self.exclusive = exclusive
self.disk_image = None
self.type = ntype
self.hardware_type = None
self.interfaces = []
self.services = []
self.routable_control_ip = False
self.component_id = component_id
self.component_manager_id = None
self._ext_children = []
for name,ext in Node.EXTENSIONS:
self._wrapext(name,ext)
self._raw_elements = []
[docs]
class DuplicateInterfaceName(Exception):
def __str__ (self):
return "Duplicate interface names"
def _wrapext (self, name, klass):
@functools.wraps(klass.__init__)
def wrap(*args, **kw):
if getattr(klass, "__ONCEONLY__", False):
if any(map(lambda x: isinstance(x,klass),self._ext_children)):
raise DuplicateExtensionError(klass)
instance = klass(*args, **kw)
if getattr(klass, "__WANTPARENT__", False):
instance._parent = self
for ns in getattr(klass, "__NAMESPACES__", []):
self.addNamespace(ns)
self._ext_children.append(instance)
return instance
setattr(self, name, wrap)
@property
def _parent(self):
return self.parent_request
@_parent.setter
def _parent(self, request):
self.parent_request = request
pass
@property
def name (self):
return self.client_id
def _write (self, root):
# pylint: disable=too-many-branches
nd = ET.SubElement(root, "{%s}node" % (GNS.REQUEST.name))
nd.attrib["client_id"] = self.client_id
if self.exclusive is not None: # Don't write this for EG
nd.attrib["exclusive"] = str(self.exclusive).lower()
if self.component_id:
if isinstance(self.component_id, geni.urn.Base):
nd.attrib["component_id"] = str(self.component_id)
else:
nd.attrib["component_id"] = self.component_id
if self.component_manager_id:
if isinstance(self.component_manager_id, geni.urn.Base):
nd.attrib["component_manager_id"] = str(self.component_manager_id)
else:
nd.attrib["component_manager_id"] = self.component_manager_id
st = ET.SubElement(nd, "{%s}sliver_type" % (GNS.REQUEST.name))
st.attrib["name"] = self.type
if self.disk_image:
# TODO: Force disk images to be objects, and stop supporting old style strings
if isinstance(self.disk_image, (six.string_types)):
di = ET.SubElement(st, "{%s}disk_image" % (GNS.REQUEST.name))
di.attrib["name"] = self.disk_image
elif isinstance(self.disk_image, geni.urn.Base):
di = ET.SubElement(st, "{%s}disk_image" % (GNS.REQUEST.name))
di.attrib["name"] = str(self.disk_image)
else:
self.disk_image._write(st)
if self.hardware_type:
hwt = ET.SubElement(nd, "{%s}hardware_type" % (GNS.REQUEST.name))
hwt.attrib["name"] = self.hardware_type
if self.interfaces:
for intf in self.interfaces:
intf._write(nd)
if self.services:
svc = ET.SubElement(nd, "{%s}services" % (GNS.REQUEST.name))
for service in self.services:
service._write(svc)
if self.routable_control_ip:
ET.SubElement(nd, "{%s}routable_control_ip" % (Namespaces.EMULAB.name))
for obj in self._ext_children:
obj._write(nd)
for elem in self._raw_elements:
nd.append(elem)
return nd
[docs]
def addInterface (self, name = None, address = None):
existingNames = [x.name for x in self.interfaces]
if name is not None:
if name.find(":") > 0:
intfName = name
else:
intfName = "%s:%s" % (self.client_id, name)
pass
else:
for i in range(0, 100):
intfName = "%s:if%i" % (self.client_id, i)
if intfName not in existingNames:
break
if intfName in existingNames:
raise Node.DuplicateInterfaceName()
intf = Interface(intfName, self, address)
self.interfaces.append(intf)
return intf
[docs]
def addService (self, svc, atfront = False):
if atfront:
self.services.insert(0, svc)
else:
self.services.append(svc)
[docs]
def addRawElement (self, elem):
self._raw_elements.append(elem)
Request.EXTENSIONS.append(("Node", Node))
[docs]
class RawPC(Node):
def __init__ (self, name, component_id = None):
super(RawPC, self).__init__(name, NodeType.RAW, component_id = component_id, exclusive = True)
Request.EXTENSIONS.append(("RawPC", RawPC))
[docs]
class VZContainer(Node):
def __init__ (self, name, exclusive = False):
super(VZContainer, self).__init__(name, "emulab-openvz", exclusive)
[docs]
class Namespaces(object):
CLIENT = GNS.Namespace("client", "http://www.protogeni.net/resources/rspec/ext/client/1")
RS = GNS.Namespace("rs", "http://www.protogeni.net/resources/rspec/ext/emulab/1")
EMULAB = GNS.Namespace("emulab", "http://www.protogeni.net/resources/rspec/ext/emulab/1")
VTOP = GNS.Namespace("vtop", "http://www.protogeni.net/resources/rspec/ext/emulab/1", "vtop_extension.xsd")
TOUR = GNS.Namespace("tour", "http://www.protogeni.net/resources/rspec/ext/apt-tour/1")
JACKS = GNS.Namespace("jacks", "http://www.protogeni.net/resources/rspec/ext/jacks/1")
INFO = GNS.Namespace("info", "http://www.protogeni.net/resources/rspec/ext/site-info/1")
PARAMS = GNS.Namespace("parameters", "http://www.protogeni.net/resources/rspec/ext/profile-parameters/1")
DATA = GNS.Namespace("data", "http://www.protogeni.net/resources/rspec/ext/user-data/1")
DELAY = GNS.Namespace("delay", "http://www.protogeni.net/resources/rspec/ext/delay/1")
ANSIBLE = GNS.Namespace("ansible", "http://www.protogeni.net/resources/rspec/ext/ansible/1")
#### DEPRECATED #####
[docs]
class XenVM(Node):
"""
.. deprecated:: 0.4
Use :py:class:`geni.rspec.igext.XenVM` instead."""
def __init__ (self, name, component_id = None, exclusive = False):
import geni.warnings as GW
import warnings
warnings.warn("geni.rspec.pg.XenVM is deprecated, please use geni.rspec.igext.XenVM instead",
GW.GENILibDeprecationWarning)
super(XenVM, self).__init__(name, NodeType.XEN, component_id = component_id, exclusive = exclusive)
self.cores = 1
self.ram = 256
self.disk = 8
def _write (self, root):
nd = super(XenVM, self)._write(root)
st = nd.find("{%s}sliver_type" % (GNS.REQUEST.name))
xen = ET.SubElement(st, "{%s}xen" % (Namespaces.EMULAB.name))
xen.attrib["cores"] = str(self.cores)
xen.attrib["ram"] = str(self.ram)
xen.attrib["disk"] = str(self.disk)
return nd
VM = XenVM