aboutsummaryrefslogtreecommitdiffstats
path: root/smoke-usecases-pythonsdk/README.md
diff options
context:
space:
mode:
authormrichomme <morgan.richomme@orange.com>2020-08-04 15:38:56 +0200
committermrichomme <morgan.richomme@orange.com>2020-08-05 10:28:03 +0200
commitf85d137e483e632f0b8d912708aae485baeabf1b (patch)
treef1f6111610f14221bb600e996ac6d6752671b95c /smoke-usecases-pythonsdk/README.md
parent12457c4de491842f001fb1f9ac0393b9e1fe6b4e (diff)
Improve xtesting documentation
- replace gitlab.com images by Nexus3 images - update smoke test (even it will be deprecated soon) Issue-ID: INT-1676 Signed-off-by: mrichomme <morgan.richomme@orange.com> Change-Id: Ic7ebaa4d12b3e1872e51a895fc1b67dfc084e900 Signed-off-by: mrichomme <morgan.richomme@orange.com>
Diffstat (limited to 'smoke-usecases-pythonsdk/README.md')
-rw-r--r--smoke-usecases-pythonsdk/README.md47
1 files changed, 44 insertions, 3 deletions
diff --git a/smoke-usecases-pythonsdk/README.md b/smoke-usecases-pythonsdk/README.md
index 7f9e0b7..a840ef1 100644
--- a/smoke-usecases-pythonsdk/README.md
+++ b/smoke-usecases-pythonsdk/README.md
@@ -11,16 +11,57 @@ but the Dockerfile must be adapted accordingly.
The tests are:
-* basic_vm: it onboard/distribute/deploy a single Ubuntu VM in ONAP using
+- basic_vm: it onboard/distribute/deploy a single Ubuntu VM in ONAP using
VNF-API. The components used are SDC, SO, AA&I, SDNC.
-* freeradius_nbi: based on basic_vm, the instantiation part is done through the
+- freeradius_nbi: based on basic_vm, the instantiation part is done through the
ONAP external API (NBI) module.
-* clearwater_ims: it consists in a full deployment of an clearwater vIMS in ONAP.
+- clearwater_ims: it consists in a full deployment of an clearwater vIMS in ONAP.
## Usage
+Note this docker will be deprecated in Guilin. The existing 3 test cases and
+additional ones will be performed through test cases [2] consuming the Python
+ONAP SDK [1]
+
### Configuration
+Mandatory:
+
+Assuming that these use cases were based on onap-tests, the service descriptions
+must be overwritten with the right cloud informations as well as the onap-tests
+configuration. That is why 2 volumes are needed:
+
+- <custom onap-tests config>: The last section of the default configuration must
+ be adapted to your environement [3]
+- <service description dir>: the customized service descriptions including the
+ parameters to be overwritten (SDNC preload) [4]
+
+Optional:
+
+- The local result directory path: to store the results in your local
+ environement. It shall corresponds to the internal result docker path
+ /var/lib/xtesting/results
+- The cloud.yaml if you enable the Openstack verification option (Openstack
+ client call to check that the stack is created in Openstack)
+
### Command
+```
+docker run
+-v <your local env>:/var/lib/xtesting/conf/env_file
+-v <custom onap-tests config>:/usr/lib/python3.8/site-packages/onap_tests/onap-conf/onap-testing.yaml
+-v <service description dir>:/usr/lib/python3.8/site-packages/onap_tests/templates/vnf-services
+-v <cloud.yaml file corresponding to your VNF tenant>/root/.config/openstack.yaml
+-v <result directory>:/var/lib/xtesting/results
+nexus3.onap.org:10001/onap/xtesting-infra-healthcheck:latest
+```
+
### Output
+
+[1]: https://gitlab.com/Orange-OpenSource/lfn/onap/python-onapsdk "Python ONAP SDK repository"
+
+[2]: https://git.onap.org/testsuite/pythonsdk-tests/tree/ "Scenario consuming Python SDK"
+
+[3]: https://gitlab.com/Orange-OpenSource/lfn/onap/onap-tests/-/blob/master/onap_tests/onap-conf/onap-testing.yaml "onap-test configuration"
+
+[4]: https://gitlab.com/Orange-OpenSource/lfn/onap/xtesting-onap/-/tree/master/roles/xtesting-onap-vnf "File and templates of service descriptions"