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 The A1 Mediator is implemented in Python, currently version 3.8, and
  15 depends on these third-party packages and technologies:
  16
  17 - OpenAPI3
  18 - Connexion
  19 - Flask with Gevent serving
  20 - Swagger
  21 - Prometheus
  22
  23
  24 Version bumping A1
  25 ------------------
  26
  27 This project follows semver. When the version string changes, these
  28 files must be updated:
  29
  30 #. ``setup.py``
  31 #. ``container-tag.yaml``
  32 #. ``integration_tests/a1mediator/Chart.yaml``
  33 #. ``docs/release-notes.rst``
  34 #. ``a1/openapi.yaml`` But note this is an API version, not a software version; there's no need to bump on non-API changes.
  35 #.  And over in the ric-plt/ric-dep repo that contains the A1 Mediator helm chart, files ``values.yaml`` and ``Chart.yaml``.
  36
  37 It's convenient to use the Python utility `bumpversion` to maintain
  38 the first three items.  After setup (``pip install bumpversion``) you
  39 can change the patch version like this::
  40
  41     bumpversion --verbose patch
  42
  43 Or change the minor version like this::
  44
  45     bumpversion --verbose minor
  46
  47 After the `bumpversion` utility has modified the files, update the
  48 release notes then commit.
  49
  50
  51 Version bumping RMR
  52 -------------------
  53
  54 A1 (Dockerfile), Dockerfile-Unit-Test, and all three integration test
  55 receivers use an Alpine base image and install RMR from a base builder
  56 image.  Must update and rebuild all 5 containers in the A1 repo (or
  57 just A1 itself for production usage).
  58
  59 In addition these items in this repo must be kept in sync:
  60
  61 #. ``rmr-version.yaml`` controls what rmr gets installed for unit
  62    testing in Jenkins
  63 #. ``integration_tests/install_rmr.sh`` is a useful script for a
  64    variety of local testing.
  65
  66
  67 Version bumping Python
  68 ----------------------
  69
  70 If you want to update the version of python; for example this was
  71 recently done to move from 3.7 to 3.8, update these files:
  72
  73 #. ``Dockerfile``
  74 #. ``Dockerfile-Unit-Test``
  75 #. ``tox.ini``
  76
  77
  78 Running A1 Standalone
  79 ---------------------
  80
  81 The A1 container can be run standalone, which means using an in-memory mock
  82 version of SDL and a static route table. The host machine must have the RMR
  83 library and the environment must define the variable `prometheus_multiproc_dir`
  84 with a value like /tmp.  Alternately, use the following command to run A1 as
  85 a Docker container, using a route table mounted as a file from this git
  86 repository and exposing the server's HTTP port on the Docker host::
  87
  88     docker run -e USE_FAKE_SDL=True -p 10000:10000 -v `pwd`:/opt/route [DOCKER_IMAGE_ID_HERE]
  89
  90 Then test the server with an invocation such as this::
  91
  92     curl localhost:10000/a1-p/healthcheck
  93
  94
  95 Unit Testing
  96 ------------
  97
  98 Running the unit tests requires the python packages ``tox`` and ``pytest``.
  99
 100 The RMR library is also required during unit tests. If running
 101 directly from tox (outside a Docker container), install RMR using the
 102 script in the integration_tests directory: ``install_rmr.sh``.
 103
 104 Upon completion, view the test coverage like this:
 105
 106 ::
 107
 108    tox
 109    open htmlcov/index.html
 110
 111 Alternatively, you can run the unit tests in Docker (this is somewhat
 112 less nice because you don't get the pretty HTML)
 113
 114 ::
 115
 116    docker build  --no-cache -f Dockerfile-Unit-Test .
 117
 118
 119 Integration testing
 120 -------------------
 121
 122 This tests A1’s external API with three test receivers. This requires
 123 docker, kubernetes and helm.
 124
 125 Build all the images:
 126
 127 ::
 128
 129     docker build  -t a1:latest .
 130     cd integration_tests/testxappcode
 131     docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
 132     docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
 133     docker build -t testreceiver:latest  -f Dockerfile-test-receiver  .
 134
 135
 136 Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
 137
 138 ::
 139
 140    tox -c tox-integration.ini
 141
 142 This script:
 143
 144 #. Deploys 3 helm charts (5 containers) into a local kubernetes installation
 145 #. Port forwards a pod ClusterIP to localhost
 146 #. Uses “tavern” to run some tests against the server
 147 #. Barrages the server with Apache bench
 148 #. Tears everything down