Change the name of ip4 and prefix4 into endpoint_ip and endpoint_prefix

[nepi.git] / src / nepi / resources / planetlab / tap.py

diff --git a/src/nepi/resources/planetlab/tap.py b/src/nepi/resources/planetlab/tap.py
index 75e84de..5a47663 100644 (file)
--- a/src/nepi/resources/planetlab/tap.py
+++ b/src/nepi/resources/planetlab/tap.py
@@ -25,7 +25,6 @@ from nepi.resources.planetlab.node import PlanetlabNode
 from nepi.util.timefuncs import tnow, tdiffsec
 
 import os
-import socket
 import time
 
 PYTHON_VSYS_VERSION = "1.0"
@@ -38,13 +37,15 @@ class PlanetlabTap(LinuxApplication):
 
     @classmethod
     def _register_attributes(cls):
-        ip4 = Attribute("ip4", "IPv4 Address",
+        endpoint_ip = Attribute("endpoint_ip", "IP of the endpoint. This is the attribute " 
+                                "you should use to establish a tunnel or a remote "
+                                "connection between endpoint",
               flags = Flags.Design)
 
         mac = Attribute("mac", "MAC Address",
                 flags = Flags.Design)
 
-        prefix4 = Attribute("prefix4", "IPv4 network prefix",
+        endpoint_prefix = Attribute("endpoint_prefix", "IPv4 network prefix of the endpoint",
                 type = Types.Integer,
                 flags = Flags.Design)
 
@@ -84,9 +85,9 @@ class PlanetlabTap(LinuxApplication):
                 "Bash script to be executed before releasing the resource",
                 flags = Flags.Design)
 
-        cls._register_attribute(ip4)
+        cls._register_attribute(endpoint_ip)
         cls._register_attribute(mac)
-        cls._register_attribute(prefix4)
+        cls._register_attribute(endpoint_prefix)
         cls._register_attribute(mtu)
         cls._register_attribute(devname)
         cls._register_attribute(up)
@@ -106,7 +107,7 @@ class PlanetlabTap(LinuxApplication):
     def node(self):
         node = self.get_connected(PlanetlabNode.get_rtype())
         if node: return node[0]
-        return None
+        raise RuntimeError, "TAP/TUN devices must be connected to Node"
 
     @property
     def gre_enabled(self):
@@ -160,9 +161,8 @@ class PlanetlabTap(LinuxApplication):
         # upload stop.sh script
         stop_command = self.replace_paths(self._stop_command)
 
-        self.node.upload(stop_command,
-                os.path.join(self.app_home, "stop.sh"),
-                text = True,
+        self.node.upload_command(stop_command,
+                shfile = os.path.join(self.app_home, "stop.sh"),
                 # Overwrite file every time. 
                 # The stop.sh has the path to the socket, which should change
                 # on every experiment run.
@@ -266,17 +266,23 @@ class PlanetlabTap(LinuxApplication):
 
         super(PlanetlabTap, self).do_release()
 
-    def wait_vif_name(self):
+    def wait_vif_name(self, exec_run_home = None):
         """ Waits until the vif_name file for the command is generated, 
             and returns the vif_name for the device """
         vif_name = None
         delay = 0.5
 
+        # The vif_name file will be created in the tap-home, while the
+        # current execution home might be elsewhere to check for errors
+        # (e.g. could be a tunnel-home)
+        if not exec_run_home:
+            exec_run_home = self.run_home
+
         for i in xrange(20):
             (out, err), proc = self.node.check_output(self.run_home, "vif_name")
 
             if proc.poll() > 0:
-                (out, err), proc = self.node.check_errors(self.run_home)
+                (out, err), proc = self.node.check_errors(exec_run_home)
                 
                 if err.strip():
                     raise RuntimeError, err
@@ -301,9 +307,8 @@ class PlanetlabTap(LinuxApplication):
 
         # upload command to connect.sh script
         shfile = os.path.join(connection_app_home, "gre-connect.sh")
-        self.node.upload(gre_connect_command,
-                shfile,
-                text = True, 
+        self.node.upload_command(gre_connect_command,
+                shfile = shfile,
                 overwrite = False)
 
         # invoke connect script
@@ -333,7 +338,7 @@ class PlanetlabTap(LinuxApplication):
         # After creating the TAP, the pl-vif-create.py script
         # will write the name of the TAP to a file. We wait until
         # we can read the interface name from the file.
-        vif_name = self.wait_vif_name()
+        vif_name = self.wait_vif_name(exec_run_home = connection_run_home)
         self.set("deviceName", vif_name) 
 
         return True
@@ -346,9 +351,8 @@ class PlanetlabTap(LinuxApplication):
 
         # upload command to connect.sh script
         shfile = os.path.join(connection_app_home, "udp-connect.sh")
-        self.node.upload(udp_connect_command,
-                shfile,
-                text = True, 
+        self.node.upload_command(udp_connect_command,
+                shfile = shfile,
                 overwrite = False)
 
         # invoke connect script
@@ -381,10 +385,9 @@ class PlanetlabTap(LinuxApplication):
             cipher, cipher_key, bwlimit, txqueuelen):
 
         # Set the remote endpoint
-        self.set("pointopoint", remote_endpoint.get("ip4"))
+        self.set("pointopoint", remote_endpoint.get("endpoint_ip"))
 
-        remote_ip = socket.gethostbyname(
-                remote_endpoint.node.get("hostname"))
+        remote_ip = remote_endpoint.node.get("ip")
 
         local_port_file = os.path.join(connection_run_home, 
                 "local_port")
@@ -431,9 +434,8 @@ class PlanetlabTap(LinuxApplication):
 
     def _gre_connect_command(self, remote_endpoint, connection_run_home): 
         # Set the remote endpoint
-        self.set("pointopoint", remote_endpoint.get("ip4"))
-        self.set("greRemote", socket.gethostbyname(
-            remote_endpoint.node.get("hostname")))
+        self.set("pointopoint", remote_endpoint.get("endpoint_ip"))
+        self.set("greRemote", remote_endpoint.node.get("ip"))
 
         # Generate GRE connect command
 
@@ -462,8 +464,8 @@ class PlanetlabTap(LinuxApplication):
             command = ["sudo -S python ${SRC}/pl-vif-create.py"]
             
             command.append("-t %s" % self.vif_type)
-            command.append("-a %s" % self.get("ip4"))
-            command.append("-n %d" % self.get("prefix4"))
+            command.append("-a %s" % self.get("endpoint_ip"))
+            command.append("-n %d" % self.get("endpoint_prefix"))
             command.append("-f %s " % self.vif_name_file)
             command.append("-S %s " % self.sock_name)
 
@@ -505,8 +507,8 @@ class PlanetlabTap(LinuxApplication):
         command.append("-u %s" % self.node.get("username"))
         command.append("-N %s" % device_name)
         command.append("-t %s" % self.vif_type)
-        command.append("-a %s" % self.get("ip4"))
-        command.append("-n %d" % self.get("prefix4"))
+        command.append("-a %s" % self.get("endpoint_ip"))
+        command.append("-n %d" % self.get("endpoint_prefix"))
 
         if self.get("snat") == True:
             command.append("-s")