src/nepi/execution/resource.py

   1 #
   2 #    NEPI, a framework to manage network experiments
   3 #    Copyright (C) 2013 INRIA
   4 #
   5 #    This program is free software: you can redistribute it and/or modify
   6 #    it under the terms of the GNU General Public License as published by
   7 #    the Free Software Foundation, either version 3 of the License, or
   8 #    (at your option) any later version.
   9 #
  10 #    This program is distributed in the hope that it will be useful,
  11 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #    GNU General Public License for more details.
  14 #
  15 #    You should have received a copy of the GNU General Public License
  16 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #
  18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
  19
  20 from nepi.util.timefuncs import tnow, tdiff, tdiffsec, stabsformat
  21 from nepi.util.logger import Logger
  22 from nepi.execution.attribute import Attribute, Flags, Types
  23 from nepi.execution.trace import TraceAttr
  24
  25 import copy
  26 import functools
  27 import logging
  28 import os
  29 import pkgutil
  30 import sys
  31 import threading
  32 import weakref
  33
  34 reschedule_delay = "1s"
  35
  36 class ResourceAction:
  37     """ Action that a user can order to a Resource Manager
  38
  39     """
  40     DEPLOY = 0
  41     START = 1
  42     STOP = 2
  43
  44 class ResourceState:
  45     """ State of a Resource Manager
  46
  47     """
  48     NEW = 0
  49     DISCOVERED = 1
  50     PROVISIONED = 2
  51     READY = 3
  52     STARTED = 4
  53     STOPPED = 5
  54     FAILED = 6
  55     RELEASED = 7
  56
  57 ResourceState2str = dict({
  58     ResourceState.NEW : "NEW",
  59     ResourceState.DISCOVERED : "DISCOVERED",
  60     ResourceState.PROVISIONED : "PROVISIONED",
  61     ResourceState.READY : "READY",
  62     ResourceState.STARTED : "STARTED",
  63     ResourceState.STOPPED : "STOPPED",
  64     ResourceState.FAILED : "FAILED",
  65     ResourceState.RELEASED : "RELEASED",
  66     })
  67
  68 def clsinit(cls):
  69     """ Initializes template information (i.e. attributes and traces)
  70     on classes derived from the ResourceManager class.
  71
  72     It is used as a decorator in the class declaration as follows:
  73
  74         @clsinit
  75         class MyResourceManager(ResourceManager):
  76
  77             ...
  78
  79      """
  80
  81     cls._clsinit()
  82     return cls
  83
  84 def clsinit_copy(cls):
  85     """ Initializes template information (i.e. attributes and traces)
  86     on classes direved from the ResourceManager class.
  87     It differs from the clsinit method in that it forces inheritance
  88     of attributes and traces from the parent class.
  89
  90     It is used as a decorator in the class declaration as follows:
  91
  92         @clsinit
  93         class MyResourceManager(ResourceManager):
  94
  95             ...
  96
  97
  98     clsinit_copy should be prefered to clsinit when creating new
  99     ResourceManager child classes.
 100
 101     """
 102
 103     cls._clsinit_copy()
 104     return cls
 105
 106 def failtrap(func):
 107     """ Decorator function for instance methods that should set the
 108     RM state to FAILED when an error is raised. The methods that must be
 109     decorated are: discover, provision, deploy, start, stop.
 110
 111     """
 112     def wrapped(self, *args, **kwargs):
 113         try:
 114             return func(self, *args, **kwargs)
 115         except:
 116             import traceback
 117             err = traceback.format_exc()
 118             self.error(err)
 119             self.debug("SETTING guid %d to state FAILED" % self.guid)
 120             self.fail()
 121             raise
 122
 123     return wrapped
 124
 125 @clsinit
 126 class ResourceManager(Logger):
 127     """ Base clase for all ResourceManagers.
 128
 129     A ResourceManger is specific to a resource type (e.g. Node,
 130     Switch, Application, etc) on a specific backend (e.g. PlanetLab,
 131     OMF, etc).
 132
 133     The ResourceManager instances are responsible for interacting with
 134     and controlling concrete (physical or virtual) resources in the
 135     experimental backends.
 136
 137     """
 138     _rtype = "Resource"
 139     _attributes = None
 140     _traces = None
 141     _help = None
 142     _backend = None
 143
 144     @classmethod
 145     def _register_attribute(cls, attr):
 146         """ Resource subclasses will invoke this method to add a
 147         resource attribute
 148
 149         """
 150
 151         cls._attributes[attr.name] = attr
 152
 153     @classmethod
 154     def _remove_attribute(cls, name):
 155         """ Resource subclasses will invoke this method to remove a
 156         resource attribute
 157
 158         """
 159
 160         del cls._attributes[name]
 161
 162     @classmethod
 163     def _register_trace(cls, trace):
 164         """ Resource subclasses will invoke this method to add a
 165         resource trace
 166
 167         """
 168
 169         cls._traces[trace.name] = trace
 170
 171     @classmethod
 172     def _remove_trace(cls, name):
 173         """ Resource subclasses will invoke this method to remove a
 174         resource trace
 175
 176         """
 177
 178         del cls._traces[name]
 179
 180     @classmethod
 181     def _register_attributes(cls):
 182         """ Resource subclasses will invoke this method to register
 183         resource attributes.
 184
 185         This method should be overriden in the RMs that define
 186         attributes.
 187
 188         """
 189
 190         critical = Attribute("critical",
 191                 "Defines whether the resource is critical. "
 192                 "A failure on a critical resource will interrupt "
 193                 "the experiment. ",
 194                 type = Types.Bool,
 195                 default = True,
 196                 flags = Flags.Design)
 197
 198         cls._register_attribute(critical)
 199
 200     @classmethod
 201     def _register_traces(cls):
 202         """ Resource subclasses will invoke this method to register
 203         resource traces
 204
 205         This method should be overriden in the RMs that define traces.
 206
 207         """
 208
 209         pass
 210
 211     @classmethod
 212     def _clsinit(cls):
 213         """ ResourceManager classes have different attributes and traces.
 214         Attribute and traces are stored in 'class attribute' dictionaries.
 215         When a new ResourceManager class is created, the _clsinit method is
 216         called to create a new instance of those dictionaries and initialize
 217         them.
 218
 219         The _clsinit method is called by the clsinit decorator method.
 220
 221         """
 222
 223         # static template for resource attributes
 224         cls._attributes = dict()
 225         cls._register_attributes()
 226
 227         # static template for resource traces
 228         cls._traces = dict()
 229         cls._register_traces()
 230
 231     @classmethod
 232     def _clsinit_copy(cls):
 233         """ Same as _clsinit, except that after creating new instances of the
 234         dictionaries it copies all the attributes and traces from the parent
 235         class.
 236
 237         The _clsinit_copy method is called by the clsinit_copy decorator method.
 238
 239         """
 240         # static template for resource attributes
 241         cls._attributes = copy.deepcopy(cls._attributes)
 242         cls._register_attributes()
 243
 244         # static template for resource traces
 245         cls._traces = copy.deepcopy(cls._traces)
 246         cls._register_traces()
 247
 248     @classmethod
 249     def get_rtype(cls):
 250         """ Returns the type of the Resource Manager
 251
 252         """
 253         return cls._rtype
 254
 255     @classmethod
 256     def get_attributes(cls):
 257         """ Returns a copy of the attributes
 258
 259         """
 260         return copy.deepcopy(cls._attributes.values())
 261
 262     @classmethod
 263     def get_attribute(cls, name):
 264         """ Returns a copy of the attribute with name 'name'
 265
 266         """
 267         return copy.deepcopy(cls._attributes[name])
 268
 269
 270     @classmethod
 271     def get_traces(cls):
 272         """ Returns a copy of the traces
 273
 274         """
 275         return copy.deepcopy(cls._traces.values())
 276
 277     @classmethod
 278     def get_help(cls):
 279         """ Returns the description of the type of Resource
 280
 281         """
 282         return cls._help
 283
 284     @classmethod
 285     def get_backend(cls):
 286         """ Returns the identified of the backend (i.e. testbed, environment)
 287         for the Resource
 288
 289         """
 290         return cls._backend
 291
 292     def __init__(self, ec, guid):
 293         super(ResourceManager, self).__init__(self.get_rtype())
 294
 295         self._guid = guid
 296         self._ec = weakref.ref(ec)
 297         self._connections = set()
 298         self._conditions = dict()
 299
 300         # the resource instance gets a copy of all attributes
 301         self._attrs = copy.deepcopy(self._attributes)
 302
 303         # the resource instance gets a copy of all traces
 304         self._trcs = copy.deepcopy(self._traces)
 305
 306         # Each resource is placed on a deployment group by the EC
 307         # during deployment
 308         self.deployment_group = None
 309
 310         self._start_time = None
 311         self._stop_time = None
 312         self._discover_time = None
 313         self._provision_time = None
 314         self._ready_time = None
 315         self._release_time = None
 316         self._failed_time = None
 317
 318         self._state = ResourceState.NEW
 319
 320         # instance lock to synchronize exclusive state change methods (such
 321         # as deploy and release methods), in order to prevent them from being
 322         # executed at the same time
 323         self._release_lock = threading.Lock()
 324
 325     @property
 326     def guid(self):
 327         """ Returns the global unique identifier of the RM """
 328         return self._guid
 329
 330     @property
 331     def ec(self):
 332         """ Returns the Experiment Controller of the RM """
 333         return self._ec()
 334
 335     @property
 336     def connections(self):
 337         """ Returns the set of guids of connected RMs """
 338         return self._connections
 339
 340     @property
 341     def conditions(self):
 342         """ Returns the conditions to which the RM is subjected to.
 343
 344         This method returns a dictionary of conditions lists indexed by
 345         a ResourceAction.
 346
 347         """
 348         return self._conditions
 349
 350     @property
 351     def start_time(self):
 352         """ Returns the start time of the RM as a timestamp """
 353         return self._start_time
 354
 355     @property
 356     def stop_time(self):
 357         """ Returns the stop time of the RM as a timestamp """
 358         return self._stop_time
 359
 360     @property
 361     def discover_time(self):
 362         """ Returns the discover time of the RM as a timestamp """
 363         return self._discover_time
 364
 365     @property
 366     def provision_time(self):
 367         """ Returns the provision time of the RM as a timestamp """
 368         return self._provision_time
 369
 370     @property
 371     def ready_time(self):
 372         """ Returns the deployment time of the RM as a timestamp """
 373         return self._ready_time
 374
 375     @property
 376     def release_time(self):
 377         """ Returns the release time of the RM as a timestamp """
 378         return self._release_time
 379
 380     @property
 381     def failed_time(self):
 382         """ Returns the time failure occured for the RM as a timestamp """
 383         return self._failed_time
 384
 385     @property
 386     def state(self):
 387         """ Get the current state of the RM """
 388         return self._state
 389
 390     def log_message(self, msg):
 391         """ Returns the log message formatted with added information.
 392
 393         :param msg: text message
 394         :type msg: str
 395         :rtype: str
 396
 397         """
 398         return " %s guid: %d - %s " % (self._rtype, self.guid, msg)
 399
 400     def register_connection(self, guid):
 401         """ Registers a connection to the RM identified by guid
 402
 403         This method should not be overriden. Specific functionality
 404         should be added in the do_connect method.
 405
 406         :param guid: Global unique identified of the RM to connect to
 407         :type guid: int
 408
 409         """
 410         if self.valid_connection(guid):
 411             self.do_connect(guid)
 412             self._connections.add(guid)
 413
 414     def unregister_connection(self, guid):
 415         """ Removes a registered connection to the RM identified by guid
 416
 417         This method should not be overriden. Specific functionality
 418         should be added in the do_disconnect method.
 419
 420         :param guid: Global unique identified of the RM to connect to
 421         :type guid: int
 422
 423         """
 424         if guid in self._connections:
 425             self.do_disconnect(guid)
 426             self._connections.remove(guid)
 427
 428     @failtrap
 429     def discover(self):
 430         """ Performs resource discovery.
 431
 432         This  method is responsible for selecting an individual resource
 433         matching user requirements.
 434
 435         This method should not be overriden directly. Specific functionality
 436         should be added in the do_discover method.
 437
 438         """
 439         with self._release_lock:
 440             if self._state != ResourceState.RELEASED:
 441                 self.do_discover()
 442
 443     @failtrap
 444     def provision(self):
 445         """ Performs resource provisioning.
 446
 447         This  method is responsible for provisioning one resource.
 448         After this method has been successfully invoked, the resource
 449         should be accessible/controllable by the RM.
 450
 451         This method should not be overriden directly. Specific functionality
 452         should be added in the do_provision method.
 453
 454         """
 455         with self._release_lock:
 456             if self._state != ResourceState.RELEASED:
 457                 self.do_provision()
 458
 459     @failtrap
 460     def start(self):
 461         """ Starts the RM (e.g. launch remote process).
 462
 463         There is no standard start behavior. Some RMs will not need to perform
 464         any actions upon start.
 465
 466         This method should not be overriden directly. Specific functionality
 467         should be added in the do_start method.
 468
 469         """
 470
 471         if not self.state in [ResourceState.READY, ResourceState.STOPPED]:
 472             self.error("Wrong state %s for start" % self.state)
 473             return
 474
 475         with self._release_lock:
 476             if self._state != ResourceState.RELEASED:
 477                 self.do_start()
 478
 479     @failtrap
 480     def stop(self):
 481         """ Interrupts the RM, stopping any tasks the RM was performing.
 482
 483         There is no standard stop behavior. Some RMs will not need to perform
 484         any actions upon stop.
 485
 486         This method should not be overriden directly. Specific functionality
 487         should be added in the do_stop method.
 488
 489         """
 490         if not self.state in [ResourceState.STARTED]:
 491             self.error("Wrong state %s for stop" % self.state)
 492             return
 493
 494         with self._release_lock:
 495             self.do_stop()
 496
 497     @failtrap
 498     def deploy(self):
 499         """ Execute all steps required for the RM to reach the state READY.
 500
 501         This method is responsible for deploying the resource (and invoking
 502         the discover and provision methods).
 503
 504         This method should not be overriden directly. Specific functionality
 505         should be added in the do_deploy method.
 506
 507         """
 508         if self.state > ResourceState.READY:
 509             self.error("Wrong state %s for deploy" % self.state)
 510             return
 511
 512         with self._release_lock:
 513             if self._state != ResourceState.RELEASED:
 514                 self.do_deploy()
 515                 self.debug("----- READY ---- ")
 516
 517     def release(self):
 518         """ Perform actions to free resources used by the RM.
 519
 520         This  method is responsible for releasing resources that were
 521         used during the experiment by the RM.
 522
 523         This method should not be overriden directly. Specific functionality
 524         should be added in the do_release method.
 525
 526         """
 527         with self._release_lock:
 528             try:
 529                 self.do_release()
 530             except:
 531                 import traceback
 532                 err = traceback.format_exc()
 533                 self.error(err)
 534
 535             self.set_released()
 536             self.debug("----- RELEASED ---- ")
 537
 538     def fail(self):
 539         """ Sets the RM to state FAILED.
 540
 541         This method should not be overriden directly. Specific functionality
 542         should be added in the do_fail method.
 543
 544         """
 545         with self._release_lock:
 546             if self._state != ResourceState.RELEASED:
 547                 self.do_fail()
 548
 549     def set(self, name, value):
 550         """ Set the value of the attribute
 551
 552         :param name: Name of the attribute
 553         :type name: str
 554         :param name: Value of the attribute
 555         :type name: str
 556         """
 557         attr = self._attrs[name]
 558         attr.value = value
 559
 560     def get(self, name):
 561         """ Returns the value of the attribute
 562
 563         :param name: Name of the attribute
 564         :type name: str
 565         :rtype: str
 566         """
 567         attr = self._attrs[name]
 568         return attr.value
 569
 570     def enable_trace(self, name):
 571         """ Explicitly enable trace generation
 572
 573         :param name: Name of the trace
 574         :type name: str
 575         """
 576         trace = self._trcs[name]
 577         trace.enabled = True
 578
 579     def trace_enabled(self, name):
 580         """Returns True if trace is enables
 581
 582         :param name: Name of the trace
 583         :type name: str
 584         """
 585         trace = self._trcs[name]
 586         return trace.enabled
 587
 588     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
 589         """ Get information on collected trace
 590
 591         :param name: Name of the trace
 592         :type name: str
 593
 594         :param attr: Can be one of:
 595                          - TraceAttr.ALL (complete trace content),
 596                          - TraceAttr.STREAM (block in bytes to read starting at offset),
 597                          - TraceAttr.PATH (full path to the trace file),
 598                          - TraceAttr.SIZE (size of trace file).
 599         :type attr: str
 600
 601         :param block: Number of bytes to retrieve from trace, when attr is TraceAttr.STREAM
 602         :type name: int
 603
 604         :param offset: Number of 'blocks' to skip, when attr is TraceAttr.STREAM
 605         :type name: int
 606
 607         :rtype: str
 608         """
 609         pass
 610
 611     def register_condition(self, action, group, state, time = None):
 612         """ Registers a condition on the resource manager to allow execution
 613         of 'action' only after 'time' has elapsed from the moment all resources
 614         in 'group' reached state 'state'
 615
 616         :param action: Action to restrict to condition (either 'START' or 'STOP')
 617         :type action: str
 618         :param group: Group of RMs to wait for (list of guids)
 619         :type group: int or list of int
 620         :param state: State to wait for on all RM in group. (either 'STARTED', 'STOPPED' or 'READY')
 621         :type state: str
 622         :param time: Time to wait after 'state' is reached on all RMs in group. (e.g. '2s')
 623         :type time: str
 624
 625         """
 626
 627         if not action in self.conditions:
 628             self._conditions[action] = list()
 629
 630         conditions = self.conditions.get(action)
 631
 632         # For each condition to register a tuple of (group, state, time) is
 633         # added to the 'action' list
 634         if not isinstance(group, list):
 635             group = [group]
 636
 637         conditions.append((group, state, time))
 638
 639     def unregister_condition(self, group, action = None):
 640         """ Removed conditions for a certain group of guids
 641
 642         :param action: Action to restrict to condition (either 'START', 'STOP' or 'READY')
 643         :type action: str
 644
 645         :param group: Group of RMs to wait for (list of guids)
 646         :type group: int or list of int
 647
 648         """
 649         # For each condition a tuple of (group, state, time) is
 650         # added to the 'action' list
 651         if not isinstance(group, list):
 652             group = [group]
 653
 654         for act, conditions in self.conditions.iteritems():
 655             if action and act != action:
 656                 continue
 657
 658             for condition in list(conditions):
 659                 (grp, state, time) = condition
 660
 661                 # If there is an intersection between grp and group,
 662                 # then remove intersected elements
 663                 intsec = set(group).intersection(set(grp))
 664                 if intsec:
 665                     idx = conditions.index(condition)
 666                     newgrp = set(grp)
 667                     newgrp.difference_update(intsec)
 668                     conditions[idx] = (newgrp, state, time)
 669
 670     def get_connected(self, rtype = None):
 671         """ Returns the list of RM with the type 'rtype'
 672
 673         :param rtype: Type of the RM we look for
 674         :type rtype: str
 675         :return: list of guid
 676         """
 677         connected = []
 678         rclass = ResourceFactory.get_resource_type(rtype)
 679         for guid in self.connections:
 680             rm = self.ec.get_resource(guid)
 681
 682             if not rtype or isinstance(rm, rclass):
 683                 connected.append(rm)
 684         return connected
 685
 686     @failtrap
 687     def _needs_reschedule(self, group, state, time):
 688         """ Internal method that verify if 'time' has elapsed since
 689         all elements in 'group' have reached state 'state'.
 690
 691         :param group: Group of RMs to wait for (list of guids)
 692         :type group: int or list of int
 693         :param state: State to wait for on all RM in group. (either 'STARTED', 'STOPPED' or 'READY')
 694         :type state: str
 695         :param time: Time to wait after 'state' is reached on all RMs in group. (e.g. '2s')
 696         :type time: str
 697
 698         .. note : time should be written like "2s" or "3m" with s for seconds, m for minutes, h for hours, ...
 699         If for example, you need to wait 2min 30sec, time could be "150s" or "2.5m".
 700         For the moment, 2m30s is not a correct syntax.
 701
 702         """
 703         reschedule = False
 704         delay = reschedule_delay
 705
 706         # check state and time elapsed on all RMs
 707         for guid in group:
 708             rm = self.ec.get_resource(guid)
 709
 710             # If one of the RMs this resource needs to wait for has FAILED
 711             # and is critical we raise an exception
 712             if rm.state == ResourceState.FAILED:
 713                 if not rm.get('critical'):
 714                     continue
 715                 msg = "Resource can not wait for FAILED RM %d. Setting Resource to FAILED"
 716                 raise RuntimeError, msg
 717
 718             # If the RM state is lower than the requested state we must
 719             # reschedule (e.g. if RM is READY but we required STARTED).
 720             if rm.state < state:
 721                 reschedule = True
 722                 break
 723
 724             # If there is a time restriction, we must verify the
 725             # restriction is satisfied
 726             if time:
 727                 if state == ResourceState.DISCOVERED:
 728                     t = rm.discover_time
 729                 if state == ResourceState.PROVISIONED:
 730                     t = rm.provision_time
 731                 elif state == ResourceState.READY:
 732                     t = rm.ready_time
 733                 elif state == ResourceState.STARTED:
 734                     t = rm.start_time
 735                 elif state == ResourceState.STOPPED:
 736                     t = rm.stop_time
 737                 elif state == ResourceState.RELEASED:
 738                     t = rm.release_time
 739                 else:
 740                     break
 741
 742                 # time already elapsed since RM changed state
 743                 waited = "%fs" % tdiffsec(tnow(), t)
 744
 745                 # time still to wait
 746                 wait = tdiffsec(stabsformat(time), stabsformat(waited))
 747
 748                 if wait > 0.001:
 749                     reschedule = True
 750                     delay = "%fs" % wait
 751                     break
 752
 753         return reschedule, delay
 754
 755     def set_with_conditions(self, name, value, group, state, time):
 756         """ Set value 'value' on attribute with name 'name' when 'time'
 757         has elapsed since all elements in 'group' have reached state
 758         'state'
 759
 760         :param name: Name of the attribute to set
 761         :type name: str
 762         :param name: Value of the attribute to set
 763         :type name: str
 764         :param group: Group of RMs to wait for (list of guids)
 765         :type group: int or list of int
 766         :param state: State to wait for on all RM in group. (either 'STARTED', 'STOPPED' or 'READY')
 767         :type state: str
 768         :param time: Time to wait after 'state' is reached on all RMs in group. (e.g. '2s')
 769         :type time: str
 770         """
 771
 772         reschedule = False
 773         delay = reschedule_delay
 774
 775         ## evaluate if set conditions are met
 776
 777         # only can set with conditions after the RM is started
 778         if self.state != ResourceState.STARTED:
 779             reschedule = True
 780         else:
 781             reschedule, delay = self._needs_reschedule(group, state, time)
 782
 783         if reschedule:
 784             callback = functools.partial(self.set_with_conditions,
 785                     name, value, group, state, time)
 786             self.ec.schedule(delay, callback)
 787         else:
 788             self.set(name, value)
 789
 790     def start_with_conditions(self):
 791         """ Starts RM when all the conditions in self.conditions for
 792         action 'START' are satisfied.
 793
 794         """
 795         #import pdb;pdb.set_trace()
 796
 797         reschedule = False
 798         delay = reschedule_delay
 799
 800
 801         ## evaluate if conditions to start are met
 802         if self.ec.abort:
 803             return
 804
 805         # Can only start when RM is either STOPPED or READY
 806         if self.state not in [ResourceState.STOPPED, ResourceState.READY]:
 807             reschedule = True
 808             self.debug("---- RESCHEDULING START ---- state %s " % self.state )
 809         else:
 810             start_conditions = self.conditions.get(ResourceAction.START, [])
 811
 812             self.debug("---- START CONDITIONS ---- %s" % start_conditions)
 813
 814             # Verify all start conditions are met
 815             for (group, state, time) in start_conditions:
 816                 # Uncomment for debug
 817                 unmet = []
 818                 for guid in group:
 819                     rm = self.ec.get_resource(guid)
 820                     unmet.append((guid, rm._state))
 821
 822                 self.debug("---- WAITED STATES ---- %s" % unmet )
 823
 824                 reschedule, delay = self._needs_reschedule(group, state, time)
 825                 if reschedule:
 826                     break
 827
 828         if reschedule:
 829             self.ec.schedule(delay, self.start_with_conditions)
 830         else:
 831             self.debug("----- STARTING ---- ")
 832             self.start()
 833
 834     def stop_with_conditions(self):
 835         """ Stops RM when all the conditions in self.conditions for
 836         action 'STOP' are satisfied.
 837
 838         """
 839         reschedule = False
 840         delay = reschedule_delay
 841
 842         ## evaluate if conditions to stop are met
 843         if self.ec.abort:
 844             return
 845
 846         # only can stop when RM is STARTED
 847         if self.state != ResourceState.STARTED:
 848             reschedule = True
 849             self.debug("---- RESCHEDULING STOP ---- state %s " % self.state )
 850         else:
 851             self.debug(" ---- STOP CONDITIONS ---- %s" %
 852                     self.conditions.get(ResourceAction.STOP))
 853
 854             stop_conditions = self.conditions.get(ResourceAction.STOP, [])
 855             for (group, state, time) in stop_conditions:
 856                 reschedule, delay = self._needs_reschedule(group, state, time)
 857                 if reschedule:
 858                     break
 859
 860         if reschedule:
 861             callback = functools.partial(self.stop_with_conditions)
 862             self.ec.schedule(delay, callback)
 863         else:
 864             self.debug(" ----- STOPPING ---- ")
 865             self.stop()
 866
 867     def deploy_with_conditions(self):
 868         """ Deploy RM when all the conditions in self.conditions for
 869         action 'READY' are satisfied.
 870
 871         """
 872         reschedule = False
 873         delay = reschedule_delay
 874
 875         ## evaluate if conditions to deploy are met
 876         if self.ec.abort:
 877             return
 878
 879         # only can deploy when RM is either NEW, DISCOVERED or PROVISIONED
 880         if self.state not in [ResourceState.NEW, ResourceState.DISCOVERED,
 881                 ResourceState.PROVISIONED]:
 882             reschedule = True
 883             self.debug("---- RESCHEDULING DEPLOY ---- state %s " % self.state )
 884         else:
 885             deploy_conditions = self.conditions.get(ResourceAction.DEPLOY, [])
 886
 887             self.debug("---- DEPLOY CONDITIONS ---- %s" % deploy_conditions)
 888
 889             # Verify all start conditions are met
 890             for (group, state, time) in deploy_conditions:
 891                 # Uncomment for debug
 892                 #unmet = []
 893                 #for guid in group:
 894                 #    rm = self.ec.get_resource(guid)
 895                 #    unmet.append((guid, rm._state))
 896
 897                 #self.debug("---- WAITED STATES ---- %s" % unmet )
 898
 899                 reschedule, delay = self._needs_reschedule(group, state, time)
 900                 if reschedule:
 901                     break
 902
 903         if reschedule:
 904             self.ec.schedule(delay, self.deploy_with_conditions)
 905         else:
 906             self.debug("----- DEPLOYING ---- ")
 907             self.deploy()
 908
 909     def do_connect(self, guid):
 910         """ Performs actions that need to be taken upon associating RMs.
 911         This method should be redefined when necessary in child classes.
 912         """
 913         pass
 914
 915     def do_disconnect(self, guid):
 916         """ Performs actions that need to be taken upon disassociating RMs.
 917         This method should be redefined when necessary in child classes.
 918         """
 919         pass
 920
 921     def valid_connection(self, guid):
 922         """Checks whether a connection with the other RM
 923         is valid.
 924         This method need to be redefined by each new Resource Manager.
 925
 926         :param guid: Guid of the current Resource Manager
 927         :type guid: int
 928         :rtype:  Boolean
 929
 930         """
 931         # TODO: Validate!
 932         return True
 933
 934     def do_discover(self):
 935         self.set_discovered()
 936
 937     def do_provision(self):
 938         self.set_provisioned()
 939
 940     def do_start(self):
 941         self.set_started()
 942
 943     def do_stop(self):
 944         self.set_stopped()
 945
 946     def do_deploy(self):
 947         self.set_ready()
 948
 949     def do_release(self):
 950         pass
 951
 952     def do_fail(self):
 953         self.set_failed()
 954
 955     def set_started(self):
 956         """ Mark ResourceManager as STARTED """
 957         self.set_state(ResourceState.STARTED, "_start_time")
 958
 959     def set_stopped(self):
 960         """ Mark ResourceManager as STOPPED """
 961         self.set_state(ResourceState.STOPPED, "_stop_time")
 962
 963     def set_ready(self):
 964         """ Mark ResourceManager as READY """
 965         self.set_state(ResourceState.READY, "_ready_time")
 966
 967     def set_released(self):
 968         """ Mark ResourceManager as REALEASED """
 969         self.set_state(ResourceState.RELEASED, "_release_time")
 970
 971     def set_failed(self):
 972         """ Mark ResourceManager as FAILED """
 973         self.set_state(ResourceState.FAILED, "_failed_time")
 974
 975     def set_discovered(self):
 976         """ Mark ResourceManager as DISCOVERED """
 977         self.set_state(ResourceState.DISCOVERED, "_discover_time")
 978
 979     def set_provisioned(self):
 980         """ Mark ResourceManager as PROVISIONED """
 981         self.set_state(ResourceState.PROVISIONED, "_provision_time")
 982
 983     def set_state(self, state, state_time_attr):
 984         """ Set the state of the RM while keeping a trace of the time """
 985
 986         # Ensure that RM state will not change after released
 987         if self._state == ResourceState.RELEASED:
 988             return
 989
 990         setattr(self, state_time_attr, tnow())
 991         self._state = state
 992
 993 class ResourceFactory(object):
 994     _resource_types = dict()
 995
 996     @classmethod
 997     def resource_types(cls):
 998         """Return the type of the Class"""
 999         return cls._resource_types
