diff options
author | Ram Krishna Verma <ram_krishna.verma@bell.ca> | 2021-11-12 15:26:59 +0000 |
---|---|---|
committer | Gerrit Code Review <gerrit@onap.org> | 2021-11-12 15:26:59 +0000 |
commit | 125887847b013f0123ebb941876b21a8b543de6e (patch) | |
tree | b0788edf9db1efc8cb2c2020974725f22496895c | |
parent | 119895946e206c516c2198e58553774fdc143fea (diff) | |
parent | 6a7d19ece22fab89ccc7aabced4609bef11ce3c7 (diff) |
Merge "Add document for policy-api smoke test" into istanbul
-rw-r--r-- | docs/development/devtools/api-smoke.rst | 47 | ||||
-rw-r--r-- | docs/development/devtools/devtools.rst | 2 |
2 files changed, 47 insertions, 2 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. diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index fae3d17c..cef06796 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -279,8 +279,6 @@ familiar with the Policy Framework components and test any local changes. clamp-smoke.rst clamp-cl-participant-protocol-smoke.rst policy-participant-smoke.rst - -.. api-smoke.rst .. |