X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Fdeveloper-guide.rst;h=f2db426ac82c21fb0268810a272f8ca4418a475f;hb=efeb06cc49320e812441a43a071907a9830955ad;hp=9c0132cbf85f4fd51f086608f6b223571db42e3f;hpb=c91a4a172446229f4b11e76547ffdf454528b30d;p=ric-plt%2Fa1.git diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 9c0132c..f2db426 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -11,68 +11,7 @@ Developer Guide Tech Stack ---------- -The A1 Mediator is implemented in Python, currently version 3.8, and -depends on these third-party packages and technologies: - -- OpenAPI3 -- Connexion -- Flask with Gevent serving -- Swagger -- Prometheus - - -Version bumping A1 ------------------- - -This project follows semver. When the version string changes, these -files must be updated: - -#. ``setup.py`` -#. ``container-tag.yaml`` -#. ``integration_tests/a1mediator/Chart.yaml`` -#. ``docs/release-notes.rst`` -#. ``a1/openapi.yaml`` But note this is an API version, not a software version; there's no need to bump on non-API changes. -#. And over in the ric-plt/ric-dep repo that contains the A1 Mediator helm chart, files ``values.yaml`` and ``Chart.yaml``. - -It's convenient to use the Python utility `bumpversion` to maintain -the first three items. After setup (``pip install bumpversion``) you -can change the patch version like this:: - - bumpversion --verbose patch - -Or change the minor version like this:: - - bumpversion --verbose minor - -After the `bumpversion` utility has modified the files, update the -release notes then commit. - - -Version bumping RMR -------------------- - -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 production 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 ----------------------- - -If you want to update the version of python; for example this was -recently done to move from 3.7 to 3.8, update these files: - -#. ``Dockerfile`` -#. ``Dockerfile-Unit-Test`` -#. ``tox.ini`` +The A1 Mediator is implemented in Golang. Running A1 Standalone @@ -92,30 +31,6 @@ Then test the server with an invocation such as this:: curl localhost:10000/a1-p/healthcheck -Unit Testing ------------- - -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) - -:: - - docker build --no-cache -f Dockerfile-Unit-Test . - - Integration testing -------------------