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 A1 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.8
  18
  19 Version bumping A1
  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 5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
  33
  34 6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
  35
  36
  37 Version bumping RMR
  38 -------------------
  39
  40 As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three
  41 integration test receivers use an Alpine base image and install RMR
  42 from a base builder image.  Must update and rebuild all 5 containers
  43 in the A1 repo (or just A1 itself for prod usage).
  44
  45 In addition these items in this repo must be kept in sync:
  46 * ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
  47 * ``integration_tests/install_rmr.sh`` is a useful script for a variety of local testing.
  48
  49 Version bumping Python
  50 ----------------------
  51
  52 If you want to update the version of python itself (ie just done from 37 to 38):
  53
  54 1) ``Dockerfile``
  55
  56 2) ``Dockerfile-Unit-Test``
  57
  58 3) ``tox.ini``
  59
  60 Unit Testing
  61 ------------
  62
  63 Running the unit tests requires the python packages ``tox`` and ``pytest``.
  64
  65 The RMR library is also required during unit tests. If running directly from tox
  66 (outside a Docker container), install RMR using the script in the integration_tests
  67 directory: ``install_rmr.sh``.
  68
  69 Upon completion, view the test coverage like this:
  70
  71 ::
  72
  73    tox
  74    open htmlcov/index.html
  75
  76 Alternatively, you can run the unit tests in Docker (this is somewhat
  77 less nice because you don't get the pretty HTML)
  78
  79 ::
  80
  81    docker build  --no-cache -f Dockerfile-Unit-Test .
  82
  83 Integration testing
  84 -------------------
  85
  86 This tests A1’s external API with three test receivers. This requires
  87 docker, kubernetes and helm.
  88
  89 Build all the images:
  90
  91 ::
  92
  93     docker build  -t a1:latest .
  94     cd integration_tests/testxappcode
  95     docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
  96     docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
  97     docker build -t testreceiver:latest  -f Dockerfile-test-receiver  .
  98
  99
 100 Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
 101
 102 ::
 103
 104    tox -c tox-integration.ini
 105
 106 This script:
 107 1. Deploys 3 helm charts (5 containers) into a local kubernetes installation
 108 2. Port forwards a pod ClusterIP to localhost
 109 3. Uses “tavern” to run some tests against the server
 110 4. Barrages the server with apache bench
 111 5. Tears everything down