niryo_libraries.rosunit.pyunit

module documentation

Wrapper for running Python unittest within rosunit/rostest framework.

Function	`start_coverage`	Undocumented
Function	`stop_coverage`	@param packages: list of packages to generate coverage reports for @type packages: [str] @param html: (optional) if not None, directory to generate html report to @type html: str
Function	`unitrun`	Wrapper routine from running python unitttests with JUnit-compatible XML output. This is meant for unittests that do not not need a running ROS graph (i.e. offline tests only).
Variable	`_cov`	Undocumented

def start_coverage(packages): ¶

Undocumented

def stop_coverage(packages, html=None): ¶

@param packages: list of packages to generate coverage reports for @type packages: [str] @param html: (optional) if not None, directory to generate html report to @type html: str

def unitrun(package, test_name, test, sysargs=None, coverage_packages=None): ¶

Wrapper routine from running python unitttests with JUnit-compatible XML output. This is meant for unittests that do not not need a running ROS graph (i.e. offline tests only).

This enables JUnit-compatible test reporting so that test results can be reported to higher-level tools.

WARNING: unitrun() will trigger a sys.exit() on test failure in order to properly exit with an error code. This routine is meant to be used as a main() routine, not as a library.

@param package: name of ROS package that is running the test @type package: str @param test: a test case instance or a name resolving to a test case or suite @type test: unittest.TestCase, or string @param coverage_packages: list of Python package to compute coverage results for. Defaults to package @type coverage_packages: [str] @param sysargs: (optional) alternate sys.argv @type sysargs: [str]

_cov = ¶

Undocumented