lsst.utils
14.0-6-g4f52afe+1
|
Test that executables can be run and return good status. More...
Public Member Functions | |
def | setUpClass (cls) |
def | testSanity (self) |
def | assertExecutable (self, executable, root_dir=None, args=None, msg=None) |
Check an executable runs and returns good status. More... | |
def | create_executable_tests (cls, ref_file, executables=None) |
Discover executables to test and create corresponding test methods. More... | |
Public Attributes | |
TESTS_DISCOVERED | |
Static Public Attributes | |
int | TESTS_DISCOVERED = -1 |
Test that executables can be run and return good status.
The test methods are dynamically created. Callers must subclass this class in their own test file and invoke the create_executable_tests() class method to register the tests.
def lsst.utils.tests.ExecutablesTestCase.assertExecutable | ( | self, | |
executable, | |||
root_dir = None , |
|||
args = None , |
|||
msg = None |
|||
) |
Check an executable runs and returns good status.
executable | Path to an executable. root_dir is not used if this is an absolute path. |
root_dir | Directory containing exe. Ignored if None. |
args | List or tuple of arguments to be provided to the executable. |
msg | Message to use when the test fails. Can be None for default message. |
Prints output to standard out. On bad exit status the test fails. If the executable can not be located the test is skipped.
def lsst.utils.tests.ExecutablesTestCase.create_executable_tests | ( | cls, | |
ref_file, | |||
executables = None |
|||
) |
Discover executables to test and create corresponding test methods.
Scans the directory containing the supplied reference file (usually file supplied from the test class) to look for executables. If executables are found a test method is created for each one. That test method will run the executable and check the returned value.
Executable scripts with a .py extension and shared libraries are ignored by the scanner.
This class method must be called before test discovery.
Example:
cls.create_executable_tests(file)
The list of executables can be overridden by passing in a sequence of explicit executables that should be tested. If an item in the sequence can not be found the test will be configured to skip rather than fail.
def lsst.utils.tests.ExecutablesTestCase.setUpClass | ( | cls | ) |
def lsst.utils.tests.ExecutablesTestCase.testSanity | ( | self | ) |
|
static |