Planetlab examples
[nepi.git] / examples / planetlab / ping_with_filters.py
similarity index 53%
rename from examples/planetlab/ping_filters_experiment.py
rename to examples/planetlab/ping_with_filters.py
index 79d4738..71f23d9 100644 (file)
 #
 # Author: Lucia Guevgeozian <lucia.guevgeozian_odizzio@inria.fr>
 
+# Example of how to run this experiment (replace with your information):
+#
+# $ cd <path-to-nepi>
+# python examples/planetlab/ping_with_filters.py -s <pl-slice> -u <pl-user> -p <pl-password> -k <pl-ssh-key>  
+
 from nepi.execution.ec import ExperimentController
 from nepi.execution.resource import ResourceAction, ResourceState
 
+from optparse import OptionParser
 import os
 
-def create_node(ec, username, pl_user, pl_password, hostname=None, country=None,
-                operatingSystem=None, minBandwidth=None, minCpu=None):
+
+def create_node(ec, pl_slice, pl_ssh_key, pl_user, pl_password, 
+       hostname = None, country = None, operatingSystem = None, 
+       minBandwidth = None, minCpu = None):
 
     node = ec.register_resource("PlanetlabNode")
 
-    if username:
-        ec.set(node, "username", username)
-    if pl_user:
-        ec.set(node, "pluser", pl_user)
-    if pl_password:
-        ec.set(node, "plpassword", pl_password)
+    ec.set(node, "username", pl_slice)
+    ec.set(node, "identity", pl_ssh_key)
+    ec.set(node, "pluser", pl_user)
+    ec.set(node, "plpassword", pl_password)
 
     if hostname:
         ec.set(node, "hostname", hostname)
