OMF examples
authorAlina Quereilhac <alina.quereilhac@inria.fr>
Wed, 24 Sep 2014 20:45:31 +0000 (22:45 +0200)
committerAlina Quereilhac <alina.quereilhac@inria.fr>
Wed, 24 Sep 2014 20:45:31 +0000 (22:45 +0200)
examples/omf/iminds_omf6_ping.py
examples/omf/iminds_omf6_vlc.ns [new file with mode: 0644]
examples/omf/iminds_omf6_vlc.py [new file with mode: 0644]
examples/omf/nitos_omf6_ping.py
examples/omf/nitos_omf6_vlc.py [new file with mode: 0644]
src/nepi/resources/omf/omf6_parser.py

index 08c3efe..327409d 100644 (file)
@@ -26,7 +26,7 @@
 # Topology
 #
 #
-#  Testbed : IMinds
+#  Testbed : iMinds
 #
 #     Node
 #     node0ZZ 
@@ -37,7 +37,6 @@
 #     Node
 #     node0ZZ 
 #     PING
-#     
 #   
 #      - Experiment:
 #        - t0 : Deployment
@@ -67,9 +66,6 @@ parser.add_option("-z", "--nodez", dest="nodez",
             " nodex.<experiment_id>.<project_id>.wilab2.ilabt.iminds.be"
             " all letters in lowercase )", 
         type="str")
-parser.add_option("-c", "--channel", dest="channel", 
-        help="Nitos reserved channel",
-        type="str")
 parser.add_option("-s", "--slice-name", dest="slicename", 
         help="Nitos slice name", type="str")
 (options, args) = parser.parse_args()
