x/tobiko
Code Issues Proposed changes

Update project README.rst file

Browse Source 
Change-Id: Ie3082d359d28b61c112755a33547ef3b2852e485
This commit is contained in:
Federico Ressi 2020-06-09 16:54:02 +02:00
parent 79b119d0ae
commit 61af47e6b5
1 changed files with 52 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
README.rst
View File

@ -9,18 +9,23 @@ Test Big Cloud Operations
Tobiko is an OpenStack testing framework focusing on areas mostly Tobiko is an OpenStack testing framework focusing on areas mostly
complementary to `Tempest <https://docs.openstack.org/tempest/latest/>`__. complementary to `Tempest <https://docs.openstack.org/tempest/latest/>`__.
While tempest main focus has been testing OpenStack rest APIs, the main Tobiko While tempest main focus has been testing OpenStack rest APIs, the main Tobiko
focus would be to test OpenStack system operations while "simulating" focus is to test OpenStack system operations while "simulating"
the use of the cloud as the final user would. the use of the cloud as the final user would.
Tobiko's test cases populate the cloud with workloads such as instances, allows Tobiko's test cases populate the cloud with workloads such as Nova instances;
the CI workflow to perform an operation such as an update or upgrade, and then they execute disruption operations such as services/nodes restart; finally they
runs test cases to validate that the cloud workloads are still functional. run test cases to validate that the cloud workloads are still functional.
Tobiko's test cases can also be used, for example, for testing that previously
created workloads are working right after OpenStack services update/upgrade
operation.
Project Requirements Project Requirements
-------------------- --------------------
Tobiko Python framework is being tested with below Python versions: Tobiko Python framework is being automatically tested with below Python
versions:
- Python 3.6 - Python 3.6
- Python 3.7 - Python 3.7
@ -28,24 +33,41 @@ Tobiko Python framework is being tested with below Python versions:
and below Linux distributions: and below Linux distributions:
- CentOS 7 (with Python 3.6 and 3.8) - CentOS 7 / RHEL 7 (with Python 3.6)
- CentOS 8 / RHEL 8 (with Python 3.6)
- Ubuntu Bionic (with Python 3.6 and 3.7) - Ubuntu Bionic (with Python 3.6 and 3.7)
The framework is being used for executing test cases. As Tobiko can be executed Tobiko is also tested for development purposes with below OSes:
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 - Fedora 31 (with Python 3.7)
or Linux distributions. - Fedora 32 (with Python 3.8)
- OSX (with Python 3.8)
- Ubuntu Focal (with Python 3.8)
The Tobiko Python framework is being used to implement 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 above Python
versions or Linux distributions.
Main Project Goals Main Project Goals
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
- To provide a Python framework to write system scenario test cases. - To test OpenStakc and Red Hat OpenStack Platform projects before they are
- To provide tools for testing OpenStack system operations like update, released.
upgrades and fast forward upgrade. - To provide a Python framework to write system scenario test cases (create
- To provide CLI tools to implement a workflow designed to test potentially and test workloads), to write white boxing test cases (to log to cloud nodes
destructive operations (like rebooting cloud nodes, restarting services for internal inspection purpose), to write disruptive test cases (to simulate
or others kinds of fault injections). service disruptions like for example rebooting/interrupting a service to
verify cloud reliability).
- To provide Ansible roles to implement a work-flow designed to run an ordered
sequence of test cases groups (like for example tests that creates resources
and verify they are working, tests that execute cloud disruptions, and finally
tests that verify if resources initially created are still working). The main
use of these roles is writing continuous integration jobs for Zuul (via bare
Ansible roles) or other services like Jenkins (via the InfraRed plug-in).
- To verify previously created workloads are working fine after executing
OpenStack nodes update/upgrade.
- To provide tools to monitor and recollect the healthy status of the cloud as - 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 seen from user perspective (black-box testing) or from inside (white-box
testing). testing).
@ -57,5 +79,18 @@ References
* Free software: Apache License, Version 2.0 * Free software: Apache License, Version 2.0
* Documentation: https://tobiko.readthedocs.io/en/latest/ * Documentation: https://tobiko.readthedocs.io/en/latest/
* Release notes: https://docs.openstack.org/releasenotes/tobiko/ * Release notes: https://docs.openstack.org/releasenotes/tobiko/
* Source: https://opendev.org/x/tobiko * Source code: https://opendev.org/x/tobiko
* Bugs: https://storyboard.openstack.org/#!/project/x/tobiko * Bugs: https://storyboard.openstack.org/#!/project/x/tobiko
Related projects
~~~~~~~~~~~~~~~~
* OpenStack: https://www.openstack.org/
* Red Hat OpenStack Platform: https://www.redhat.com/en/technologies/linux-platforms/openstack-platform
* Python: https://www.python.org/
* Testtools: https://github.com/testing-cabal/testtools
* Ansible: https://www.ansible.com/
* InfraRed: https://infrared.readthedocs.io/en/latest/
* DevStack: https://docs.openstack.org/devstack/latest/
* Zuul: https://docs.openstack.org/infra/system-config/zuul.html
* Jenkins: https://www.jenkins.io/