History

Yong Sheng Gong e99072d65c Fix typos in tempest/api/README.rst Change-Id: Icf2ba80e5561ca439a91f4851b09bf013e0d2492 Fixes: Bug #1212545		2013-08-15 13:59:42 +08:00
..
compute	Cleanup try/except/finally blocks in several tests	2013-08-14 08:02:55 -07:00
identity	Merge "Test cases for Roles V3 Actions"	2013-08-10 11:54:02 +00:00
image	Add tenant isolation for scenario tests	2013-08-12 19:16:52 +00:00
network	Add network api test cases	2013-08-05 14:20:44 +05:30
object_storage	Merge "Add tests for swift container listing filters"	2013-08-10 11:57:53 +00:00
orchestration	Flag InstanceCfnInitTestJSON as the first slow heat test	2013-08-08 09:36:23 +12:00
volume	Cleanup try/except/finally blocks in several tests	2013-08-14 08:02:55 -07:00
README.rst	Fix typos in tempest/api/README.rst	2013-08-15 13:59:42 +08:00
__init__.py	rename tests -> api	2013-05-20 17:20:54 -04:00
utils.py	Use nose skip exception conditionally	2013-07-24 15:28:53 +10:00

README.rst

Tempest Guide to API tests

What are these tests?

One of Tempest's prime function is to ensure that your OpenStack cloud works with the OpenStack API as documented. The current largest portion of Tempest code is devoted to test cases that do exactly this.

It's also important to test not only the expected positive path on APIs, but also to provide them with invalid data to ensure they fail in expected and documented ways. Over the course of the OpenStack project Tempest has discovered many fundamental bugs by doing just this.

In order for some APIs to return meaningful results, there must be enough data in the system. This means these tests might start by spinning up a server, image, etc, then operating on it.

Why are these tests in tempest?

This is one of the core missions for the Tempest project, and where it started. Many people use this bit of function in Tempest to ensure their clouds haven't broken the OpenStack API.

It could be argued that some of the negative testing could be done back in the projects themselves, and we might evolve there over time, but currently in the OpenStack gate this is a fundamentally important place to keep things.

Scope of these tests

API tests should always use the Tempest implementation of the OpenStack API, as we want to ensure that bugs aren't hidden by the official clients.

They should test specific API calls, and can build up complex state if it's needed for the API call to be meaningful.

They should send not only good data, but bad data at the API and look for error codes.

They should all be able to be run on their own, not depending on the state created by a previous test.