python3 - 2to3 + miscell obvious tweaks
[sfa.git] / sfa / rspecs / elements / versions / iotlabv1Node.py
index 50f8e48..e64368a 100644 (file)
@@ -1,7 +1,7 @@
 
 from sfa.util.xrn import Xrn
 from sfa.util.xml import XpathFilter
-from sfa.rspecs.elements.node import Node
+from sfa.rspecs.elements.node import NodeElement
 from sfa.rspecs.elements.sliver import Sliver
 from sfa.rspecs.elements.location import Location
 from sfa.rspecs.elements.hardware_type import HardwareType
@@ -10,21 +10,27 @@ from sfa.rspecs.elements.interface import Interface
 from sfa.rspecs.elements.versions.iotlabv1Sliver import Iotlabv1Sliver
 from sfa.util.sfalogging import logger
 
-class IotlabNode(Node):
-    #First get the fields already defined in the class Node
-    fields = list(Node.fields)
-    #Extend it with iotlab's specific fields
-    fields.extend (['archi', 'radio', 'mobile','position'])
+
+class IotlabNode(NodeElement):
+    # First get the fields already defined in the class Node
+    fields = list(NodeElement.fields)
+    # Extend it with iotlab's specific fields
+    fields.extend(['archi', 'radio', 'mobile', 'position'])
 
 
 class IotlabPosition(Element):
-    fields = ['posx', 'posy','posz']
+    fields = ['x', 'y', 'z']
+
 
 class IotlabLocation(Location):
     fields = list(Location.fields)
-    fields.extend (['site'])
+    fields.extend(['site'])
 
 
+class IotlabMobility(Element):
+    """ Class to give information of a node's mobility, and what kind of
+    mobility it is (train, roomba robot ...) """
+    fields = ['mobile', 'mobility_type']
 
 
 class Iotlabv1Node:
