#! /usr/bin/env python

## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-

#

# Copyright (c) 2009 University of Washington

#

# 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, write to the Free Software

# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

#

import os

import sys

import optparse

import subprocess

import threading

import Queue

import signal

import random

import xml.dom.minidom

import shutil

#

# XXX This should really be part of a waf command to list the configuration

# items relative to optional ns-3 pieces.

#

# A list of interesting configuration items in the waf configuration 

# cache which we may be interested in when deciding on which examples

# to run and how to run them.  These are set by waf during the 

# configuration phase and the corresponding assignments are usually

# found in the associated subdirectory wscript files.

#

interesting_config_items = [

    "NS3_BUILDDIR",

    "NS3_MODULE_PATH",

    "ENABLE_NSC",

    "ENABLE_REAL_TIME",

]

ENABLE_NSC = False

ENABLE_REAL_TIME = False

#

# A list of examples to run as smoke tests just to ensure that they remain 

# buildable and runnable over time.  Also a condition under which to run

# the example (from the waf configuration).

#

# XXX Should this not be read from a configuration file somewhere and not

# hardcoded.

#

example_tests = [

    ("csma-bridge", "True"),

    ("csma-bridge-one-hop", "True"),

    ("csma-broadcast", "True"),

    ("csma-multicast", "True"),

    ("csma-one-subnet", "True"),

    ("csma-packet-socket", "True"),

    ("csma-ping", "True"),

    ("csma-raw-ip-socket", "True"),

    ("csma-star", "True"),

    ("dynamic-global-routing", "True"),

    ("first", "True"),

    ("global-injection-slash32", "True"),

    ("global-routing-slash32", "True"),

    ("hello-simulator", "True"),

    ("icmpv6-redirect", "True"),

    ("mesh", "True"),

    ("mixed-global-routing", "True"),

    ("mixed-wireless", "True"),

    ("multirate", "False"), # takes forever to run

    ("nix-simple", "True"),

    ("nms-p2p-nix", "False"), # takes forever to run

    ("object-names", "True"),

    ("ping6", "True"),

    ("radvd", "True"),

    ("radvd-two-prefix", "True"),    

    ("realtime-udp-echo", "ENABLE_REAL_TIME == True"),

    ("second", "True"),

    ("simple-alternate-routing", "True"),

    ("simple-error-model", "True"),

    ("simple-global-routing", "True"),

    ("simple-point-to-point-olsr", "True"),

    ("simple-routing-ping6", "True"),

    ("simple-wifi-frame-aggregation", "True"),

    ("star", "True"),

    ("static-routing-slash32", "True"),

    ("tcp-large-transfer", "True"),

    ("tcp-nsc-zoo", "ENABLE_NSC == True"),

    ("tcp-star-server", "True"),

    ("test-ipv6", "True"),

    ("third", "True"),

    ("udp-echo", "True"),

    ("virtual-net-device", "True"),

    ("wifi-adhoc", "False"), # takes forever to run

    ("wifi-ap", "True"),

    ("wifi-wired-bridging", "True"),

]

#

# Most of the examples produce gangs of trace files, so we want to find

# somewhere to put them that won't pollute the current directory.  One

# obvious place is somewhere in /tmp.

#

TMP_TRACES_DIR = "/tmp/unchecked-traces"

#

# The test suites are going to want to output status.  They are running

# concurrently.  This means that unless we are careful, the output of

# the test suites will be interleaved.  Rather than introducing a lock

# file that could unintentionally start serializing execution, we ask

# the tests to write their output to a temporary directory and then 

# put together the final output file when we "join" the test tasks back

# to the main thread.

#

TMP_OUTPUT_DIR = "/tmp/testpy"

def get_node_text(node):

    for child in node.childNodes:

        if child.nodeType == child.TEXT_NODE:

            return child.nodeValue

    return "None"

#

#

def translate_to_text(results_file, text_file):

    f = open(text_file, 'w')

    dom = xml.dom.minidom.parse(results_file)

    for suite in dom.getElementsByTagName("TestSuite"):

        result = get_node_text(suite.getElementsByTagName("SuiteResult")[0])

        name = get_node_text(suite.getElementsByTagName("SuiteName")[0])

        time = get_node_text(suite.getElementsByTagName("SuiteTime")[0])

        output = "%s: Test Suite \"%s\" (%s)\n" % (result, name, time)

        f.write(output)

        if result != "CRASH":

            for case in suite.getElementsByTagName("TestCase"):

                result = get_node_text(case.getElementsByTagName("CaseResult")[0])

                name = get_node_text(case.getElementsByTagName("CaseName")[0])

                time = get_node_text(case.getElementsByTagName("CaseTime")[0])

                output =   "  %s: Test Case \"%s\" (%s)\n" % (result, name, time)

                f.write(output)

                if result == "FAIL":

    for example in dom.getElementsByTagName("Example"):

        result = get_node_text(example.getElementsByTagName("Result")[0])

        name = get_node_text(example.getElementsByTagName("Name")[0])

        output = "%s: Example \"%s\"\n" % (result, name)

        f.write(output)

    f.close()

#

#

