src/nepi/core/design.py

   1 #!/usr/bin/env python
   2 # -*- coding: utf-8 -*-
   3
   4 """
   5 Experiment design API
   6 """
   7
   8 from nepi.core.attributes import AttributesMap, Attribute
   9 from nepi.core.connector import ConnectorTypeBase
  10 from nepi.core.metadata import Metadata
  11 from nepi.util import validation
  12 from nepi.util.guid import GuidGenerator
  13 from nepi.util.graphical_info import GraphicalInfo
  14 from nepi.util.parser._xml import XmlExperimentParser
  15 import sys
  16
  17 class ConnectorType(ConnectorTypeBase):
  18     def __init__(self, testbed_id, factory_id, name, help, max = -1, min = 0):
  19         super(ConnectorType, self).__init__(testbed_id, factory_id, name, max, min)
  20
  21         # help -- help text
  22         self._help = help
  23
  24         # allowed_connections -- keys in the dictionary correspond to the
  25         # connector_type_id for possible connections. The value indicates if
  26         # the connection is allowed accros different testbed instances
  27         self._allowed_connections = dict()
  28
  29     @property
  30     def help(self):
  31         return self._help
  32
  33     def add_allowed_connection(self, testbed_id, factory_id, name, can_cross):
  34         type_id = self.make_connector_type_id(testbed_id, factory_id, name)
  35         self._allowed_connections[type_id] = can_cross
  36
  37     def can_connect(self, connector_type_id, testbed_guid1, testbed_guid2):
  38         for lookup_type_id in self._type_resolution_order(connector_type_id):
  39             if lookup_type_id in self._allowed_connections:
  40                 can_cross = self._allowed_connections[lookup_type_id]
  41                 if can_cross or (testbed_guid1 == testbed_guid2):
  42                     return True
  43         else:
  44             return False
  45
  46 class Connector(object):
  47     """A Connector sepcifies the connection points in an Object"""
  48     def __init__(self, box, connector_type):
  49         super(Connector, self).__init__()
  50         self._box = box
  51         self._connector_type = connector_type
  52         self._connections = list()
  53
  54     def __str__(self):
  55         return "Connector(%s, %s)" % (self.box, self.connector_type)
  56
  57     @property
  58     def box(self):
  59         return self._box
  60
  61     @property
  62     def connector_type(self):
  63         return self._connector_type
  64
  65     @property
  66     def connections(self):
  67         return self._connections
  68
  69     def is_full(self):
  70         """Return True if the connector has the maximum number of connections
  71         """
  72         return len(self.connections) == self.connector_type.max
  73
  74     def is_complete(self):
  75         """Return True if the connector has the minimum number of connections
  76         """
  77         return len(self.connections) >= self.connector_type.min
  78
  79     def is_connected(self, connector):
  80         return connector in self._connections
  81
  82     def connect(self, connector):
  83         if not self.can_connect(connector) or not connector.can_connect(self):
  84             raise RuntimeError("Could not connect. %s to %s" % (self, connector))
  85         self._connections.append(connector)
  86         connector._connections.append(self)
  87
  88     def disconnect(self, connector):
  89         if connector not in self._connections or\
  90                 self not in connector._connections:
  91                 raise RuntimeError("Could not disconnect.")
  92         self._connections.remove(connector)
  93         connector._connections.remove(self)
  94
  95     def can_connect(self, connector):
  96         if self.is_full() or connector.is_full():
  97             return False
  98         if self.is_connected(connector):
  99             return False
 100         connector_type_id = connector.connector_type.connector_type_id
 101         testbed_guid1 = self.box.testbed_guid
 102         testbed_guid2 = connector.box.testbed_guid
 103         return self.connector_type.can_connect(connector_type_id,
 104                 testbed_guid1, testbed_guid2)
 105
 106     def destroy(self):
 107         for connector in self.connections:
 108             self.disconnect(connector)
 109         self._box = self._connectors = None
 110
 111 class Trace(AttributesMap):
 112     def __init__(self, trace_id, help, enabled = False):
 113         super(Trace, self).__init__()
 114         self._trace_id = trace_id
 115         self._help = help
 116         self._enabled = enabled
 117
 118     @property
 119     def trace_id(self):
 120         return self._trace_id
 121
 122     @property
 123     def help(self):
 124         return self._help
 125
 126     @property
 127     def enabled(self):
 128         return self._enabled
 129
 130     def enable(self):
 131         self._enabled = True
 132
 133     def disable(self):
 134         self._enabled = False
 135
 136 class Address(AttributesMap):
 137     def __init__(self):
 138         super(Address, self).__init__()
 139         self.add_attribute(name = "AutoConfigure",
 140                 help = "If set, this address will automatically be assigned",
 141                 type = Attribute.BOOL,
 142                 value = False,
 143                 flags = Attribute.DesignOnly,
 144                 validation_function = validation.is_bool)
 145         self.add_attribute(name = "Address",
 146                 help = "Address number",
 147                 type = Attribute.STRING,
 148                 flags = Attribute.HasNoDefaultValue,
 149                 validation_function = validation.is_ip_address)
 150         self.add_attribute(name = "NetPrefix",
 151                 help = "Network prefix for the address",
 152                 type = Attribute.INTEGER,
 153                 range = (0, 128),
 154                 value = 24,
 155                 flags = Attribute.HasNoDefaultValue,
 156                 validation_function = validation.is_integer)
 157         self.add_attribute(name = "Broadcast",
 158                 help = "Broadcast address",
 159                 type = Attribute.STRING,
 160                 validation_function = validation.is_ip4_address)
 161
 162 class Route(AttributesMap):
 163     def __init__(self):
 164         super(Route, self).__init__()
 165         self.add_attribute(name = "Destination",
 166                 help = "Network destintation",
 167                 type = Attribute.STRING,
 168                 validation_function = validation.is_ip_address)
 169         self.add_attribute(name = "NetPrefix",
 170                 help = "Network destination prefix",
 171                 type = Attribute.INTEGER,
 172                 range = (0, 128),
 173                 value = 24,
 174                 flags = Attribute.HasNoDefaultValue,
 175                 validation_function = validation.is_integer)
 176         self.add_attribute(name = "NextHop",
 177                 help = "Address for the next hop",
 178                 type = Attribute.STRING,
 179                 flags = Attribute.HasNoDefaultValue,
 180                 validation_function = validation.is_ip_address)
 181
 182 class Box(AttributesMap):
 183     def __init__(self, guid, factory, testbed_guid, container = None):
 184         super(Box, self).__init__()
 185         # guid -- global unique identifier
 186         self._guid = guid
 187         # factory_id -- factory identifier or name
 188         self._factory_id = factory.factory_id
 189         # testbed_guid -- parent testbed guid
 190         self._testbed_guid = testbed_guid
 191         # container -- boxes can be nested inside other 'container' boxes
 192         self._container = container
 193         # traces -- list of available traces for the box
 194         self._traces = dict()
 195         # tags -- list of tags for the box
 196         self._tags = list()
 197         # connectors -- list of available connectors for the box
 198         self._connectors = dict()
 199         # factory_attributes -- factory attributes for box construction
 200         self._factory_attributes = dict()
 201         # graphical_info -- GUI position information
 202         self.graphical_info = GraphicalInfo()
 203
 204         for connector_type in factory.connector_types:
 205             connector = Connector(self, connector_type)
 206             self._connectors[connector_type.name] = connector
 207         for trace in factory.traces:
 208             tr = Trace(trace.trace_id, trace.help, trace.enabled)
 209             self._traces[trace.trace_id] = tr
 210         for tag_id in factory.tags:
 211             self._tags.append(tag_id)
 212         for attr in factory.box_attributes.attributes:
 213             self.add_attribute(attr.name, attr.help, attr.type, attr.value,
 214                     attr.range, attr.allowed, attr.flags,
 215                     attr.validation_function, attr.category)
 216         for attr in factory.attributes:
 217             if attr.modified:
 218                 self._factory_attributes[attr.name] = attr.value
 219
 220     def __str__(self):
 221         return "Box(%s, %s, %s)" % (self.guid, self.factory_id, self.testbed_guid)
 222
 223     @property
 224     def guid(self):
 225         return self._guid
 226
 227     @property
 228     def factory_id(self):
 229         return self._factory_id
 230
 231     @property
 232     def testbed_guid(self):
 233         return self._testbed_guid
 234
 235     @property
 236     def container(self):
 237         return self._container
 238
 239     @property
 240     def connectors(self):
 241         return self._connectors.values()
 242
 243     @property
 244     def traces(self):
 245         return self._traces.values()
 246
 247     @property
 248     def trace_names(self):
 249         return self._traces.keys()
 250
 251     @property
 252     def factory_attributes(self):
 253         return self._factory_attributes
 254
 255     @property
 256     def tags(self):
 257         return self._tags
 258
 259     def trace_help(self, trace_id):
 260         return self._traces[trace_id].help
 261
 262     def enable_trace(self, trace_id):
 263         self._traces[trace_id].enable()
 264
 265     def disable_trace(self, trace_id):
 266         self._traces[trace_id].disable()
 267
 268     def is_trace_enabled(self, trace_id):
 269         return self._traces[trace_id].enabled
 270
 271     def connector(self, name):
 272         return self._connectors[name]
 273
 274     def destroy(self):
 275         super(Box, self).destroy()
 276         for c in self.connectors:
 277             c.destroy()
 278         for t in self.traces:
 279             t.destroy()
 280         self._connectors = self._traces = self._factory_attributes = None
 281
 282 class AddressableMixin(object):
 283     def __init__(self, guid, factory, testbed_guid, container = None):
 284         super(AddressableMixin, self).__init__(guid, factory, testbed_guid,
 285                 container)
 286         self._max_addresses = 1 # TODO: How to make this configurable!
 287         self._addresses = list()
 288
 289     @property
 290     def addresses(self):
 291         return self._addresses
 292
 293     @property
 294     def max_addresses(self):
 295         return self._max_addresses
 296
 297 class UserAddressableMixin(AddressableMixin):
 298     def __init__(self, guid, factory, testbed_guid, container = None):
 299         super(UserAddressableMixin, self).__init__(guid, factory, testbed_guid,
 300                 container)
 301
 302     def add_address(self):
 303         if len(self._addresses) == self.max_addresses:
 304             raise RuntimeError("Maximun number of addresses for this box reached.")
 305         address = Address()
 306         self._addresses.append(address)
 307         return address
 308
 309     def delete_address(self, address):
 310         self._addresses.remove(address)
 311         del address
 312
 313     def destroy(self):
 314         super(UserAddressableMixin, self).destroy()
 315         for address in list(self.addresses):
 316             self.delete_address(address)
 317         self._addresses = None
 318
 319 class RoutableMixin(object):
 320     def __init__(self, guid, factory, testbed_guid, container = None):
 321         super(RoutableMixin, self).__init__(guid, factory, testbed_guid,
 322             container)
 323         self._routes = list()
 324
 325     @property
 326     def routes(self):
 327         return self._routes
 328
 329 class UserRoutableMixin(RoutableMixin):
 330     def __init__(self, guid, factory, testbed_guid, container = None):
 331         super(UserRoutableMixin, self).__init__(guid, factory, testbed_guid,
 332             container)
 333
 334     def add_route(self):
 335         route = Route()
 336         self._routes.append(route)
 337         return route
 338
 339     def delete_route(self, route):
 340         self._routes.remove(route)
 341         del route
 342
 343     def destroy(self):
 344         super(UserRoutableMixin, self).destroy()
 345         for route in list(self.routes):
 346             self.delete_route(route)
 347         self._route = None
 348
 349 def MixIn(MyClass, MixIn):
 350     # Mixins are installed BEFORE "Box" because
 351     # Box inherits from non-cooperative classes,
 352     # so the MRO chain gets broken when it gets
 353     # to Box.
 354
 355     # Install mixin
 356     MyClass.__bases__ = (MixIn,) + MyClass.__bases__
 357
 358     # Add properties
 359     # Somehow it doesn't work automatically
 360     for name in dir(MixIn):
 361         prop = getattr(MixIn,name,None)
 362         if isinstance(prop, property):
 363             setattr(MyClass, name, prop)
 364
 365     # Update name
 366     MyClass.__name__ = MyClass.__name__.replace(
 367         'Box',
 368         MixIn.__name__.replace('MixIn','')+'Box',
 369         1)
 370
 371 class Factory(AttributesMap):
 372     _box_class_cache = {}
 373
 374     def __init__(self, factory_id,
 375             allow_addresses = False, has_addresses = False,
 376             allow_routes = False, has_routes = False,
 377             Help = None, category = None):
 378         super(Factory, self).__init__()
 379         self._factory_id = factory_id
 380         self._allow_addresses = bool(allow_addresses)
 381         self._allow_routes = bool(allow_routes)
 382         self._has_addresses = bool(allow_addresses) or self._allow_addresses
 383         self._has_routes = bool(allow_routes) or self._allow_routes
 384         self._help = help
 385         self._category = category
 386         self._connector_types = list()
 387         self._traces = list()
 388         self._tags = list()
 389         self._box_attributes = AttributesMap()
 390
 391         if not self._has_addresses and not self._has_routes:
 392             self._factory = Box
 393         else:
 394             addresses = 'w' if self._allow_addresses else ('r' if self._has_addresses else '-')
 395             routes    = 'w' if self._allow_routes else ('r' if self._has_routes else '-')
 396             key = addresses+routes
 397
 398             if key in self._box_class_cache:
 399                 self._factory = self._box_class_cache[key]
 400             else:
 401                 # Create base class
 402                 class _factory(Box):
 403                     def __init__(self, guid, factory, testbed_guid, container = None):
 404                         super(_factory, self).__init__(guid, factory, testbed_guid, container)
 405
 406                 # Add mixins, one by one
 407                 if allow_addresses:
 408                     MixIn(_factory, UserAddressableMixin)
 409                 elif has_addresses:
 410                     MixIn(_factory, AddressableMixin)
 411
 412                 if allow_routes:
 413                     MixIn(_factory, UserRoutableMixin)
 414                 elif has_routes:
 415                     MixIn(_factory, RoutableMixin)
 416
 417                 # Put into cache
 418                 self._box_class_cache[key] = self._factory = _factory
 419
 420     @property
 421     def factory_id(self):
 422         return self._factory_id
 423
 424     @property
 425     def allow_addresses(self):
 426         return self._allow_addresses
 427
 428     @property
 429     def allow_routes(self):
 430         return self._allow_routes
 431
 432     @property
 433     def has_addresses(self):
 434         return self._has_addresses
 435
 436     @property
 437     def has_routes(self):
 438         return self._has_routes
 439
 440     @property
 441     def help(self):
 442         return self._help
 443
 444     @property
 445     def category(self):
 446         return self._category
 447
 448     @property
 449     def connector_types(self):
 450         return self._connector_types
 451
 452     @property
 453     def traces(self):
 454         return self._traces
 455
 456     @property
 457     def tags(self):
 458         return self._tags
 459
 460     @property
 461     def box_attributes(self):
 462         return self._box_attributes
 463
 464     def add_connector_type(self, connector_type):
 465         self._connector_types.append(connector_type)
 466
 467     def add_trace(self, trace_id, help, enabled = False):
 468         trace = Trace(trace_id, help, enabled)
 469         self._traces.append(trace)
 470
 471     def add_tag(self, tag_id):
 472         self._tags.append(tag_id)
 473
 474     def add_box_attribute(self, name, help, type, value = None, range = None,
 475         allowed = None, flags = Attribute.NoFlags, validation_function = None,
 476         category = None):
 477         self._box_attributes.add_attribute(name, help, type, value, range,
 478                 allowed, flags, validation_function, category)
 479
 480     def create(self, guid, testbed_description):
 481         return self._factory(guid, self, testbed_description.guid)
 482
 483     def destroy(self):
 484         super(Factory, self).destroy()
 485         self._connector_types = None
 486
 487 class FactoriesProvider(object):
 488     def __init__(self, testbed_id, testbed_version):
 489         super(FactoriesProvider, self).__init__()
 490         self._testbed_id = testbed_id
 491         self._testbed_version = testbed_version
 492         self._factories = dict()
 493
 494         metadata = Metadata(testbed_id, testbed_version)
 495         for factory in metadata.build_design_factories():
 496             self.add_factory(factory)
 497
 498     @property
 499     def testbed_id(self):
 500         return self._testbed_id
 501
 502     @property
 503     def testbed_version(self):
 504         return self._testbed_version
 505
 506     @property
 507     def factories(self):
 508         return self._factories.values()
 509
 510     def factory(self, factory_id):
 511         return self._factories[factory_id]
 512
 513     def add_factory(self, factory):
 514         self._factories[factory.factory_id] = factory
 515
 516     def remove_factory(self, factory_id):
 517         del self._factories[factory_id]
 518
 519 class TestbedDescription(AttributesMap):
 520     def __init__(self, guid_generator, provider, guid = None):
 521         super(TestbedDescription, self).__init__()
 522         self._guid_generator = guid_generator
 523         self._guid = guid_generator.next(guid)
 524         self._provider = provider
 525         self._boxes = dict()
 526         self.graphical_info = GraphicalInfo()
 527
 528         metadata = Metadata(provider.testbed_id, provider.testbed_version)
 529         for attr in metadata.testbed_attributes().attributes:
 530             self.add_attribute(attr.name, attr.help, attr.type, attr.value,
 531                     attr.range, attr.allowed, attr.flags,
 532                     attr.validation_function, attr.category)
 533
 534     @property
 535     def guid(self):
 536         return self._guid
 537
 538     @property
 539     def provider(self):
 540         return self._provider
 541
 542     @property
 543     def boxes(self):
 544         return self._boxes.values()
 545
 546     def box(self, guid):
 547         return self._boxes[guid] if guid in self._boxes else None
 548
 549     def create(self, factory_id, guid = None):
 550         guid = self._guid_generator.next(guid)
 551         factory = self._provider.factory(factory_id)
 552         box = factory.create(guid, self)
 553         self._boxes[guid] = box
 554         return box
 555
 556     def delete(self, guid):
 557         box = self._boxes[guid]
 558         del self._boxes[guid]
 559         box.destroy()
 560
 561     def destroy(self):
 562         for guid, box in self._boxes.iteritems():
 563             box.destroy()
 564         self._boxes = None
 565
 566 class ExperimentDescription(object):
 567     def __init__(self):
 568         self._guid_generator = GuidGenerator()
 569         self._testbed_descriptions = dict()
 570
 571     @property
 572     def testbed_descriptions(self):
 573         return self._testbed_descriptions.values()
 574
 575     def to_xml(self):
 576         parser = XmlExperimentParser()
 577         return parser.to_xml(self)
 578
 579     def from_xml(self, xml):
 580         parser = XmlExperimentParser()
 581         parser.from_xml(self, xml)
 582
 583     def testbed_description(self, guid):
 584         return self._testbed_descriptions[guid] \
 585                 if guid in self._testbed_descriptions else None
 586
 587     def box(self, guid):
 588         for testbed_description in self._testbed_descriptions.values():
 589             box = testbed_description.box(guid)
 590             if box: return box
 591         return None
 592
 593     def get_element(self, guid):
 594         if guid in self._testbed_descriptions:
 595             return self._testbed_descriptions[guid]
 596         for testbed_description in self._testbed_descriptions.values():
 597             box = testbed_description.box(guid)
 598             if box: return box
 599         return None
 600
 601     def add_testbed_description(self, provider, guid = None):
 602         testbed_description = TestbedDescription(self._guid_generator,
 603                 provider, guid)
 604         guid = testbed_description.guid
 605         self._testbed_descriptions[guid] = testbed_description
 606         return testbed_description
 607
 608     def remove_testbed_description(self, guid):
 609         testbed_description = self._testbed_descriptions[guid]
 610         del self._testbed_descriptions[guid]
 611         testbed_description.destroy()
 612
 613     def destroy(self):
 614         for testbed_description in self.testbed_descriptions:
 615             testbed_description.destroy()
 616
 617