Add document for policy-pap smoke test
[policy/parent.git] / docs / development / devtools / pap-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-pap-smoke-testing-label:
6
7 .. toctree::
8    :maxdepth: 2
9
10 Policy PAP Smoke Test
11 ~~~~~~~~~~~~~~~~~~~~~
12
13 The policy-pap 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 - DMaaP for the communication between components.
32 - Policy PAP to perform runtime administration (deploy/undeploy/status/statistics/etc).
33 - Policy Apex-PDP to deploy & undeploy policies. And send heartbeats to PAP.
34 - Policy Drools-PDP to deploy & undeploy policies. And send heartbeats to PAP.
35 - Policy Xacml-PDP to deploy & undeploy policies. And send heartbeats to PAP.
36
37
38 Testing procedure
39 *****************
40
41 The test set is focused on the following use cases:
42
43 - Execute all the REST api's exposed by policy-pap component.
44
45 Create policies using policy-api
46 --------------------------------
47 In order to test policy-pap, we need to use policy-api component to create the policies.
48
49 Download & execute the steps in postman collection for creating policies.
50 The steps needs to be performed sequentially one after another. And no input is required from user.
51
52 `Policy Framework Lifecycle API <https://github.com/onap/policy-api/blob/master/postman/lifecycle-api-collection.json>`_
53
54 Make sure to skip the delete policy steps.
55
56
57 Execute policy-pap testing
58 --------------------------
59 Download & execute the steps in postman collection for verifying policy-pap component.
60 The steps needs to be performed sequentially one after another. And no input is required from user.
61
62 `Policy Framework Administration API <https://github.com/onap/policy-pap/blob/master/postman/pap-api-collection.json>`_
63
64 Make sure to execute the delete steps in order to clean the setup after testing.
65
66
67 Delete policies using policy-api
68 --------------------------------
69 Use the previously downloaded policy-api postman collection to delete the policies created for testing.