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.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
  41
  42 - Export the setting file in a environment variable
  43   ```shell
  44   export ONAP_PYTHON_SDK_SETTINGS="onaptests.configuration.settings"
  45   ```
  46
  47 - (optional) Open ssh tunnel towards your openlab setting a dynamic
  48   port forward (by default 1080):
  49   ```shell
  50   ssh user@onap.pod4.opnfv.fr -D 1080
  51   ```
  52
  53 - Once the different input datas are updated in run\_\*.py files and
  54   that the templates files for your service are defined, start to run
  55   the different steps:
  56   ```shell
  57   python run.py
  58   ```
  59
  60 - By default, all the logs are stored in the file pythonsdk.debug.log.
  61   The file name and location can be set in the settings.py