#!/usr/bin/env python
from __future__ import with_statement
"""Minimal test script to check for modules needed in scipy tutorials.

Execute this code at the command line by typing:

    python intro_tut_checklist.py

If it does NOT say 'OK' at the end, copy the *entire* output of the run and
send it to the course instructor for help.

Note: it NEEDS nose to run at all, so if you don't have nose, it will fail
completely to even start.  You can download and install nose from the Python
Package Index:

    http://pypi.python.org/pypi/nose

"""

# Standard library imports
import glob
import os
import platform
import shutil
import sys
import tempfile

from StringIO import StringIO
from textwrap import dedent

# Third-party imports
import nose
import nose.tools as nt

##############################################################################
# Code begins

#-----------------------------------------------------------------------------
# Generic utility functions
def sys_info():
    """Summarize some info about the system"""

    print '=================='
    print 'System information'
    print '=================='
    print 'os.name      :',os.name
    try:
        print 'os.uname     :',os.uname()
    except:
        # Unix-only
        pass
    print 'platform     :',sys.platform
    print 'platform+    :',platform.platform()
    print 'prefix       :',sys.prefix
    print 'exec_prefix  :',sys.exec_prefix
    print 'executable   :',sys.executable
    print 'version_info :',sys.version_info
    print 'version      :',sys.version
    print '=================='


def c(cmd):
    """Run system command, raise SystemExit if it returns an error."""
    print "$",cmd
    stat = os.system(cmd)
    #stat = 0  # Uncomment this and comment previous to run in debug mode
    if stat:
        raise SystemExit("Command %s failed with code: %s" % (cmd, stat))


def validate_mpl(m):
    """Called if matplotlib imports.  Sets backend for further examples."""
    m.use('Agg')
    # Set this so we can see the big math title in one of the test images
    m.rcParams['figure.subplot.top'] = 0.85

    
#-----------------------------------------------------------------------------
# Tests

def check_import(mnames, validator=None):
    """Check that the given module name can be imported.

    If more than one name is given, all but the last are allowed to raise
    exceptions which are ignored.  Basically, this means that any of the names
    is considered to satisfy the group, and we only report an error if they all
    fail to import.

    A validator is a function that will be called with the imported module
    object if the import succeeds.  It can either do extra tests on the module
    (such as version checks) or simply configure it.
    """

    if isinstance(mnames, basestring):
        exec "import %s as m" % mnames
    else:
        group, last = mnames[:-1], mnames[-1]
        for mname in group:
            try:
                exec "import %s as m" % mname
            except:
                pass
            else:
                break # We exit on first success
        else:
            # If we exhausted all, we try the last one without swallowing errors
            exec "import %s as m" % last

    if validator is not None:
        validator(m)

    # Try to collect some version information
    for vname in ['__version__', 'version', 'Version']:
        try:
            vinfo = eval("m.%s" % vname)
            break
        except AttributeError:
            pass
    else:
        vinfo = '*no info*'
    print 'MOD: %s, version: %s' % (m.__name__,vinfo)


# Test generators are best written without docstrings, because nose can then
# show the parameters being used.
def test_imports():
    modules = ['setuptools',
               'IPython',
               'numpy','scipy','scipy.io',
               'matplotlib','pylab',
               'enthought.mayavi.api',
               ]

    validators = dict(matplotlib = validate_mpl)

    for mname in modules:
        yield (check_import, mname, validators.get(mname))


# Test generator, don't put a docstring in it
def test_loadtxt():
    import numpy as np
    import numpy.testing as npt

    # Examples taken from the loadtxt docstring
    array = np.array
    
    c = StringIO("0 1\n2 3")
    a1 = np.loadtxt(c)
    a2 = np.array([[ 0.,  1.],
                   [ 2.,  3.]])
    yield npt.assert_array_equal, a1, a2

    d = StringIO("M 21 72\nF 35 58")
    a1 = np.loadtxt(d, dtype={'names': ('gender', 'age', 'weight'),
                         'formats': ('S1', 'i4', 'f4')})
    
    a2 = np.array([('M', 21, 72.0), ('F', 35, 58.0)],
                  dtype=[('gender', '|S1'), ('age', '<i4'), ('weight', '<f4')])
    yield npt.assert_array_equal, a1, a2

    c = StringIO("1,0,2\n3,0,4")
    x,y = np.loadtxt(c, delimiter=',', usecols=(0,2), unpack=True)
    yield npt.assert_array_equal, x, np.array([ 1.,  3.])
    yield npt.assert_array_equal, y, np.array([ 2.,  4.])


def test_plot():
    "Simple plot generation."
    from matplotlib import pyplot as plt
    plt.figure()
    plt.plot([1,2,3])
    plt.xlabel('some numbers')
    plt.savefig('tmp_test_plot.png')


def test_plot_math():
    "Plots with math"
    from matplotlib import pyplot as plt
    plt.figure()
    plt.plot([1,2,3],label='data')
    t=(r'And X is $\sum_{i=0}^\infty \gamma_i + \frac{\alpha^{i^2}}{\gamma}'
       r'+ \cos(2 \theta^2)$')
    plt.title(t)
    plt.legend()
    plt.grid()
    plt.savefig('tmp_test_plot_math.png')


def main():
    """Main routine, executed when this file is run as a script """

    # Create a tempdir, as a subdirectory of the current one, which all tests
    # use for their storage.  By default, it is removed at the end.
    global TESTDIR
    cwd = os.getcwd()
    TESTDIR = tempfile.mkdtemp(prefix='tmp-testdata-', dir=cwd)
    
    print "Running tests:"
    # This call form is ipython-friendly
    try:
        os.chdir(TESTDIR)
        ret = nose.runmodule(argv=[__file__,'-vvs'], exit=False)
    finally:
        os.chdir(cwd)
        print "Cleanup - removing temp directory:", TESTDIR
        # If you need to debug a problem, comment out the next line that cleans
        # up the temp directory, and you can see in there all temporary files
        # created by the test code
        shutil.rmtree(TESTDIR)
    print """
***************************************************************************
                           TESTS FINISHED
***************************************************************************

If the printout above did not finish in 'OK' but instead says 'FAILED', copy
and send the *entire* output, including the system information below, for help.
We'll do our best to assist you.  You can send your message to the Scipy user
mailing list:

    http://mail.scipy.org/mailman/listinfo/scipy-user

but feel free to also CC directly:  cburns at berkeley dot edu

    """

    sys_info()


#-----------------------------------------------------------------------------
if __name__ == '__main__':
    main()