docs/developer-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 Developer-Guide
   5 ===============
   6
   7 .. contents::
   8    :depth: 3
   9    :local:
  10
  11 Tech Stack
  12 ----------
  13
  14 -  OpenAPI3
  15 -  Connexion
  16 -  Flask with Gevent serving
  17 -  Python3.7
  18
  19 Version bumping
  20 ---------------
  21
  22 This project follows semver. When changes are made, the versions are in:
  23
  24 1) ``docs/release-notes.rst``
  25
  26 2) ``setup.py``
  27
  28 3) ``container-tag.yaml``
  29
  30 4) ``integration_tests/a1mediator/Chart.yaml``
  31
  32 6) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
  33
  34 7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
  35
  36
  37 Version bumping rmr
  38 -------------------
  39 As of 2020/02/13, A1 and all three integration test receivers use a base image from o-ran-sc.
  40 The rmr version is in that base image.
  41 However, the one item in this repo that must be kept in sync is ``rmr-version.yaml``. This controls what rmr gets installed for unit testing.
  42
  43 Version bumping pyrmr
  44 ---------------------
  45 rmr-python is the python binding to rmr . Installing rmr per the above does not install it.
  46 Bumping the rmr python version dependency requires changes in:
  47
  48 1) ``setup.py``
  49
  50 2) ``integration_tests/Dockerfile-test-delay-receiver``
  51
  52 3) ``integration_tests/Dockerfile-query-receiver``
  53
  54 Run the integration tests after attempting this.
  55
  56 Unit Testing
  57 ------------
  58 Note,  before this will work, for the first time on the machine running the tests, run ``./install_deps.sh``. This is only needed once on the machine.
  59 Also, this requires the python packages ``tox`` and ``pytest``.
  60
  61 ::
  62
  63    tox
  64    open htmlcov/index.html
  65
  66 Alternatively, you can run the unit tests in Docker (this is somewhat less nice because you don't get the pretty HTML)
  67
  68 ::
  69
  70    docker build  --no-cache -t a1test:latest -f Dockerfile-Unit-Test
  71
  72 Integration testing
  73 -------------------
  74 This tests A1’s external API with three test receivers. This depends on helm+k8s.
  75
  76 Build all the containers:
  77
  78 ::
  79
  80     docker build  -t a1:latest .; cd integration_tests/; docker build  -t testreceiver:latest . -f Dockerfile-test-delay-receiver; docker build -t queryreceiver:latest . -f Dockerfile-query-receiver; cd ..
  81
  82
  83 Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
  84
  85 ::
  86
  87    tox -c tox-integration.ini
  88
  89 This script:
  90 1. Deploys 2 helm charts (4 containers) into a local kubernetes installation
  91 2. Port forwards a pod ClusterIP to localhost
  92 3. Uses “tavern” to run some tests against the server
  93 4. Barrages the server with apache bench
  94 5. Tears everything down