-A1
-==
+.. 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
- Python3.7
Version bumping
-===============
+---------------
This project follows semver. When changes are made, the versions are in:
2) ``setup.py``
-3) ``a1/openapi.yml``
+3) ``container-tag.yaml``
-Running locally
-===============
+4) ``integration_tests/a1mediator/Chart.yaml``
-1. This requires that RMR is installed on the base system. (the
- Dockerfile does this when running in Docker)
+6) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes)
-2. It also requires rmr-python >= 0.10.1 installed. (The dockerfile also
- does this)
+7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
-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.
-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
+-------------------
+As of 2020/02/13, A1 and all three integration test receivers use a base image from o-ran-sc.
+The rmr version is in that base image.
+However, the one item in this repo that must be kept in sync is ``rmr-version.yaml``. This controls what rmr gets installed for unit testing.
- ::
+Version bumping pyrmr
+---------------------
+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:
- cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json cp
- tests/fixtures/rmr_string_int_mapping.txt
- /opt/rmr_string_int_mapping.txt
+1) ``setup.py``
-5. Then:
+2) ``integration_tests/Dockerfile-test-delay-receiver``
- 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
+3) ``integration_tests/Dockerfile-query-receiver``
-Testing locally
-===============
+Run the integration tests after attempting this.
-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):
+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``.
::
- 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 -t a1test:latest -f Dockerfile-Unit-Test
+
+Integration testing
+-------------------
+This tests A1’s external API with three test receivers. This depends on helm+k8s.
-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 containers:
::
- 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/; docker build -t testreceiver:latest . -f Dockerfile-test-delay-receiver; docker build -t queryreceiver:latest . -f Dockerfile-query-receiver; cd ..
-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 2 helm charts (4 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
Code Review / ric-plt / a1.git / blobdiff