@@ -51,9 +57,10 @@ def create_node(ec, username, pl_user, pl_password, hostname=None, country=None,
     
     return node
 
-def add_app(ec, command, node, sudo=None, video=None, depends=None, forward_x11=None, \
-        env=None):
+def add_app(ec, command, node, newname = None, sudo = None, 
+        video = None, depends = None, forward_x11 = None, env = None):
     app = ec.register_resource("LinuxApplication")
+
     if sudo is not None:
         ec.set(app, "sudo", sudo)
     if video is not None:
@@ -64,59 +71,90 @@ def add_app(ec, command, node, sudo=None, video=None, depends=None, forward_x11=
         ec.set(app, "forwardX11", forward_x11)
     if env is not None:
         ec.set(app, "env", env)
+
     ec.set(app, "command", command)
 
     ec.register_connection(app, node)
 
+    # add collector to download application standar output
+    collector = ec.register_resource("Collector")
+    ec.set(collector, "traceName", "stdout")
+    if newname:
+        ec.set(collector, "rename", newname)
+    ec.register_connection(app, collector)
+
     return app
 
-exp_id = "ping_filters_exp"
+usage = ("usage: %prog -s <pl-slice> -u <pl-user> -p <pl-password> "
+    "-k <pl-ssh-key> -c <country> -o <operating-system> -H <hostname> ")
+
+parser = OptionParser(usage = usage)
+parser.add_option("-s", "--pl-slice", dest="pl_slice",
+        help="PlanetLab slicename", type="str")
+parser.add_option("-u", "--pl-user", dest="pl_user",
+        help="PlanetLab web username", type="str")
+parser.add_option("-p", "--pl-password", dest="pl_password",
+        help="PlanetLab web password", type="str")
+parser.add_option("-k", "--pl-ssh-key", dest="pl_ssh_key",
+        help="Path to private SSH key associated with the PL account",
+        type="str")
+parser.add_option("-c", "--country", dest="country",
+        help="Country for the PL hosts",
+        type="str")
+parser.add_option("-o", "--os", dest="os",
+        help="Operating system for the PL hosts", default="f14",
+        type="str")
+parser.add_option("-H", "--hostname", dest="hostname",
+        help="PlanetLab hostname",
+        type="str")
+
+(options, args) = parser.parse_args()
+
+pl_slice = options.pl_slice
+pl_ssh_key = options.pl_ssh_key
+pl_user = options.pl_user
+pl_password = options.pl_password
+hostname = options.hostname
+country = options.country
+os = options.os
 
 # Create the entity Experiment Controller:
-ec = ExperimentController(exp_id)
+ec = ExperimentController("pl_ping_filters")
 
 # Register the nodes resources:
 
-# The username in this case is the slice name, the one to use for login in 
-# via ssh into PlanetLab nodes. Replace with your own slice name.
-username = "inria_sfatest"
-
-# The pluser and plpassword are the ones used to login in the PlanetLab web 
-# site. Replace with your own user and password account information.
-pl_user = "lucia.guevgeozian_odizzio@inria.fr"
-pl_password =  os.environ.get("PL_PASS")
-
 # Choose the PlanetLab nodes for the experiment, in this example 5 nodes are
 # used, and they are picked according to different criterias.
 
 # First node will be the one defined by its hostname.
-hostname = "planetlab2.utt.fr"
-node1 = create_node(ec, username, pl_user, pl_password, hostname=hostname)
+node1 = create_node(ec, pl_slice, pl_ssh_key, pl_user, pl_password, 
+        hostname = hostname)
 
-# Second node will be any node in France.
-country = "France"
-node2 = create_node(ec, username, pl_user, pl_password, country=country)
+# Second node will be any node in the selected country.
+node2 = create_node(ec, pl_slice, pl_ssh_key, pl_user, pl_password, 
+        country=country)
 
-# Third node will be a node in France that has Fedora 14 installed.
-operatingSystem = "f14"
-node3 = create_node(ec, username, pl_user, pl_password, country=country,
-                operatingSystem=operatingSystem)
+# Third node will be a node in the selected country and with the selected
+# fedora OS
+node3 = create_node(ec, pl_slice, pl_ssh_key, pl_user, pl_password, 
+        country = country,
+        operatingSystem = os)
 
 # Forth node will have at least 50% of CPU available
 minCpu=50
-node4 = create_node(ec, username, pl_user, pl_password, minCpu=minCpu)
+node4 = create_node(ec, pl_slice, pl_ssh_key, pl_user, pl_password, 
+        minCpu = minCpu)
 
 # Fifth node can be any node, constrains are not important.
-node5 = create_node(ec, username, pl_user, pl_password)
+node5 = create_node(ec, pl_slice, pl_ssh_key, pl_user, pl_password)
 
 # Register the applications to run in the nodes, in this case just ping to the 
 # first node:
-apps_per_node = dict()
 apps = []
 for node in [node2, node3, node4, node5]:
-    command = "ping -c5 %s > ping%s.txt" % (hostname, node)
-    app = add_app(ec, command, node)
-    apps_per_node[node] = app
+    command = "ping -c5 %s" % hostname
+    trace_name = "%s.ping" % hostname
+    app = add_app(ec, command, node, newname = trace_name)
     apps.append(app)
 
 # Register conditions
@@ -125,7 +163,7 @@ for node in [node2, node3, node4, node5]:
 # before the rest of the nodes. This assures that no other resource will use the
 # identified node even if the constraints matchs. 
 # In this example node2, node3, node4 and node5, are deployed after node1 is 
-# provisioned. node1 must be the node planetlab2.utt.fr, meanwhile node2, node3,
+# provisioned. node1 must be the node hostname, meanwhile node2, node3,
 # node4 and node5 just need to fulfill certain constraints.
 # Applications are always deployed after nodes, so no need to register conditions
 # for the apps in this example.
@@ -141,19 +179,7 @@ ec.deploy()
 # Wait until the applications are finish to retrive the traces:
 ec.wait_finished(apps)
 
-traces = dict() 
-for node, app in apps_per_node.iteritems():
-    ping_string = "ping%s.txt" % node
-    trace = ec.trace(app, ping_string)
-    traces[node]= trace
-
-# Choose a directory to store the traces locally, change to a convenient path for you:
-directory = "examples/planetlab/"
-for node, trace in traces.iteritems():
-    trace_file = directory + "ping%s.txt" % node
-    f = open(trace_file, "w")
-    f.write(trace)
-    f.close()
+print "Results stored at", ec.exp_dir
 
 # Do the experiment controller shutdown:
 ec.shutdown()