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_KEY, dict(name = DC.DEPLOYMENT_KEY,
202 help = "Path to SSH key to use for connecting",
203 type = Attribute.STRING,
204 flags = Attribute.DesignOnly,
205 validation_function = validation.is_string
207 (DC.DEPLOYMENT_PORT, dict(name = DC.DEPLOYMENT_PORT,
208 help = "Port on the Host",
209 type = Attribute.INTEGER,
211 flags = Attribute.DesignOnly,
212 validation_function = validation.is_integer
214 (DC.ROOT_DIRECTORY, dict(name = DC.ROOT_DIRECTORY,
215 help = "Root directory for storing process files",
216 type = Attribute.STRING,
218 flags = Attribute.DesignOnly,
219 validation_function = validation.is_string # TODO: validation.is_path
221 (DC.USE_AGENT, dict(name = DC.USE_AGENT,
222 help = "Use -A option for forwarding of the authentication agent, if ssh access is used",
223 type = Attribute.BOOL,
225 flags = Attribute.DesignOnly,
226 validation_function = validation.is_bool
228 (DC.LOG_LEVEL, dict(name = DC.LOG_LEVEL,
229 help = "Log level for instance",
230 type = Attribute.ENUM,
231 value = DC.ERROR_LEVEL,
236 flags = Attribute.DesignOnly,
237 validation_function = validation.is_enum
239 (DC.RECOVER, dict(name = DC.RECOVER,
240 help = "Do not intantiate testbeds, rather, reconnect to already-running instances. Used to recover from a dead controller.",
241 type = Attribute.BOOL,
243 flags = Attribute.DesignOnly,
244 validation_function = validation.is_bool
248 STANDARD_TESTBED_ATTRIBUTES += DEPLOYMENT_ATTRIBUTES
253 def __init__(self, testbed_id, version):
254 self._version = version
255 self._testbed_id = testbed_id
256 metadata_module = self._load_versioned_metadata_module()
257 self._metadata = metadata_module.VersionedMetadataInfo()
260 def create_order(self):
261 return self._metadata.create_order
264 def configure_order(self):
265 return self._metadata.configure_order
268 def preconfigure_order(self):
269 return self._metadata.preconfigure_order
271 def testbed_attributes(self):
272 attributes = AttributesMap()
274 # standard attributes
275 self._add_standard_attributes(attributes, None, True, False,
276 self.STANDARD_TESTBED_ATTRIBUTES)
278 # custom attributes - they override standard ones
279 for attr_info in self._metadata.testbed_attributes.values():
280 name = attr_info["name"]
281 help = attr_info["help"]
282 type = attr_info["type"]
283 value = attr_info["value"] if "value" in attr_info else None
284 range = attr_info["range"] if "range" in attr_info else None
285 allowed = attr_info["allowed"] if "allowed" in attr_info else None
286 flags = attr_info["flags"] if "flags" in attr_info \
287 else Attribute.NoFlags
288 validation_function = attr_info["validation_function"]
289 attributes.add_attribute(name, help, type, value,
290 range, allowed, flags, validation_function)
294 def build_design_factories(self):
295 from nepi.core.design import Factory
297 for factory_id, info in self._metadata.factories_info.iteritems():
299 category = info["category"]
300 allow_addresses = info.get("allow_addresses", False)
301 allow_routes = info.get("allow_routes", False)
302 has_addresses = info.get("has_addresses", False)
303 has_routes = info.get("has_routes", False)
304 factory = Factory(factory_id,
305 allow_addresses, has_addresses,
306 allow_routes, has_routes,
309 # standard attributes
310 self._add_standard_attributes(factory, info, True, True,
311 self.STANDARD_BOX_ATTRIBUTES)
313 # custom attributes - they override standard ones
314 self._add_attributes(factory, info, "factory_attributes")
315 self._add_attributes(factory, info, "box_attributes", True)
317 self._add_design_traces(factory, info)
318 self._add_design_connector_types(factory, info)
319 factories.append(factory)
322 def build_execute_factories(self):
323 from nepi.core.execute import Factory
325 for factory_id, info in self._metadata.factories_info.iteritems():
326 create_function = info.get("create_function")
327 start_function = info.get("start_function")
328 stop_function = info.get("stop_function")
329 status_function = info.get("status_function")
330 configure_function = info.get("configure_function")
331 preconfigure_function = info.get("preconfigure_function")
332 allow_addresses = info.get("allow_addresses", False)
333 allow_routes = info.get("allow_routes", False)
334 has_addresses = info.get("has_addresses", False)
335 has_routes = info.get("has_routes", False)
336 factory = Factory(factory_id, create_function, start_function,
337 stop_function, status_function,
338 configure_function, preconfigure_function,
339 allow_addresses, has_addresses,
340 allow_routes, has_routes)
342 # standard attributes
343 self._add_standard_attributes(factory, info, False, True,
344 self.STANDARD_BOX_ATTRIBUTES)
346 # custom attributes - they override standard ones
347 self._add_attributes(factory, info, "factory_attributes")
348 self._add_attributes(factory, info, "box_attributes", True)
350 self._add_execute_traces(factory, info)
351 self._add_execute_connector_types(factory, info)
352 factories.append(factory)
355 def _load_versioned_metadata_module(self):
356 mod_name = "nepi.testbeds.%s.metadata_v%s" % (self._testbed_id.lower(),
358 if not mod_name in sys.modules:
360 return sys.modules[mod_name]
362 def _add_standard_attributes(self, factory, info, design, box, STANDARD_ATTRIBUTES):
364 attr_bundle = STANDARD_ATTRIBUTES
366 # Only add non-DesignOnly attributes
367 def nonDesign(attr_info):
368 return not (attr_info[1].get('flags',Attribute.NoFlags) & Attribute.DesignOnly)
369 attr_bundle = filter(nonDesign, STANDARD_ATTRIBUTES)
370 self._add_attributes(factory, info, None, box,
371 attr_bundle = STANDARD_ATTRIBUTES)
373 def _add_attributes(self, factory, info, attr_key, box_attributes = False, attr_bundle = ()):
374 if not attr_bundle and info and attr_key in info:
375 attr_bundle = [ (attr_id, self._metadata.attributes[attr_id])
376 for attr_id in info[attr_key] ]
377 for attr_id, attr_info in attr_bundle:
378 name = attr_info["name"]
379 help = attr_info["help"]
380 type = attr_info["type"]
381 value = attr_info["value"] if "value" in attr_info else None
382 range = attr_info["range"] if "range" in attr_info else None
383 allowed = attr_info["allowed"] if "allowed" in attr_info \
385 flags = attr_info["flags"] if "flags" in attr_info \
386 and attr_info["flags"] != None \
387 else Attribute.NoFlags
388 validation_function = attr_info["validation_function"]
390 factory.add_box_attribute(name, help, type, value, range,
391 allowed, flags, validation_function)
393 factory.add_attribute(name, help, type, value, range,
394 allowed, flags, validation_function)
396 def _add_design_traces(self, factory, info):
398 for trace in info["traces"]:
399 trace_info = self._metadata.traces[trace]
400 trace_id = trace_info["name"]
401 help = trace_info["help"]
402 factory.add_trace(trace_id, help)
404 def _add_execute_traces(self, factory, info):
406 for trace in info["traces"]:
407 trace_info = self._metadata.traces[trace]
408 trace_id = trace_info["name"]
409 factory.add_trace(trace_id)
411 def _add_design_connector_types(self, factory, info):
412 from nepi.core.design import ConnectorType
413 if "connector_types" in info:
415 for connection in self._metadata.connections:
416 from_ = connection["from"]
417 to = connection["to"]
418 can_cross = connection["can_cross"]
419 if from_ not in connections:
420 connections[from_] = list()
421 if to not in connections:
422 connections[to] = list()
423 connections[from_].append((to, can_cross))
424 connections[to].append((from_, can_cross))
425 for connector_id in info["connector_types"]:
426 connector_type_info = self._metadata.connector_types[
428 name = connector_type_info["name"]
429 help = connector_type_info["help"]
430 max = connector_type_info["max"]
431 min = connector_type_info["min"]
432 testbed_id = self._testbed_id
433 factory_id = factory.factory_id
434 connector_type = ConnectorType(testbed_id, factory_id, name,
436 for (to, can_cross) in connections[(testbed_id, factory_id,
438 (testbed_id_to, factory_id_to, name_to) = to
439 connector_type.add_allowed_connection(testbed_id_to,
440 factory_id_to, name_to, can_cross)
441 factory.add_connector_type(connector_type)
443 def _add_execute_connector_types(self, factory, info):
444 from nepi.core.execute import ConnectorType
445 if "connector_types" in info:
446 from_connections = dict()
447 to_connections = dict()
448 for connection in self._metadata.connections:
449 from_ = connection["from"]
450 to = connection["to"]
451 can_cross = connection["can_cross"]
452 init_code = connection["init_code"] \
453 if "init_code" in connection else None
454 compl_code = connection["compl_code"] \
455 if "compl_code" in connection else None
456 if from_ not in from_connections:
457 from_connections[from_] = list()
458 if to not in to_connections:
459 to_connections[to] = list()
460 from_connections[from_].append((to, can_cross, init_code,
462 to_connections[to].append((from_, can_cross, init_code,
464 for connector_id in info["connector_types"]:
465 connector_type_info = self._metadata.connector_types[
467 name = connector_type_info["name"]
468 max = connector_type_info["max"]
469 min = connector_type_info["min"]
470 testbed_id = self._testbed_id
471 factory_id = factory.factory_id
472 connector_type = ConnectorType(testbed_id, factory_id, name,
474 connector_key = (testbed_id, factory_id, name)
475 if connector_key in to_connections:
476 for (from_, can_cross, init_code, compl_code) in \
477 to_connections[connector_key]:
478 (testbed_id_from, factory_id_from, name_from) = from_
479 connector_type.add_from_connection(testbed_id_from,
480 factory_id_from, name_from, can_cross,
481 init_code, compl_code)
482 if connector_key in from_connections:
483 for (to, can_cross, init_code, compl_code) in \
484 from_connections[(testbed_id, factory_id, name)]:
485 (testbed_id_to, factory_id_to, name_to) = to
486 connector_type.add_to_connection(testbed_id_to,
487 factory_id_to, name_to, can_cross, init_code,
489 factory.add_connector_type(connector_type)