aboutsummaryrefslogtreecommitdiffstats
path: root/docs/development/devtools/api-smoke.rst
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2021-11-11 14:36:15 -0500
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2021-11-11 19:45:03 +0000
commita38f506800bdfb0c960072f08571ce84c95c66ff (patch)
tree2570aacd8bc49280cbca3b9d1d7d4b2f313ddd02 /docs/development/devtools/api-smoke.rst
parenta79dddcd4862ca36048553b7e325ab7b327259e6 (diff)
Add document for policy-api smoke test
Adding document for policy-api smoke testing. Issue-ID: POLICY-3717 Change-Id: Icc87a4927cfa84068c354cfaa2115486f4b0caab Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Diffstat (limited to 'docs/development/devtools/api-smoke.rst')
-rw-r--r--docs/development/devtools/api-smoke.rst47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/development/devtools/api-smoke.rst b/docs/development/devtools/api-smoke.rst
new file mode 100644
index 00000000..638546bd
--- /dev/null
+++ b/docs/development/devtools/api-smoke.rst
@@ -0,0 +1,47 @@
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+.. _policy-api-smoke-testing-label:
+
+.. toctree::
+ :maxdepth: 2
+
+Policy API Smoke Test
+~~~~~~~~~~~~~~~~~~~~~
+
+The policy-api 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.
+
+
+Testing procedure
+*****************
+
+The test set is focused on the following use cases:
+
+- Execute all the REST api's exposed by policy-api component.
+
+Execute policy-api testing
+--------------------------
+Download & execute the steps in postman collection for verifying policy-api component.
+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 execute the delete steps in order to clean the setup after testing.