Improve xtesting documentation 87/110887/3
authormrichomme <morgan.richomme@orange.com>
Tue, 4 Aug 2020 13:38:56 +0000 (15:38 +0200)
committermrichomme <morgan.richomme@orange.com>
Wed, 5 Aug 2020 08:28:03 +0000 (10:28 +0200)
- 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>
healthcheck/jobs/healthcheck-job-template.yaml
infra-healthcheck/README.md
security/README.md
smoke-usecases-pythonsdk/README.md
smoke-usecases-robot/README.md

index 049ec22..f000352 100644 (file)
@@ -1,22 +1,13 @@
----
-tests:
-  - core
-
-healthcheck_deployment:
-  apiVersion: batch/v1
-  kind: Job
-  metadata:
-    name: "functest-onap-{{ run_type }}"
-    namespace: "{{ onap_namespace }}"
-  spec:
+apiVersion: batch/v1
+kind: Job
+metadata:
+    name: integration-onap-"{{ run_type }}"
+    namespace: onap
+spec:
     template:
-      spec:
-        restartPolicy: Never
-        containers:
-          - name: functest-onap
-            image: registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting/health
-            imagePullPolicy: Always
-            env:
+        spec:
+            containers:
+            - env:
               - name: INSTALLER_TYPE
                 value: "{{ deployment_name }}"
               - name: DEPLOY_SCENARIO
@@ -24,29 +15,31 @@ healthcheck_deployment:
               - name: NODE_NAME
                 value: "{{ node_name }}"
               - name: TEST_DB_URL
-                value:
-                  "{{ test_result_url }}"
+                value: http://testresults.opnfv.org/onap/api/v1/results
               - name: BUILD_TAG
                 value: "{{ build_tag }}"
               - name: TAG
                 value: "{{ run_type }}"
+            image: nexus3.onap.org:10001/onap/xtesting-healthcheck:latest
+            imagePullPolicy: Always
+            name: integration-"{{ run_type }}"
             volumeMounts:
-              - name: localtime
-                mountPath: /etc/localtime
-                readOnly: true
-              - name: robot-eteshare
-                mountPath: /share/config
-              - name: robot-save-results
-                mountPath:
-                  /var/lib/xtesting/results/
-        volumes:
-          - name: localtime
-            hostPath:
+            - mountPath: /etc/localtime
+              name: localtime
+              readOnly: true
+            - mountPath: /share/config
+              name: robot-eteshare
+            - mountPath: /var/lib/xtesting/results/
+              name: robot-save-results
+            restartPolicy: Never
+            volumes:
+            - hostPath:
               path: /etc/localtime
-          - name: robot-eteshare
-            configMap:
-              name: "{{ onap_namespace }}-robot-robot-eteshare-configmap"
-              defaultMode: 0755
-          - name: robot-save-results
-            hostPath:
-              path: "{{ res_local_path }}/{{ run_type }}"
+              name: localtime
+            - configMap:
+                  defaultMode: 493
+                  name: onap-robot-eteshare-configmap
+              name: robot-eteshare
+            - hostPath:
+                  path: "{{ res_local_path }}"
+              name: robot-save-results
index 9a27cfd..0f7001b 100644 (file)
@@ -39,7 +39,7 @@ You can run this docker by typing:
 ```
 docker run -v <the kube config>:/root/.kube/config -v
 <result directory>:/var/lib/xtesting/results
-registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting/infra-healthcheck:latest
+nexus3.onap.org:10001/onap/xtesting-infra-healthcheck:latest
 ```
 
 Options:
@@ -67,9 +67,9 @@ The command becomes:
 
 ```
 docker run -v <the kube config>:/root/.kube/config -v
-<result directory>:/var/lib/xtesting/results registry.gitlab.com/orange-opensour
-ce/lfn/onap/integration/xtesting/infra-healthcheck:latest:latest /bin/bash -c "
-run_tests -r -t all
+<result directory>:/var/lib/xtesting/results
+nexus3.onap.org:10001/onap/xtesting-infra-healthcheck:latest:latest
+/bin/bash -c "run_tests -r -t all"
 ```
 
 ### Output
index 3365d55..6a5e38e 100644 (file)
@@ -42,7 +42,7 @@ You can run this docker by typing:
 ```
 docker run -v <the kube config>:/root/.kube/config -v
 <result directory>:/var/lib/xtesting/results
-registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting/security:latest
+nexus3.onap.org:10001/onap/xtesting-security:latest
 ```
 
 Options:
@@ -68,8 +68,9 @@ The command becomes:
 
 ```
 docker run -v <the kube config>:/root/.kube/config -v
-<result directory>:/var/lib/xtesting/results registry.gitlab.com/orange-opensour
-ce/lfn/onap/integration/xtesting/security:latest /bin/bash -c "run_tests -r -t all
+<result directory>:/var/lib/xtesting/results
+nexus3.onap.org:10001/onap/xtesting-security:latest
+/bin/bash -c "run_tests -r -t all
 ```
 
 ### Output
@@ -78,10 +79,10 @@ ce/lfn/onap/integration/xtesting/security:latest /bin/bash -c "run_tests -r -t a
 +-----------------------+------------+------------+------------+-----------+
 |       TEST CASE       |  PROJECT   |    TIER    |  DURATION  |  RESULT   |
 +-----------------------+------------+------------+------------+-----------+
-|       root_pods       |  security  |  security  |   03:48    |   FAIL    |
+|       root_pods       |  security  |  security  |   03:48    |   PASS    |
 |    unlimitted_pods    |  security  |  security  |   00:37    |   FAIL    |
-|     cis_kubernetes    |  security  |  security  |   00:01    |   FAIL    |
-| http_public_endpoints |  security  |  security  |   00:01    |   FAIL    |
-|       jdpw_ports      |  security  |  security  |   05:39    |   FAIL    |
+|     cis_kubernetes    |  security  |  security  |   00:01    |   PASS    |
+| http_public_endpoints |  security  |  security  |   00:01    |   PASS    |
+|       jdpw_ports      |  security  |  security  |   05:39    |   PASS    |
 +-----------------------+------------+------------+------------+-----------+
 ```
index 7f9e0b7..a840ef1 100644 (file)
@@ -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"
index 74b36f3..b2be51d 100644 (file)
@@ -43,7 +43,7 @@ spec:
                     value: gitlab_ci-functest-kubespray-baremetal-daily-master-559950989
                 -   name: TAG
                     value: 5gbulkpm
-                image: registry.gitlab.com/orange-opensource/lfn/onap/integration/xtesting/smoke-usecases-robot:latest
+                image: nexus3.onap.org:10001/onap/xtesting-smoke-usecases-robot:latest
                 imagePullPolicy: Always
                 name: functest-onap
                 volumeMounts: