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