API Reference¶

Welcome to the PySys System Test Framework.

pysys.basetest contains (or provides links to) pretty much everything you need for the main business of creating testcases using PySys.

However for more advanced users, it is possible to customize many aspects of PySys behaviour by providing custom implementations of PySys classes described in this API reference:

pysys.baserunner.BaseRunner to customize orchestration of all the tests in a test run.

pysys.writer classes to customize how test outcomes are recorded.

pysys.perf to customize how numeric performance results are reported.

pysys.config.descriptor.DescriptorLoader to customize how PySys find and runs tests (e.g. to support running tests from other frameworks within PySys).

pysys.utils.logutils.BaseLogFormatter for advanced customization of log message format.

There are also many utility functions which could be helpful when creating custom assertion methods. However before using any functions from pysys.utils, always check first if there is a more convenient method available to do the job on pysys.basetest.BaseTest/pysys.baserunner.BaseRunner.

`pysys.baserunner`	The runner is responsible for orchestrating concurrent execution of the tests, and for setup/cleanup of any resources that are shared across multiple tests.
`pysys.config`	Test/directory descriptors (`pysystest.*`/`pysysdirconfig.xml`) and project configuration (`pysysproject.xml`).
`pysys.constants`	Standard constants that are used throughout the PySys framework.
`pysys.exceptions`	Exceptions used and raised by PySys methods.
`pysys.launcher`	Implementation of the pysys.py command line launcher.
`pysys.mappers`	Mapper filter or transform lines of input, for use with methods such as `pysys.basetest.BaseTest.copy` and `pysys.basetest.BaseTest.assertGrep`.
`pysys.perf`	Performance reporters are configurable plugins responsible for storing or displaying performance result numbers.
`pysys.process`	Process execution and monitoring implementations.
`pysys.unit`	Unit test support (currently just PyUnit).
`pysys.utils`	Utility functions and classes.
`pysys.writer`	Writers are configurable plugins responsible for summarising test results or processing test output as each test completes, or at the end when all tests has completed.