-.. ==================================================================================
-.. Copyright (c) 2019 Nokia
-.. Copyright (c) 2018-2019 AT&T Intellectual Property.
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-.. ==================================================================================
-
-A1 Dev Guide
-============
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Developer Guide
+===============
+
+.. contents::
+ :depth: 3
+ :local:
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) ``a1/openapi.yml``
+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::
-Running locally
-===============
+ bumpversion --verbose patch
-1. This requires that RMR is installed on the base system. (the
- Dockerfile does this when running in Docker)
+Or change the minor version like this::
-2. It also requires rmr-python >= 0.10.1 installed. (The dockerfile also
- does this)
+ bumpversion --verbose minor
-3. Create a ``local.rt`` file and copy it into ``/opt/route/local.rt``.
- Note, the example one in ``local_tests`` will need to be modified for
- your scenario and machine.
+After the `bumpversion` utility has modified the files, update the
+release notes then commit.
-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:
- ::
+Version bumping RMR
+-------------------
- cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json cp
- tests/fixtures/rmr_string_int_mapping.txt
- /opt/rmr_string_int_mapping.txt
+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).
-5. Then:
+In addition these items in this repo must be kept in sync:
- sudo pip install –ignore-installed .; 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
+#. ``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.
-Testing locally
-===============
-There are also two test receivers in ``localtests`` you can run locally.
-The first is meant to be used with the ``control_admission`` policy
-(that comes in test fixture ric manifest):
+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:
+
+#. ``Dockerfile``
+#. ``Dockerfile-Unit-Test``
+#. ``tox.ini``
+
+
+Running A1 Standalone
+---------------------
+
+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]
+
+Then test the server with an invocation such as this::
+
+ curl localhost:10000/a1-p/healthcheck
+
+
+Unit Testing
+------------
+
+Running the unit tests requires the python packages ``tox`` and ``pytest``.
+
+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``.
+
+Upon completion, view the test coverage like this:
::
- set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; python receiver.py
+ tox
+ open htmlcov/index.html
-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:
+Alternatively, you can run the unit tests in Docker (this is somewhat
+less nice because you don't get the pretty HTML)
::
- 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
+ docker build --no-cache -f Dockerfile-Unit-Test .
-To test the async nature of A1, trigger a call to ``test_policy``, which
-will target the delayed receicer, 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.
+
+Integration testing
+-------------------
+
+This tests A1’s external API with three test receivers. This requires
+docker, kubernetes and helm.
+
+Build all the images:
::
- 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 '{"dc_admission_start_time": "10:00:00", "dc_admission_end_time": "11:00:00"}' localhost:10000/ric/policies/control_admission_time
+ 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 .
-Finally, there is a test “bombarder” that will flood A1 with messages
-with good message types but bad transaction IDs, to test A1’s resilience
-against queue-overflow attacks
+
+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 ; python bombard.py
+ tox -c tox-integration.ini
+
+This script:
+
+#. 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