Developer Guide¶
This document explains how to maintain the RIC Xapp framework. Information for users of this framework (i.e., Xapp developers) is in the User Guide.
Tech Stack¶
The framework requires Python version 3.7 or later, and depends on these packages provided by the O-RAN-SC project and third parties:
- msgpack
- mdclogpy
- ricsdl
Version bumping the framework¶
This project follows semver. When changes are made, the versions are in:
docs/release-notes.rst
setup.py
Version bumping RMR¶
These items in this repo must be kept in sync with the RMR version:
- Dockerfile-Unit-Test
- examples/Dockerfile-Ping
- examples/Dockerfile-Pong
rmr-version.yaml
controls what version of RMR is installed for unit testing in Jenkins CI
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 according to its instructions.
Upon completion, view the test coverage like this:
tox
open htmlcov/index.html
Alternatively, if you cannot install RMR locally, you can run the unit tests in Docker. This is somewhat less nice because you don’t get the pretty HTML report on coverage.
docker build --no-cache -f Dockerfile-Unit-Test .