rename src/nepi/ into just nepi/

[nepi.git] / nepi / resources / linux / tunnel.py

diff --git a/nepi/resources/linux/tunnel.py b/nepi/resources/linux/tunnel.py
new file mode 100644 (file)
index 0000000..1bb587d
--- /dev/null
+++ b/nepi/resources/linux/tunnel.py
@@ -0,0 +1,165 @@
+#
+#    NEPI, a framework to manage network experiments
+#    Copyright (C) 2013 INRIA
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 2 as
+#    published by the Free Software Foundation;
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Author: Alina Quereilhac <alina.quereilhac@inria.fr>
+
+from nepi.execution.resource import clsinit_copy, ResourceState
+from nepi.resources.linux.application import LinuxApplication
+from nepi.util.timefuncs import tnow, tdiffsec
+
+import os
+import time
+
+state_check_delay = 0.5
+
+@clsinit_copy
+class LinuxTunnel(LinuxApplication):
+    _rtype = "abstract::linux::Tunnel"
+    _help = "Constructs a tunnel between two Linux endpoints"
+
+    def __init__(self, ec, guid):
+        super(LinuxTunnel, self).__init__(ec, guid)
+        self._home = "tunnel-%s" % self.guid
+
+    def log_message(self, msg):
+        return " guid %d - tunnel %s - %s - %s " % (self.guid, 
+                self.endpoint1.node.get("hostname"), 
+                self.endpoint2.node.get("hostname"), 
+                msg)
+
+    def get_endpoints(self):
+        """ Returns the list of RM that are endpoints to the tunnel 
+        """
+        raise NotImplementedError
+
+    @property
+    def endpoint1(self):
+        endpoints = self.get_endpoints()
+        if endpoints: return endpoints[0]
+        return None
+
+    @property
+    def endpoint2(self):
+        endpoints = self.get_endpoints()
+        if endpoints and len(endpoints) > 1: return endpoints[1]
+        return None
+
+    def app_home(self, endpoint):
+        return os.path.join(endpoint.node.exp_home, self._home)
+
+    def run_home(self, endpoint):
+        return os.path.join(self.app_home(endpoint), self.ec.run_id)
+
+    def endpoint_mkdir(self, endpoint):
+        endpoint.node.mkdir(self.run_home(endpoint))
+
+    def initiate_connection(self, endpoint, remote_endpoint):
+        raise NotImplementedError
+
+    def establish_connection(self, endpoint, remote_endpoint, data):
+        raise NotImplementedError
+
+    def verify_connection(self, endpoint, remote_endpoint):
+        raise NotImplementedError
+
+    def terminate_connection(self, endpoint, remote_endpoint):
+        raise NotImplementedError
+
+    def check_state_connection(self, endpoint, remote_endpoint):
+        raise NotImplementedError
+
+    def do_provision(self):
+        # create run dir for tunnel on each node 
+        self.endpoint_mkdir(self.endpoint1)
+        self.endpoint_mkdir(self.endpoint2)
+
+        self.debug("Initiate the connection")
+        # Start 2 step connection
+        # Initiate connection from endpoint 1 to endpoint 2
+        data1 = self.initiate_connection(self.endpoint1, self.endpoint2)
+
+        # Initiate connection from endpoint 2 to endpoint 1
+        data2 = self.initiate_connection(self.endpoint2, self.endpoint1)
+
+        self.debug("Establish the connection")
+        # Establish connection from endpoint 1 to endpoint 2
+        self.establish_connection(self.endpoint1, self.endpoint2, data2)
+        
+        # Establish connection from endpoint 2 to endpoint 1
+        self.establish_connection(self.endpoint2, self.endpoint1, data1)
+
+        self.debug("Verify the connection")
+        # check if connection was successful on both sides
+        self.verify_connection(self.endpoint1, self.endpoint2)
+        self.verify_connection(self.endpoint2, self.endpoint1)
+       
+        self.info("Provisioning finished")
+ 
+        self.set_provisioned()
+
+    def do_deploy(self):
+        if (not self.endpoint1 or self.endpoint1.state < ResourceState.READY) or \
+            (not self.endpoint2 or self.endpoint2.state < ResourceState.READY):
+            self.ec.schedule(self.reschedule_delay, self.deploy)
+        else:
+            self.do_discover()
+            self.do_provision()
+ 
+            self.set_ready()
+
+    def do_start(self):
+        if self.state == ResourceState.READY:
+            command = self.get("command")
+            self.info("Starting command '%s'" % command)
+            
+            self.set_started()
+        else:
+            msg = " Failed to execute command '%s'" % command
+            self.error(msg, out, err)
+            raise RuntimeError(msg)
+
+    def do_stop(self):
+        """ Stops application execution
+        """
+
+        if self.state == ResourceState.STARTED:
+            self.info("Stopping tunnel")
+
+            self.terminate_connection(self.endpoint1, self.endpoint2)
+            self.terminate_connection(self.endpoint2, self.endpoint1)
+
+            self.set_stopped()
+
+    @property
+    def state(self):
+        """ Returns the state of the application
+        """
+        if self._state == ResourceState.STARTED:
+            # In order to avoid overwhelming the remote host and
+            # the local processor with too many ssh queries, the state is only
+            # requested every 'state_check_delay' seconds.
+            if tdiffsec(tnow(), self._last_state_check) > state_check_delay:
+                
+                self.check_state_connection()
+
+                self._last_state_check = tnow()
+
+        return self._state
+
+    def valid_connection(self, guid):
+        # TODO: Validate!
+        return True
+