.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-Developer-Guide
-===============
+A1 Developer Guide
+==================
.. contents::
:depth: 3
- OpenAPI3
- Connexion
- Flask with Gevent serving
-- Python3.7
+- Python3.8
-Version bumping
----------------
+Version bumping A1
+------------------
This project follows semver. When changes are made, the versions are in:
6) in the ric-plt repo that contains a1 helm chart, ``values.yaml``, ``Chart.yml``
-Version bumping rmr
+Version bumping RMR
-------------------
-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).
-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.
+As of 2020/02/13, A1 (Dockerfile), Dockerfile-Unit-Test, and all three
+integration test receivers use an Alpine base image and install RMR
+from a base builder image. Must update and rebuild all 5 containers
+in the A1 repo (or just A1 itself for prod usage).
+
+In addition these items in this repo must be kept in sync:
+* ``rmr-version.yaml`` controls what rmr gets installed for unit testing in Jenkins
+* ``integration_tests/install_rmr.sh`` is a useful script for a variety of local testing.
+
+Version bumping Python
+----------------------
-Version bumping python itself
------------------------------
If you want to update the version of python itself (ie just done from 37 to 38):
1) ``Dockerfile``
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``.
+
+Running the unit tests requires the python packages ``tox`` and ``pytest``.
+
+The RMR library is also required during unit tests. If running directly from tox
+(outside a Docker container), install RMR using the script in the integration_tests
+directory: ``install_rmr.sh``.
+
+Upon completion, view the test coverage like this:
::
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)
+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
+ docker build --no-cache -f Dockerfile-Unit-Test .
Integration testing
-------------------
-This tests A1’s external API with three test receivers. This depends on helm+k8s.
-Build all the containers:
+This tests A1’s external API with three test receivers. This requires
+docker, kubernetes and helm.
+
+Build all the images:
::
- docker build -t a1:latest .; cd integration_tests/; docker build -t testreceiver:latest . -f Dockerfile-test-delay-receiver; docker build -t queryreceiver:latest . -f Dockerfile-query-receiver; cd ..
+ docker build -t a1:latest .
+ cd integration_tests/testxappcode
+ docker build -t delayreceiver:latest -f Dockerfile-delay-receiver .
+ docker build -t queryreceiver:latest -f Dockerfile-query-receiver .
+ docker build -t testreceiver:latest -f Dockerfile-test-receiver .
Then, run all the tests from the root (this requires the python packages ``tox``, ``pytest``, and ``tavern``).
Code Review / ric-plt / a1.git / blobdiff