Tempest plugin for validation of Airship components.

Go to file

Carter, Matthew (mc981n) f1609695bd Add the tempest-plugin-jobs Zuul template Add the openstack Zuul template to the gates for the project, so we aren't just running with noop for gating. Can't add running unit tests to gates yet because this project has no unit tests. Change-Id: I8826b564f81c1294f034c8a5bea1637f1b077020		2019-05-06 14:42:22 -05:00
airship_tempest_plugin	Rename test_site_statuses.py to test_site_statuses_rbac.py	2018-10-12 10:33:48 -04:00
.zuul.yaml	Add the tempest-plugin-jobs Zuul template	2019-05-06 14:42:22 -05:00
README.rst	Cleanup clients, add documenation, and fix 2 tests	2018-08-24 17:33:47 -04:00
requirements.txt	Add patrole to requirements to resolve dependency issue	2019-05-06 19:33:52 +00:00
setup.cfg	Framework for Airship Tempest Plugin	2018-08-17 13:40:11 -04:00
setup.py	Framework for Airship Tempest Plugin	2018-08-17 13:40:11 -04:00
test-requirements.txt	Add Additional RBAC Test Coverage for Shipyard	2018-08-21 16:25:32 -04:00
tox.ini	Add Additional RBAC Test Coverage for Shipyard	2018-08-21 16:25:32 -04:00

README.rst

Tempest Integration of airship-tempest-plugin

Purpose:

The purpose of this plugin is to provide automated tests for all OpenStack Airship components.

DISCALIMER:

This initial implementation is just to meet the first use case which is RBAC testing. For RBAC testing, we only need to hit the API endpoint and check role permission to the API being tested. Some of the REST clients will need to be rewritten if functional testing is desired. Those that need to be rewritten are documented in each service client code.

Environment Information:

Testing can be done in a airship-in-a-bottle environment. Please refer to [0] and [1]. Tempest and Tempest plugin installation can be done in a Python virtual environment.

FAQ:

Where do the REST clients exist? https://github.com/att-comdev/airship-tempest-plugin/tree/master/airship_tempest_plugin/services
Where do the tests exists? [3] https://github.com/att-comdev/airship-tempest-plugin/tree/master/airship_tempest_plugin/tests/api
Example of where/how the REST clients are instantiated. https://github.com/att-comdev/airship-tempest-plugin/blob/master/airship_tempest_plugin/tests/api/shipyard/base.py
Where do we define expected results (requirements)? https://github.com/att-comdev/airship-tempest-plugin/blob/master/airship_tempest_plugin/tests/api/common/rbac_roles.yaml
Where do we add configuration to support another Airship component? https://github.com/att-comdev/airship-tempest-plugin/blob/master/airship_tempest_plugin/config.py
Where do we run the test from? After the plugin is installed, run it from the tempest directory
Example of how to run all the RBAC tests for Shipyard: 'tempest run --regex airship_tempest_plugin.tests.api.shipyard.rbac'
What is Patrole? https://github.com/openstack/patrole/blob/master/README.rst
What is a Tempest plugin? [8] https://docs.openstack.org/tempest/latest/plugin.html

Patrole Supporting Documentation:

Patrole documentation for requirements driven approach that is used: https://github.com/openstack/patrole/blob/master/doc/source/framework/requirements_authority.rst Patrole role-overriding: https://github.com/openstack/patrole/blob/master/doc/source/framework/rbac_utils.rst#role-overriding Patrole under-permission exception: https://github.com/openstack/patrole/blob/master/patrole_tempest_plugin/rbac_exceptions.py#L51 Patrole over-permission exception: https://github.com/openstack/patrole/blob/master/patrole_tempest_plugin/rbac_exceptions.py#L44

Future Considerations: ---------------------Will the airship-tempest-plugin continue to live here: https://github.com/att-comdev/airship-tempest-plugin or will it be moved under OpenStack? Will there exist a RBAC gate for all Airship projects?

Referenced Links:

[0] https://github.com/openstack/airship-in-a-bottle [1] https://www.airshipit.org/