X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdevelopment%2Fdevtools%2Fdevtools.rst;h=5dc3af33a95247925cd3e04b5e64359d0f801c2f;hb=a38f506800bdfb0c960072f08571ce84c95c66ff;hp=fac06ac6591f7110197c46dde1205bcf51c93ed9;hpb=8216132d2a5a12f10610ab652a7ae68322bdbff9;p=policy%2Fparent.git diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index fac06ac6..5dc3af33 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -58,7 +58,7 @@ ONAP Policy Framework has dependencies to the ONAP Parent *oparent* module, the policy/xacml-pdp \ policy/distribution \ policy/gui \ - policy/engine " + policy/clamp " ## ## Help screen and exit condition (i.e. too few arguments) @@ -152,7 +152,7 @@ Execution of the script above results in the following directory hierarchy in yo * ~/git/onap/policy/docker * ~/git/onap/policy/drools-applications * ~/git/onap/policy/drools-pdp - * ~/git/onap/policy/engine + * ~/git/onap/policy/clamp * ~/git/onap/policy/apex-pdp * ~/git/onap/policy/xacml-pdp * ~/git/onap/policy/distribution @@ -198,10 +198,7 @@ Building ONAP Policy Framework Components drools-applications distribution gui - - engine + clamp @@ -233,7 +230,7 @@ Developing and Debugging each Policy Component Running a MariaDb Instance ++++++++++++++++++++++++++ -The Policy Framework requires a MariaDb instance running. The easiest way to do this is to run a docker image locally. +The Policy Framework requires a MariaDb instance running. The easiest way to do this is to run a docker image locally. One example on how to do this is to use the scripts used by the policy/api S3P tests. @@ -267,6 +264,39 @@ An example of running the api using a docker compose script is located in the Po `Policy CSIT API Docker Compose `_ +Running the Smoke Tests +*********************** + +The following links contain instructions on how to run the smoke tests. These may be helpful to developers to become +familiar with the Policy Framework components and test any local changes. + +.. toctree:: + :maxdepth: 1 + + policy-gui-controlloop-smoke.rst + db-migrator-smoke.rst + cl-participants-smoke.rst + clamp-smoke.rst + clamp-cl-participant-protocol-smoke.rst + policy-participant-smoke.rst + api-smoke.rst + +.. + pap-smoke.rst + +.. + apex-smoke.rst + +.. + drools-smoke.rst + +.. + xacml-smoke.rst + +.. + distribution-smoke.rst + + Running the Stability/Performance Tests *************************************** @@ -282,6 +312,39 @@ familiar with the Policy Framework components and test any local changes. drools-s3p.rst xacml-s3p.rst distribution-s3p.rst + clamp-s3p.rst + +Running the Pairwise Tests +************************** + +The following links contain instructions on how to run the pairwise tests. These may be helpful to developers check that +the Policy Framework works in a full ONAP deployment. + +.. toctree:: + :maxdepth: 1 + + clamp-policy.rst + + clamp-dcae.rst + +.. + api-pairwise.rst + +.. + pap-pairwise.rst + +.. + apex-pairwise.rst + +.. + drools-pairwise.rst + +.. + xacml-pairwise.rst + +.. + distribution-pairwise.rst + Generating Swagger Documentation ********************************