2 # -*- coding: utf-8 -*-
4 from nepi.core.attributes import Attribute, AttributesMap
7 from nepi.util import validation
8 from nepi.util.constants import ATTR_NEPI_TESTBED_ENVIRONMENT_SETUP, DeploymentConfiguration
10 class VersionedMetadataInfo(object):
12 def connector_types(self):
13 """ dictionary of dictionaries with allowed connection information.
16 "name": connector type name,
17 "max": maximum number of connections allowed (-1 for no limit),
18 "min": minimum number of connections allowed
21 raise NotImplementedError
24 def connections(self):
25 """ array of dictionaries with allowed connection information.
27 "from": (testbed_id1, factory_id1, connector_type_name1),
28 "to": (testbed_id2, factory_id2, connector_type_name2),
29 "init_code": connection function to invoke for connection initiation
30 "compl_code": connection function to invoke for connection
32 "can_cross": whether the connection can be done across testbed
36 raise NotImplementedError
40 """ dictionary of dictionaries of all available attributes.
42 "name": attribute name,
44 "type": attribute type,
45 "value": default attribute value,
46 "range": (maximum, minimun) values else None if not defined,
47 "allowed": array of posible values,
48 "flags": attributes flags,
49 "validation_function": validation function for the attribute
52 raise NotImplementedError
56 """ dictionary of dictionaries of all available traces.
62 raise NotImplementedError
65 def create_order(self):
66 """ list of factory ids that indicates the order in which the elements
67 should be instantiated.
69 raise NotImplementedError
72 def configure_order(self):
73 """ list of factory ids that indicates the order in which the elements
76 raise NotImplementedError
79 def preconfigure_order(self):
80 """ list of factory ids that indicates the order in which the elements
81 should be preconfigured.
83 Default: same as configure_order
85 return self.configure_order
88 def factories_info(self):
89 """ dictionary of dictionaries of factory specific information
91 "allow_addresses": whether the box allows adding IP addresses,
92 "allow_routes": wether the box allows adding routes,
93 "has_addresses": whether the box allows obtaining IP addresses,
94 "has_routes": wether the box allows obtaining routes,
96 "category": category the element belongs to,
97 "create_function": function for element instantiation,
98 "start_function": function for element starting,
99 "stop_function": function for element stoping,
100 "status_function": function for retrieving element status,
101 "preconfigure_function": function for element preconfiguration,
102 (just after connections are made,
103 just before netrefs are resolved)
104 "configure_function": function for element configuration,
105 "factory_attributes": list of references to attribute_ids,
106 "box_attributes": list of regerences to attribute_ids,
107 "traces": list of references to trace_id
108 "connector_types": list of references to connector_types
111 raise NotImplementedError
114 def testbed_attributes(self):
115 """ dictionary of attributes for testbed instance configuration
116 attributes_id = dict({
117 "name": attribute name,
119 "type": attribute type,
120 "value": default attribute value,
121 "range": (maximum, minimun) values else None if not defined,
122 "allowed": array of posible values,
123 "flags": attributes flags,
124 "validation_function": validation function for the attribute
128 raise NotImplementedError
130 class Metadata(object):
131 STANDARD_BOX_ATTRIBUTES = (
134 validation_function = validation.is_string,
135 type = Attribute.STRING,
136 flags = Attribute.DesignOnly,
137 help = "A unique identifier for referring to this box",
141 # Shorthand for DeploymentConfiguration
142 # Syntactic sugar to shorten stuff
143 DC = DeploymentConfiguration
145 STANDARD_TESTBED_ATTRIBUTES = (
146 ("home_directory", dict(
147 name = "homeDirectory",
148 validation_function = validation.is_string,
149 help = "Path to the directory where traces and other files will be stored",
150 type = Attribute.STRING,
152 flags = Attribute.DesignOnly,
156 DEPLOYMENT_ATTRIBUTES = (
157 # TESTBED DEPLOYMENT ATTRIBUTES
158 (DC.DEPLOYMENT_ENVIRONMENT_SETUP, dict(
159 name = DC.DEPLOYMENT_ENVIRONMENT_SETUP,
160 validation_function = validation.is_string,
161 help = "Shell commands to run before spawning TestbedController processes",
162 type = Attribute.STRING,
163 flags = Attribute.DesignOnly,
165 (DC.DEPLOYMENT_MODE, dict(name = DC.DEPLOYMENT_MODE,
166 help = "Instance execution mode",
167 type = Attribute.ENUM,
168 value = DC.MODE_SINGLE_PROCESS,
171 DC.MODE_SINGLE_PROCESS
173 flags = Attribute.DesignOnly,
174 validation_function = validation.is_enum
176 (DC.DEPLOYMENT_COMMUNICATION, dict(name = DC.DEPLOYMENT_COMMUNICATION,
177 help = "Instance communication mode",
178 type = Attribute.ENUM,
179 value = DC.ACCESS_LOCAL,
184 flags = Attribute.DesignOnly,
185 validation_function = validation.is_enum
187 (DC.DEPLOYMENT_HOST, dict(name = DC.DEPLOYMENT_HOST,
188 help = "Host where the testbed will be executed",
189 type = Attribute.STRING,
191 flags = Attribute.DesignOnly,
192 validation_function = validation.is_string
194 (DC.DEPLOYMENT_USER, dict(name = DC.DEPLOYMENT_USER,
195 help = "User on the Host to execute the testbed",
196 type = Attribute.STRING,
197 value = getpass.getuser(),
198 flags = Attribute.DesignOnly,
199 validation_function = validation.is_string
201 (DC.DEPLOYMENT_PORT, dict(name = DC.DEPLOYMENT_PORT,
202 help = "Port on the Host",
203 type = Attribute.INTEGER,
205 flags = Attribute.DesignOnly,
206 validation_function = validation.is_integer
208 (DC.ROOT_DIRECTORY, dict(name = DC.ROOT_DIRECTORY,
209 help = "Root directory for storing process files",
210 type = Attribute.STRING,
212 flags = Attribute.DesignOnly,
213 validation_function = validation.is_string # TODO: validation.is_path
215 (DC.USE_AGENT, dict(name = DC.USE_AGENT,
216 help = "Use -A option for forwarding of the authentication agent, if ssh access is used",
217 type = Attribute.BOOL,
219 flags = Attribute.DesignOnly,
220 validation_function = validation.is_bool
222 (DC.LOG_LEVEL, dict(name = DC.LOG_LEVEL,
223 help = "Log level for instance",
224 type = Attribute.ENUM,
225 value = DC.ERROR_LEVEL,
230 flags = Attribute.DesignOnly,
231 validation_function = validation.is_enum
233 (DC.RECOVER, dict(name = DC.RECOVER,
234 help = "Do not intantiate testbeds, rather, reconnect to already-running instances. Used to recover from a dead controller.",
235 type = Attribute.BOOL,
237 flags = Attribute.DesignOnly,
238 validation_function = validation.is_bool
242 STANDARD_TESTBED_ATTRIBUTES += DEPLOYMENT_ATTRIBUTES
247 def __init__(self, testbed_id, version):
248 self._version = version
249 self._testbed_id = testbed_id
250 metadata_module = self._load_versioned_metadata_module()
251 self._metadata = metadata_module.VersionedMetadataInfo()
254 def create_order(self):
255 return self._metadata.create_order
258 def configure_order(self):
259 return self._metadata.configure_order
262 def preconfigure_order(self):
263 return self._metadata.preconfigure_order
265 def testbed_attributes(self):
266 attributes = AttributesMap()
268 # standard attributes
269 self._add_standard_attributes(attributes, None, True, False,
270 self.STANDARD_TESTBED_ATTRIBUTES)
272 # custom attributes - they override standard ones
273 for attr_info in self._metadata.testbed_attributes.values():
274 name = attr_info["name"]
275 help = attr_info["help"]
276 type = attr_info["type"]
277 value = attr_info["value"] if "value" in attr_info else None
278 range = attr_info["range"] if "range" in attr_info else None
279 allowed = attr_info["allowed"] if "allowed" in attr_info else None
280 flags = attr_info["flags"] if "flags" in attr_info \
281 else Attribute.NoFlags
282 validation_function = attr_info["validation_function"]
283 attributes.add_attribute(name, help, type, value,
284 range, allowed, flags, validation_function)
288 def build_design_factories(self):
289 from nepi.core.design import Factory
291 for factory_id, info in self._metadata.factories_info.iteritems():
293 category = info["category"]
294 allow_addresses = info.get("allow_addresses", False)
295 allow_routes = info.get("allow_routes", False)
296 has_addresses = info.get("has_addresses", False)
297 has_routes = info.get("has_routes", False)
298 factory = Factory(factory_id,
299 allow_addresses, has_addresses,
300 allow_routes, has_routes,
303 # standard attributes
304 self._add_standard_attributes(factory, info, True, True,
305 self.STANDARD_BOX_ATTRIBUTES)
307 # custom attributes - they override standard ones
308 self._add_attributes(factory, info, "factory_attributes")
309 self._add_attributes(factory, info, "box_attributes", True)
311 self._add_design_traces(factory, info)
312 self._add_design_connector_types(factory, info)
313 factories.append(factory)
316 def build_execute_factories(self):
317 from nepi.core.execute import Factory
319 for factory_id, info in self._metadata.factories_info.iteritems():
320 create_function = info.get("create_function")
321 start_function = info.get("start_function")
322 stop_function = info.get("stop_function")
323 status_function = info.get("status_function")
324 configure_function = info.get("configure_function")
325 preconfigure_function = info.get("preconfigure_function")
326 allow_addresses = info.get("allow_addresses", False)
327 allow_routes = info.get("allow_routes", False)
328 has_addresses = info.get("has_addresses", False)
329 has_routes = info.get("has_routes", False)
330 factory = Factory(factory_id, create_function, start_function,
331 stop_function, status_function,
332 configure_function, preconfigure_function,
333 allow_addresses, has_addresses,
334 allow_routes, has_routes)
336 # standard attributes
337 self._add_standard_attributes(factory, info, False, True,
338 self.STANDARD_BOX_ATTRIBUTES)
340 # custom attributes - they override standard ones
341 self._add_attributes(factory, info, "factory_attributes")
342 self._add_attributes(factory, info, "box_attributes", True)
344 self._add_execute_traces(factory, info)
345 self._add_execute_connector_types(factory, info)
346 factories.append(factory)
349 def _load_versioned_metadata_module(self):
350 mod_name = "nepi.testbeds.%s.metadata_v%s" % (self._testbed_id.lower(),
352 if not mod_name in sys.modules:
354 return sys.modules[mod_name]
356 def _add_standard_attributes(self, factory, info, design, box, STANDARD_ATTRIBUTES):
358 attr_bundle = STANDARD_ATTRIBUTES
360 # Only add non-DesignOnly attributes
361 def nonDesign(attr_info):
362 return not (attr_info[1].get('flags',Attribute.NoFlags) & Attribute.DesignOnly)
363 attr_bundle = filter(nonDesign, STANDARD_ATTRIBUTES)
364 self._add_attributes(factory, info, None, box,
365 attr_bundle = STANDARD_ATTRIBUTES)
367 def _add_attributes(self, factory, info, attr_key, box_attributes = False, attr_bundle = ()):
368 if not attr_bundle and info and attr_key in info:
369 attr_bundle = [ (attr_id, self._metadata.attributes[attr_id])
370 for attr_id in info[attr_key] ]
371 for attr_id, attr_info in attr_bundle:
372 name = attr_info["name"]
373 help = attr_info["help"]
374 type = attr_info["type"]
375 value = attr_info["value"] if "value" in attr_info else None
376 range = attr_info["range"] if "range" in attr_info else None
377 allowed = attr_info["allowed"] if "allowed" in attr_info \
379 flags = attr_info["flags"] if "flags" in attr_info \
380 and attr_info["flags"] != None \
381 else Attribute.NoFlags
382 validation_function = attr_info["validation_function"]
384 factory.add_box_attribute(name, help, type, value, range,
385 allowed, flags, validation_function)
387 factory.add_attribute(name, help, type, value, range,
388 allowed, flags, validation_function)
390 def _add_design_traces(self, factory, info):
392 for trace in info["traces"]:
393 trace_info = self._metadata.traces[trace]
394 trace_id = trace_info["name"]
395 help = trace_info["help"]
396 factory.add_trace(trace_id, help)
398 def _add_execute_traces(self, factory, info):
400 for trace in info["traces"]:
401 trace_info = self._metadata.traces[trace]
402 trace_id = trace_info["name"]
403 factory.add_trace(trace_id)
405 def _add_design_connector_types(self, factory, info):
406 from nepi.core.design import ConnectorType
407 if "connector_types" in info:
409 for connection in self._metadata.connections:
410 from_ = connection["from"]
411 to = connection["to"]
412 can_cross = connection["can_cross"]
413 if from_ not in connections:
414 connections[from_] = list()
415 if to not in connections:
416 connections[to] = list()
417 connections[from_].append((to, can_cross))
418 connections[to].append((from_, can_cross))
419 for connector_id in info["connector_types"]:
420 connector_type_info = self._metadata.connector_types[
422 name = connector_type_info["name"]
423 help = connector_type_info["help"]
424 max = connector_type_info["max"]
425 min = connector_type_info["min"]
426 testbed_id = self._testbed_id
427 factory_id = factory.factory_id
428 connector_type = ConnectorType(testbed_id, factory_id, name,
430 for (to, can_cross) in connections[(testbed_id, factory_id,
432 (testbed_id_to, factory_id_to, name_to) = to
433 connector_type.add_allowed_connection(testbed_id_to,
434 factory_id_to, name_to, can_cross)
435 factory.add_connector_type(connector_type)
437 def _add_execute_connector_types(self, factory, info):
438 from nepi.core.execute import ConnectorType
439 if "connector_types" in info:
440 from_connections = dict()
441 to_connections = dict()
442 for connection in self._metadata.connections:
443 from_ = connection["from"]
444 to = connection["to"]
445 can_cross = connection["can_cross"]
446 init_code = connection["init_code"] \
447 if "init_code" in connection else None
448 compl_code = connection["compl_code"] \
449 if "compl_code" in connection else None
450 if from_ not in from_connections:
451 from_connections[from_] = list()
452 if to not in to_connections:
453 to_connections[to] = list()
454 from_connections[from_].append((to, can_cross, init_code,
456 to_connections[to].append((from_, can_cross, init_code,
458 for connector_id in info["connector_types"]:
459 connector_type_info = self._metadata.connector_types[
461 name = connector_type_info["name"]
462 max = connector_type_info["max"]
463 min = connector_type_info["min"]
464 testbed_id = self._testbed_id
465 factory_id = factory.factory_id
466 connector_type = ConnectorType(testbed_id, factory_id, name,
468 connector_key = (testbed_id, factory_id, name)
469 if connector_key in to_connections:
470 for (from_, can_cross, init_code, compl_code) in \
471 to_connections[connector_key]:
472 (testbed_id_from, factory_id_from, name_from) = from_
473 connector_type.add_from_connection(testbed_id_from,
474 factory_id_from, name_from, can_cross,
475 init_code, compl_code)
476 if connector_key in from_connections:
477 for (to, can_cross, init_code, compl_code) in \
478 from_connections[(testbed_id, factory_id, name)]:
479 (testbed_id_to, factory_id_to, name_to) = to
480 connector_type.add_to_connection(testbed_id_to,
481 factory_id_to, name_to, can_cross, init_code,
483 factory.add_connector_type(connector_type)