src/nepi/resources/all/collector.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.execution.attribute import Attribute, Flags, Types
  21 from nepi.execution.trace import Trace, TraceAttr
  22 from nepi.execution.resource import ResourceManager, clsinit, ResourceState, \
  23         ResourceAction
  24 from nepi.util.sshfuncs import ProcStatus
  25
  26 import os
  27 import tempfile
  28
  29 @clsinit
  30 class Collector(ResourceManager):
  31     """ The collector is reponsible of collecting traces
  32     of a same type associated to RMs into a local directory.
  33
  34     .. class:: Class Args :
  35
  36         :param ec: The Experiment controller
  37         :type ec: ExperimentController
  38         :param guid: guid of the RM
  39         :type guid: int
  40         :param creds: Credentials to communicate with the rm (XmppClient)
  41         :type creds: dict
  42
  43     """
  44     _rtype = "Collector"
  45
  46     @classmethod
  47     def _register_attributes(cls):
  48         trace_name = Attribute("traceName", "Name of the trace to be collected",
  49                 flags = Flags.ExecReadOnly)
  50         store_dir = Attribute("storeDir", "Path to local directory to store trace results",
  51                 default = tempfile.gettempdir(),
  52                 flags = Flags.ExecReadOnly)
  53         sub_dir = Attribute("subDir", "Sub directory to collect traces into",
  54                 flags = Flags.ExecReadOnly)
  55         rename = Attribute("rename", "Name to give to the collected trace file",
  56                 flags = Flags.ExecReadOnly)
  57
  58         cls._register_attribute(trace_name)
  59         cls._register_attribute(store_dir)
  60         cls._register_attribute(sub_dir)
  61         cls._register_attribute(rename)
  62
  63     def __init__(self, ec, guid):
  64         super(Collector, self).__init__(ec, guid)
  65         self._store_path =  None
  66
  67     @property
  68     def store_path(self):
  69         return self._store_path
  70
  71     def provision(self):
  72         trace_name = self.get("traceName")
  73         if not trace_name:
  74             self.fail()
  75
  76             msg = "No traceName was specified"
  77             self.error(msg)
  78             raise RuntimeError, msg
  79
  80         store_dir = self.get("storeDir")
  81         self._store_path = os.path.join(store_dir, self.ec.exp_id, self.ec.run_id)
  82
  83         subdir = self.get("subDir")
  84         if subdir:
  85             self._store_path = os.path.join(self._store_path, subdir)
  86
  87         msg = "Creating local directory at %s to store %s traces " % (
  88             store_dir, trace_name)
  89         self.info(msg)
  90
  91         try:
  92             os.makedirs(self.store_path)
  93         except OSError:
  94             pass
  95
  96         super(Collector, self).provision()
  97
  98     def deploy(self):
  99         try:
 100             self.discover()
 101             self.provision()
 102         except:
 103             self.fail()
 104             raise
 105
 106         super(Collector, self).deploy()
 107
 108     def release(self):
 109         trace_name = self.get("traceName")
 110         rename = self.get("rename") or trace_name
 111
 112         msg = "Collecting '%s' traces to local directory %s" % (
 113             trace_name, self.store_path)
 114         self.info(msg)
 115
 116         rms = self.get_connected()
 117         for rm in rms:
 118             result = self.ec.trace(rm.guid, trace_name)
 119             fpath = os.path.join(self.store_path, "%d.%s" % (rm.guid,
 120                 rename))
 121             try:
 122                 f = open(fpath, "w")
 123                 f.write(result)
 124                 f.close()
 125             except:
 126                 msg = "Couldn't retrieve trace %s for %d at %s " % (trace_name,
 127                         rm.guid, fpath)
 128                 self.error(msg)
 129                 continue
 130
 131         super(Collector, self).release()
 132
 133     def valid_connection(self, guid):
 134         # TODO: Validate!
 135         return True
 136