X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=9ce6e51cac3c4c4f3d2ab7c879d6901cbba1c7e7;hb=d5024709403d3ae909b91af8cd04c9caef1e49c6;hp=60c1d9ab755ed6a50f54ba7635b19767aed3b1c9;hpb=438a0a662e2e67af7f248f9715b54f92efc4a80c;p=ric-plt%2Fa1.git

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 60c1d9a..9ce6e51 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -43,15 +43,34 @@ 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, this requires rmr to be installed on the system executing the tests. Also, this requires the python packages ``tox`` and ``pytest``.
+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``.
 
 ::
 
    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.
@@ -72,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``).
 ::
 
@@ -86,17 +103,18 @@ This script:
 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. This requires that RMR is installed on the base system. (the
-   Dockerfile does this when running in Docker)
+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 ``local_tests`` will need to be modified for
+   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
@@ -105,19 +123,17 @@ Running locally
 
    ::
 
-     cp tests/fixtures/ricmanifest.json /opt/ricmanifest.json cp
-     tests/fixtures/rmr_string_int_mapping.txt
-     /opt/rmr_string_int_mapping.txt
+     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 –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;
+   ::
+
+   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
 
-Testing locally
-===============
 
 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
@@ -145,12 +161,6 @@ 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 '{"dc_admission_start_time": "10:00:00", "dc_admission_end_time": "11:00:00"}' localhost:10000/ric/policies/control_admission_time
-
-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
+   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