Add document for policy-api smoke test
[policy/parent.git] / docs / development / devtools / api-smoke.rst
1 .. This work is licensed under a
2 .. Creative Commons Attribution 4.0 International License.
3 .. http://creativecommons.org/licenses/by/4.0
4
5 .. _policy-api-smoke-testing-label:
6
7 .. toctree::
8    :maxdepth: 2
9
10 Policy API Smoke Test
11 ~~~~~~~~~~~~~~~~~~~~~
12
13 The policy-api smoke testing is executed against a default ONAP installation as per OOM charts.
14 This test verifies the execution of all the REST api's exposed by the component to make sure the contract works as expected.
15
16 General Setup
17 *************
18
19 The kubernetes installation will allocate all onap components across multiple worker node VMs.
20 The normal worker VM hosting onap components has the following spec:
21
22 - 16GB RAM
23 - 8 VCPU
24 - 160GB Ephemeral Disk
25
26
27 The ONAP components used during the smoke tests are:
28
29 - Policy API to perform CRUD of policies.
30 - Policy DB to store the policies.
31
32
33 Testing procedure
34 *****************
35
36 The test set is focused on the following use cases:
37
38 - Execute all the REST api's exposed by policy-api component.
39
40 Execute policy-api testing
41 --------------------------
42 Download & execute the steps in postman collection for verifying policy-api component.
43 The steps needs to be performed sequentially one after another. And no input is required from user.
44
45 `Policy Framework Lifecycle API <https://github.com/onap/policy-api/blob/master/postman/lifecycle-api-collection.json>`_
46
47 Make sure to execute the delete steps in order to clean the setup after testing.