Add document for policy-pap smoke test

Adding document for policy-pap smoke testing.

Issue-ID: POLICY-3718
Change-Id: If60a1c3698c12b2f4d039068366678d7a263a852
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>

diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index cef0679..4c65bb0 100644 (file)
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -280,8 +280,6 @@ familiar with the Policy Framework components and test any local changes.
    clamp-cl-participant-protocol-smoke.rst
    policy-participant-smoke.rst
    api-smoke.rst
-
-..
    pap-smoke.rst
 
 ..

diff --git a/docs/development/devtools/pap-smoke.rst b/docs/development/devtools/pap-smoke.rst
new file mode 100644 (file)
index 0000000..07d143b
--- /dev/null
+++ b/docs/development/devtools/pap-smoke.rst
@@ -0,0 +1,69 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _policy-pap-smoke-testing-label:
+
+.. toctree::
+   :maxdepth: 2
+
+Policy PAP Smoke Test
+~~~~~~~~~~~~~~~~~~~~~
+
+The policy-pap smoke testing is executed against a default ONAP installation as per OOM charts.
+This test verifies the execution of all the REST api's exposed by the component to make sure the contract works as expected.
+
+General Setup
+*************
+
+The kubernetes installation will allocate all onap components across multiple worker node VMs.
+The normal worker VM hosting onap components has the following spec:
+
+- 16GB RAM
+- 8 VCPU
+- 160GB Ephemeral Disk
+
+
+The ONAP components used during the smoke tests are:
+
+- Policy API to perform CRUD of policies.
+- Policy DB to store the policies.
+- DMaaP for the communication between components.
+- Policy PAP to perform runtime administration (deploy/undeploy/status/statistics/etc).
+- Policy Apex-PDP to deploy & undeploy policies. And send heartbeats to PAP.
+- Policy Drools-PDP to deploy & undeploy policies. And send heartbeats to PAP.
+- Policy Xacml-PDP to deploy & undeploy policies. And send heartbeats to PAP.
+
+
+Testing procedure
+*****************
+
+The test set is focused on the following use cases:
+
+- Execute all the REST api's exposed by policy-pap component.
+
+Create policies using policy-api
+--------------------------------
+In order to test policy-pap, we need to use policy-api component to create the policies.
+
+Download & execute the steps in postman collection for creating policies.
+The steps needs to be performed sequentially one after another. And no input is required from user.
+
+`Policy Framework Lifecycle API <https://github.com/onap/policy-api/blob/master/postman/lifecycle-api-collection.json>`_
+
+Make sure to skip the delete policy steps.
+
+
+Execute policy-pap testing
+--------------------------
+Download & execute the steps in postman collection for verifying policy-pap component.
+The steps needs to be performed sequentially one after another. And no input is required from user.
+
+`Policy Framework Administration API <https://github.com/onap/policy-pap/blob/master/postman/pap-api-collection.json>`_
+
+Make sure to execute the delete steps in order to clean the setup after testing.
+
+
+Delete policies using policy-api
+--------------------------------
+Use the previously downloaded policy-api postman collection to delete the policies created for testing.