| Attila Fazekas | 58d2330 | 2013-07-24 10:25:02 +0200 | [diff] [blame] | 1 | ============================ |
| Sean Dague | 7679b48 | 2013-05-24 08:49:44 -0400 | [diff] [blame] | 2 | Tempest Field Guide Overview |
| Attila Fazekas | 58d2330 | 2013-07-24 10:25:02 +0200 | [diff] [blame] | 3 | ============================ |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 4 | |
| 5 | Tempest is designed to be useful for a large number of different |
| 6 | environments. This includes being useful for gating commits to |
| 7 | OpenStack core projects, being used to validate OpenStack cloud |
| 8 | implementations for both correctness, as well as a burn in tool for |
| 9 | OpenStack clouds. |
| 10 | |
| 11 | As such Tempest tests come in many flavors, each with their own rules |
| 12 | and guidelines. Below is the proposed Havana restructuring for Tempest |
| 13 | to make this clear. |
| 14 | |
| Xiao Hanyu | a4036d1 | 2013-06-19 14:12:23 +0800 | [diff] [blame] | 15 | | tempest/ |
| 16 | | api/ - API tests |
| Xiao Hanyu | a4036d1 | 2013-06-19 14:12:23 +0800 | [diff] [blame] | 17 | | scenario/ - complex scenario tests |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 18 | |
| 19 | Each of these directories contains different types of tests. What |
| 20 | belongs in each directory, the rules and examples for good tests, are |
| 21 | documented in a README.rst file in the directory. |
| 22 | |
| Matthew Treinish | a9aef87 | 2014-07-25 16:03:08 -0400 | [diff] [blame] | 23 | :ref:`api_field_guide` |
| 24 | ---------------------- |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 25 | |
| 26 | API tests are validation tests for the OpenStack API. They should not |
| 27 | use the existing python clients for OpenStack, but should instead use |
| guo yunxian | a221647 | 2016-08-01 16:34:43 +0800 | [diff] [blame] | 28 | the tempest implementations of clients. Having raw clients let us |
| 29 | pass invalid JSON to the APIs and see the results, something we could |
| 30 | not get with the native clients. |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 31 | |
| 32 | When it makes sense, API testing should be moved closer to the |
| 33 | projects themselves, possibly as functional tests in their unit test |
| 34 | frameworks. |
| 35 | |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 36 | |
| Matthew Treinish | a9aef87 | 2014-07-25 16:03:08 -0400 | [diff] [blame] | 37 | :ref:`scenario_field_guide` |
| 38 | --------------------------- |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 39 | |
| 40 | Scenario tests are complex "through path" tests for OpenStack |
| 41 | functionality. They are typically a series of steps where complicated |
| 42 | state requiring multiple services is set up exercised, and torn down. |
| 43 | |
| ghanshyam | 50f1947 | 2014-11-26 17:04:37 +0900 | [diff] [blame] | 44 | Scenario tests should not use the existing python clients for OpenStack, |
| 45 | but should instead use the tempest implementations of clients. |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 46 | |
| Sean Dague | 31a57ad | 2013-05-07 15:24:05 -0400 | [diff] [blame] | 47 | |
| Matthew Treinish | 817a808 | 2014-07-25 16:07:20 -0400 | [diff] [blame] | 48 | :ref:`unit_tests_field_guide` |
| 49 | ----------------------------- |
| 50 | |
| 51 | Unit tests are the self checks for Tempest. They provide functional |
| 52 | verification and regression checking for the internal components of tempest. |
| 53 | They should be used to just verify that the individual pieces of tempest are |
| 54 | working as expected. |