X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=63ddde32e8ef2ffd0a17b46afa21fc10aaff93ea;hb=refs%2Fchanges%2F07%2F2907%2F10;hp=e3e47c5dab8b78f9302aab6920fe30002645bc6d;hpb=9d5ad7161f64346c17e9c466bf1992e4257e9bde;p=ric-plt%2Fa1.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index e3e47c5..63ddde3 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -29,35 +29,28 @@ 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: - -1) ``Dockerfile`` - -2) ``Dockerfile-Unit-Test`` - -3) ``integration_tests/Dockerfile-test-delay-receiver`` - -4) ``integration_tests/Dockerfile-query-receiver`` - -5) ``rmr-version.yaml`` +------------------- +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). -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: +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. -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 ------------ @@ -93,7 +86,7 @@ Then, run all the tests from the root (this requires the python packages ``tox`` tox -c tox-integration.ini This script: -1. Deploys 2 helm charts (4 containers) 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