@@ -77,7 +73,6 @@ parser.add_option("-s", "--slice-name", dest="slicename",
 nodex = options.nodex
 nodez = options.nodez
 slicename = options.slicename
-chan = options.channel
 
 # Create the EC
 ec = ExperimentController(exp_id="iminds_omf6_ping")
@@ -124,16 +119,19 @@ app1 = ec.register_resource("OMFApplication")
 ec.set(app1, "command", "ping -c3 192.168.0.2") 
 ec.register_connection(app1, node1)
 
-ec.register_condition([app1], ResourceAction.STOP, [app1], 
+## Make sure the ping stops after 30 seconds
+ec.register_condition(app1, ResourceAction.STOP, app1, 
         ResourceState.STARTED , "30s")
 
 # Deploy
 ec.deploy()
 
+# Wait until the VLC client is finished
 ec.wait_finished([app1])
 
-# RESULT
-print ec.trace(app1, "stdout")
+# Retrieve the output of the ping command
+ping_output = ec.trace(app1, "stdout")
+print "\n PING OUTPUT\n", ping_output, "\n"
 
 # Stop Experiment
 ec.shutdown()
diff --git a/examples/omf/iminds_omf6_vlc.ns b/examples/omf/iminds_omf6_vlc.ns
new file mode 100644 (file)
index 0000000..9d8e320
--- /dev/null
@@ -0,0 +1,17 @@
+# Generated by NetlabClient
+
+set ns [new Simulator]
+source tb_compat.tcl
+
+# Nodes
+set node0 [$ns node]
+tb-set-node-os $node0 NepiVlcOMF6Baseline
+set node1 [$ns node]
+tb-set-node-os $node1 NepiVlcOMF6Baseline
+
+$ns rtproto Static
+$ns run
+
+# NetlabClient generated file ends here.
+# Finished at: 6/19/14 5:38 PM
+
diff --git a/examples/omf/iminds_omf6_vlc.py b/examples/omf/iminds_omf6_vlc.py
new file mode 100644 (file)
index 0000000..18f6ebd
--- /dev/null
@@ -0,0 +1,172 @@
+#!/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/>.
+#
+# Authors: Alina Quereilhac <alina.quereilhac@inria.fr>
+#         Julien Tribino <julien.tribino@inria.fr>
+#
+###############################################################################
+      
+# Topology
+#
+#
+#  Testbed : iMinds
+#
+#     Node
+#     node0ZZ 
+#     0
+#     |
+#     |
+#     0
+#     Node
+#     node0ZZ 
+#     PING
+#     
+#   
+#      - Experiment:
+#        - t0 : Deployment
+#        - t1 : Ping Start
+#        - t2 (t1 + 10s) : Ping stop
+#        - t3 (t2 + 2s) : Kill the application
+#
+
+from nepi.execution.resource import ResourceAction, ResourceState
+from nepi.execution.ec import ExperimentController
+
+from optparse import OptionParser
+import os
+
+usage = ("usage: %prog -x <nodex> -z <nodez> -s <slice-name> -c <channel>")
+
+parser = OptionParser(usage = usage)
+parser.add_option("-x", "--nodex", dest="nodex", 
+        help="w-iLab.t first reserved node "
+            "(must be of form:  "
+            " nodex.<experiment_id>.<project_id>.wilab2.ilabt.iminds.be"
+            " all letters in lowercase )", 
+        type="str")
+parser.add_option("-z", "--nodez", dest="nodez", 
+        help="w-iLab.t first reserved node "
+             "(must be of form:  "
+            " nodex.<experiment_id>.<project_id>.wilab2.ilabt.iminds.be"
+            " all letters in lowercase )", 
+        type="str")
+parser.add_option("-c", "--channel", dest="channel", 
+        help="Nitos reserved channel",
+        type="str")
+parser.add_option("-s", "--slice-name", dest="slicename", 
+        help="Nitos slice name", type="str")
+(options, args) = parser.parse_args()
+
+nodex = options.nodex
+nodez = options.nodez
+slicename = options.slicename
+chan = options.channel
+
+# Create the EC
+ec = ExperimentController(exp_id="iminds_omf6_ping")
+
+# Create and Configure the Nodes
+
+node1 = ec.register_resource("OMFNode")
+ec.set(node1, "hostname", nodex)
+ec.set(node1, "xmppUser", slicename)
+ec.set(node1, "xmppServer", "xmpp.ilabt.iminds.be")
+ec.set(node1, "xmppPort", "5222")
+ec.set(node1, "xmppPassword", "1234")
+
+iface1 = ec.register_resource("OMFWifiInterface")
+ec.set(iface1, "name", "wlan0")
+ec.set(iface1, "mode", "adhoc")
+ec.set(iface1, "hw_mode", "g")
+ec.set(iface1, "essid", "ping")
+ec.set(iface1, "ip", "192.168.0.1/24")
+ec.register_connection(iface1, node1)
+
+node2 = ec.register_resource("OMFNode")
+ec.set(node2, "hostname", nodez)
+ec.set(node2, "xmppUser", slicename)
+ec.set(node2, "xmppServer", "xmpp.ilabt.iminds.be")
+ec.set(node2, "xmppPort", "5222")
+ec.set(node2, "xmppPassword", "1234")
+
+iface2 = ec.register_resource("OMFWifiInterface")
+ec.set(iface2, "name", "wlan0")
+ec.set(iface2, "mode", "adhoc")
+ec.set(iface2, "hw_mode", "g")
+ec.set(iface2, "essid", "vlc")
+ec.set(iface2, "ip", "192.168.0.2/24")
+ec.register_connection(iface2, node2)
+
+channel = ec.register_resource("OMFChannel")
+ec.set(channel, "channel", "6")
+ec.register_connection(iface1, channel)
+ec.register_connection(iface2, channel)
+
+client_ip = "192.168.0.2" 
+
+# Create and Configure the Application
+app1 = ec.register_resource("OMFApplication")
+ec.set(app1, "command", 
+    "DISPLAY=localhost:10.0 XAUTHORITY=/root/.Xauthority /root/vlc/vlc-1.1.13/cvlc /root/10-by-p0d.avi --sout '#rtp{dst=%s,port=5004,mux=ts}'" % client_ip) 
+ec.register_connection(app1, node1)
+
+## Add a OMFApplication to run the client VLC and count the numer of bytes 
+## transmitted,  using wc.
+app2 = ec.register_resource("OMFApplication")
+## Send the transmitted video to a file.
+ec.set(app2, "command", "DISPLAY=localhost:10.0 XAUTHORITY=/root/.Xauthority /root/vlc/vlc-1.1.13/cvlc rtp://%s:5004 --sout '#standard{access=file,mux=ts,dst=/root/video}'" % client_ip)
+
+## Alternativelly, you can try to send the video to standard output and 
+## recover it using the stdout trace. However, it seems that sending 
+## binary messages back to the client is not well supported by the OMF 6 RC
+#ec.set(app2, "command", "DISPLAY=localhost:10.0 XAUTHORITY=/root/.Xauthority /root/vlc/vlc-1.1.13/cvlc rtp://%s:5004 --sout '#standard{access=file,mux=ts,dst=-}'" % client_ip)
+ec.register_connection(app2, node2)
+
+## stop app1 65s after it started
+ec.register_condition(app1, ResourceAction.STOP, app1, ResourceState.STARTED , "65s")
+## start app2 5s after app1
+ec.register_condition(app2, ResourceAction.START, app1, ResourceState.STARTED , "5s")
+## stop app2 5 seconds after app2
+ec.register_condition(app2, ResourceAction.STOP, app1, ResourceState.STOPPED , "5s")
+
+# Deploy
+ec.deploy()
+
+ec.wait_finished([app2])
+
+# Retrieve the bytes transmitted count and print it
+byte_count = ec.trace(app2, "stdout")
+print "BYTES transmitted", byte_count
+
+## If you redirected the video to standard output, you can try to 
+## retrieve the stdout of the VLC client
+## video = ec.trace(app2, "stdout")
+#f = open("video.ts", "w")
+#f.write(video)
+#f.close()
+
+# Stop Experiment
+ec.shutdown()
+# RESULT
+print ec.trace(app1, "stdout")
+
+# Stop Experiment
+ec.shutdown()
+
index 0fcb288..1f6d871 100644 (file)
@@ -112,7 +112,6 @@ ec.set(iface2, "essid", "ping")
 ec.set(iface2, "ip", "192.168.0.%s/24" % nodez[-2:]) 
 ec.register_connection(node2, iface2)
 
-
 # Create and Configure the Channel
 channel = ec.register_resource("OMFChannel")
 ec.set(channel, "channel", chan)
@@ -129,22 +128,18 @@ ec.set(app1, "appid", "Ping#1")
 ec.set(app1, "command", "/bin/ping -c3 192.168.0.%s" % nodez[-2:])
 ec.register_connection(app1, node1)
 
-app2 = ec.register_resource("OMFApplication")
-ec.set(app2, "appid", "Kill#1")
-ec.set(app2, "command", "/usr/bin/killall ping")
-ec.register_connection(app2, node1)
-
-# User Behaviour
-ec.register_condition(app1, ResourceAction.STOP, app1, ResourceState.STARTED , "10s")
-ec.register_condition(app2, ResourceAction.START, app1, ResourceState.STARTED , "12s")
-ec.register_condition(app2, ResourceAction.STOP, app2, ResourceState.STARTED , "1s")
+## Make sure the ping stops after 30 seconds
+ec.register_condition(app1, ResourceAction.STOP, app1, 
+        ResourceState.STARTED , "30s")
 
 # Deploy
 ec.deploy()
 
-ec.wait_finished([app1, app2])
+ec.wait_finished([app1])
 
-print ec.trace(app1, "stdout")
+# Retrieve the output of the ping command
+ping_output = ec.trace(app1, "stdout")
+print "\n PING OUTPUT\n", ping_output, "\n"
 
 # Stop Experiment
 ec.shutdown()
diff --git a/examples/omf/nitos_omf6_vlc.py b/examples/omf/nitos_omf6_vlc.py
new file mode 100644 (file)
index 0000000..749dd35
--- /dev/null
@@ -0,0 +1,171 @@
+#!/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/>.
+#
+# Authors: Alina Quereilhac <alina.quereilhac@inria.fr>
+#         Julien Tribino <julien.tribino@inria.fr>
+#
+###############################################################################
+      
+# Topology
+#
+#
+#  Testbed : Nitos
+#
+#     Node
+#     node0XX
+#     VLC client
+#     0
+#     |
+#     |
+#     0
+#     Node
+#     node0ZZ 
+#     VLC server
+#     
+#   
+#      - Experiment:
+#        - t0 : Deployment
+#        - t1 : Ping Start
+#        - t2 (t1 + 10s) : Ping stop
+#        - t3 (t2 + 2s) : Kill the application
+#
+
+from nepi.execution.resource import ResourceAction, ResourceState
+from nepi.execution.ec import ExperimentController
+
+from optparse import OptionParser
+import os
+
+usage = ("usage: %prog -x <nodex> -z <nodez> -s <slice-name> -c <channel>")
+
+parser = OptionParser(usage = usage)
+parser.add_option("-x", "--nodex", dest="nodex", 
+        help="Nitos first reserved node "
+            "(e.g. hostname must be of form: node0XX)", 
+        type="str")
+parser.add_option("-z", "--nodez", dest="nodez", 
+        help="Nitos second reserved node "
+            "(e.g. hostname must be of form: node0ZZ)", 
+        type="str")
+parser.add_option("-c", "--channel", dest="channel", 
+        help="Nitos reserved channel",
+        type="str")
+parser.add_option("-s", "--slice-name", dest="slicename", 
+        help="Nitos slice name", type="str")
+(options, args) = parser.parse_args()
+
+nodex = options.nodex
+nodez = options.nodez
+slicename = options.slicename
+chan = options.channel
+
+# Create the EC
+ec = ExperimentController(exp_id="nitos_omf6_vlc")
+
+# Create and Configure the Nodes
+node1 = ec.register_resource("OMFNode")
+ec.set(node1, "hostname", nodex)
+ec.set(node1, "xmppUser", slicename)
+ec.set(node1, "xmppServer", "nitlab.inf.uth.gr")
+ec.set(node1, "xmppPort", "5222")
+ec.set(node1, "xmppPassword", "1234")
+
+# Create and Configure the Interfaces
+iface1 = ec.register_resource("OMFWifiInterface")
+ec.set(iface1, "name", "wlan0")
+ec.set(iface1, "mode", "adhoc")
+ec.set(iface1, "hw_mode", "g")
+ec.set(iface1, "essid", "ping")
+ec.set(iface1, "ip", "192.168.0.%s/24" % nodex[-2:]) 
+ec.register_connection(node1, iface1)
+
+# Create and Configure the Nodes
+node2 = ec.register_resource("OMFNode")
+ec.set(node2, "hostname", nodez)
+ec.set(node2, "xmppUser", slicename)
+ec.set(node2, "xmppServer", "nitlab.inf.uth.gr")
+ec.set(node2, "xmppPort", "5222")
+ec.set(node2, "xmppPassword", "1234")
+
+# Create and Configure the Interfaces
+iface2 = ec.register_resource("OMFWifiInterface")
+ec.set(iface2, "name", "wlan0")
+ec.set(iface2, "mode", "adhoc")
+ec.set(iface2, "hw_mode", "g")
+ec.set(iface2, "essid", "ping")
+ec.set(iface2, "ip", "192.168.0.%s/24" % nodez[-2:]) 
+ec.register_connection(node2, iface2)
+
+# Create and Configure the Channel
+channel = ec.register_resource("OMFChannel")
+ec.set(channel, "channel", chan)
+ec.set(channel, "xmppUser", slicename)
+ec.set(channel, "xmppServer", "nitlab.inf.uth.gr")
+ec.set(channel, "xmppPort", "5222")
+ec.set(channel, "xmppPassword", "1234")
+ec.register_connection(iface1, channel)
+ec.register_connection(iface2, channel)
+
+client_ip = "192.168.0.%s" % nodez[-2:]
+
+# Create and Configure the Application
+app1 = ec.register_resource("OMFApplication")
+ec.set(app1, "command", 
+    "DISPLAY=localhost:10.0 XAUTHORITY=/root/.Xauthority /root/vlc/vlc-1.1.13/cvlc /root/10-by-p0d.avi --sout '#rtp{dst=%s,port=5004,mux=ts}'" % client_ip) 
+ec.register_connection(app1, node1)
+
+## Add a OMFApplication to run the client VLC and count the numer of bytes 
+## transmitted,  using wc.
+app2 = ec.register_resource("OMFApplication")
+ec.set(app2, "command", 
+    "DISPLAY=localhost:10.0 XAUTHORITY=/root/.Xauthority /root/vlc/vlc-1.1.13/cvlc rtp://%s:5004 | wc -c "% client_ip)
+
+## Alternativelly, you can try to send the video to standard output and 
+## recover it using the stdout trace. However, it seems that sending 
+## binary messages back to the client is not well supported by the OMF 6 RC
+#ec.set(app2, "command", "DISPLAY=localhost:10.0 XAUTHORITY=/root/.Xauthority /root/vlc/vlc-1.1.13/cvlc rtp://%s:5004 --sout '#standard{access=file,mux=ts,dst=-}'" % client_ip)
+ec.register_connection(app2, node2)
+
+## stop app1 65s after it started
+ec.register_condition(app1, ResourceAction.STOP, app1, ResourceState.STARTED , "65s")
+## start app2 5s after app1
+ec.register_condition(app2, ResourceAction.START, app1, ResourceState.STARTED , "5s")
+## stop app2 5 seconds after app2
+ec.register_condition(app2, ResourceAction.STOP, app1, ResourceState.STOPPED , "5s")
+
+# Deploy
+ec.deploy()
+
+ec.wait_finished([app2])
+
+# Retrieve the bytes transmitted count and print it
+byte_count = ec.trace(app2, "stdout")
+print "BYTES transmitted", byte_count
+
+## If you redirected the video to standard output, you can try to 
+## retrieve the stdout of the VLC client
+## video = ec.trace(app2, "stdout")
+#f = open("video.ts", "w")
+#f.write(video)
+#f.close()
+
+# Stop Experiment
+ec.shutdown()
+
index c3b37a8..6e72077 100644 (file)
@@ -20,6 +20,7 @@
 
 from nepi.util.logger import Logger
 
+import os
 import traceback
 import xml.etree.ElementTree as ET
 
@@ -174,22 +175,6 @@ class OMF6Parser(Logger):
         uid = self._check_for_tag(root, namespaces, "uid")
         event = self._check_for_tag(root, namespaces, "event")
 
-        if event == "STDOUT":
-            if not uid+'out' in self.traces:
-                f = open('/tmp/'+ uid + '.out','w')
-                self.traces[uid+'out'] = f
-            self.trace = self.traces[uid+'out']
-        elif event == "STDERR" :
-            if not uid+'err' in self.traces:
-                g = open('/tmp/'+ uid + '.err','w')
-                self.traces[uid+'err'] = g
-            self.trace = self.traces[uid+'err']
-        elif event == "EXIT" :
-            if uid+'out' in self.traces:
-                self.traces[uid+'out'].close()
-            if uid+'err' in self.traces:
-                self.traces[uid+'err'].close()
-            
         log = "STATUS -- "
         for elt in props.keys():
             ns, tag = elt.split('}')
@@ -199,8 +184,20 @@ class OMF6Parser(Logger):
                 self.mailbox['started'].append(uid)
                 log = log + "event : " + props[elt]+" -- "
             elif tag == "msg":
-                if event == "STDOUT" or event == "STDERR" :
-                    self.trace.write(props[elt]+'\n')
+                if event == "STDOUT" : 
+                    filename = os.path.join("/tmp", "%s.out" % uid)
+                    f = open(filename,'a+')
+                    # XXX: Adding fake \n for visual formatting 
+                    msg = props[elt] + "\n"
+                    f.write(msg)
+                    f.close()
+                elif event == "STDERR" :
+                    filename = os.path.join("/tmp", "%s.err" % uid)
+                    f = open(filename,'a+')
+                    # XXX: Adding fake \n for visual formatting 
+                    msg = props[elt] + "\n"
+                    f.write(msg)
+                    f.close()
                 log = log + tag +" : " + props[elt]+" -- "
             else:
                 log = log + tag +" : " + props[elt]+" -- "