quarchpy.utilities package¶
Submodules¶
quarchpy.utilities.TestCenter module¶
Implements the standard TestCenter API for Python, allowing a Python script to execute all TestCenter functions. This is Quarch internal use only. Each function uses the stdin/stdout to communicate with the TestCenter process as such, communication is based on simple strings
- quarchpy.utilities.TestCenter.beginTestBlock(message_text)¶
Notes the start of a block of tests. This allows multiple nested layers of related tests to improve readability of the results. This has no effect on the test execution, only on the reporting of the results.
- Parameters
message_text (str) – User message describing the test block. This will be shown in the results
- Returns
test_response – String returned from test function. This will be “1” on success and “0” on error
- Return type
str
- quarchpy.utilities.TestCenter.endTest()¶
Orders the end of the test. This will terminate the test parser and disponse of any resources held by the test libraries (including quarch module connections)
- quarchpy.utilities.TestCenter.endTestBlock()¶
Notes the end of a block of tests. This allows multiple nested layers of related tests to improve readability of the results. This has no effect on the test execution, only on the reporting of the results.
- Returns
test_response – String returned from test function. This will be “1” on success and “0” on error
- Return type
str
- quarchpy.utilities.TestCenter.setup(interface_name, *command_params)¶
Sets up a test interface, passing the interface parameters onto TestCenter to process
- Parameters
interface_name (str) – Name of the interface to setup
command_params (iterable object) – List of parameter strings to be passed to the setup function
- Returns
setup_response – String returned from setup function. Generally “1” or “0” as a boolean success flag
- Return type
str
- quarchpy.utilities.TestCenter.testPoint(command_name, *command_params)¶
Runs a test point from the testcenter library functions
- Parameters
command_name (str) – In the form InterfaceName.TestName
command_params (iterable object) – List of parameter strings to be passed to the test function
- Returns
test_response – String returned from test function. This varies based on the TestPoint spec
- Return type
str