1000
1001     @classmethod
1002     def get_resource_type(cls, rtype):
1003         """Return the type of the Class"""
1004         return cls._resource_types.get(rtype)
1005
1006     @classmethod
1007     def register_type(cls, rclass):
1008         """Register a new Ressource Manager"""
1009         cls._resource_types[rclass.get_rtype()] = rclass
1010
1011     @classmethod
1012     def create(cls, rtype, ec, guid):
1013         """Create a new instance of a Ressource Manager"""
1014         rclass = cls._resource_types[rtype]
1015         return rclass(ec, guid)
1016
1017 def populate_factory():
1018     """Register all the possible RM that exists in the current version of Nepi.
1019     """
1020     # Once the factory is populated, don't repopulate
1021     if not ResourceFactory.resource_types():
1022         for rclass in find_types():
1023             ResourceFactory.register_type(rclass)
1024
1025 def find_types():
1026     """Look into the different folders to find all the
1027     availables Resources Managers
1028     """
1029     search_path = os.environ.get("NEPI_SEARCH_PATH", "")
1030     search_path = set(search_path.split(" "))
1031
1032     import inspect
1033     import nepi.resources
1034     path = os.path.dirname(nepi.resources.__file__)
1035     search_path.add(path)
1036
1037     types = set()
1038
1039     for importer, modname, ispkg in pkgutil.walk_packages(search_path,
1040             prefix = "nepi.resources."):
1041
1042         loader = importer.find_module(modname)
1043
1044         try:
1045             # Notice: Repeated calls to load_module will act as a reload of the module
1046             if modname in sys.modules:
1047                 module = sys.modules.get(modname)
1048             else:
1049                 module = loader.load_module(modname)
1050
1051             for attrname in dir(module):
1052                 if attrname.startswith("_"):
1053                     continue
1054
1055                 attr = getattr(module, attrname)
1056
1057                 if attr == ResourceManager:
1058                     continue
1059
1060                 if not inspect.isclass(attr):
1061                     continue
1062
1063                 if issubclass(attr, ResourceManager):
1064                     types.add(attr)
1065
1066                     if not modname in sys.modules:
1067                         sys.modules[modname] = module
1068
1069         except:
1070             import traceback
1071             import logging
1072             err = traceback.format_exc()
1073             logger = logging.getLogger("Resource.find_types()")
1074             logger.error("Error while loading Resource Managers %s" % err)
1075
1076     return types
1077