docs/developer-guide.rst

   1 A1
   2 ==
   3
   4 Tech Stack
   5 ==========
   6
   7 -  OpenAPI3
   8 -  Connexion
   9 -  Flask with Gevent serving
  10 -  Python3.7
  11
  12 Version bumping
  13 ===============
  14
  15 This project follows semver. When changes are made, the versions are in:
  16
  17 1) ``docs/release-notes.rst``
  18
  19 2) ``setup.py``
  20
  21 3) ``a1/openapi.yml``
  22
  23 Running locally
  24 ===============
  25
  26 1. This requires that RMR is installed on the base system. (the
  27    Dockerfile does this when running in Docker)
  28
  29 2. It also requires rmr-python >= 0.10.1 installed. (The dockerfile also
  30    does this)
  31
  32 3. Create a ``local.rt`` file and copy it into ``/opt/route/local.rt``.
  33    Note, the example one in ``local_tests`` will need to be modified for
  34    your scenario and machine.
  35
  36 4. Copy a ric manifest into ``/opt/ricmanifest.json`` and an rmr mapping
  37    table into ``/opt/rmr_string_int_mapping.txt``. You can use the test
  38    ones packaged if you want:
  39
  40    ::
  41
  42      cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json cp
  43      tests/fixtures/rmr_string_int_mapping.txt
  44      /opt/rmr_string_int_mapping.txt
  45
  46 5. Then:
  47
  48    sudo pip install –ignore-installed .; set -x LD_LIBRARY_PATH
  49    /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; set -x
  50    RMR_RCV_RETRY_INTERVAL 500; set -x RMR_RETRY_TIMES 10;
  51    /usr/bin/run.py
  52
  53 Testing locally
  54 ===============
  55
  56 There are also two test receivers in ``localtests`` you can run locally.
  57 The first is meant to be used with the ``control_admission`` policy
  58 (that comes in test fixture ric manifest):
  59
  60 ::
  61
  62    set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; python receiver.py
  63
  64 The second can be used against the ``test_policy`` policy to test the
  65 async nature of A1, and to test race conditions. You can start it with
  66 several env variables as follows:
  67
  68 ::
  69
  70    set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; set -x TEST_RCV_PORT 4563; set -x TEST_RCV_RETURN_MINT 10001; set -x TEST_RCV_SEC_DELAY 5; set -x TEST_RCV_RETURN_PAYLOAD '{"ACK_FROM": "DELAYED_TEST", "status": "SUCCESS"}' ; python receiver.py
  71
  72 To test the async nature of A1, trigger a call to ``test_policy``, which
  73 will target the delayed receicer, then immediately call
  74 ``control_admission``. The ``control_admission`` policy return should be
  75 returned immediately, whereas the ``test_policy`` should return after
  76 about ``TEST_RCV_SEC_DELAY 5``. The ``test_policy`` should not block A1
  77 while it is sleeping, and both responses should be correct.
  78
  79 ::
  80
  81    curl -v -X PUT -H "Content-Type: application/json" -d '{}' localhost:10000/ric/policies/test_policy
  82    curl -v -X PUT -H "Content-Type: application/json" -d '{"dc_admission_start_time": "10:00:00", "dc_admission_end_time": "11:00:00"}' localhost:10000/ric/policies/control_admission_time
  83
  84 Finally, there is a test “bombarder” that will flood A1 with messages
  85 with good message types but bad transaction IDs, to test A1’s resilience
  86 against queue-overflow attacks
  87
  88 ::
  89
  90    set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ;  python bombard.py