Pykiso is an integration test framework that is used by kiso to ensure that all provided kiso features will always work. Pykiso can nevertheless be used as stand-alone to test any features in an embedded device.
- Python 3.6+
- pip/pipenv (used to get the rest of the requirements)
cd kiso-testing
pip install .Pipenv is more appropriate for developers as it automatically creates virtual environments.
cd kiso-testing
pipenv install --dev
pipenv shellTo improve code-quality, a configuration of pre-commit hooks are available. The following pre-commit hooks are used:
- black
- trailing-whitespace
- end-of-file-fixer
- check-docstring-first
- check-json
- check-added-large-files
- check-yaml
- debug-statements
If you don't have pre-commit installed, you can get it using pip:
pip install pre-commitStart using the hooks with
pre-commit installOnce installed the application is bound to pykiso, it can be called with the following arguments:
Usage: pykiso [OPTIONS]
Embedded Integration Test Framework
Options:
-c, --test-configuration-file FILE
path to the test configuration file (in YAML
format) [required]
-l, --log-path PATH path to log-file or folder. If not set will
log to STDOUT
--log-level [DEBUG|INFO|WARNING|ERROR]
set the verbosity of the logging
--version Show the version and exit.
--help Show this message and exit.Suitable config files are available in the test-examples folder.
invoke runinvoke testor
pytest- When the auxiliary does not answer (ping or else), GenericTest.BasicTest.cleanup_and_skip() call will result in a lock and break the framework.
- Add verbosity parameters to pass to the unittest framework to get more details about the test.
- Add result parsing for Jenkins (see: https://stackoverflow.com/questions/11241781/python-unittests-in-jenkins).
- Host it on pypi.