Update requirements-dev.txt based on osmclient and IM requirements
[osm/tests.git] / README.md
index f38799c..03d6054 100644 (file)
--- a/README.md
+++ b/README.md
@@ -39,50 +39,15 @@ PACKAGES_FOLDER=osm-packages
 git clone https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git ${PACKAGES_FOLDER}
 ```
 
-Configure a file `envfile.rc` copying from `envconfig-local.rc` and set the required variables
+## Configure the environment
 
-```bash
-# VIM Setup
-OS_USERNAME=<openstack_username>
-OS_PASSWORD=<openstack_password>
-OS_TENANT_NAME=<openstack_tenant_name>
-OS_AUTH_URL=<openstack_authorization_url>
-OS_TENANT_ID=<openstack_tenant_id>
-
-# OSM Setup
-OSM_HOSTNAME=<osm_ip_address>
-VIM_TARGET=<osm_vim_name>
-VIM_MGMT_NET=<osm_vim_mgmt_name>
-
-# Clouds file datacenter
-OS_CLOUD=<datacenter_in_clouds_file>
-# SDNCs file
-OS_SDNC=<SDN_controller_in_sdncs_file>
-
-# K8S config file
-K8S_CREDENTIALS=<path_to_kubeconfig>
-
-# The following set of environment variables will be used in host
-# of the robot framework. Not needed for docker execution
-
-# Folder where Robot tests are stored
-ROBOT_DEVOPS_FOLDER=robot-systest
-
-# Folder to save alternative DUT environments (optional)
-ENVIRONMENTS_FOLDER=environments
-
-# Folder where all required packages are stored
-PACKAGES_FOLDER=osm-packages
-
-# Folder where test results should be exported
-ROBOT_REPORT_FOLDER=results
-```
+Create a file `envfile.rc` copying from `envconfig-local.rc` and set the required variables.
 
 ## Running the tests
 
 ### From the host machine
 
-If you have installed all the dependecnies, the way of executing the tests is via the following command:
+If you have installed all the dependencies, the way of executing the tests is via the following command:
 
 ```bash
 source envfile.rc
@@ -128,7 +93,7 @@ docker run --rm=true -t osmtests --env-file <env_file> \
 
 ### From an environment identical to OSM CICD
 
-````bash
+```bash
 git clone https://osm.etsi.org/gerrit/osm/devops
 git clone https://osm.etsi.org/gerrit/osm/IM
 git clone https://osm.etsi.org/gerrit/osm/osmclient
@@ -181,6 +146,7 @@ The following tags exist for each testsuite:
   - `cluster_sa`: `sa_01`, `sa_02`, `sa_07`
   - `cluster_slices`: `slice_01`, `slice_02`
   - `cluster_heal`: `heal_01`, `heal_02`, `heal_03`, `heal_04`
+  - `cluster_sol003`: `sol003_01`
 - daily: for all testsuites that will run in the daily job
 - regression: for all testsuites that should pass in the current stable branch
 - sanity: for all testsuites that should be passed by each commit in the
@@ -193,11 +159,11 @@ the tests were forcefully stopped.
 
 - For helping in the migration tests and other scenarios in which you don't want
 to destroy the deployments immediately, the following tags are used:
-  - prepare: for the tests that are used to deploy the network
+  - `prepare`: for the tests that are used to deploy the network
   services under test
-  - verify: for the tests that perform the actual testing, or changes for
+  - `verify`: for the tests that perform the actual testing, or changes for
   additional verifications (e.g. scaling).
-  - cleanup: already described above.
+  - `cleanup`: already described above.
 
   So, for instance, you could first deploy a number of network services executing
   the tests with "prepare" tag, migrate to another OSM version, and then