""" Module to run the example files and report their success/failure results

Add a function to the ExampleTest class corresponding to an example script to
be tested.
This is done till better strategy for parallel testing is implemented

"""

from nose.plugins.attrib import attr

from example_test_case import ExampleTestCase

def skip_if_no_openmp():
    from pysph.base.nnps import get_number_of_threads
    from nose.plugins.skip import SkipTest
    n_threads = get_number_of_threads()
    if n_threads == 1:
        reason = "N_threads=1; OpenMP does not seem available."
        raise SkipTest(reason)
    else:
        print("Running OpenMP tests with %s threads"%n_threads)

skip_if_no_openmp()


class TestOpenMPExamples(ExampleTestCase):

    @attr(slow=True)
    def test_3Ddam_break_example(self):
        dt = 1e-5; tf = 25*dt
        serial_kwargs = dict(timestep=dt, tf=tf, pfreq=100)
        extra_parallel_kwargs = dict(openmp=None)
        # Note that we set nprocs=1 here since we do not want
        # to run this with mpirun.
        self.run_example(
            'dambreak3D.py', nprocs=1, atol=1e-14,
            serial_kwargs=serial_kwargs,
            extra_parallel_kwargs=extra_parallel_kwargs
        )

    @attr(slow=True)
    def test_elliptical_drop_example(self):
        serial_kwargs = None
        extra_parallel_kwargs = dict(openmp=None)
        # Note that we set nprocs=1 here since we do not want
        # to run this with mpirun.
        self.run_example(
            'elliptical_drop.py', nprocs=1, atol=1e-14,
            serial_kwargs=serial_kwargs,
            extra_parallel_kwargs=extra_parallel_kwargs
        )

    def test_ldcavity_example(self):
        dt=1e-4; tf=200*dt
        serial_kwargs = dict(timestep=dt, tf=tf, pfreq=500)
        extra_parallel_kwargs = dict(openmp=None)
        # Note that we set nprocs=1 here since we do not want
        # to run this with mpirun.
        self.run_example(
            'cavity.py', nprocs=1, atol=1e-14,
            serial_kwargs=serial_kwargs,
            extra_parallel_kwargs=extra_parallel_kwargs
        )

