X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2Ftests.git;a=blobdiff_plain;f=README.md;h=eb13bf06cf98955c8f69c9e35cd2b30be2783edb;hp=86013229f759ddd6745c7cac27fa29aa9a63af30;hb=f96bb45c0a03f2188688d90d67ea718851cec2de;hpb=83721f3f6fba26d9137d0271af9ed700bb615caa

diff --git a/README.md b/README.md
index 8601322..eb13bf0 100644
--- a/README.md
+++ b/README.md
@@ -14,55 +14,103 @@ implied.
 See the License for the specific language governing permissions and
 limitations under the License
 -->
-# Project Title
 
-One Paragraph of project description goes here
+# OSM test automation project - osm/tests
 
-## Getting Started
+This repository contains tools and configuration files for testing and automation needs of OSM projet
 
-These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+## Prerequisites
 
-### Prerequisites
+* **Robot Framework**
+* **Packages**: ssh ping yq git
+* **Python3 packages**: haikunator requests robotframework robotframework-seleniumlibrary robotframework-requests robotframework-jsonlibrary robotframework-sshlibrary
+* Clone **osm-packages** from gitlab
+* Environment config file for your infrastructure [envfile.rc]
 
-What things you need to install the software and how to install them
+## Installing
 
-```
-Give examples
+This bash script can be used to setup your environment to execute the tests.
+
+```bash
+   PACKAGES_FOLDER=osm-packages
+   add-apt-repository -y ppa:rmescandon/yq && apt update && apt install yq git iputils-ping ssh -y
+   pip install haikunator requests robotframework robotframework-seleniumlibrary robotframework-requests robotframework-jsonlibrary \
+      robotframework-sshlibrary
+   # Download community packages
+   git clone https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git ${PACKAGES_FOLDER}
 ```
 
-### Installing
+envfile.rc
 
-A step by step series of examples that tell you how to get a development env running
+```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_HOSTNAME=<osm_ip_address>
+   VIM_TARGET=<osm_vim_name>
+   VIM_MGMT_NET=<osm_vim_mgmt_name>
 
-Say what the step will be
+   # The following set of environment variables will be used in host
+   # of the robot framework. Not needed for docker execution
 
-```
-Give the example
-```
+   # Folder where Robot tests are stored
+   ROBOT_DEVOPS_FOLDER=robot-systest
 
-And repeat
+   # Folder to save alternative DUT environments (optional)
+   ENVIRONMENTS_FOLDER=environments
 
-```
-until finished
+   # Folder where all required packages are stored
+   PACKAGES_FOLDER=osm-packages
+
+   # Folder where test results should be exported
+   ROBOT_REPORT_FOLDER=results
 ```
 
-End with an example of getting some data out of the system or using it for a little demo
+## Deployment
 
-## Running the tests
+It is possible to run the tests directly from the repository or using a docker container with the tests
 
-Explain how to run the automated tests for this system
+1. Docker container creation:
 
+```bash
+docker build -t osmtests .
 ```
-Give an example
+
+Options:
+
+* --env-file: It is the environmental file where is described the OSM target and VIM
+* -o <osmclient_version> [OPTIONAL]: It is used to specify a particular osmclient version. Default: latest
+* -p <package_branch> [OPTIONAL]: OSM packages repository branch. Default: master
+* -t <testing_tags> [OPTIONAL]: Robot tests tags. [sanity, regression, particular_test]. Default: sanity
+
+Volumes:
+
+* <path_to_reports> [OPTIONAL]: It is the absolute path to reports location in the host
+* <path_to_clouds.yaml> [OPTIONAL]: It is the absolute path to the clouds.yaml file in the host
+
+```bash
+   docker run --rm=true -t osmtests --env-file <env_file> \
+       -v <path_to_reports>:/reports osmtests -v <path_to_clouds.yaml>:/robot-systest/clouds.yaml \
+       -v <path_to_kubeconfig>:/robot-systest/kubeconfig.yaml
+       -o <osmclient_version> -p <package_branch> -t <testing_tags>
 ```
 
-## Deployment
+1. Running the tests manually:
 
-Add additional notes about how to deploy this on a live system
+The way of executing the tests is via the following command:
+
+```bash
+   source envfile.rc
+   robot -d reports -i <testing_tags> testsuite/
+```
 
 ## Built With
 
 * [Python](www.python.org/) - The language used
+* [Robot Framework](robotframework.org) - The testing framework
 
 ## Contributing
 
@@ -70,13 +118,10 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://osm.etsi.org/gitweb/?p=osm/TEMPLATE.git;a=tags).
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://osm.etsi.org/gitweb/?p=osm/tests.git;a=tags).
 
 ## License
 
 This project is licensed under the Apache2 License - see the [LICENSE.md](LICENSE) file for details
 
 ## Acknowledgments
-
-* **Billie Thompson** - *Initial work* - [PurpleBooth](https://github.com/PurpleBooth)
-