X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9ce6e51cac3c4c4f3d2ab7c879d6901cbba1c7e7;hb=refs%2Ftags%2F0.10.3;hp=2274b6e75153dc3a93b8e63a1deb342ed6c77ac8;hpb=fdf050451414e1a816e343bcd56f33186a742e49;p=ric-plt%2Fa1.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 2274b6e..9ce6e51 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -43,6 +43,18 @@ This project follows semver. When changes are made, the versions are in: 7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml`` +Version bumping rmr-python +========================== +rmr-python is a critial dependency of A1. Bumping the rmr version dependency requires changes in: + +1) ``setup.py`` + +2) ``Dockerfile`` + +3) ``integration_tests/Dockerfile`` + +Run the integration tests after attempting this. + 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. @@ -53,6 +65,12 @@ Also, this requires the python packages ``tox`` and ``pytest``. 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) + +:: + + 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. @@ -73,8 +91,6 @@ If you've never run the integration tests before, build the test receiver, which cd integration_tests docker build --no-cache -t testreceiver:latest . -You do not need the "bombarder" image as they are not currently used in the integration tests (that is more for load testing). - Finally, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``). :: @@ -95,8 +111,7 @@ Running locally 1. Before this will work, for the first time on that machine, run ``./install_deps.sh`` -2. It also requires rmr-python >= 0.10.1 installed. (The dockerfile also - does this) +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 @@ -149,11 +164,3 @@ while it is sleeping, and both responses should be correct. 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 - -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 - -:: - - set -x LD_LIBRARY_PATH /usr/local/lib/; set -x RMR_SEED_RT /opt/route/local.rt ; python bombard.py