Source code for cis_interface.drivers.tests.test_MatlabModelDriver

import os
import unittest
from cis_interface.tests import scripts, assert_raises
import cis_interface.drivers.tests.test_ModelDriver as parent
from cis_interface import runner
from cis_interface.drivers import MatlabModelDriver
from cis_interface.examples import yamls as ex_yamls


_session_fname = os.path.join(os.getcwd(), 'nt_screen_session.txt')


[docs]def test_is_matlab_running():
    r"""Test if there is Matlab engine running."""
    MatlabModelDriver.is_matlab_running()
    MatlabModelDriver.kill_all()
    assert(not MatlabModelDriver.is_matlab_running())


[docs]@unittest.skipIf(MatlabModelDriver._matlab_installed, "Matlab installed.")
def test_matlab_not_installed():  # pragma: no matlab
    r"""Assert that errors are raised when Matlab is not installed."""
    assert_raises(RuntimeError, MatlabModelDriver.start_matlab)
    assert_raises(RuntimeError, MatlabModelDriver.stop_matlab,
                  None, None, None, None)
    assert_raises(RuntimeError, MatlabModelDriver.MatlabProcess, None, None)
    assert_raises(RuntimeError, MatlabModelDriver.MatlabModelDriver, None, None)


[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
def test_matlab_runner():  # pragma: matlab
    r"""Use get_runner to start a Matlab run."""
    cr = runner.get_runner([ex_yamls['hello']['matlab']])
    cr.run()


[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
def test_matlab_exit():  # pragma: matlab
    r"""Test error when model contains 'exit' call."""
    MatlabModelDriver.MatlabModelDriver('error', [scripts['matlab_error']])
    # Re-enable if it becomes necessary to raise an error instead of just a warning
    # assert_raises(RuntimeError, MatlabModelDriver.MatlabModelDriver, 'error',
    #               [scripts['matlab_error']])


[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
def test_get_matlab_version():  # pragma: matlab
    r"""Test get_matlab_version."""
    MatlabModelDriver.get_matlab_version()


[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
def test_locate_matlabroot():  # pragma: matlab
    r"""Test locate_matlabroot."""
    MatlabModelDriver.locate_matlabroot()


[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
class TestMatlabModelParam(parent.TestModelParam):  # pragma: matlab
    r"""Test parameters for MatlabModelDriver."""

    driver = "MatlabModelDriver"
    
    def __init__(self, *args, **kwargs):
        super(TestMatlabModelParam, self).__init__(*args, **kwargs)
        self.args = [scripts["matlab"], "test", 1]
        self.attr_list += ['started_matlab', 'mlengine']

[docs]    def test_a(self):
        r"""Dummy test to start matlab."""
        if self.instance.screen_session is None:  # pragma: debug
            print("Matlab was not started by this test. Close any "
                  + "existing Matlab sessions to test creation/removal.")
        else:
            with open(_session_fname, 'w') as f:
                f.write(self.instance.screen_session)
            self.instance.screen_session = None
            self.instance.started_matlab = False

[docs]    def test_z(self):
        r"""Dummy test to stop matlab."""
        if os.path.isfile(_session_fname):
            with open(_session_fname, 'r') as f:
                session = f.read()
            os.remove(_session_fname)
            self.instance.screen_session = session
            self.instance.started_matlab = True
        else:  # pragma: debug
            print("Skipping removal of Matlab session as the test did "
                  + "not create it.")

            
[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
class TestMatlabModelDriverNoStart(TestMatlabModelParam,
                                   parent.TestModelDriverNoStart):  # pragma: matlab
    r"""Test runner for MatlabModelDriver."""
    
    pass


[docs]@unittest.skipIf(not MatlabModelDriver._matlab_installed, "Matlab not installed.")
class TestMatlabModelDriver(TestMatlabModelParam,
                            parent.TestModelDriver):  # pragma: matlab
    r"""Test runner for MatlabModelDriver."""
    
    pass