PySys 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.utils.perfreporter.CSVPerformanceReporter to customize how numeric performance results are reported.

• pysys.xml.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.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.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 plug-ins that record test outcomes (typically on disk, on the console, or to your CI tooling).
pysys.xml	Test/directory descriptors (pysystest.xml/pysysdirconfig.xml) and project configuration (pysysproject.xml).