Updates:
* Switch to python3.8
* Switch to SI95 from NNG (rmr v3 vs rmr v1)
* The switch to SI95 led to a rabbit hole in which we eventually discovered that rmr_send may sometimes block for an arbitrary period of time. Because of this issue, a1's sends are now threaded. Please see the longer comment about this in a1rmr.
* Bump version of py xapp frame (SDL used only) in A1
* Bump version of go xapp frame (0.0.24 -> 0.4.2) in integration tests
* Add some additional logging in A1
Issue-ID: RIC-156
Change-Id: I8ed5356bea60a3ccea6fa2d03981ad634b98bab1
Signed-off-by: Tommy Carpenter <tc677g@att.com>
diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index b458b1f..6ef21f9 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -36,22 +36,26 @@
Version bumping rmr
-------------------
-As of 2020/02/13, A1, Dockerfile-Unit-Test, and all three integration test receivers use a base image from o-ran-sc.
+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.
-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.
+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).
+
+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.
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:
+Bumping the rmr python version is done via ``setup.py``
-1) ``setup.py``
+Version bumping python itself
+-----------------------------
+If you want to update the version of python itself (ie just done from 37 to 38):
-2) ``integration_tests/Dockerfile-test-delay-receiver``
+1) ``Dockerfile``
-3) ``integration_tests/Dockerfile-query-receiver``
+2) ``Dockerfile-Unit-Test``
-Run the integration tests after attempting this.
+3) ``tox.ini``
Unit Testing
------------