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.ExecReadOnly)
 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                 self.set_released()
 535                 self.debug("----- RELEASED ---- ")
 536
 537     def fail(self):
 538         """ Sets the RM to state FAILED.
 539
 540         This method should not be overriden directly. Specific functionality
 541         should be added in the do_fail method.
 542
 543         """
 544         with self._release_lock:
 545             if self._state != ResourceState.RELEASED:
 546                 self.do_fail()
 547
 548     def set(self, name, value):
 549         """ Set the value of the attribute
 550
 551         :param name: Name of the attribute
 552         :type name: str
 553         :param name: Value of the attribute
 554         :type name: str
 555         """
 556         attr = self._attrs[name]
 557         attr.value = value
 558
 559     def get(self, name):
 560         """ Returns the value of the attribute
 561
 562         :param name: Name of the attribute
 563         :type name: str
 564         :rtype: str
 565         """
 566         attr = self._attrs[name]
 567         return attr.value
 568
 569     def enable_trace(self, name):
 570         """ Explicitly enable trace generation
 571
 572         :param name: Name of the trace
 573         :type name: str
 574         """
 575         trace = self._trcs[name]
 576         trace.enabled = True
 577
 578     def trace_enabled(self, name):
 579         """Returns True if trace is enables
 580
 581         :param name: Name of the trace
 582         :type name: str
 583         """
 584         trace = self._trcs[name]
 585         return trace.enabled
 586
 587     def trace(self, name, attr = TraceAttr.ALL, block = 512, offset = 0):
 588         """ Get information on collected trace
 589
 590         :param name: Name of the trace
 591         :type name: str
 592
 593         :param attr: Can be one of:
 594                          - TraceAttr.ALL (complete trace content),
 595                          - TraceAttr.STREAM (block in bytes to read starting at offset),
 596                          - TraceAttr.PATH (full path to the trace file),
 597                          - TraceAttr.SIZE (size of trace file).
 598         :type attr: str
 599
 600         :param block: Number of bytes to retrieve from trace, when attr is TraceAttr.STREAM
 601         :type name: int
 602
 603         :param offset: Number of 'blocks' to skip, when attr is TraceAttr.STREAM
 604         :type name: int
 605
 606         :rtype: str
 607         """
 608         pass
 609
 610     def register_condition(self, action, group, state, time = None):
 611         """ Registers a condition on the resource manager to allow execution
 612         of 'action' only after 'time' has elapsed from the moment all resources
 613         in 'group' reached state 'state'
 614
 615         :param action: Action to restrict to condition (either 'START' or 'STOP')
 616         :type action: str
 617         :param group: Group of RMs to wait for (list of guids)
 618         :type group: int or list of int
 619         :param state: State to wait for on all RM in group. (either 'STARTED', 'STOPPED' or 'READY')
 620         :type state: str
 621         :param time: Time to wait after 'state' is reached on all RMs in group. (e.g. '2s')
 622         :type time: str
 623
 624         """
 625
 626         if not action in self.conditions:
 627             self._conditions[action] = list()
 628
 629         conditions = self.conditions.get(action)
 630
 631         # For each condition to register a tuple of (group, state, time) is
 632         # added to the 'action' list
 633         if not isinstance(group, list):
 634             group = [group]
 635
 636         conditions.append((group, state, time))
 637
 638     def unregister_condition(self, group, action = None):
 639         """ Removed conditions for a certain group of guids
 640
 641         :param action: Action to restrict to condition (either 'START', 'STOP' or 'READY')
 642         :type action: str
 643
 644         :param group: Group of RMs to wait for (list of guids)
 645         :type group: int or list of int
 646
 647         """
 648         # For each condition a tuple of (group, state, time) is
 649         # added to the 'action' list
 650         if not isinstance(group, list):
 651             group = [group]
 652
 653         for act, conditions in self.conditions.iteritems():
 654             if action and act != action:
 655                 continue
 656
 657             for condition in list(conditions):
 658                 (grp, state, time) = condition
 659
 660                 # If there is an intersection between grp and group,
 661                 # then remove intersected elements
 662                 intsec = set(group).intersection(set(grp))
 663                 if intsec:
 664                     idx = conditions.index(condition)
 665                     newgrp = set(grp)
 666                     newgrp.difference_update(intsec)
 667                     conditions[idx] = (newgrp, state, time)
 668
 669     def get_connected(self, rtype = None):
 670         """ Returns the list of RM with the type 'rtype'
 671
 672         :param rtype: Type of the RM we look for
 673         :type rtype: str
 674         :return: list of guid
 675         """
 676         connected = []
 677         rclass = ResourceFactory.get_resource_type(rtype)
 678         for guid in self.connections:
 679             rm = self.ec.get_resource(guid)
 680             if not rtype or isinstance(rm, rclass):
 681                 connected.append(rm)
 682         return connected
 683
 684     @failtrap
 685     def _needs_reschedule(self, group, state, time):
 686         """ Internal method that verify if 'time' has elapsed since
 687         all elements in 'group' have reached state 'state'.
 688
 689         :param group: Group of RMs to wait for (list of guids)
 690         :type group: int or list of int
 691         :param state: State to wait for on all RM in group. (either 'STARTED', 'STOPPED' or 'READY')
 692         :type state: str
 693         :param time: Time to wait after 'state' is reached on all RMs in group. (e.g. '2s')
 694         :type time: str
 695
 696         .. note : time should be written like "2s" or "3m" with s for seconds, m for minutes, h for hours, ...
 697         If for example, you need to wait 2min 30sec, time could be "150s" or "2.5m".
 698         For the moment, 2m30s is not a correct syntax.
 699
 700         """
 701         reschedule = False
 702         delay = reschedule_delay
 703
 704         # check state and time elapsed on all RMs
 705         for guid in group:
 706             rm = self.ec.get_resource(guid)
 707
 708             # If one of the RMs this resource needs to wait for has FAILED
 709             # and is critical we raise an exception
 710             if rm.state == ResourceState.FAILED:
 711                 if not rm.get('critical'):
 712                     continue
 713                 msg = "Resource can not wait for FAILED RM %d. Setting Resource to FAILED"
 714                 raise RuntimeError, msg
 715
 716             # If the RM state is lower than the requested state we must
 717             # reschedule (e.g. if RM is READY but we required STARTED).
 718             if rm.state < state:
 719                 reschedule = True
 720                 break
 721
 722             # If there is a time restriction, we must verify the
 723             # restriction is satisfied
 724             if time:
 725                 if state == ResourceState.DISCOVERED:
 726                     t = rm.discover_time
 727                 if state == ResourceState.PROVISIONED:
 728                     t = rm.provision_time
 729                 elif state == ResourceState.READY:
 730                     t = rm.ready_time
 731                 elif state == ResourceState.STARTED:
 732                     t = rm.start_time
 733                 elif state == ResourceState.STOPPED:
 734                     t = rm.stop_time
 735                 elif state == ResourceState.RELEASED:
 736                     t = rm.release_time
 737                 else:
 738                     break
 739
 740                 # time already elapsed since RM changed state
 741                 waited = "%fs" % tdiffsec(tnow(), t)
 742
 743                 # time still to wait
 744                 wait = tdiffsec(stabsformat(time), stabsformat(waited))
 745
 746                 if wait > 0.001:
 747                     reschedule = True
 748                     delay = "%fs" % wait
 749                     break
 750
 751         return reschedule, delay
 752
 753     def set_with_conditions(self, name, value, group, state, time):
 754         """ Set value 'value' on attribute with name 'name' when 'time'
 755         has elapsed since all elements in 'group' have reached state
 756         'state'
 757
 758         :param name: Name of the attribute to set
 759         :type name: str
 760         :param name: Value of the attribute to set
 761         :type name: str
 762         :param group: Group of RMs to wait for (list of guids)
 763         :type group: int or list of int
 764         :param state: State to wait for on all RM in group. (either 'STARTED', 'STOPPED' or 'READY')
 765         :type state: str
 766         :param time: Time to wait after 'state' is reached on all RMs in group. (e.g. '2s')
 767         :type time: str
 768         """
 769
 770         reschedule = False
 771         delay = reschedule_delay
 772
 773         ## evaluate if set conditions are met
 774
 775         # only can set with conditions after the RM is started
 776         if self.state != ResourceState.STARTED:
 777             reschedule = True
 778         else:
 779             reschedule, delay = self._needs_reschedule(group, state, time)
 780
 781         if reschedule:
 782             callback = functools.partial(self.set_with_conditions,
 783                     name, value, group, state, time)
 784             self.ec.schedule(delay, callback)
 785         else:
 786             self.set(name, value)
 787
 788     def start_with_conditions(self):
 789         """ Starts RM when all the conditions in self.conditions for
 790         action 'START' are satisfied.
 791
 792         """
 793         #import pdb;pdb.set_trace()
 794
 795         reschedule = False
 796         delay = reschedule_delay
 797
 798
 799         ## evaluate if conditions to start are met
 800         if self.ec.abort:
 801             return
 802
 803         # Can only start when RM is either STOPPED or READY
 804         if self.state not in [ResourceState.STOPPED, ResourceState.READY]:
 805             reschedule = True
 806             self.debug("---- RESCHEDULING START ---- state %s " % self.state )
 807         else:
 808             start_conditions = self.conditions.get(ResourceAction.START, [])
 809
 810             self.debug("---- START CONDITIONS ---- %s" % start_conditions)
 811
 812             # Verify all start conditions are met
 813             for (group, state, time) in start_conditions:
 814                 # Uncomment for debug
 815                 unmet = []
 816                 for guid in group:
 817                     rm = self.ec.get_resource(guid)
 818                     unmet.append((guid, rm._state))
 819
 820                 self.debug("---- WAITED STATES ---- %s" % unmet )
 821
 822                 reschedule, delay = self._needs_reschedule(group, state, time)
 823                 if reschedule:
 824                     break
 825
 826         if reschedule:
 827             self.ec.schedule(delay, self.start_with_conditions)
 828         else:
 829             self.debug("----- STARTING ---- ")
 830             self.start()
 831
 832     def stop_with_conditions(self):
 833         """ Stops RM when all the conditions in self.conditions for
 834         action 'STOP' are satisfied.
 835
 836         """
 837         reschedule = False
 838         delay = reschedule_delay
 839
 840         ## evaluate if conditions to stop are met
 841         if self.ec.abort:
 842             return
 843
 844         # only can stop when RM is STARTED
 845         if self.state != ResourceState.STARTED:
 846             reschedule = True
 847             self.debug("---- RESCHEDULING STOP ---- state %s " % self.state )
 848         else:
 849             self.debug(" ---- STOP CONDITIONS ---- %s" %
 850                     self.conditions.get(ResourceAction.STOP))
 851
 852             stop_conditions = self.conditions.get(ResourceAction.STOP, [])
 853             for (group, state, time) in stop_conditions:
 854                 reschedule, delay = self._needs_reschedule(group, state, time)
 855                 if reschedule:
 856                     break
 857
 858         if reschedule:
 859             callback = functools.partial(self.stop_with_conditions)
 860             self.ec.schedule(delay, callback)
 861         else:
 862             self.debug(" ----- STOPPING ---- ")
 863             self.stop()
 864
 865     def deploy_with_conditions(self):
 866         """ Deploy RM when all the conditions in self.conditions for
 867         action 'READY' are satisfied.
 868
 869         """
 870         reschedule = False
 871         delay = reschedule_delay
 872
 873         ## evaluate if conditions to deploy are met
 874         if self.ec.abort:
 875             return
 876
 877         # only can deploy when RM is either NEW, DISCOVERED or PROVISIONED
 878         if self.state not in [ResourceState.NEW, ResourceState.DISCOVERED,
 879                 ResourceState.PROVISIONED]:
 880             reschedule = True
 881             self.debug("---- RESCHEDULING DEPLOY ---- state %s " % self.state )
 882         else:
 883             deploy_conditions = self.conditions.get(ResourceAction.DEPLOY, [])
 884
 885             self.debug("---- DEPLOY CONDITIONS ---- %s" % deploy_conditions)
 886
 887             # Verify all start conditions are met
 888             for (group, state, time) in deploy_conditions:
 889                 # Uncomment for debug
 890                 #unmet = []
 891                 #for guid in group:
 892                 #    rm = self.ec.get_resource(guid)
 893                 #    unmet.append((guid, rm._state))
 894
 895                 #self.debug("---- WAITED STATES ---- %s" % unmet )
 896
 897                 reschedule, delay = self._needs_reschedule(group, state, time)
 898                 if reschedule:
 899                     break
 900
 901         if reschedule:
 902             self.ec.schedule(delay, self.deploy_with_conditions)
 903         else:
 904             self.debug("----- DEPLOYING ---- ")
 905             self.deploy()
 906
 907     def do_connect(self, guid):
 908         """ Performs actions that need to be taken upon associating RMs.
 909         This method should be redefined when necessary in child classes.
 910         """
 911         pass
 912
 913     def do_disconnect(self, guid):
 914         """ Performs actions that need to be taken upon disassociating RMs.
 915         This method should be redefined when necessary in child classes.
 916         """
 917         pass
 918
 919     def valid_connection(self, guid):
 920         """Checks whether a connection with the other RM
 921         is valid.
 922         This method need to be redefined by each new Resource Manager.
 923
 924         :param guid: Guid of the current Resource Manager
 925         :type guid: int
 926         :rtype:  Boolean
 927
 928         """
 929         # TODO: Validate!
 930         return True
 931
 932     def do_discover(self):
 933         self.set_discovered()
 934
 935     def do_provision(self):
 936         self.set_provisioned()
 937
 938     def do_start(self):
 939         self.set_started()
 940
 941     def do_stop(self):
 942         self.set_stopped()
 943
 944     def do_deploy(self):
 945         self.set_ready()
 946
 947     def do_release(self):
 948         self.set_released()
 949         self.debug("----- RELEASED ---- ")
 950
 951     def do_fail(self):
 952         self.set_failed()
 953
 954     def set_started(self):
 955         """ Mark ResourceManager as STARTED """
 956         self.set_state(ResourceState.STARTED, "_start_time")
 957
 958     def set_stopped(self):
 959         """ Mark ResourceManager as STOPPED """
 960         self.set_state(ResourceState.STOPPED, "_stop_time")
 961
 962     def set_ready(self):
 963         """ Mark ResourceManager as READY """
 964         self.set_state(ResourceState.READY, "_ready_time")
 965
 966     def set_released(self):
 967         """ Mark ResourceManager as REALEASED """
 968         self.set_state(ResourceState.RELEASED, "_release_time")
 969
 970     def set_failed(self):
 971         """ Mark ResourceManager as FAILED """
 972         self.set_state(ResourceState.FAILED, "_failed_time")
 973
 974     def set_discovered(self):
 975         """ Mark ResourceManager as DISCOVERED """
 976         self.set_state(ResourceState.DISCOVERED, "_discover_time")
 977
 978     def set_provisioned(self):
 979         """ Mark ResourceManager as PROVISIONED """
 980         self.set_state(ResourceState.PROVISIONED, "_provision_time")
 981
 982     def set_state(self, state, state_time_attr):
 983         """ Set the state of the RM while keeping a trace of the time """
 984
 985         # Ensure that RM state will not change after released
 986         if self._state == ResourceState.RELEASED:
 987             return
 988
 989         setattr(self, state_time_attr, tnow())
 990         self._state = state
 991
 992 class ResourceFactory(object):
 993     _resource_types = dict()
 994
 995     @classmethod
 996     def resource_types(cls):
 997         """Return the type of the Class"""
 998         return cls._resource_types
 999
