X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=2274b6e75153dc3a93b8e63a1deb342ed6c77ac8;hb=fdf050451414e1a816e343bcd56f33186a742e49;hp=f9a95ccfa429b0b8d194d3c811a877d7cc12ceb6;hpb=09edf28fd47faf808e053d6ede06315c3926fa45;p=ric-plt%2Fa1.git

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index f9a95cc..2274b6e 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -37,23 +37,69 @@ This project follows semver. When changes are made, the versions are in:
 
 3) ``container-tag.yaml``
 
-4) ``a1mediator/values.yaml``
+4) ``integration_tests/a1mediator/Chart.yaml``
 
-5) ``a1mediator/Chart.yaml``
+6) ``a1/openapi.yml`` (this is an API version, not a software version)
 
-6) ``a1/openapi.yml``
+7) in the it/dep repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
+
+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``.
+
+::
+
+   tox
+   open htmlcov/index.html
+
+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.
+
+First, build the latest A1 you are testing (from the root):
+::
+
+    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.
+
+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 .
+
+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``).
+::
+
+   tox -c tox-integration.ini
+
+This script:
+1. Deploys 3 helm charts 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. 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)
 
 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
@@ -62,19 +108,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
@@ -102,7 +146,9 @@ 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
+   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