Cleaning up examples folder
[nepi.git] / examples / linux / testing / ccncat_2_nodes.py
diff --git a/examples/linux/testing/ccncat_2_nodes.py b/examples/linux/testing/ccncat_2_nodes.py
new file mode 100644 (file)
index 0000000..7efe118
--- /dev/null
@@ -0,0 +1,242 @@
+#!/usr/bin/env python
+
+#
+#    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 as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    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>
+
+
+# NOTE: This experiment example uses the generic LinuxApplication
+#       ResourceManager to do the CCN set up in the hosts.
+#       Alternatively, CCN specific ResourceManagers can be used
+#       (i.e. LinuxCCND, LinuxCCNR, etc...), and those require less 
+#       manual configuration.
+#
+#
+
+# CCN topology:
+#
+#                
+#                 
+#  content                ccncat
+#  Linux host               Linux host
+#  0 ------- Internet ------ 0
+#           
+
+from nepi.execution.ec import ExperimentController, ECState 
+from nepi.execution.resource import ResourceState, ResourceAction 
+from nepi.resources.linux.node import OSType
+
+from optparse import OptionParser, SUPPRESS_HELP
+
+import getpass
+import os
+import time
+
+def add_node(ec, host, user, ssh_key = None):
+    node = ec.register_resource("LinuxNode")
+    ec.set(node, "hostname", host)
+    ec.set(node, "username", user)
+    ec.set(node, "identity", ssh_key)
+    ec.set(node, "cleanHome", True)
+    ec.set(node, "cleanProcesses", True)
+    return node
+
+def add_ccnd(ec, os_type, peers):
+    if os_type == OSType.FEDORA:
+        depends = ( " autoconf openssl-devel  expat-devel libpcap-devel "
+                " ecryptfs-utils-devel libxml2-devel automake gawk " 
+                " gcc gcc-c++ git pcre-devel make ")
+    else: # UBUNTU
+        depends = ( " autoconf libssl-dev libexpat-dev libpcap-dev "
+                " libecryptfs0 libxml2-utils automake gawk gcc g++ "
+                " git-core pkg-config libpcre3-dev make ")
+
+    sources = "http://www.ccnx.org/releases/ccnx-0.7.1.tar.gz"
+
+    build = (
+        # Evaluate if ccnx binaries are already installed
+        " ( "
+            "  test -f ${BIN}/ccnx-0.7.1/bin/ccnd"
+        " ) || ( "
+        # If not, untar and build
+            " ( "
+                " mkdir -p ${SRC}/ccnx-0.7.1 && "
+                " tar xf ${SRC}/ccnx-0.7.1.tar.gz --strip-components=1 -C ${SRC}/ccnx-0.7.1 "
+             " ) && "
+                "cd ${SRC}/ccnx-0.7.1 && "
+                # Just execute and silence warnings...
+                "( ./configure && make ) "
+         " )") 
+
+    install = (
+        # Evaluate if ccnx binaries are already installed
+        " ( "
+            "  test -f ${BIN}/ccnx-0.7.1/bin/ccnd"
+        " ) || ( "
+            "  mkdir -p ${BIN}/ccnx-0.7.1/bin && "
+            "  cp -r ${SRC}/ccnx-0.7.1/bin ${BIN}/ccnx-0.7.1"
+        " )"
+    )
+
+    env = "PATH=$PATH:${BIN}/ccnx-0.7.1/bin"
+
+    # BASH command -> ' ccndstart ; ccndc add ccnx:/ udp  host ;  ccnr '
+    command = "ccndstart && "
+    peers = map(lambda peer: "ccndc add ccnx:/ udp  %s" % peer, peers)
+    command += " ; ".join(peers) + " && "
+    command += " ccnr & "
+
+    app = ec.register_resource("LinuxApplication")
+    ec.set(app, "depends", depends)
+    ec.set(app, "sources", sources)
+    ec.set(app, "install", install)
+    ec.set(app, "build", build)
+    ec.set(app, "env", env)
+    ec.set(app, "command", command)
+
+    return app
+
+def add_publish(ec, movie):
+    env = "PATH=$PATH:${BIN}/ccnx-0.7.1/bin"
+    command = "ccnseqwriter -r ccnx:/VIDEO"
+
+    app = ec.register_resource("LinuxApplication")
+    ec.set(app, "stdin", movie)
+    ec.set(app, "env", env)
+    ec.set(app, "command", command)
+
+    return app
+
+def add_stream(ec):
+    env = "PATH=$PATH:${BIN}/ccnx-0.7.1/bin"
+    command = "sudo -S dbus-uuidgen --ensure ; ( ccncat ccnx:/VIDEO | vlc - ) "
+
+    app = ec.register_resource("LinuxApplication")
+    ec.set(app, "depends", "vlc")
+    ec.set(app, "forwardX11", True)
+    ec.set(app, "env", env)
+    ec.set(app, "command", command)
+
+    return app
+
+def get_options():
+    pl_slice = os.environ.get("PL_SLICE")
+
+    # We use a specific SSH private key for PL if the PL_SSHKEY is specified or the
+    # id_rsa_planetlab exists 
+    default_key = "%s/.ssh/id_rsa_planetlab" % (os.environ['HOME'])
+    default_key = default_key if os.path.exists(default_key) else None
+    pl_ssh_key = os.environ.get("PL_SSHKEY", default_key)
+
+    # Default planetlab host
+    pl_host = "planetlab2.u-strasbg.fr"
+
+    # Another Linux host 
+    # IMPORTANT NOTE: you must replace this host for another one
+    #       you have access to. You must set up your SSH keys so
+    #       the host can be accessed through SSH without prompting
+    #       for a password. The host must allow X forwarding using SSH.
+    linux_host = 'roseval.pl.sophia.inria.fr'
+    linux_user = getpass.getuser()
+    
+    usage = "usage: %prog -p <pl-host> -s <pl-slice> -l <linux-host> -u <linux-user> -m <movie> -e <exp-id> -i <ssh_key>"
+
+    parser = OptionParser(usage=usage)
+    parser.add_option("-p", "--pl-host", dest="pl_host", 
+            help="PlanetLab hostname (already added to the <pl-slice> on the web site)", 
+            default = pl_host, type="str")
+    parser.add_option("-s", "--pl-slice", dest="pl_slice", 
+            help="PlanetLab slicename", default = pl_slice, type="str")
+    parser.add_option("-l", "--linux-host", dest="linux_host", 
+            help="Hostname of second Linux host (non PlanetLab)",
+            default = linux_host, type="str")
+    parser.add_option("-u", "--linux-user", dest="linux_user", 
+            help="User for extra Linux host (non PlanetLab)", 
+            default = linux_user, type="str")
+    parser.add_option("-m", "--movie", dest="movie", 
+            help="Stream movie", type="str")
+    parser.add_option("-e", "--exp-id", dest="exp_id", 
+            help="Label to identify experiment", type="str")
+    parser.add_option("-i", "--pl-ssh-key", dest="pl_ssh_key", 
+            help="Path to private SSH key to be used for connection", 
+            default = pl_ssh_key, type="str")
+
+    (options, args) = parser.parse_args()
+
+    if not options.movie:
+        parser.error("movie is a required argument")
+
+    return (options.pl_host, options.pl_slice, options.linux_host, 
+            options.linux_user, options.movie, options.exp_id, 
+            options.pl_ssh_key)
+
+if __name__ == '__main__':
+    ( pl_host, pl_user, linux_host, linux_user, movie, exp_id, pl_ssh_key 
+            ) = get_options()
+
+    # Create the ExperimentController instance
+    ec = ExperimentController(exp_id = exp_id)
+
+    # Register ResourceManager (RM) 
+
+    # Register first PlanetLab host
+    node1 = add_node(ec, pl_host, pl_user, pl_ssh_key)
+
+    # Register CCN setup for PL host
+    peers = [linux_host]
+    ccnd1 = add_ccnd(ec, OSType.FEDORA, peers)
+    ec.register_connection(ccnd1, node1)
+
+    # Register content producer application (ccnseqwriter)
+    pub = add_publish(ec, movie)
+    ec.register_connection(pub, node1)
+
+    # The movie can only be published after ccnd is running
+    ec.register_condition(pub, ResourceAction.START, 
+            ccnd1, ResourceState.STARTED)
+   
+    # Register Linux host
+    node2 = add_node(ec, linux_host, linux_user)
+
+    # Register CCN setup for Linux host
+    peers = [pl_host]
+    ccnd2 = add_ccnd(ec, "ubuntu", peers)
+    ec.register_connection(ccnd2, node2)
+     
+    # Register consumer application (ccncat)
+    stream = add_stream(ec)
+    ec.register_connection(stream, node2)
+
+    # The stream can only be retrieved after ccnd is running
+    ec.register_condition(stream, ResourceAction.START, 
+            ccnd2, ResourceState.STARTED)
+
+    # And also, the stream can only be retrieved after it was published
+    ec.register_condition(stream, ResourceAction.START, 
+            pub, ResourceState.STARTED)
+    # Deploy all ResourceManagers
+    ec.deploy()
+
+    # Wait until the applications are finished
+    apps = [ccnd1, pub, ccnd2, stream]
+    ec.wait_finished(apps)
+
+    # Shutdown the experiment controller
+    ec.shutdown()
+