classobj Test_suite_runner

Class for running all components of the relax test suite.

This currently includes the following categories of tests:

• System/functional tests.
• Unit tests.
• GUI tests.
• Verification tests.

Instance Methods

__init__(self, tests=[], from_gui=False, categories=['system', 'unit', 'gui', 'verification'], timing=False, io_capture=True, list_tests=False)
Store the list of tests to preform.

bool run_all_tests(self, reset=True)
Execute all of the test suite test types.

bool run_gui_tests(self, summary=True, reset=True)
Execute the GUI tests.

bool run_system_tests(self, summary=True, reset=True)
Execute the system/functional tests.

bool run_unit_tests(self, summary=True, reset=True)
Execute the unit tests.

run_verification_tests(self, summary=True, reset=True)
Execute the software verification tests.

summary(self)
Print out a summary of the relax test suite.

summary_skipped(self)
Print out information about skipped tests.

Method Details

__init__(self, tests=[], from_gui=False, categories=['system', 'unit', 'gui', 'verification'], timing=False, io_capture=True, list_tests=False)
(Constructor)

Store the list of tests to preform.

The test list should be something like ['N_state_model.test_stereochem_analysis']. The first part is the imported test case class, the second is the specific test.

Parameters:

• tests (list of str) - The list of tests to preform. If left at [], then all tests will be run.
• from_gui (bool) - A flag which indicates if the tests are being run from the GUI or not.
• categories (list of str) - The list of test categories to run, for example ['system', 'unit', 'gui', 'verification'] for all tests.
• timing (bool) - A flag which if True will enable timing of individual tests.
• io_capture (bool) - A flag which if True will cause all IO to be captured and only printed out for failing or error tests.
• list_tests (bool) - A flag which if True will cause the tests to be listed rather than executed.

run_all_tests(self, reset=True)

Execute all of the test suite test types.

Parameters:

• reset (bool) - A flag which if True will reset the relax status objects for the tests.

Returns: bool

The combined status of the test categories.

run_gui_tests(self, summary=True, reset=True)

Execute the GUI tests.

Parameters:

• summary (bool) - A flag which if True will cause a summary to be printed.
• reset (bool) - A flag which if True will reset the relax status objects for the tests.

Returns: bool

True if the tests were run, False if a KeyboardInterrupt occurred.

run_system_tests(self, summary=True, reset=True)

Execute the system/functional tests.

Parameters:

• summary (bool) - A flag which if True will cause a summary to be printed.
• reset (bool) - A flag which if True will reset the relax status objects for the tests.

Returns: bool

True if the tests were run, False if a KeyboardInterrupt occurred.

run_unit_tests(self, summary=True, reset=True)

Execute the unit tests.

Parameters:

• summary (bool) - A flag which if True will cause a summary to be printed.
• reset (bool) - A flag which if True will reset the relax status objects for the tests.

Returns: bool

True if the tests were run, False if a KeyboardInterrupt occurred.

run_verification_tests(self, summary=True, reset=True)

Execute the software verification tests.

Parameters:

• summary (bool) - A flag which if True will cause a summary to be printed.
• reset (bool) - A flag which if True will reset the relax status objects for the tests.