#!/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 version 2 as
#    published by the Free Software Foundation;
#
#    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 :  Julien Tribino <julien.tribino@inria.fr>
#          Alina Quereilhac <alina.quereilhac@inria.fr>
#
# Topology :
# 
#         Switch1  
#            /               
#           /            
#          /               
#       Host1           
#
#
# Execution example:  
# 
# $ PYTHONPATH=$PYTHONPATH:src/ python examples/openvswitch/ovs_ping.py -n "192.168.3.0/24" -s <slicename> -i /~/.ssh/id_rsa
#

from __future__ import print_function

from nepi.execution.ec import ExperimentController

import os
from optparse import OptionParser
import sys
import time

def parse_args():
    pl_slice = os.environ.get("PL_SLICE")
    pl_user = os.environ.get("PL_USER")
    pl_pass = os.environ.get("PL_PASS")
    identity = os.environ.get("PL_SSHKEY")

    usage = ("usage: %prog -a <host> -b <switch>"
            "-n <vsys_vnet> -C <controller> -s <slicename> -u <pl-user> " 
            "-p <pl-password> -i <ssh-key> ")

    switch = "planetlab2.virtues.fi"
    host = "planetlab2.ionio.gr"

    parser = OptionParser(usage = usage)
    parser.add_option("-a", "--host", dest="host", 
        help="Hostname for PlanetLab host", default=host)
    parser.add_option("-b", "--switch", dest="switch", 
        help="Hostname for PlanetLab switch", default=switch)
    parser.add_option("-n", "--vsys_vnet", dest="vsys_vnet", 
        help="Overlay network address of the form x.x.x.x/yy. "
            "Must correspond to the vsys_vnet tag on the PlanetLab slice")
    parser.add_option("-C", "--controller", dest="controller", 
        help="IP address for the OpenFlow controller, if one has been deployed")
    parser.add_option("-s", "--slicename", dest="slicename", 
        help="Name of PlanetLab slice", 
        default=pl_slice)
    parser.add_option("-u", "--pl_user", dest="pl_user", 
        help="PlanetLab user (email address)", 
        default=pl_user)
    parser.add_option("-p", "--pl_pass", dest="pl_pass", 
        help="PlanetLab password", 
        default=pl_pass)
    parser.add_option("-i", "--identity", dest="identity", 
        help="Path to SSH key", 
        default=identity)

    (options, args) = parser.parse_args()

    return (options.host, options.switch,  
            options.vsys_vnet, options.controller, options.slicename, 
            options.pl_user, options.pl_pass, identity)

(host, switch, vsys_vnet, controller, slicename, 
        pl_user, pl_pass, identity) = parse_args()

# Create the EC
ec = ExperimentController(exp_id = "ovs_ping")

net = vsys_vnet.split("/")
prefix = net[-1]
network = net[0]
net_segs = network.split(".")
ip1 = "%s.1" % ".".join(net_segs[:-1]) # x.x.x.1
ip2 = "%s.2" % ".".join(net_segs[:-1]) # x.x.x.2

# Add OVS switch 
node1 = ec.register_resource("planetlab::Node")
ec.set(node1, "hostname", switch)
ec.set(node1, "username", slicename)
ec.set(node1, "identity", identity)
ec.set(node1, "pluser", pl_user)
ec.set(node1, "plpassword", pl_pass)
ec.set(node1, "cleanExperiment", True)
ec.set(node1, "cleanProcesses", True)

addr1 = "%s/%s" % (ip1, prefix) # x.x.x.1/prefix
ovs = ec.register_resource("planetlab::OVSSwitch")
ec.set(ovs, "bridge_name", "nepi_bridge")
ec.set(ovs, "virtual_ip_pref", addr1)
ec.set(ovs, "controller_ip", controller)
ec.set(ovs, "controller_port", "6633")
ec.register_connection(ovs, node1)

# Add host
node2 = ec.register_resource("planetlab::Node")
ec.set(node2, "hostname", host)
ec.set(node2, "username", slicename)
ec.set(node2, "identity", identity)
ec.set(node2, "pluser", pl_user)
ec.set(node2, "plpassword", pl_pass)
ec.set(node2, "cleanExperiment", True)
ec.set(node2, "cleanProcesses", True)

# Creating overlay
# Add tap device
tap = ec.register_resource("planetlab::Tap")
ec.set(tap, "ip", ip2)
ec.set(tap, "prefix", prefix)
ec.set(tap, "pointopoint", ip1)
ec.register_connection(tap, node2)

# Add ports on OVS
port = ec.register_resource("planetlab::OVSPort")
ec.set(port, "port_name", "nepi_port")
ec.set(port, "network", network)
ec.register_connection(port, ovs)

# Add tunnel between host and switch
tunnel = ec.register_resource("linux::UdpTunnel")
ec.register_connection(port, tunnel)
ec.register_connection(tunnel, tap)

## Ping switch from host
app = ec.register_resource("linux::Application")
ec.set(app, "command", "ping -c5 %s" % ip1)
ec.register_connection(app, node2)

ec.deploy()

ec.wait_finished([app])

# Retreive ping results and save them in a file
ping = ec.trace(app, "stdout")

print(ping)

# Delete the overlay network
ec.shutdown()