smo-install/test/pythonsdk/README.md

   1 # Python ORAN SDK
   2
   3 An extension of ONAP SDK, to use ORAN and ONAP components programmatically with Python code
   4
   5 ## Description
   6
   7 ORAN SDK is an extension of ONAP SDK. Please check [doc](https://python-onapsdk.readthedocs.io/en/latest/index.html) site to find out all the features about ONAP SDK.
   8
   9 This project aims to provide a consistent and complete set of interactions with ORAN’s many services.
  10
  11 Using few python commands, you should be able to run different tests with different components from ONAP and ORAN.
  12
  13 ### Setting up development environment
  14
  15 Ensure you have executed the script located in ... scripts/layer-0/0-setup-tests-env.sh
  16 This will setup eveything for you.
  17
  18 ### Testing
  19
  20 This project uses tox to run all the tests and do lint and docstyle checks.
  21
  22 ```
  23 $ tox
  24 ```
  25
  26 #### Unit testing
  27 To run only the unit test:
  28
  29 ```
  30 $ tox -e unit-tests
  31 ```
  32
  33 #### Integration testing
  34
  35 To run the integration tests, start all the needed ONAP and ORAN components & network simulators first on kubernetes.
  36
  37 Go to *scripts/layer-2* directory and start all the needed components with the scripts.
  38
  39 Then execute the integration tests with command:
  40
  41 ```
  42 $ tox -e oran-tests
  43 ```
  44
  45 #### Code analyse and check style checking
  46 To run code analyse and check check styles:
  47
  48 ```
  49 $ tox -e pylint
  50 ```
  51
  52 To check compliance with Python docstring conventions:
  53
  54 ```
  55 $ tox -e pydocstyle
  56 ```