1000     @classmethod
1001     def get_resource_type(cls, rtype):
1002         """Return the type of the Class"""
1003         return cls._resource_types.get(rtype)
1004
1005     @classmethod
1006     def register_type(cls, rclass):
1007         """Register a new Ressource Manager"""
1008         cls._resource_types[rclass.get_rtype()] = rclass
1009
1010     @classmethod
1011     def create(cls, rtype, ec, guid):
1012         """Create a new instance of a Ressource Manager"""
1013         rclass = cls._resource_types[rtype]
1014         return rclass(ec, guid)
1015
1016 def populate_factory():
1017     """Register all the possible RM that exists in the current version of Nepi.
1018     """
1019     # Once the factory is populated, don't repopulate
1020     if not ResourceFactory.resource_types():
1021         for rclass in find_types():
1022             ResourceFactory.register_type(rclass)
1023
1024 def find_types():
1025     """Look into the different folders to find all the
1026     availables Resources Managers
1027     """
1028     search_path = os.environ.get("NEPI_SEARCH_PATH", "")
1029     search_path = set(search_path.split(" "))
1030
1031     import inspect
1032     import nepi.resources
1033     path = os.path.dirname(nepi.resources.__file__)
1034     search_path.add(path)
1035
1036     types = []
1037
1038     for importer, modname, ispkg in pkgutil.walk_packages(search_path,
1039             prefix = "nepi.resources."):
1040
1041         loader = importer.find_module(modname)
1042
1043         try:
1044             # Notice: Repeated calls to load_module will act as a reload of teh module
1045             if modname in sys.modules:
1046                 module = sys.modules.get(modname)
1047             else:
1048                 module = loader.load_module(modname)
1049
1050             for attrname in dir(module):
1051                 if attrname.startswith("_"):
1052                     continue
1053
1054                 attr = getattr(module, attrname)
1055
1056                 if attr == ResourceManager:
1057                     continue
1058
1059                 if not inspect.isclass(attr):
1060                     continue
1061
1062                 if issubclass(attr, ResourceManager):
1063                     types.append(attr)
1064
1065                     if not modname in sys.modules:
1066                         sys.modules[modname] = module
1067
1068         except:
1069             import traceback
1070             import logging
1071             err = traceback.format_exc()
1072             logger = logging.getLogger("Resource.find_types()")
1073             logger.error("Error while loading Resource Managers %s" % err)
1074
1075     return types
1076
1077