.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Developer-Guide
+Developer Guide
===============
.. contents::
Tech Stack
----------
-- OpenAPI3
-- Connexion
-- Flask with Gevent serving
-- Python3.7
+The A1 Mediator is implemented in Python, currently version 3.8, and
+depends on these third-party packages and technologies:
-Version bumping
----------------
+- OpenAPI3
+- Connexion
+- Flask with Gevent serving
+- Swagger
+- Prometheus
-This project follows semver. When changes are made, the versions are in:
-1) ``docs/release-notes.rst``
+Version bumping A1
+------------------
-2) ``setup.py``
+This project follows semver. When the version string changes, these
+files must be updated:
-3) ``container-tag.yaml``
+#. ``setup.py``
+#. ``container-tag.yaml``
+#. ``integration_tests/a1mediator/Chart.yaml``
+#. ``docs/release-notes.rst``
+#. ``a1/openapi.yaml`` But note this is an API version, not a software version; there's no need to bump on non-API changes.
+#. And over in the ric-plt/ric-dep repo that contains the A1 Mediator helm chart, files ``values.yaml`` and ``Chart.yaml``.
-4) ``integration_tests/a1mediator/Chart.yaml``
+It's convenient to use the Python utility `bumpversion` to maintain
+the first three items. After setup (``pip install bumpversion``) you
+can change the patch version like this::
-6) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
+ bumpversion --verbose patch
-7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
+Or change the minor version like this::
+ bumpversion --verbose minor
-Version bumping rmr
---------------------
-rmr is a critical dependency of A1. Bumping the rmr version dependency requires changes in:
+After the `bumpversion` utility has modified the files, update the
+release notes then commit.
-1) ``Dockerfile``
-2) ``Dockerfile-Unit-Test``
+Version bumping RMR
+-------------------
-3) ``integration_tests/Dockerfile``
+A1 (Dockerfile), Dockerfile-Unit-Test, and all three integration test
+receivers use an Alpine base image and install RMR from a base builder
+image. Must update and rebuild all 5 containers in the A1 repo (or
+just A1 itself for production usage).
-rmr-python is the python binding to rmr . Installing rmr per the above does not install it.
-Bumping the rmr python version dependency requires changes in:
+In addition these items in this repo must be kept in sync:
-1) ``setup.py``
+#. ``rmr-version.yaml`` controls what rmr gets installed for unit
+ testing in Jenkins
+#. ``integration_tests/install_rmr.sh`` is a useful script for a
+ variety of local testing.
-2) ``integration_tests/Dockerfile``
-Run the integration tests after attempting this.
+Version bumping Python
+----------------------
+If you want to update the version of python; for example this was
+recently done to move from 3.7 to 3.8, update these files:
-Unit Testing
-------------
-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.
-Also, this requires the python packages ``tox`` and ``pytest``.
+#. ``Dockerfile``
+#. ``Dockerfile-Unit-Test``
+#. ``tox.ini``
-::
- tox
- open htmlcov/index.html
+Running A1 Standalone
+---------------------
-Alternatively, you can run the unit tests in Docker (this is somewhat less nice because you don't get the pretty HTML)
+The A1 container can be run standalone, which means using an in-memory mock
+version of SDL and a static route table. The host machine must have the RMR
+library and the environment must define the variable `prometheus_multiproc_dir`
+with a value like /tmp. Alternately, use the following command to run A1 as
+a Docker container, using a route table mounted as a file from this git
+repository and exposing the server's HTTP port on the Docker host::
-::
+ docker run -e USE_FAKE_SDL=True -p 10000:10000 -v `pwd`:/opt/route [DOCKER_IMAGE_ID_HERE]
- docker build --no-cache -t a1test:latest -f Dockerfile-Unit-Test
+Then test the server with an invocation such as this::
-Integration testing
--------------------
-This tests A1’s external API with two test receivers. This depends on helm+k8s, meaning you cannot run this if this is not installed.
+ curl localhost:10000/a1-p/healthcheck
-Unlike the unit tests, however, this does not require rmr to be installed on the base system, as everything
-runs in Docker, and the Dockerfiles provide/install rmr.
-First, build the latest A1 you are testing (from the root):
-::
-
- docker build --no-cache -t a1:latest .
+Unit Testing
+------------
-Note that this step also runs the unit tests, since running the unit tests are part of the Dockerfile for A1.
+Running the unit tests requires the python packages ``tox`` and ``pytest``.
-If you've never run the integration tests before, build the test receiver, which is referenced in the helm chart:
-::
+The RMR library is also required during unit tests. If running
+directly from tox (outside a Docker container), install RMR using the
+script in the integration_tests directory: ``install_rmr.sh``.
- cd integration_tests
- docker build --no-cache -t testreceiver:latest .
+Upon completion, view the test coverage like this:
-Finally, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
::
- tox -c tox-integration.ini
-
-This script:
-1. Deploys 3 helm charts into a local kubernetes installation
-2. Port forwards a pod ClusterIP to localhost
-3. Uses “tavern” to run some tests against the server
-4. Barrages the server with apache bench
-5. Tears everything down
-
-Unless you're a core A1 developer, you should probably stop here. The below instructions
-are for running A1 locally, without docker, and is much more involved (however useful when developing a1).
-
-Running locally
----------------
-
-1. Before this will work, for the first time on that machine, run ``./install_deps.sh``
-
-2. It also requires rmr-python installed. (The dockerfile does this)
-
-3. Create a ``local.rt`` file and copy it into ``/opt/route/local.rt``.
- Note, the example one in ``integration_tests`` will need to be modified for
- your scenario and machine.
-
-4. Copy a ric manifest into ``/opt/ricmanifest.json`` and an rmr mapping
- table into ``/opt/rmr_string_int_mapping.txt``. You can use the test
- ones packaged if you want:
+ tox
+ open htmlcov/index.html
- ::
+Alternatively, you can run the unit tests in Docker (this is somewhat
+less nice because you don't get the pretty HTML)
- cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json
- cp tests/fixtures/rmr_string_int_mapping.txt /opt/rmr_string_int_mapping.txt
+::
-5. Then:
+ docker build --no-cache -f Dockerfile-Unit-Test .
- ::
- sudo pip install -e .
- set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; set -x RMR_RCV_RETRY_INTERVAL 500; set -x RMR_RETRY_TIMES 10;
- /usr/bin/run.py
+Integration testing
+-------------------
+This tests A1’s external API with three test receivers. This requires
+docker, kubernetes and helm.
-There are also two test receivers in ``integration_tests`` you can run locally.
-The first is meant to be used with the ``control_admission`` policy
-(that comes in test fixture ric manifest):
+Build all the images:
::
- set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; python receiver.py
+ docker build -t a1:latest .
+ cd integration_tests/testxappcode
+ docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
+ docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
+ docker build -t testreceiver:latest -f Dockerfile-test-receiver .
-The second can be used against the ``test_policy`` policy to test the
-async nature of A1, and to test race conditions. You can start it with
-several env variables as follows:
-::
+Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
- 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
+::
-To test the async nature of A1, trigger a call to ``test_policy``, which
-will target the delayed receiver, then immediately call
-``control_admission``. The ``control_admission`` policy return should be
-returned immediately, whereas the ``test_policy`` should return after
-about ``TEST_RCV_SEC_DELAY 5``. The ``test_policy`` should not block A1
-while it is sleeping, and both responses should be correct.
+ tox -c tox-integration.ini
-::
+This script:
- curl -v -X PUT -H "Content-Type: application/json" -d '{}' localhost:10000/ric/policies/test_policy
- curl -v -X PUT -H "Content-Type: application/json" -d '{ "enforce":true, "window_length":10, "blocking_rate":20, "trigger_threshold":10 }' localhost:10000/ric/policies/admission_control_policy
- curl -v localhost:10000/ric/policies/admission_control_policy
- curl -v localhost:10000/a1-p/healthcheck
+#. Deploys 3 helm charts (5 containers) into a local kubernetes installation
+#. Port forwards a pod ClusterIP to localhost
+#. Uses “tavern” to run some tests against the server
+#. Barrages the server with Apache bench
+#. Tears everything down
Code Review / ric-plt / a1.git / blobdiff