blob: b0bfdf7dd6ac33db2472f780ed7aeff3d730b0f8 [file] [log] [blame]
Matthew Treinisha9aef872014-07-25 16:03:08 -04001.. _third_party_field_guide:
2
Masayuki Igawac268dd62013-09-18 00:51:05 +09003Tempest Field Guide to Third Party API tests
4============================================
Sean Dague09761f62013-05-13 15:20:40 -04005
6
7What are these tests?
Attila Fazekas58d23302013-07-24 10:25:02 +02008---------------------
Sean Dague09761f62013-05-13 15:20:40 -04009
10Third party tests are tests for non native OpenStack APIs that are
11part of OpenStack projects. If we ship an API, we're really required
12to ensure that it's working.
13
14An example is that Nova Compute currently has EC2 API support in tree,
15which should be tested as part of normal process.
16
17
18Why are these tests in tempest?
Attila Fazekas58d23302013-07-24 10:25:02 +020019-------------------------------
Sean Dague09761f62013-05-13 15:20:40 -040020
21If we ship an API in an OpenStack component, there should be tests in
22tempest to exercise it in some way.
23
24
25Scope of these tests
Attila Fazekas58d23302013-07-24 10:25:02 +020026--------------------
Sean Dague09761f62013-05-13 15:20:40 -040027
28Third party API testing should be limited to the functional testing of
29third party API compliance. Complex scenarios should be avoided, and
30instead exercised with the OpenStack API, unless the third party API
31can't be tested without those scenarios.
32
33Whenever possible third party API testing should use a client as close
34to the third party API as possible. The point of these tests is API
35validation.