tweaked ping.py for inclusion in r2lab's tutorials - essentially as-is, except for...

diff --git a/examples/linux/ping.py b/examples/linux/ping.py
index 2f7b4ee..4d6c7a9 100644 (file)
--- a/examples/linux/ping.py
+++ b/examples/linux/ping.py
@@ -17,26 +17,38 @@
 #
 # Author: Alina Quereilhac <alina.quereilhac@inria.fr>
 
-# Example of how to run this experiment (replace with your information):
+# This very simple experiment will ssh in a linux box, and from there
+# issue a ping command towards a landmark (default faraday.inria.fr)
 #
-# $ cd <path-to-nepi>
-# python examples/linux/ping.py -a <hostname> -u <username> -i <ssh-key>
+# $ ping.py -u root mybox.domain.com
+# 
+# would do the equivalent of
+# ssh root@mybox.domain.com ping -c3 faraday.inria.fr
+#
+# If nepi is not installed in your system, and you only have a git clone
+# you might wish to do instead
+#  
+# $ cd <path-to-nepi>/src
+# $ python ../examples/linux/ping.py -u root mybox.domain.com
 
+# let's be ready for python3
 from __future__ import print_function
 
+import os
+from argparse import ArgumentParser
+
 from nepi.execution.ec import ExperimentController 
 
-# SUPPRESS_HELP was not used here, but:
-# to suppress an arg from the help, use
-# add_argument( help=argparse.SUPPRESS)
-from argparse import ArgumentParser
-import os
+# 
+default_landmark = "faraday.inria.fr"
 
 parser = ArgumentParser()
 parser.add_argument("-u", "--username", dest="username", 
                     help="Username to SSH to remote host")
 parser.add_argument("-i", "--ssh-key", dest="ssh_key", 
                     help="Path to private SSH key to be used for connection")
+parser.add_argument("-l", "--landmark", dest='landmark', default=default_landmark,
+                    help="Set pings destination, default={}".format(default_landmark))
 # this is required
 parser.add_argument("hostname", type=str)
 
@@ -45,6 +57,7 @@ args = parser.parse_args()
 hostname = args.hostname
 username = args.username
 ssh_key = args.ssh_key
+landmark = args.landmark
 
 ec = ExperimentController(exp_id = "ping-exp")
         
@@ -56,7 +69,7 @@ ec.set(node, "cleanExperiment", True)
 ec.set(node, "cleanProcesses", True)
 
 app = ec.register_resource("linux::Application")
-ec.set(app, "command", "ping -c3 nepi.inria.fr")
+ec.set(app, "command", "ping -c3 {}".format(landmark))
 ec.register_connection(app, node)
 
 ec.deploy()