@@ -36,130 +42,150 @@ class Iotlabv1Node:
         should be used after add_nodes, which creates the network item.
 
         """
-        logger.debug(" add_connection_information " )
-        #Get network item in the xml
+        logger.debug(" add_connection_information ")
+        # Get network item in the xml
         network_elems = xml.xpath('//network')
         if len(network_elems) > 0:
             network_elem = network_elems[0]
 
-        iotlab_network_dict = {}
-        iotlab_network_dict['login'] = ldap_username
-
-        iotlab_network_dict['ssh'] = \
-            ['ssh ' + ldap_username + '@'+site+'.iotlab.info' \
-            for site in sites_set]
-        network_elem.set('ssh', \
-                unicode(iotlab_network_dict['ssh']))
-        network_elem.set('login', unicode( iotlab_network_dict['login']))
+            iotlab_network_dict = {}
+            iotlab_network_dict['login'] = ldap_username
 
+            iotlab_network_dict['ssh'] = \
+                ['ssh ' + ldap_username + '@' + site + '.iotlab.info'
+                 for site in sites_set]
+            network_elem.set('ssh',
+                             str(iotlab_network_dict['ssh']))
+            network_elem.set('login', str(iotlab_network_dict['login']))
 
     @staticmethod
-    def add_nodes(xml, nodes):
-        #Add network item in the xml
+    def add_nodes(xml, nodes, rspec_content_type=None):
+        """Adds the nodes to the xml.
+
+        Adds the nodes as well as dedicated iotlab fields to the node xml
+        element.
+
+        :param xml: the xml being constructed.
+        :type xml: xml
+        :param nodes: list of node dict
+        :type nodes: list
+        :returns: a list of node elements.
+        :rtype: list
+
+        """
+        # Add network item in the xml
         network_elems = xml.xpath('//network')
         if len(network_elems) > 0:
             network_elem = network_elems[0]
         elif len(nodes) > 0 and nodes[0].get('component_manager_id'):
             network_urn = nodes[0]['component_manager_id']
-            network_elem = xml.add_element('network', \
-                                        name = Xrn(network_urn).get_hrn())
+            network_elem = xml.add_element('network',
+                                           name=Xrn(network_urn).get_hrn())
         else:
             network_elem = xml
 
-        logger.debug("iotlabv1Node \t add_nodes  nodes %s \r\n "%(nodes[0]))
         node_elems = []
-        #Then add nodes items to the network item in the xml
+        # Then add nodes items to the network item in the xml
         for node in nodes:
-            #Attach this node to the network element
-            node_fields = ['component_manager_id', 'component_id', 'exclusive',\
-                                                    'boot_state', 'mobile']
+            # Attach this node to the network element
+            node_fields = ['component_manager_id', 'component_id', 'exclusive',
+                           'boot_state', 'mobile']
             node_elem = network_elem.add_instance('node', node, node_fields)
             node_elems.append(node_elem)
 
-            #Set the attibutes of this node element
+            # Set the attibutes of this node element
             for attribute in node:
-            # set component name
-                if attribute is 'component_id':
+                # set component name
+                if attribute is 'component_name':
                     component_name = node['component_name']
                     node_elem.set('component_name', component_name)
 
             # set hardware types, extend fields to add Iotlab's architecture
-            #and radio type
+            # and radio type
 
                 if attribute is 'hardware_types':
                     for hardware_type in node.get('hardware_types', []):
                         fields = HardwareType.fields
-                        fields.extend(['archi','radio'])
+                        fields.extend(['archi', 'radio'])
                         node_elem.add_instance('hardware_types', node, fields)
 
+            # set mobility
+                if attribute is 'mobility':
+                    node_elem.add_instance('mobility', node['mobility'],
+                                           IotlabMobility.fields)
             # set location
                 if attribute is 'location':
-                    node_elem.add_instance('location', node['location'], \
-                                                        IotlabLocation.fields)
+                    node_elem.add_instance('location', node['location'],
+                                           IotlabLocation.fields)
+
              # add granularity of the reservation system
-             #TODO put the granularity in network instead SA 18/07/12
-                if attribute is 'granularity' :
+             # TODO put the granularity in network instead SA 18/07/12
+                if attribute is 'granularity':
                     granularity = node['granularity']
                     if granularity:
-                        node_elem.add_instance('granularity', \
-                                    granularity, granularity.fields)
-
+                        node_elem.add_instance('granularity',
+                                               granularity, granularity.fields)
 
             # set available element
                 if attribute is 'boot_state':
                     if node.get('boot_state').lower() == 'alive':
-                        available_elem = node_elem.add_element('available', \
-                                                                    now='true')
+                        available_elem = node_elem.add_element('available',
+                                                               now='true')
                     else:
-                        available_elem = node_elem.add_element('available', \
-                                                                now='false')
+                        available_elem = node_elem.add_element('available',
+                                                               now='false')
 
-            #set position
+            # set position
                 if attribute is 'position':
-                    node_elem.add_instance('position', node['position'], \
-                                                        IotlabPosition.fields)
-            ## add services
+                    node_elem.add_instance('position', node['position'],
+                                           IotlabPosition.fields)
+            # add services
             #PGv2Services.add_services(node_elem, node.get('services', []))
             # add slivers
                 if attribute is 'slivers':
                     slivers = node.get('slivers', [])
                     if not slivers:
-                    # we must still advertise the available sliver types
+                        # we must still advertise the available sliver types
                         slivers = Sliver({'type': 'iotlab-node'})
                     # we must also advertise the available initscripts
                     #slivers['tags'] = []
-                    #if node.get('pl_initscripts'):
-                        #for initscript in node.get('pl_initscripts', []):
-                            #slivers['tags'].append({'name': 'initscript', \
-                                                    #'value': initscript['name']})
+                    # if node.get('pl_initscripts'):
+                        # for initscript in node.get('pl_initscripts', []):
+                        slivers['tags'].append({'name': 'initscript', \
+                        #'value': initscript['name']})
 
                     Iotlabv1Sliver.add_slivers(node_elem, slivers)
+                # add sliver tag in Request Rspec
+            if rspec_content_type == "request":
+                node_elem.add_instance('sliver', '', [])
         return node_elems
 
-
-
     @staticmethod
-    def get_nodes(xml, filter={}):
-        xpath = '//node%s | //default:node%s' % (XpathFilter.xpath(filter), \
-                                                    XpathFilter.xpath(filter))
+    def get_nodes(xml, filter=None):
+        if filter is None:
+            filter = {}
+        xpath = '//node%s | //default:node%s' % (XpathFilter.xpath(filter),
+                                                 XpathFilter.xpath(filter))
         node_elems = xml.xpath(xpath)
         return Iotlabv1Node.get_node_objs(node_elems)
 
     @staticmethod
-    def get_nodes_with_slivers(xml, sliver_filter={}):
+    def get_nodes_with_slivers(xml, sliver_filter=None):
+        if sliver_filter is None:
+            sliver_filter = {}
 
         xpath = '//node[count(sliver)>0] | \
                                 //default:node[count(default:sliver) > 0]'
         node_elems = xml.xpath(xpath)
         logger.debug("SLABV1NODE \tget_nodes_with_slivers  \
-                                node_elems %s"%(node_elems))
+                                node_elems %s" % (node_elems))
         return Iotlabv1Node.get_node_objs(node_elems)
 
     @staticmethod
     def get_node_objs(node_elems):
         nodes = []
         for node_elem in node_elems:
-            node = Node(node_elem.attrib, node_elem)
+            node = NodeElement(node_elem.attrib, node_elem)
             nodes.append(node)
             if 'component_id' in node_elem.attrib:
                 node['authority_id'] = \
@@ -168,21 +194,26 @@ class Iotlabv1Node:
             # get hardware types
             hardware_type_elems = node_elem.xpath('./default:hardware_type | \
                                                             ./hardware_type')
-            node['hardware_types'] = [hw_type.get_instance(HardwareType) \
-                                            for hw_type in hardware_type_elems]
+            node['hardware_types'] = [hw_type.get_instance(HardwareType)
+                                      for hw_type in hardware_type_elems]
 
             # get location
             location_elems = node_elem.xpath('./default:location | ./location')
-            locations = [location_elem.get_instance(Location) \
-                                            for location_elem in location_elems]
+            locations = [location_elem.get_instance(Location)
+                         for location_elem in location_elems]
             if len(locations) > 0:
                 node['location'] = locations[0]
 
-
             # get interfaces
             iface_elems = node_elem.xpath('./default:interface | ./interface')
-            node['interfaces'] = [iface_elem.get_instance(Interface) \
-                                            for iface_elem in iface_elems]
+            node['interfaces'] = [iface_elem.get_instance(Interface)
+                                  for iface_elem in iface_elems]
+
+            # get position
+            position_elems = node_elem.xpath('./default:position | ./position')
+            if position_elems:
+                position_elem = position_elems[0]
+                node['position'] = position_elem.get_instance(IotlabPosition)
 
             # get services
             #node['services'] = PGv2Services.get_services(node_elem)
@@ -198,10 +229,9 @@ class Iotlabv1Node:
                     node['boot_state'] = 'disabled'
 
         logger.debug("SLABV1NODE \tget_nodes_objs  \
-                                #nodes %s"%(nodes))
+                                #nodes %s" % (nodes))
         return nodes
 
-
     @staticmethod
     def add_slivers(xml, slivers):
         logger.debug("Iotlabv1NODE \tadd_slivers ")
@@ -224,12 +254,9 @@ class Iotlabv1Node:
     @staticmethod
     def remove_slivers(xml, hostnames):
         for hostname in hostnames:
-            nodes = Iotlabv1Node.get_nodes(xml, \
-                                    {'component_id': '*%s*' % hostname})
+            nodes = Iotlabv1Node.get_nodes(xml,
+                                           {'component_id': '*%s*' % hostname})
             for node in nodes:
                 slivers = Iotlabv1Sliver.get_slivers(node.element)
                 for sliver in slivers:
                     node.element.remove(sliver.element)
-
-
-