README.md

   1 <!--
   2 Copyright 2020 ETSI
   3
   4 Licensed under the Apache License, Version 2.0 (the "License");
   5 you may not use this file except in compliance with the License.
   6 You may obtain a copy of the License at
   7
   8    http://www.apache.org/licenses/LICENSE-2.0
   9
  10 Unless required by applicable law or agreed to in writing, software
  11 distributed under the License is distributed on an "AS IS" BASIS,
  12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  13 implied.
  14 See the License for the specific language governing permissions and
  15 limitations under the License
  16 -->
  17
  18 # OSM test automation project - osm/tests
  19
  20 This repository contains tools and configuration files for testing and automation needs of OSM projet
  21
  22 ## Prerequisites
  23
  24 * **Robot Framework**
  25 * **Packages**: ssh ping yq git
  26 * **Python3 packages**: haikunator requests robotframework robotframework-seleniumlibrary robotframework-requests robotframework-jsonlibrary robotframework-sshlibrary
  27 * Clone **osm-packages** from gitlab
  28 * Environment config file for your infrastructure [envfile.rc]
  29
  30 ## Installing
  31
  32 This bash script can be used to setup your environment to execute the tests.
  33
  34 ```bash
  35    PACKAGES_FOLDER=osm-packages
  36    add-apt-repository -y ppa:rmescandon/yq && apt update && apt install yq git iputils-ping ssh -y
  37    pip install haikunator requests robotframework robotframework-seleniumlibrary robotframework-requests robotframework-jsonlibrary \
  38       robotframework-sshlibrary
  39    # Download community packages
  40    git clone https://osm.etsi.org/gitlab/vnf-onboarding/osm-packages.git ${PACKAGES_FOLDER}
  41 ```
  42
  43 envfile.rc
  44
  45 ```bash
  46    # VIM setup
  47    OS_USERNAME=<openstack_username>
  48    OS_PASSWORD=<openstack_password>
  49    OS_TENANT_NAME=<openstack_tenant_name>
  50    OS_AUTH_URL=<openstack_authorization_url>
  51    OS_TENANT_ID=<openstack_tenant_id>
  52    OSM_HOSTNAME=<osm_ip_address>
  53    VIM_TARGET=<osm_vim_name>
  54    VIM_MGMT_NET=<osm_vim_mgmt_name>
  55
  56    # The following set of environment variables will be used in host
  57    # of the robot framework. Not needed for docker execution
  58
  59    # Folder where Robot tests are stored
  60    ROBOT_DEVOPS_FOLDER=robot-systest
  61
  62    # Folder to save alternative DUT environments (optional)
  63    ENVIRONMENTS_FOLDER=environments
  64
  65    # Folder where all required packages are stored
  66    PACKAGES_FOLDER=osm-packages
  67
  68    # Folder where test results should be exported
  69    ROBOT_REPORT_FOLDER=results
  70 ```
  71
  72 ## Deployment
  73
  74 It is possible to run the tests directly from the repository or using a docker container with the tests
  75
  76 1. Docker container creation:
  77
  78 ```bash
  79 docker build -t osmtests .
  80 ```
  81
  82 Options:
  83
  84 * --env-file: It is the environmental file where is described the OSM target and VIM
  85 * -o <osmclient_version> [OPTIONAL]: It is used to specify a particular osmclient version. Default: latest
  86 * -p <package_branch> [OPTIONAL]: OSM packages repository branch. Default: master
  87 * -t <testing_tags> [OPTIONAL]: Robot tests tags. [sanity, regression, particular_test]. Default: sanity
  88
  89 Volumes:
  90
  91 * <path_to_reports> [OPTIONAL]: It is the absolute path to reports location in the host
  92 * <path_to_clouds.yaml> [OPTIONAL]: It is the absolute path to the clouds.yaml file in the host
  93
  94 ```bash
  95    docker run --rm=true -t osmtests --env-file <env_file> \
  96        -v <path_to_reports>:/reports osmtests -v <path_to_clouds.yaml>:/robot-systest/clouds.yaml \
  97        -v <path_to_kubeconfig>:/robot-systest/kubeconfig.yaml
  98        -o <osmclient_version> -p <package_branch> -t <testing_tags>
  99 ```
 100
 101 1. Running the tests manually:
 102
 103 The way of executing the tests is via the following command:
 104
 105 ```bash
 106    source envfile.rc
 107    robot -d reports -i <testing_tags> testsuite/
 108 ```
 109
 110 ## Built With
 111
 112 * [Python](www.python.org/) - The language used
 113 * [Robot Framework](robotframework.org) - The testing framework
 114
 115 ## Contributing
 116
 117 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 118
 119 ## Versioning
 120
 121 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).
 122
 123 ## License
 124
 125 This project is licensed under the Apache2 License - see the [LICENSE.md](LICENSE) file for details
 126
 127 ## Acknowledgments