README.md

   1 # pythonsdk-tests
   2
   3 This project is a wrapper to use onapsdk toolkit to onboard and
   4 instantiate services on ONAP
   5
   6 ## Temporary help section
   7
   8 A basic example is implemented in the python file
   9
  10 - run_basicvm_multicloud_yaml.py
  11
  12 The global datas defined in these files (see input_datas) shall be
  13 adapted to your environment.
  14
  15 In addition you must define your service in directory templates/vnf-services
  16 and create zip file for heat template templates/heat_files.
  17 See ubuntu16test as example
  18
  19 ### Prepare your environment and run tests
  20
  21 - Clone the project (using instantiation branch)
  22   ```shell
  23   git clone https://gerrit.onap.org/r/testsuite/pythonsdk-tests.git
  24   ```
  25
  26 - Create a virtual environment and clone the python-onapsdk
  27   ```shell
  28   virtualenv my_test
  29   source my_test/bin/activate
  30   git clone git@gitlab.com:Orange-OpenSource/lfn/onap/python-onapsdk.
  31   git -b develop
  32   cd python-onapsdk
  33   pip install -e .
  34   cd ..
  35   pip install -e .
  36   ```
  37
  38 - Set global settings configuration files with all required input datas
  39   including the dynamic forwarding port for ssh tunnel in
  40   src/onaptests/configuration/settings.py. You can customize the path for your
  41   logs and reporting the page. Note that the reporting page assumes that the
  42   logs are put in the same directory than the html page (relative path).
  43
  44 - Set OpenStack configuration: there are 2 ways to provide the cloud information
  45   If you got the clouds.yaml, you need to reference your cloud with the env
  46   variable OS_TEST_CLOUD
  47   ```shell
  48   export OS_TEST_CLOUD=cloud-name-referenced-in-the-cloud-configuration
  49   ```
  50   If you do not have access to the cloud config, you must precise all the
  51   parameters manually
  52
  53 - Export the setting file in a environment variable
  54   ```shell
  55   export ONAP_PYTHON_SDK_SETTINGS=onaptests.configuration.ubuntu16_multicloud_yaml_settings
  56   ```
  57
  58 Note each "use case" may have its own settings corresponding to the test
  59 environment and configuration.
  60
  61 - (optional) Open ssh tunnel towards your openlab setting a dynamic
  62   port forward (by default 1080):
  63   ```shell
  64   ssh user@onap.pod4.opnfv.fr -D 1080
  65   ```
  66
  67 - Once the different input datas are updated in run\_\*.py files and
  68   that the templates files for your service are defined, start to run
  69   the different steps:
  70   ```shell
  71   python run_basicvm_nomulticloud.py
  72   ```
  73
  74 - By default, all the logs are stored in the file pythonsdk.debug.log.
  75   The file name and location can be set in the settings.py