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_copy, \
  23         ResourceState, ResourceAction
  24 from nepi.util.sshfuncs import ProcStatus
  25
  26 import os
  27 import tempfile
  28
  29 @clsinit_copy
  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
  41     """
  42     _rtype = "Collector"
  43     _help = "A Collector can be attached to a trace name on another " \
  44         "ResourceManager and will retrieve and store the trace content " \
  45         "in a local file at the end of the experiment"
  46     _backend_type = "all"
  47
  48     @classmethod
  49     def _register_attributes(cls):
  50         trace_name = Attribute("traceName", "Name of the trace to be collected",
  51                 flags = Flags.Design)
  52         store_dir = Attribute("storeDir", "Path to local directory to store trace results",
  53                 default = tempfile.gettempdir(),
  54                 flags = Flags.Design)
  55         sub_dir = Attribute("subDir", "Sub directory to collect traces into",
  56                 flags = Flags.Design)
  57         rename = Attribute("rename", "Name to give to the collected trace file",
  58                 flags = Flags.Design)
  59
  60         cls._register_attribute(trace_name)
  61         cls._register_attribute(store_dir)
  62         cls._register_attribute(sub_dir)
  63         cls._register_attribute(rename)
  64
  65     def __init__(self, ec, guid):
  66         super(Collector, self).__init__(ec, guid)
  67         self._store_path =  None
  68
  69     @property
  70     def store_path(self):
  71         return self._store_path
  72
  73     def do_provision(self):
  74         trace_name = self.get("traceName")
  75         if not trace_name:
  76             self.fail()
  77
  78             msg = "No traceName was specified"
  79             self.error(msg)
  80             raise RuntimeError, msg
  81
  82         store_dir = self.get("storeDir")
  83         self._store_path = os.path.join(store_dir, self.ec.exp_id, self.ec.run_id)
  84
  85         subdir = self.get("subDir")
  86         if subdir:
  87             self._store_path = os.path.join(self._store_path, subdir)
  88
  89         msg = "Creating local directory at %s to store %s traces " % (
  90             store_dir, trace_name)
  91         self.info(msg)
  92
  93         try:
  94             os.makedirs(self.store_path)
  95         except OSError:
  96             pass
  97
  98         super(Collector, self).do_provision()
  99
 100     def do_deploy(self):
 101         self.do_discover()
 102         self.do_provision()
 103
 104         super(Collector, self).do_deploy()
 105
 106     def do_release(self):
 107         trace_name = self.get("traceName")
 108         rename = self.get("rename") or trace_name
 109
 110         msg = "Collecting '%s' traces to local directory %s" % (
 111             trace_name, self.store_path)
 112         self.info(msg)
 113
 114         rms = self.get_connected()
 115         for rm in rms:
 116             result = self.ec.trace(rm.guid, trace_name)
 117             fpath = os.path.join(self.store_path, "%d.%s" % (rm.guid,
 118                 rename))
 119             try:
 120                 f = open(fpath, "w")
 121                 f.write(result)
 122                 f.close()
 123             except:
 124                 msg = "Couldn't retrieve trace %s for %d at %s " % (trace_name,
 125                         rm.guid, fpath)
 126                 self.error(msg)
 127                 continue
 128
 129         super(Collector, self).do_release()
 130
 131     def valid_connection(self, guid):
 132         # TODO: Validate!
 133         return True
 134