More examples and code for Linux CCN RMs
[nepi.git] / src / nepi / resources / linux / ccn / ccncontent.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.resource import clsinit_copy, ResourceState, \
22     ResourceAction
23 from nepi.resources.linux.ccn.ccnapplication import LinuxCCNApplication
24 from nepi.resources.linux.ccn.ccnr import LinuxCCNR
25 from nepi.util.timefuncs import strfnow, strfdiff
26
27 import os
28
29 @clsinit_copy
30 class LinuxCCNContent(LinuxCCNApplication):
31     _rtype = "LinuxCCNContent"
32
33     @classmethod
34     def _register_attributes(cls):
35         content_name = Attribute("contentName",
36                 "The name of the content to publish (e.g. ccn:/VIDEO) ",
37                 flags = Flags.ExecReadOnly)
38
39         content = Attribute("content",
40                 "The content to publish. It can be a path to a file or plain text ",
41                 flags = Flags.ExecReadOnly)
42
43         cls._register_attribute(content_name)
44         cls._register_attribute(content)
45
46     def __init__(self, ec, guid):
47         super(LinuxCCNContent, self).__init__(ec, guid)
48         self._home = "content-%s" % self.guid
49         
50     @property
51     def ccnr(self):
52         ccnr = self.get_connected(LinuxCCNR.rtype())
53         if ccnr: return ccnr[0]
54         return None
55
56     @property
57     def node(self):
58         if self.ccnr: return self.ccnr.node
59         return None
60
61     def deploy(self):
62         if not self.ccnr or self.ccnr.state < ResourceState.READY:
63             self.debug("---- RESCHEDULING DEPLOY ---- node state %s " % self.node.state )
64             
65             reschedule_delay = "0.5s"
66             # ccnr needs to wait until ccnd is deployed and running
67             self.ec.schedule(reschedule_delay, self.deploy)
68         else:
69             command = self._start_command
70             env = self._environment
71
72             self.set("command", command)
73             self.set("env", env)
74
75             # set content to stdin, so the content will be
76             # uploaded during provision
77             self.set("stdin", self.get("content"))
78
79             self.info("Deploying command '%s' " % command)
80
81             self.node.mkdir(self.app_home)
82
83             # upload content 
84             self.upload_stdin()
85
86             # We want to make sure the content is published
87             # before the experiment starts.
88             # Run the command as a bash script in the background, 
89             # in the host ( but wait until the command has
90             # finished to continue )
91             self.execute_command(command, env)
92
93             self.debug("----- READY ---- ")
94             self._ready_time = strfnow()
95             self._state = ResourceState.READY
96
97     def start(self):
98         if self._state == ResourceState.READY:
99             command = self.get("command")
100             self.info("Starting command '%s'" % command)
101
102             self._start_time = strfnow()
103             self._state = ResourceState.STARTED
104         else:
105             msg = " Failed to execute command '%s'" % command
106             self.error(msg, out, err)
107             self._state = ResourceState.FAILED
108             raise RuntimeError, msg
109
110     @property
111     def state(self):
112         return self._state
113
114     @property
115     def _start_command(self):
116         return "ccnseqwriter -r %s < %s" % (self.get("contentName"),
117                 os.path.join(self.app_home, 'stdin'))
118
119     def valid_connection(self, guid):
120         # TODO: Validate!
121         return True
122