tobiko/README.rst
Federico Ressi 7832a9d15c Drop support for Python3.5
Change-Id: I0703e04ab095fbe70e3fab4165d0d4c51febd73e
2020-01-16 13:07:38 +01:00

62 lines
2.0 KiB
ReStructuredText

======
Tobiko
======
Test Big Cloud Operations
-------------------------
Tobiko is an OpenStack testing framework focusing on areas mostly
complementary to `Tempest <https://docs.openstack.org/tempest/latest/>`__.
While tempest main focus has been testing OpenStack rest APIs, the main Tobiko
focus would be to test OpenStack system operations while "simulating"
the use of the cloud as the final user would.
Tobiko's test cases populate the cloud with workloads such as instances, allows
the CI workflow to perform an operation such as an update or upgrade, and then
runs test cases to validate that the cloud workloads are still functional.
Project Requirements
--------------------
Tobiko Python framework is being tested with below Python versions:
- Python 3.6
- Python 3.7
- Python 3.8
and below Linux distributions:
- CentOS 7 (with Python 3.6 and 3.8)
- Ubuntu Bionic (with Python 3.6 and 3.7)
The framework is being used for executing test cases. As Tobiko can be executed
on nodes that are not part of the cloud to test against, this doesn't mean
Tobiko requires cloud nodes have to run with one of tested Python versions
or Linux distributions.
Main Project Goals
~~~~~~~~~~~~~~~~~~
- To provide a Python framework to write system scenario test cases.
- To provide tools for testing OpenStack system operations like update,
upgrades and fast forward upgrade.
- To provide CLI tools to implement a workflow designed to test potentially
destructive operations (like rebooting cloud nodes, restarting services
or others kinds of fault injections).
- To provide tools to monitor and recollect the healthy status of the cloud as
seen from user perspective (black-box testing) or from inside (white-box
testing).
References
----------
* Free software: Apache License, Version 2.0
* Documentation: https://tobiko.readthedocs.io/en/latest/
* Release notes: https://docs.openstack.org/releasenotes/tobiko/
* Source: https://opendev.org/x/tobiko
* Bugs: https://storyboard.openstack.org/#!/project/x/tobiko