def translate_to_html(results_file, html_file):

    f = open(html_file, 'w')

    f.write("<html>\n")

    f.write("<body>\n")

    f.write("<center><h1>ns-3 Test Results</h1></center>\n")

    dom = xml.dom.minidom.parse(results_file)

    f.write("<h2>Test Suites</h2>\n")

    for suite in dom.getElementsByTagName("TestSuite"):

        name = get_node_text(suite.getElementsByTagName("SuiteName")[0])

        result = get_node_text(suite.getElementsByTagName("SuiteResult")[0])

        time = get_node_text(suite.getElementsByTagName("SuiteTime")[0])

        if result == "PASS":

            f.write("<h3 style=\"color:green\">%s: %s (%s)</h3>\n" % (result, name, time))

        else:

            f.write("<h3 style=\"color:red\">%s: %s (%s)</h3>\n" % (result, name, time))

        f.write("<th> Result </th>\n")

        if result == "CRASH":

            f.write("<tr>\n")

            f.write("<td style=\"color:red\">%s</td>\n" % result)

            f.write("</tr>\n")

            f.write("</table>\n")

            continue

        f.write("<th>Test Case Name</th>\n")

        f.write("<th> Time </th>\n")

        if result == "FAIL":

        for case in suite.getElementsByTagName("TestCase"):

            name = get_node_text(case.getElementsByTagName("CaseName")[0])

            result = get_node_text(case.getElementsByTagName("CaseResult")[0])

            time = get_node_text(case.getElementsByTagName("CaseTime")[0])

            if result == "FAIL":

            else:

                f.write("<td style=\"color:green\">%s</td>\n" % result)

                f.write("<td>%s</td>\n" % name)

                f.write("<td>%s</td>\n" % time)

                f.write("<td></td>\n")

        f.write("</table>\n")

    f.write("<h2>Examples</h2>\n")

    f.write("<table border=\"1\">\n")

    f.write("<th> Result </th>\n")

    f.write("<th>Example Name</th>\n")

    for example in dom.getElementsByTagName("Example"):

        f.write("<tr>\n")

        result = get_node_text(example.getElementsByTagName("Result")[0])

        if result in ["FAIL", "CRASH"]:

            f.write("<td style=\"color:red\">%s</td>\n" % result)

        else:

            f.write("<td style=\"color:green\">%s</td>\n" % result)

        f.write("<td>%s</td>\n" % name)

        f.write("</tr>\n")

    f.write("</table>\n")

    f.write("</body>\n")

    f.write("</html>\n")

    f.close()

#

# Python Control-C handling is broken in the presence of multiple threads.  

# Signals get delivered to the runnable/running thread by default and if 

# it is blocked, the signal is simply ignored.  So we hook sigint and set 

# a global variable telling the system to shut down gracefully.

#

thread_exit = False

def sigint_hook(signal, frame):

    global thread_exit

    thread_exit = True

    return 0

#

# Waf can be configured to compile in debug or optimized modes.  In each

# case, the resulting built goes into a different directory.  If we want

# test tests to run from the correct code-base, we have to figure out which

# mode waf is running in.  This is called its active variant.

#

# XXX This function pokes around in the waf internal state file.  To be a

# little less hacky, we should add a commmand to waf to return this info

# and use that result.

#

def read_waf_active_variant():

    for line in open("build/c4che/default.cache.py").readlines():

        if line.startswith("NS3_ACTIVE_VARIANT"):

            exec(line, globals())

            break

    if options.verbose:

        print "NS3_ACTIVE_VARIANT == %s" % NS3_ACTIVE_VARIANT

#

# In general, the build process itself naturally takes care of figuring out

# which tests are built into the test runner.  For example, if waf configure

# determines that ENABLE_EMU is false due to some missing dependency,

# the tests for the emu net device simply will not be built and will 

# therefore not be included in the built test runner.

#

# Examples, however, are a different story.  In that case, we are just given

# a list of examples that could be run.  Instead of just failing, for example,

# nsc-tcp-zoo if NSC is not present, we look into the waf saved configuration

# for relevant configuration items.  

#

# XXX This function pokes around in the waf internal state file.  To be a

# little less hacky, we should add a commmand to waf to return this info

# and use that result.

#

def read_waf_config():

    for line in open("build/c4che/%s.cache.py" % NS3_ACTIVE_VARIANT).readlines():

        for item in interesting_config_items:

            if line.startswith(item):

                exec(line, globals())

    if options.verbose:

        for item in interesting_config_items:

            print "%s ==" % item, eval(item)

#

# It seems pointless to fork a process to run waf to fork a process to run

# the test runner, so we just run the test runner directly.  The main thing 

# that waf would do for us would be to sort out the shared library path but

# we can deal with that easily and do here.

#

# There can be many different ns-3 repositories on a system, and each has 

# its own shared libraries, so ns-3 doesn't hardcode a shared library search

# path -- it is cooked up dynamically, so we do that too.

#

def make_library_path():

    global LIBRARY_PATH

    LIBRARY_PATH = "LD_LIBRARY_PATH=$LD_LIBRARY_PATH:'"        

    if sys.platform == "darwin":

        LIBRARY_PATH = "DYLD_LIBRARY_PATH='"

    elif sys.platform == "win32":

        LIBRARY_PATH = "PATH=$PATH:'"

    elif sys.platform == "cygwin":

        LIBRARY_PATH = "PATH=$PATH:'"

    for path in NS3_MODULE_PATH:

        LIBRARY_PATH = LIBRARY_PATH + path + ":"

    LIBRARY_PATH = LIBRARY_PATH + "'"

    if options.verbose:

        print "LIBRARY_PATH == %s" % LIBRARY_PATH

def run_job_synchronously(shell_command, directory):

    cmd = "%s %s/%s/%s" % (LIBRARY_PATH, NS3_BUILDDIR, NS3_ACTIVE_VARIANT, shell_command)