2 # NEPI, a framework to manage network experiments
3 # Copyright (C) 2013 INRIA
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.
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.
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/>.
18 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
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
30 class Collector(ResourceManager):
31 """ The collector is reponsible of collecting traces
32 of a same type associated to RMs into a local directory.
34 .. class:: Class Args :
36 :param ec: The Experiment controller
37 :type ec: ExperimentController
38 :param guid: guid of the RM
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"
49 def _register_attributes(cls):
50 trace_name = Attribute("traceName",
51 "Name of the trace to be collected",
54 store_dir = Attribute("storeDir",
55 "Path to local directory to store trace results",
56 default = tempfile.gettempdir(),
59 user_run_id = Attribute("useRunId",
60 "If set to True stores traces into a sub directory named after "
61 "the RUN ID assigned by the EC",
66 sub_dir = Attribute("subDir",
67 "Sub directory to collect traces into",
70 rename = Attribute("rename",
71 "Name to give to the collected trace file",
74 cls._register_attribute(trace_name)
75 cls._register_attribute(store_dir)
76 cls._register_attribute(sub_dir)
77 cls._register_attribute(rename)
78 cls._register_attribute(useRunId)
80 def __init__(self, ec, guid):
81 super(Collector, self).__init__(ec, guid)
82 self._store_path = None
86 return self._store_path
88 def do_provision(self):
89 trace_name = self.get("traceName")
93 msg = "No traceName was specified"
95 raise RuntimeError, msg
97 self._store_path = self.get("storeDir")
99 if self.get("useRunId"):
100 self._store_path = os.path.join(self._store_path, self.ec.run_id)
102 subdir = self.get("subDir")
104 self._store_path = os.path.join(self._store_path, subdir)
106 msg = "Creating local directory at %s to store %s traces " % (
107 store_dir, trace_name)
111 os.makedirs(self.store_path)
115 super(Collector, self).do_provision()
121 super(Collector, self).do_deploy()
123 def do_release(self):
124 trace_name = self.get("traceName")
125 rename = self.get("rename") or trace_name
127 msg = "Collecting '%s' traces to local directory %s" % (
128 trace_name, self.store_path)
131 rms = self.get_connected()
133 result = self.ec.trace(rm.guid, trace_name)
134 fpath = os.path.join(self.store_path, "%d.%s" % (rm.guid,
142 err = traceback.format_exc()
143 msg = "Couldn't retrieve trace %s for %d at %s " % (trace_name,
145 self.error(msg, out = "", err = err)
148 super(Collector, self).do_release()
150 def valid_connection(self, guid):