X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=f562c7cc199b0e2afd82ff84df4be09d4fb680c3;hb=refs%2Fchanges%2F54%2F3454%2F7;hp=ca9221461b4dc5cb05d0c688a2c2b2d744234274;hpb=8bcc51a6d44d40a1a338fb6a721b5ee8f992f323;p=ric-plt%2Fa1.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index ca92214..f562c7c 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -1,33 +1,23 @@ -.. ================================================================================== -.. 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 + +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: @@ -39,33 +29,34 @@ This project follows semver. When changes are made, the versions are in: 4) ``integration_tests/a1mediator/Chart.yaml`` -6) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes) +5) ``a1/openapi.yaml`` (this is an API version, not a software version; no need to bump on patch changes) -7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml`` +6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml`` -Version bumping rmr -==================== -rmr is a critical dependency of A1. Bumping the rmr version dependency requires changes in: +Version bumping RMR +------------------- -1) ``Dockerfile`` - -2) ``Dockerfile-Unit-Test`` +As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three integration test receivers use a base image from o-ran-sc. +The rmr version is in that base image. +When version changes are made in that image, rebuilding those 5 containers in the A1 repo will pick it up (or just A1 itself for prod usage). -3) ``integration_tests/Dockerfile`` +However, there are two items in this repo that must be kept in sync: ``rmr-version.yaml``, which controls what rmr gets installed for unit testing in Jenkins, and ``integration_tests/install_rmr.sh`` which is a useful script for a variety of local testing. -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: +Version bumping Python +---------------------- -1) ``setup.py`` +If you want to update the version of python itself (ie just done from 37 to 38): -2) ``integration_tests/Dockerfile`` +1) ``Dockerfile`` -Run the integration tests after attempting this. +2) ``Dockerfile-Unit-Test`` +3) ``tox.ini`` 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``. @@ -81,95 +72,30 @@ Alternatively, you can run the unit tests in Docker (this is somewhat less nice docker build --no-cache -t a1test:latest -f Dockerfile-Unit-Test 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. +------------------- -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. +This tests A1’s external API with three test receivers. This requires docker, kubernetes and helm. -First, build the latest A1 you are testing (from the root): -:: +Build all the images: - docker build --no-cache -t a1:latest . +:: -Note that this step also runs the unit tests, since running the unit tests are part of the Dockerfile for A1. + 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 . -If you've never run the integration tests before, build the test receiver, which is referenced in the helm chart: -:: - cd integration_tests - docker build --no-cache -t testreceiver:latest . +Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``). -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 +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 - -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: - - :: - - cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json - cp tests/fixtures/rmr_string_int_mapping.txt /opt/rmr_string_int_mapping.txt - -5. Then: - - :: - - 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 - - -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): - -:: - - set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; python receiver.py - -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: - -:: - - 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. - -:: - - 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