Welcome to pytest-executable documentation!¶
pytest-executable is a pytest plugin for simplifying the black-box testing of an executable, be it written in python or not. It helps to avoid writing the boilerplate test code to:
define the settings of a test case in a yaml file,
spawn a subprocess for running an executable,
reorder the tests properly either for a single test case or across several test cases,
handle the outputs and references directory trees,
provide convenient fixtures to customize the checking of the outcome of an executable.
It integrates naturally with standard test scripts written for pytest.
This plugin is originally intended for testing executables that create scientific data but it may hopefully be helpful for other kinds of executables. This project is still young, but already used in a professional environment.
The project documentation and installation instructions are available online.
A contributing guide will be soon available (just a matter of free time).
Please fill an issue on the Github issue tracker for any bug report, feature request or question.
Copyright and License¶
Copyright 2020, CS GROUP
pytest-executable is a free and open source software, distributed under the Apache License 2.0. See the LICENSE.txt file for more information, or the quick summary of this license on tl;drLegal website.
- Command line interface
- How to use
- Add a test case
- Add a post-processing
- Default test module
- API documentation