X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=d9a3a8a22d10efffe1e9fe97f2bf1ebd4685ada1;hb=fe30c1726c397b1ee100cd3d3795758e7d21b6bf;hp=57c70020ec484eca6e2c30945456c5a850e619fd;hpb=5ad8f03e1fc7683bb59da31f59edc2f6c0b2372b;p=ric-plt%2Fa1.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 57c7002..d9a3a8a 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,16 +1,23 @@ -A1 -== +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +A1 Developer Guide +================== + +.. contents:: + :depth: 3 + :local: Tech Stack -========== +---------- - OpenAPI3 - Connexion - Flask with Gevent serving -- Python3.7 +- Python3.8 -Version bumping -=============== +Version bumping A1 +------------------ This project follows semver. When changes are made, the versions are in: @@ -18,73 +25,87 @@ This project follows semver. When changes are made, the versions are in: 2) ``setup.py`` -3) ``a1/openapi.yml`` +3) ``container-tag.yaml`` + +4) ``integration_tests/a1mediator/Chart.yaml`` + +5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes) + +6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml`` + -Running locally -=============== +Version bumping RMR +------------------- -1. This requires that RMR is installed on the base system. (the - Dockerfile does this when running in Docker) +As of 2020/02/13, 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 prod usage). -2. It also requires rmr-python >= 0.10.1 installed. (The dockerfile also - does this) +In addition these items in this repo must be kept in sync: +* ``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. -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. +Version bumping Python +---------------------- -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: +If you want to update the version of python itself (ie just done from 37 to 38): - :: +1) ``Dockerfile`` - cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json cp - tests/fixtures/rmr_string_int_mapping.txt - /opt/rmr_string_int_mapping.txt +2) ``Dockerfile-Unit-Test`` -5. Then: +3) ``tox.ini`` - 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 +Unit Testing +------------ -Testing locally -=============== +Running the unit tests requires the python packages ``tox`` and ``pytest``. -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): +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 . + +Integration testing +------------------- + +This tests A1’s external API with three test receivers. This requires +docker, kubernetes and helm. -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. +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: +1. Deploys 3 helm charts (5 containers) 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